import type { ComputedRef, DefineComponent, PropType } from 'vue' import { hasProtocol } from 'ufo' import type { RouteLocationRaw } from 'vue-router' import { useRouter } from '#app/composables/router' import { useNuxtApp } from '#app/nuxt' const firstNonUndefined = (...args: (T | undefined)[]) => args.find(arg => arg !== undefined) const DEFAULT_EXTERNAL_REL_ATTRIBUTE = 'noopener noreferrer' export type NuxtLinkOptions = { componentName?: string externalRelAttribute?: string | null activeClass?: string exactActiveClass?: string prefetchedClass?: string trailingSlash?: 'append' | 'remove' } export type NuxtLinkProps = { // Routing to?: RouteLocationRaw href?: RouteLocationRaw external?: boolean replace?: boolean custom?: boolean // Attributes target?: '_blank' | '_parent' | '_self' | '_top' | (string & {}) | null rel?: string | null noRel?: boolean prefetch?: boolean noPrefetch?: boolean // Styling activeClass?: string exactActiveClass?: string // Vue Router's `` additional props ariaCurrentValue?: string } export default defineComponent({ name: 'NuxtLink', 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, }, }, setup (props, { slots }) { const router = useRouter() // Resolving `to` value from `to` and `href` props // Defaults to empty string (won't render any `href` attribute) const to: ComputedRef = computed( () => props.to || props.href || '', ) // 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 (props.target && props.target !== '_self') { return true } // When `to` is a route object then it's an internal link if (typeof to.value === 'object') { return false } return to.value === '' || hasProtocol(to.value, { acceptRelative: true }) }) // Prefetching const prefetched = ref(false) const el = import.meta.server ? undefined : ref(null) const elRef = import.meta.server ? undefined : (vm: any) => { el!.value = vm?.$el } if (import.meta.client) { 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([ Promise.resolve(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 }) } } return () => { if (!isExternal.value) { const routerLinkProps: Record = { ref: elRef, to: to.value, activeClass: props.activeClass, exactActiveClass: props.exactActiveClass, replace: props.replace, ariaCurrentValue: props.ariaCurrentValue, } // `custom` API cannot support fallthrough attributes as the slot // may render fragment or text root nodes (#14897, #19375) if (prefetched.value) { routerLinkProps.class = props.prefetchedClass } routerLinkProps.rel = props.rel // 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 || null // Resolves `target` value const target = props.target || null // Resolves `rel` const rel = props.noRel ? null : firstNonUndefined( props.rel, href ? DEFAULT_EXTERNAL_REL_ATTRIBUTE : '', ) || null // converts `""` to `null` to prevent the attribute from being added as empty (`rel=""`) return h('a', { ref: el, href, rel, target }, slots.default?.()) } }, }) as unknown as DefineComponent // --- Prefetching utils --- type CallbackFn = () => void type ObserveFn = (element: Element, callback: CallbackFn) => () => void export 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 } export 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 }