@nuxt/ui 3.0.1 → 3.1.0

package/dist/runtime/vue/components/Link.vue

@@ -1,199 +1,116 @@
-<script lang="ts">
-import type { ButtonHTMLAttributes } from 'vue'
-import { tv } from 'tailwind-variants'
-import type { AppConfig } from '@nuxt/schema'
-import _appConfig from '#build/app.config'
-import type { RouterLinkProps, RouteLocationRaw } from 'vue-router'
-import theme from '#build/ui/link'
-
-interface NuxtLinkProps extends Omit<RouterLinkProps, 'to'> {
-  /**
-   * 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
-  /**
-   * 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
-}
-
-const appConfigLink = _appConfig as AppConfig & { ui: { link: Partial<typeof theme> } }
-
-const link = tv({ extend: tv(theme), ...(appConfigLink.ui?.link || {}) })
-
-export interface LinkProps extends NuxtLinkProps {
-  /**
-   * The element or component this component should render as when not a link.
-   * @defaultValue 'button'
-   */
-  as?: any
-  /**
-   * The type of the button when not a link.
-   * @defaultValue 'button'
-   */
-  type?: ButtonHTMLAttributes['type']
-  disabled?: boolean
-  /** Force the link to be active independent of the current route. */
-  active?: boolean
-  /** Will only be active if the current route is an exact match. */
-  exact?: boolean
-  /** Will only be active if the current route query is an exact match. */
-  exactQuery?: boolean | 'partial'
-  /** Will only be active if the current route hash is an exact match. */
-  exactHash?: boolean
-  /** The class to apply when the link is inactive. */
-  inactiveClass?: string
-  custom?: boolean
-  /** When `true`, only styles from `class`, `activeClass`, and `inactiveClass` will be applied. */
-  raw?: boolean
-  class?: any
-}
-
-export interface LinkSlots {
-  default(props: { active: boolean }): any
-}
+<script>
+import theme from "#build/ui/link";
 </script>
 
-<script setup lang="ts">
-import { computed, getCurrentInstance } from 'vue'
-import { isEqual, diff } from 'ohash/utils'
-import { useForwardProps } from 'reka-ui'
-import { reactiveOmit } from '@vueuse/core'
-import { hasProtocol } from 'ufo'
-import { useRoute } from '#imports'
-import { RouterLink } from 'vue-router'
-
-defineOptions({ inheritAttrs: false })
-
-const props = withDefaults(defineProps<LinkProps>(), {
-  as: 'button',
-  type: 'button',
-  active: undefined,
-  activeClass: '',
-  inactiveClass: ''
-})
-defineSlots<LinkSlots>()
-
-// Check if vue-router is available by checking for the injection key
+<script setup>
+import { computed, getCurrentInstance } from "vue";
+import { defu } from "defu";
+import { isEqual, diff } from "ohash/utils";
+import { useForwardProps } from "reka-ui";
+import { reactiveOmit } from "@vueuse/core";
+import { hasProtocol } from "ufo";
+import { useRoute, RouterLink } from "vue-router";
+import { useAppConfig } from "#imports";
+import { tv } from "../../utils/tv";
+defineOptions({ inheritAttrs: false });
+const props = defineProps({
+  as: { type: null, required: false, default: "button" },
+  type: { type: null, required: false, default: "button" },
+  disabled: { type: Boolean, required: false },
+  active: { type: Boolean, required: false, default: void 0 },
+  exact: { type: Boolean, required: false },
+  exactQuery: { type: [Boolean, String], required: false },
+  exactHash: { type: Boolean, required: false },
+  inactiveClass: { type: String, required: false, default: "" },
+  custom: { type: Boolean, required: false },
+  raw: { type: Boolean, required: false },
+  class: { type: null, required: false },
+  to: { type: null, required: false },
+  href: { type: null, required: false },
+  external: { type: Boolean, required: false },
+  target: { type: [String, Object, null], required: false },
+  rel: { type: [String, Object, null], required: false },
+  noRel: { type: Boolean, required: false },
+  prefetchedClass: { type: String, required: false },
+  prefetch: { type: Boolean, required: false },
+  prefetchOn: { type: [String, Object], required: false },
+  noPrefetch: { type: Boolean, required: false },
+  activeClass: { type: String, required: false, default: "" },
+  exactActiveClass: { type: String, required: false },
+  ariaCurrentValue: { type: String, required: false, default: "page" },
+  viewTransition: { type: Boolean, required: false },
+  replace: { type: Boolean, required: false }
+});
+defineSlots();
 const hasRouter = computed(() => {
-  const app = getCurrentInstance()?.appContext.app
-  return !!(app?.config?.globalProperties?.$router)
-})
-
-// Only try to get route if router exists
+  const app = getCurrentInstance()?.appContext.app;
+  return !!app?.config?.globalProperties?.$router;
+});
 const route = computed(() => {
-  if (!hasRouter.value) return null
+  if (!hasRouter.value) return null;
   try {
-    return useRoute()
+    return useRoute();
   } catch {
-    return null
+    return null;
   }
-})
-
-const routerLinkProps = useForwardProps(reactiveOmit(props, 'as', 'type', 'disabled', 'active', 'exact', 'exactQuery', 'exactHash', 'activeClass', 'inactiveClass', 'to', 'raw', 'class'))
-
+});
+const appConfig = useAppConfig();
+const routerLinkProps = useForwardProps(reactiveOmit(props, "as", "type", "disabled", "active", "exact", "exactQuery", "exactHash", "activeClass", "inactiveClass", "to", "raw", "class"));
 const ui = computed(() => tv({
-  extend: link,
-  variants: {
-    active: {
-      true: props.activeClass,
-      false: props.inactiveClass
+  extend: tv(theme),
+  ...defu({
+    variants: {
+      active: {
+        true: props.activeClass,
+        false: props.inactiveClass
+      }
     }
-  }
-}))
-
-function isPartiallyEqual(item1: any, item2: any) {
+  }, appConfig.ui?.link || {})
+}));
+function isPartiallyEqual(item1, item2) {
   const diffedKeys = diff(item1, item2).reduce((filtered, q) => {
-    if (q.type === 'added') {
-      filtered.add(q.key)
+    if (q.type === "added") {
+      filtered.add(q.key);
     }
-    return filtered
-  }, new Set<string>())
-
-  const item1Filtered = Object.fromEntries(Object.entries(item1).filter(([key]) => !diffedKeys.has(key)))
-  const item2Filtered = Object.fromEntries(Object.entries(item2).filter(([key]) => !diffedKeys.has(key)))
-
-  return isEqual(item1Filtered, item2Filtered)
+    return filtered;
+  }, /* @__PURE__ */ new Set());
+  const item1Filtered = Object.fromEntries(Object.entries(item1).filter(([key]) => !diffedKeys.has(key)));
+  const item2Filtered = Object.fromEntries(Object.entries(item2).filter(([key]) => !diffedKeys.has(key)));
+  return isEqual(item1Filtered, item2Filtered);
 }
-
 const isExternal = computed(() => {
-  if (!props.to) return false
-  return typeof props.to === 'string' && hasProtocol(props.to, { acceptRelative: true })
-})
-
-function isLinkActive({ route: linkRoute, isActive, isExactActive }: any) {
-  if (props.active !== undefined) {
-    return props.active
+  if (!props.to) return false;
+  return typeof props.to === "string" && hasProtocol(props.to, { acceptRelative: true });
+});
+function isLinkActive({ route: linkRoute, isActive, isExactActive }) {
+  if (props.active !== void 0) {
+    return props.active;
   }
-
   if (!props.to || !route.value) {
-    return false
+    return false;
   }
-
-  if (props.exactQuery === 'partial') {
-    if (!isPartiallyEqual(linkRoute.query, route.value.query)) return false
+  if (props.exactQuery === "partial") {
+    if (!isPartiallyEqual(linkRoute.query, route.value.query)) return false;
   } else if (props.exactQuery === true) {
-    if (!isEqual(linkRoute.query, route.value.query)) return false
+    if (!isEqual(linkRoute.query, route.value.query)) return false;
   }
-
   if (props.exactHash && linkRoute.hash !== route.value.hash) {
-    return false
+    return false;
   }
-
   if (props.exact && isExactActive) {
-    return true
+    return true;
   }
-
   if (!props.exact && isActive) {
-    return true
+    return true;
   }
-
-  return false
+  return false;
 }
-
-function resolveLinkClass({ route, isActive, isExactActive }: any = {}) {
-  const active = isLinkActive({ route, isActive, isExactActive })
-
+function resolveLinkClass({ route: route2, isActive, isExactActive } = {}) {
+  const active = isLinkActive({ route: route2, isActive, isExactActive });
   if (props.raw) {
-    return [props.class, active ? props.activeClass : props.inactiveClass]
+    return [props.class, active ? props.activeClass : props.inactiveClass];
   }
-
-  return ui.value({ class: props.class, active, disabled: props.disabled })
+  return ui.value({ class: props.class, active, disabled: props.disabled });
 }
 </script>
 
@@ -203,26 +120,28 @@ function resolveLinkClass({ route, isActive, isExactActive }: any = {}) {
       <template v-if="custom">
         <slot
           v-bind="{
-            ...$attrs,
-            as,
-            type,
-            disabled,
-            href: to ? href : undefined,
-            navigate,
-            active: isLinkActive({ route: linkRoute, isActive, isExactActive })
-          }"
+  ...$attrs,
+  ...exact && isExactActive ? { 'aria-current': props.ariaCurrentValue } : {},
+  as,
+  type,
+  disabled,
+  href: to ? href : void 0,
+  navigate,
+  active: isLinkActive({ route: linkRoute, isActive, isExactActive })
+}"
         />
       </template>
       <ULinkBase
         v-else
         v-bind="{
-          ...$attrs,
-          as,
-          type,
-          disabled,
-          href: to ? href : undefined,
-          navigate
-        }"
+  ...$attrs,
+  ...exact && isExactActive ? { 'aria-current': props.ariaCurrentValue } : {},
+  as,
+  type,
+  disabled,
+  href: to ? href : void 0,
+  navigate
+}"
         :class="resolveLinkClass({ route: linkRoute, isActive, isExactActive })"
       >
         <slot :active="isLinkActive({ route: linkRoute, isActive, isExactActive })" />
@@ -234,26 +153,26 @@ function resolveLinkClass({ route, isActive, isExactActive }: any = {}) {
     <template v-if="custom">
       <slot
         v-bind="{
-          ...$attrs,
-          as,
-          type,
-          disabled,
-          href: to,
-          target: isExternal ? '_blank' : undefined,
-          active: false
-        }"
+  ...$attrs,
+  as,
+  type,
+  disabled,
+  href: to,
+  target: isExternal ? '_blank' : void 0,
+  active: false
+}"
       />
     </template>
     <ULinkBase
       v-else
       v-bind="{
-        ...$attrs,
-        as,
-        type,
-        disabled,
-        href: (to as string),
-        target: isExternal ? '_blank' : undefined
-      }"
+  ...$attrs,
+  as,
+  type,
+  disabled,
+  href: to,
+  target: isExternal ? '_blank' : void 0
+}"
       :is-external="isExternal"
       :class="resolveLinkClass()"
     >

package/dist/runtime/vue/components/Link.vue.d.ts

@@ -0,0 +1,124 @@
+import type { ButtonHTMLAttributes } from 'vue';
+import type { RouterLinkProps, RouteLocationRaw } from 'vue-router';
+interface NuxtLinkProps extends Omit<RouterLinkProps, 'to'> {
+    /**
+     * 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;
+}
+export interface LinkProps extends NuxtLinkProps {
+    /**
+     * The element or component this component should render as when not a link.
+     * @defaultValue 'button'
+     */
+    as?: any;
+    /**
+     * The type of the button when not a link.
+     * @defaultValue 'button'
+     */
+    type?: ButtonHTMLAttributes['type'];
+    disabled?: boolean;
+    /** Force the link to be active independent of the current route. */
+    active?: boolean;
+    /** Will only be active if the current route is an exact match. */
+    exact?: boolean;
+    /** Will only be active if the current route query is an exact match. */
+    exactQuery?: boolean | 'partial';
+    /** Will only be active if the current route hash is an exact match. */
+    exactHash?: boolean;
+    /** The class to apply when the link is inactive. */
+    inactiveClass?: string;
+    custom?: boolean;
+    /** When `true`, only styles from `class`, `activeClass`, and `inactiveClass` will be applied. */
+    raw?: boolean;
+    class?: any;
+}
+export interface LinkSlots {
+    default(props: {
+        active: boolean;
+    }): any;
+}
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<LinkProps>, {
+    as: string;
+    type: string;
+    ariaCurrentValue: string;
+    active: undefined;
+    activeClass: string;
+    inactiveClass: string;
+}>>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<LinkProps>, {
+    as: string;
+    type: string;
+    ariaCurrentValue: string;
+    active: undefined;
+    activeClass: string;
+    inactiveClass: string;
+}>>> & Readonly<{}>, {
+    type: "reset" | "submit" | "button";
+    as: any;
+    activeClass: string;
+    ariaCurrentValue: "page" | "step" | "location" | "date" | "time" | "true" | "false";
+    active: boolean;
+    inactiveClass: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, Readonly<LinkSlots> & LinkSlots>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_PrettifyLocal<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/runtime/vue/stubs.d.ts

@@ -29,7 +29,12 @@ export declare function useNuxtApp(): {
     payload: {
         serverRendered: boolean;
     };
+    hooks: import("hookable").Hookable<Record<string, any>, string>;
+    hook: <NameT extends string>(name: NameT, function_: any, options?: {
+        allowDeprecated?: boolean;
+    }) => () => void;
 };
+export declare function useRuntimeHook(name: string, fn: (...args: any[]) => void): void;
 export declare function defineNuxtPlugin(plugin: (nuxtApp: NuxtApp) => void): {
     install(app: import("vue").App<any>): void;
 };

package/dist/runtime/vue/stubs.js

@@ -1,4 +1,5 @@
-import { ref } from "vue";
+import { ref, onScopeDispose } from "vue";
+import { createHooks } from "hookable";
 import appConfig from "#build/app.config";
 import { useColorMode as useColorModeVueUse } from "@vueuse/core";
 export { useHead } from "@unhead/vue";
@@ -50,12 +51,20 @@ export const useState = (key, init) => {
   state[key] = value;
   return value;
 };
+const hooks = createHooks();
 export function useNuxtApp() {
   return {
     isHydrating: true,
-    payload: { serverRendered: false }
+    payload: { serverRendered: false },
+    hooks,
+    hook: hooks.hook
   };
 }
+export function useRuntimeHook(name, fn) {
+  const nuxtApp = useNuxtApp();
+  const unregister = nuxtApp.hook(name, fn);
+  onScopeDispose(unregister);
+}
 export function defineNuxtPlugin(plugin) {
   return {
     install(app) {