next/dist/client/components/links.d.ts

The React Framework

import type { FlightRouterState } from '../../server/app-render/types';
import type { AppRouterInstance } from '../../shared/lib/app-router-context.shared-runtime';
import { type PrefetchTaskFetchStrategy } from './segment-cache';
import { type PrefetchTask } from './segment-cache';
type LinkElement = HTMLAnchorElement | SVGAElement;
type Element = LinkElement | HTMLFormElement;
type LinkOrFormInstanceShared = {
    router: AppRouterInstance;
    fetchStrategy: PrefetchTaskFetchStrategy;
    isVisible: boolean;
    prefetchTask: PrefetchTask | null;
};
export type FormInstance = LinkOrFormInstanceShared & {
    prefetchHref: string;
    setOptimisticLinkStatus: null;
};
type PrefetchableLinkInstance = LinkOrFormInstanceShared & {
    prefetchHref: string;
    setOptimisticLinkStatus: (status: {
        pending: boolean;
    }) => void;
};
type NonPrefetchableLinkInstance = LinkOrFormInstanceShared & {
    prefetchHref: null;
    setOptimisticLinkStatus: (status: {
        pending: boolean;
    }) => void;
};
export type LinkInstance = PrefetchableLinkInstance | NonPrefetchableLinkInstance;
export declare const PENDING_LINK_STATUS: {
    pending: boolean;
};
export declare const IDLE_LINK_STATUS: {
    pending: boolean;
};
export declare function setLinkForCurrentNavigation(link: LinkInstance | null): void;
export declare function unmountLinkForCurrentNavigation(link: LinkInstance): void;
export declare function mountLinkInstance(element: LinkElement, href: string, router: AppRouterInstance, fetchStrategy: PrefetchTaskFetchStrategy, prefetchEnabled: boolean, setOptimisticLinkStatus: (status: {
    pending: boolean;
}) => void): LinkInstance;
export declare function mountFormInstance(element: HTMLFormElement, href: string, router: AppRouterInstance, fetchStrategy: PrefetchTaskFetchStrategy): void;
export declare function unmountPrefetchableInstance(element: Element): void;
export declare function onLinkVisibilityChanged(element: Element, isVisible: boolean): void;
export declare function onNavigationIntent(element: HTMLAnchorElement | SVGAElement, unstable_upgradeToDynamicPrefetch: boolean): void;
export declare function pingVisibleLinks(nextUrl: string | null, tree: FlightRouterState): void;
export {};