import type { DefineSetupFnComponent, SlotsType, UnwrapRef, VNode } from 'vue'; import type { RouteLocation, RouteLocationRaw, RouterLinkProps, UseLinkReturn } from 'vue-router'; import { type NuxtApp } from '../nuxt.js'; /** * `` is a drop-in replacement for both Vue Router's `` component and HTML's `` tag. * @see https://nuxt.com/docs/api/components/nuxt-link */ export interface NuxtLinkProps extends Omit { custom?: CustomProp; /** * Route Location the link should navigate to when clicked on. */ to?: RouteLocationRaw; /** * An alias for `to`. If used with `to`, `href` will be ignored */ href?: NuxtLinkProps['to']; /** * Forces the link to be considered as external (true) or internal (false). This is helpful to handle edge-cases */ external?: boolean; /** * Where to display the linked URL, as the name for a browsing context. */ target?: '_blank' | '_parent' | '_self' | '_top' | (string & {}) | null; /** * A rel attribute value to apply on the link. Defaults to "noopener noreferrer" for external links. */ rel?: 'noopener' | 'noreferrer' | 'nofollow' | 'sponsored' | 'ugc' | (string & {}) | null; /** * If set to true, no rel attribute will be added to the link */ noRel?: boolean; /** * A class to apply to links that have been prefetched. */ prefetchedClass?: string; /** * When enabled will prefetch middleware, layouts and payloads of links in the viewport. */ prefetch?: boolean; /** * Allows controlling when to prefetch links. By default, prefetch is triggered only on visibility. */ prefetchOn?: 'visibility' | 'interaction' | Partial<{ visibility: boolean; interaction: boolean; }>; /** * Escape hatch to disable `prefetch` attribute. */ noPrefetch?: boolean; /** * An option to either add or remove trailing slashes in the `href` for this specific link. * Overrides the global `trailingSlash` option if provided. */ trailingSlash?: 'append' | 'remove'; } /** * Create a NuxtLink component with given options as defaults. * @see https://nuxt.com/docs/api/components/nuxt-link */ export interface NuxtLinkOptions extends Partial>, Partial> { /** * The name of the component. * @default "NuxtLink" */ componentName?: string; /** * A default `rel` attribute value applied on external links. Defaults to `"noopener noreferrer"`. Set it to `""` to disable. */ externalRelAttribute?: string | null; /** * An option to either add or remove trailing slashes in the `href`. * If unset or not matching the valid values `append` or `remove`, it will be ignored. */ trailingSlash?: 'append' | 'remove'; /** * Allows controlling default setting for when to prefetch links. By default, prefetch is triggered only on visibility. */ prefetchOn?: Exclude; } type NuxtLinkDefaultSlotProps = CustomProp extends true ? { href: string; navigate: (e?: MouseEvent) => Promise; prefetch: (nuxtApp?: NuxtApp) => Promise; route: (RouteLocation & { href: string; }) | undefined; rel: string | null; target: '_blank' | '_parent' | '_self' | '_top' | (string & {}) | null; isExternal: boolean; isActive: false; isExactActive: false; } : UnwrapRef; type NuxtLinkSlots = { default?: (props: NuxtLinkDefaultSlotProps) => VNode[]; }; export declare function defineNuxtLink(options: NuxtLinkOptions): (new (props: NuxtLinkProps) => InstanceType, [], SlotsType>>>) & Record; declare const _default: (new (props: NuxtLinkProps) => InstanceType, [], SlotsType>>>) & Record; export default _default;