import type { AllowedComponentProps, AnchorHTMLAttributes, ComputedRef, DefineComponent, InjectionKey, PropType, VNodeProps } from 'vue' import { computed, defineComponent, h, inject, onBeforeUnmount, onMounted, provide, ref, resolveComponent } from 'vue' import type { RouteLocation, RouteLocationRaw, Router, RouterLinkProps } from '#vue-router' import { hasProtocol, joinURL, parseQuery, parseURL, withTrailingSlash, withoutTrailingSlash } from 'ufo' import { preloadRouteComponents } from '../composables/preload' import { onNuxtReady } from '../composables/ready' import { navigateTo, useRouter } from '../composables/router' import { useNuxtApp, useRuntimeConfig } from '../nuxt' import { cancelIdleCallback, requestIdleCallback } from '../compat/idle-callback' // @ts-expect-error virtual file import { nuxtLinkDefaults } from '#build/nuxt.config.mjs' const firstNonUndefined = (...args: (T | undefined)[]) => args.find(arg => arg !== undefined) const NuxtLinkDevKeySymbol: InjectionKey = Symbol('nuxt-link-dev-key') /** * Create a NuxtLink component with given options as defaults. * @see https://nuxt.com/docs/api/components/nuxt-link */ export interface NuxtLinkOptions extends Pick, Pick { /** * 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' } /** * 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 { /** * Route Location the link should navigate to when clicked on. */ to?: RouteLocationRaw // need to manually type to avoid breaking typedPages /** * 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 /** * Escape hatch to disable `prefetch` attribute. */ noPrefetch?: boolean } /*@__NO_SIDE_EFFECTS__*/ export function defineNuxtLink (options: NuxtLinkOptions) { const componentName = options.componentName || 'NuxtLink' function checkPropConflicts (props: NuxtLinkProps, main: keyof NuxtLinkProps, sub: keyof NuxtLinkProps): void { if (import.meta.dev && props[main] !== undefined && props[sub] !== undefined) { console.warn(`[${componentName}] \`${main}\` and \`${sub}\` cannot be used together. \`${sub}\` will be ignored.`) } } function resolveTrailingSlashBehavior (to: string, resolve: Router['resolve']): string function resolveTrailingSlashBehavior (to: RouteLocationRaw, resolve: Router['resolve']): Exclude function resolveTrailingSlashBehavior (to: RouteLocationRaw | undefined, resolve: Router['resolve']): RouteLocationRaw | RouteLocation | undefined { if (!to || (options.trailingSlash !== 'append' && options.trailingSlash !== 'remove')) { return to } if (typeof to === 'string') { return applyTrailingSlashBehavior(to, options.trailingSlash) } const path = 'path' in to && to.path !== undefined ? to.path : resolve(to).path const resolvedPath = { ...to, path: applyTrailingSlashBehavior(path, options.trailingSlash) } // named routes would otherwise always override trailing slash behavior if ('name' in resolvedPath) { delete resolvedPath.name } return resolvedPath } return defineComponent({ name: componentName, props: { // Routing to: { type: [String, Object] as PropType, default: undefined, required: false }, href: { type: [String, Object] as PropType, default: undefined, required: false }, // Attributes target: { type: String as PropType, default: undefined, required: false }, rel: { type: String as PropType, default: undefined, required: false }, noRel: { type: Boolean as PropType, default: undefined, required: false }, // Prefetching prefetch: { type: Boolean as PropType, default: undefined, required: false }, noPrefetch: { type: Boolean as PropType, default: undefined, required: false }, // Styling activeClass: { type: String as PropType, default: undefined, required: false }, exactActiveClass: { type: String as PropType, default: undefined, required: false }, prefetchedClass: { type: String as PropType, default: undefined, required: false }, // Vue Router's `` additional props replace: { type: Boolean as PropType, default: undefined, required: false }, ariaCurrentValue: { type: String as PropType, default: undefined, required: false }, // Edge cases handling external: { type: Boolean as PropType, default: undefined, required: false }, // Slot API custom: { type: Boolean as PropType, default: undefined, required: false } }, setup (props, { slots }) { const router = useRouter() const config = useRuntimeConfig() // Resolving `to` value from `to` and `href` props const to: ComputedRef = computed(() => { checkPropConflicts(props, 'to', 'href') const path = props.to || props.href || '' // Defaults to empty string (won't render any `href` attribute) return resolveTrailingSlashBehavior(path, router.resolve) }) // Lazily check whether to.value has a protocol const isAbsoluteUrl = computed(() => typeof to.value === 'string' && hasProtocol(to.value, { acceptRelative: true })) const hasTarget = computed(() => props.target && props.target !== '_self') // Resolving link type const isExternal = computed(() => { // External prop is explicitly set if (props.external) { return true } // When `target` prop is set, link is external if (hasTarget.value) { return true } // When `to` is a route object then it's an internal link if (typeof to.value === 'object') { return false } return to.value === '' || isAbsoluteUrl.value }) // Prefetching const prefetched = ref(false) const el = import.meta.server ? undefined : ref(null) const elRef = import.meta.server ? undefined : (ref: any) => { el!.value = props.custom ? ref?.$el?.nextElementSibling : ref?.$el } if (import.meta.client) { checkPropConflicts(props, 'prefetch', 'noPrefetch') const shouldPrefetch = props.prefetch !== false && props.noPrefetch !== true && props.target !== '_blank' && !isSlowConnection() if (shouldPrefetch) { const nuxtApp = useNuxtApp() let idleId: number let unobserve: (() => void) | null = null onMounted(() => { const observer = useObserver() onNuxtReady(() => { idleId = requestIdleCallback(() => { if (el?.value?.tagName) { unobserve = observer!.observe(el.value as HTMLElement, async () => { unobserve?.() unobserve = null const path = typeof to.value === 'string' ? to.value : router.resolve(to.value).fullPath await Promise.all([ nuxtApp.hooks.callHook('link:prefetch', path).catch(() => {}), !isExternal.value && preloadRouteComponents(to.value as string, router).catch(() => {}) ]) prefetched.value = true }) } }) }) }) onBeforeUnmount(() => { if (idleId) { cancelIdleCallback(idleId) } unobserve?.() unobserve = null }) } } if (import.meta.dev && import.meta.server && !props.custom) { const isNuxtLinkChild = inject(NuxtLinkDevKeySymbol, false) if (isNuxtLinkChild) { console.log('[nuxt] [NuxtLink] You can\'t nest one inside another . This will cause a hydration error on client-side. You can pass the `custom` prop to take full control of the markup.') } else { provide(NuxtLinkDevKeySymbol, true) } } return () => { if (!isExternal.value) { const routerLinkProps: RouterLinkProps & VNodeProps & AllowedComponentProps & AnchorHTMLAttributes = { ref: elRef, to: to.value, activeClass: props.activeClass || options.activeClass, exactActiveClass: props.exactActiveClass || options.exactActiveClass, replace: props.replace, ariaCurrentValue: props.ariaCurrentValue, custom: props.custom } // `custom` API cannot support fallthrough attributes as the slot // may render fragment or text root nodes (#14897, #19375) if (!props.custom) { if (prefetched.value) { routerLinkProps.class = props.prefetchedClass || options.prefetchedClass } routerLinkProps.rel = props.rel || undefined } // Internal link return h( resolveComponent('RouterLink'), routerLinkProps, slots.default ) } // Resolves `to` value if it's a route location object // converts `""` to `null` to prevent the attribute from being added as empty (`href=""`) const href = typeof to.value === 'object' ? router.resolve(to.value)?.href ?? null : (to.value && !props.external && !isAbsoluteUrl.value) ? resolveTrailingSlashBehavior(joinURL(config.app.baseURL, to.value), router.resolve) as string : to.value || null // Resolves `target` value const target = props.target || null // Resolves `rel` checkPropConflicts(props, 'noRel', 'rel') const rel = firstNonUndefined( // converts `""` to `null` to prevent the attribute from being added as empty (`rel=""`) props.noRel ? '' : props.rel, options.externalRelAttribute, /* * A fallback rel of `noopener noreferrer` is applied for external links or links that open in a new tab. * This solves a reverse tabnapping security flaw in browsers pre-2021 as well as improving privacy. */ (isAbsoluteUrl.value || hasTarget.value) ? 'noopener noreferrer' : '' ) || null // https://router.vuejs.org/api/#custom if (props.custom) { if (!slots.default) { return null } const navigate = () => navigateTo(href, { replace: props.replace, external: props.external }) return slots.default({ href, navigate, get route () { if (!href) { return undefined } const url = parseURL(href) return { path: url.pathname, fullPath: url.pathname, get query () { return parseQuery(url.search) }, hash: url.hash, params: {}, name: undefined, matched: [], redirectedFrom: undefined, meta: {}, href } satisfies RouteLocation & { href: string } }, rel, target, isExternal: isExternal.value, isActive: false, isExactActive: false }) } return h('a', { ref: el, href, rel, target }, slots.default?.()) } } }) as unknown as DefineComponent } export default defineNuxtLink(nuxtLinkDefaults) // -- NuxtLink utils -- function applyTrailingSlashBehavior (to: string, trailingSlash: NuxtLinkOptions['trailingSlash']): string { const normalizeFn = trailingSlash === 'append' ? withTrailingSlash : withoutTrailingSlash // Until https://github.com/unjs/ufo/issues/189 is resolved const hasProtocolDifferentFromHttp = hasProtocol(to) && !to.startsWith('http') if (hasProtocolDifferentFromHttp) { return to } return normalizeFn(to, true) } // --- Prefetching utils --- type CallbackFn = () => void type ObserveFn = (element: Element, callback: CallbackFn) => () => void function useObserver (): { observe: ObserveFn } | undefined { if (import.meta.server) { return } const nuxtApp = useNuxtApp() if (nuxtApp._observer) { return nuxtApp._observer } let observer: IntersectionObserver | null = null const callbacks = new Map() const observe: ObserveFn = (element, callback) => { if (!observer) { observer = new IntersectionObserver((entries) => { for (const entry of entries) { const callback = callbacks.get(entry.target) const isVisible = entry.isIntersecting || entry.intersectionRatio > 0 if (isVisible && callback) { callback() } } }) } callbacks.set(element, callback) observer.observe(element) return () => { callbacks.delete(element) observer!.unobserve(element) if (callbacks.size === 0) { observer!.disconnect() observer = null } } } const _observer = nuxtApp._observer = { observe } return _observer } function isSlowConnection () { if (import.meta.server) { return } // https://developer.mozilla.org/en-US/docs/Web/API/Navigator/connection const cn = (navigator as any).connection as { saveData: boolean, effectiveType: string } | null if (cn && (cn.saveData || /2g/.test(cn.effectiveType))) { return true } return false }