@nuxt/ui 3.3.3 → 4.0.0-alpha.1

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

@@ -0,0 +1,47 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { NuxtError } from '#app';
+import theme from '#build/ui/error';
+import type { ButtonProps } from '../types';
+import type { ComponentConfig } from '../types/tv';
+type Error = ComponentConfig<typeof theme, AppConfig, 'error'>;
+export interface ErrorProps {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'div'
+     */
+    as?: any;
+    error?: Partial<NuxtError & {
+        message: string;
+    }>;
+    /**
+     * The URL to redirect to when the error is cleared.
+     * @defaultValue '/'
+     */
+    redirect?: string;
+    /**
+     * Display a button to clear the error in the links slot.
+     * `{ size: 'lg', color: 'primary', variant: 'solid', label: 'Back to home' }`{lang="ts-type"}
+     * @defaultValue true
+     */
+    clear?: boolean | Partial<ButtonProps>;
+    class?: any;
+    ui?: Error['slots'];
+}
+export interface ErrorSlots {
+    default(props?: {}): any;
+    statusCode(props?: {}): any;
+    statusMessage(props?: {}): any;
+    message(props?: {}): any;
+    links(props?: {}): any;
+}
+declare const _default: __VLS_WithSlots<import("vue").DefineComponent<ErrorProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<ErrorProps> & Readonly<{}>, {
+    clear: boolean | Partial<ButtonProps>;
+    as: any;
+    redirect: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, ErrorSlots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/{ButtonGroup.vue → FieldGroup.vue}

@@ -1,12 +1,12 @@
 <script>
-import theme from "#build/ui/button-group";
+import theme from "#build/ui/field-group";
 </script>
 
 <script setup>
 import { provide, computed } from "vue";
 import { Primitive } from "reka-ui";
 import { useAppConfig } from "#imports";
-import { buttonGroupInjectionKey } from "../composables/useButtonGroup";
+import { fieldGroupInjectionKey } from "../composables/useFieldGroup";
 import { tv } from "../utils/tv";
 const props = defineProps({
   as: { type: null, required: false },
@@ -17,8 +17,8 @@ const props = defineProps({
 });
 defineSlots();
 const appConfig = useAppConfig();
-const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.buttonGroup || {} }));
-provide(buttonGroupInjectionKey, computed(() => ({
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.fieldGroup || {} }));
+provide(fieldGroupInjectionKey, computed(() => ({
   orientation: props.orientation,
   size: props.size
 })));

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

@@ -0,0 +1,34 @@
+import type { AppConfig } from '@nuxt/schema';
+import theme from '#build/ui/field-group';
+import type { ComponentConfig } from '../types/tv';
+type FieldGroup = ComponentConfig<typeof theme, AppConfig, 'fieldGroup'>;
+export interface FieldGroupProps {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'div'
+     */
+    as?: any;
+    /**
+     * @defaultValue 'md'
+     */
+    size?: FieldGroup['variants']['size'];
+    /**
+     * The orientation the buttons are laid out.
+     * @defaultValue 'horizontal'
+     */
+    orientation?: FieldGroup['variants']['orientation'];
+    class?: any;
+    ui?: FieldGroup['slots'];
+}
+export interface FieldGroupSlots {
+    default(props?: {}): any;
+}
+declare const _default: __VLS_WithSlots<import("vue").DefineComponent<FieldGroupProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<FieldGroupProps> & Readonly<{}>, {
+    orientation: FieldGroup["variants"]["orientation"];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, FieldGroupSlots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/FileUpload.vue

@@ -18,7 +18,7 @@ const props = defineProps({
   as: { type: null, required: false },
   id: { type: String, required: false },
   name: { type: String, required: false },
-  icon: { type: String, required: false },
+  icon: { type: [String, Object], required: false },
   label: { type: String, required: false },
   description: { type: String, required: false },
   color: { type: null, required: false },
@@ -34,9 +34,9 @@ const props = defineProps({
   interactive: { type: Boolean, required: false, default: true },
   required: { type: Boolean, required: false },
   disabled: { type: Boolean, required: false },
-  fileIcon: { type: String, required: false },
+  fileIcon: { type: [String, Object], required: false },
   fileDelete: { type: [Boolean, Object], required: false },
-  fileDeleteIcon: { type: String, required: false },
+  fileDeleteIcon: { type: [String, Object], required: false },
   class: { type: null, required: false },
   ui: { type: null, required: false }
 });

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

@@ -1,8 +1,8 @@
 import type { AppConfig } from '@nuxt/schema';
 import type { UseFileDialogReturn } from '@vueuse/core';
 import theme from '#build/ui/file-upload';
-import type { ButtonProps } from '../types';
-import type { ComponentConfig } from '../types/utils';
+import type { ButtonProps, IconProps } from '../types';
+import type { ComponentConfig } from '../types/tv';
 type FileUpload = ComponentConfig<typeof theme, AppConfig, 'fileUpload'>;
 export interface FileUploadProps<M extends boolean = false> {
     /**
@@ -17,7 +17,7 @@ export interface FileUploadProps<M extends boolean = false> {
      * @defaultValue appConfig.ui.icons.upload
      * @IconifyIcon
      */
-    icon?: string;
+    icon?: IconProps['name'];
     label?: string;
     description?: string;
     /**
@@ -76,7 +76,7 @@ export interface FileUploadProps<M extends boolean = false> {
      * @defaultValue appConfig.ui.icons.file
      * @IconifyIcon
      */
-    fileIcon?: string;
+    fileIcon?: IconProps['name'];
     /**
      * Configure the delete button for the file.
      * When `layout` is `grid`, the default is `{ color: 'neutral', variant: 'solid', size: 'xs' }`{lang="ts-type"}
@@ -88,7 +88,7 @@ export interface FileUploadProps<M extends boolean = false> {
      * @defaultValue appConfig.ui.icons.close
      * @IconifyIcon
      */
-    fileDeleteIcon?: string;
+    fileDeleteIcon?: IconProps['name'];
     class?: any;
     ui?: FileUpload['slots'];
 }

package/dist/runtime/components/Footer.vue

@@ -0,0 +1,45 @@
+<script>
+import theme from "#build/ui/footer";
+</script>
+
+<script setup>
+import { computed } from "vue";
+import { Primitive } from "reka-ui";
+import { useAppConfig } from "#imports";
+import { tv } from "../utils/tv";
+import UContainer from "./Container.vue";
+const props = defineProps({
+  as: { type: null, required: false, default: "footer" },
+  class: { type: null, required: false },
+  ui: { type: null, required: false }
+});
+const slots = defineSlots();
+const appConfig = useAppConfig();
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.footer || {} })());
+</script>
+
+<template>
+  <Primitive :as="as" :class="ui.root({ class: [props.ui?.root, props.class] })">
+    <div v-if="!!slots.top" :class="ui.top({ class: props.ui?.top })">
+      <slot name="top" />
+    </div>
+
+    <UContainer :class="ui.container({ class: props.ui?.container })">
+      <div :class="ui.right({ class: props.ui?.right })">
+        <slot name="right" />
+      </div>
+
+      <div :class="ui.center({ class: props.ui?.center })">
+        <slot />
+      </div>
+
+      <div :class="ui.left({ class: props.ui?.left })">
+        <slot name="left" />
+      </div>
+    </UContainer>
+
+    <div v-if="!!slots.bottom" :class="ui.bottom({ class: props.ui?.bottom })">
+      <slot name="bottom" />
+    </div>
+  </Primitive>
+</template>

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

@@ -0,0 +1,29 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { ComponentConfig } from '../types/tv';
+import theme from '#build/ui/footer';
+type Footer = ComponentConfig<typeof theme, AppConfig, 'footer'>;
+export interface FooterProps {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'footer'
+     */
+    as?: any;
+    class?: any;
+    ui?: Footer['slots'];
+}
+export interface FooterSlots {
+    left(props?: {}): any;
+    default(props?: {}): any;
+    right(props?: {}): any;
+    top(props?: {}): any;
+    bottom(props?: {}): any;
+}
+declare const _default: __VLS_WithSlots<import("vue").DefineComponent<FooterProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<FooterProps> & Readonly<{}>, {
+    as: any;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, FooterSlots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/components/FooterColumns.vue

@@ -0,0 +1,71 @@
+<script>
+import theme from "#build/ui/footer-columns";
+</script>
+
+<script setup>
+import { computed } from "vue";
+import { Primitive } from "reka-ui";
+import { useAppConfig } from "#imports";
+import { pickLinkProps } from "../utils/link";
+import { tv } from "../utils/tv";
+import ULink from "./Link.vue";
+import ULinkBase from "./LinkBase.vue";
+import UIcon from "./Icon.vue";
+const props = defineProps({
+  as: { type: null, required: false, default: "nav" },
+  class: { type: null, required: false },
+  columns: { type: Array, required: false },
+  ui: { type: null, required: false }
+});
+const slots = defineSlots();
+const appConfig = useAppConfig();
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.footerColumns || {} })());
+</script>
+
+<template>
+  <Primitive :as="as" :class="ui.root({ class: [props.ui?.root, props.class] })">
+    <div v-if="!!slots.left" :class="ui.left({ class: props.ui?.left })">
+      <slot name="left" />
+    </div>
+
+    <div v-if="!!slots.default || columns?.length" :class="ui.center({ class: props.ui?.center })">
+      <slot>
+        <div v-for="(column, index) in columns" :key="index">
+          <h3 :class="ui.label({ class: props.ui?.label })">
+            <slot name="column-label" :column="column">
+              {{ column.label }}
+            </slot>
+          </h3>
+
+          <ul :class="ui.list({ class: props.ui?.list })">
+            <li v-for="(link, linkIndex) in column.children" :key="linkIndex" :class="ui.item({ class: [props.ui?.item, link.ui?.item] })">
+              <ULink v-slot="{ active, ...slotProps }" v-bind="pickLinkProps(link)" custom>
+                <ULinkBase v-bind="slotProps" :class="ui.link({ class: [props.ui?.link, link.ui?.link, link.class], active })">
+                  <slot name="link" :link="link" :active="active">
+                    <slot name="link-leading" :link="link" :active="active">
+                      <UIcon v-if="link.icon" :name="link.icon" :class="ui.linkLeadingIcon({ class: [props.ui?.linkLeadingIcon, link.ui?.linkLeadingIcon], active })" />
+                    </slot>
+
+                    <span v-if="link.label || !!slots['link-label']" :class="ui.linkLabel({ class: [props.ui?.linkLabel, link.ui?.linkLabel], active })">
+                      <slot name="link-label" :link="link" :active="active">
+                        {{ link.label }}
+                      </slot>
+
+                      <UIcon v-if="link.target === '_blank'" :name="appConfig.ui.icons.external" :class="ui.linkLabelExternalIcon({ class: [props.ui?.linkLabelExternalIcon, link.ui?.linkLabelExternalIcon], active })" />
+                    </span>
+
+                    <slot name="link-trailing" :link="link" :active="active" />
+                  </slot>
+                </ULinkBase>
+              </ULink>
+            </li>
+          </ul>
+        </div>
+      </slot>
+    </div>
+
+    <div v-if="!!slots.right" :class="ui.right({ class: props.ui?.right })">
+      <slot name="right" />
+    </div>
+  </Primitive>
+</template>

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

@@ -0,0 +1,57 @@
+import type { AppConfig } from '@nuxt/schema';
+import theme from '#build/ui/footer-columns';
+import type { IconProps, LinkProps } from '../types';
+import type { ComponentConfig } from '../types/tv';
+type FooterColumns = ComponentConfig<typeof theme, AppConfig, 'footerColumns'>;
+export interface FooterColumnLink extends Omit<LinkProps, 'custom'> {
+    label: string;
+    /**
+     * @IconifyIcon
+     */
+    icon?: IconProps['name'];
+    class?: any;
+    ui?: Pick<FooterColumns['slots'], 'item' | 'link' | 'linkLabel' | 'linkLabelExternalIcon' | 'linkLeadingIcon'>;
+}
+export interface FooterColumn<T extends FooterColumnLink = FooterColumnLink> {
+    label: string;
+    children?: T[];
+}
+export interface FooterColumnsProps<T extends FooterColumnLink = FooterColumnLink> {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'div'
+     */
+    as?: any;
+    class?: any;
+    columns?: FooterColumn<T>[];
+    ui?: FooterColumns['slots'];
+}
+type SlotProps<T> = (props: {
+    link: T;
+    active: boolean;
+}) => any;
+export interface FooterColumnsSlots<T extends FooterColumnLink = FooterColumnLink> {
+    'left'(props?: {}): any;
+    'default'(props?: {}): any;
+    'right'(props?: {}): any;
+    'column-label'?: (props: {
+        column: FooterColumn<T>;
+    }) => any;
+    'link': SlotProps<T>;
+    'link-leading': SlotProps<T>;
+    'link-label': SlotProps<T>;
+    'link-trailing': SlotProps<T>;
+}
+declare const _default: <T extends FooterColumnLink>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, never> & FooterColumnsProps<T> & {}> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: FooterColumnsSlots<T>;
+    emit: {};
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T as K]: T[K];
+} & {};

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

@@ -1,6 +1,6 @@
 import type { AppConfig } from '@nuxt/schema';
 import theme from '#build/ui/form-field';
-import type { ComponentConfig } from '../types/utils';
+import type { ComponentConfig } from '../types/tv';
 type FormField = ComponentConfig<typeof theme, AppConfig, 'formField'>;
 export interface FormFieldProps {
     /**

package/dist/runtime/components/Header.vue

@@ -0,0 +1,141 @@
+<script>
+import theme from "#build/ui/header";
+</script>
+
+<script setup>
+import { computed, watch, toRef } from "vue";
+import { Primitive } from "reka-ui";
+import { defu } from "defu";
+import { createReusableTemplate } from "@vueuse/core";
+import { useAppConfig, useRoute } from "#imports";
+import { useLocale } from "../composables/useLocale";
+import { getSlotChildrenText } from "../utils";
+import { tv } from "../utils/tv";
+import UButton from "./Button.vue";
+import ULink from "./Link.vue";
+import UContainer from "./Container.vue";
+import USlideover from "./Slideover.vue";
+import UModal from "./Modal.vue";
+import UDrawer from "./Drawer.vue";
+defineOptions({ inheritAttrs: false });
+const props = defineProps({
+  as: { type: null, required: false, default: "header" },
+  title: { type: String, required: false, default: "Nuxt UI" },
+  to: { type: String, required: false, default: "/" },
+  mode: { type: null, required: false, default: "modal" },
+  menu: { type: null, required: false },
+  toggle: { type: [Boolean, Object], required: false, default: true },
+  toggleSide: { type: String, required: false, default: "right" },
+  class: { type: null, required: false },
+  ui: { type: null, required: false }
+});
+const slots = defineSlots();
+const open = defineModel("open", { type: Boolean, ...{ default: false } });
+const route = useRoute();
+const { t } = useLocale();
+const appConfig = useAppConfig();
+const [DefineLeftTemplate, ReuseLeftTemplate] = createReusableTemplate();
+const [DefineRightTemplate, ReuseRightTemplate] = createReusableTemplate();
+const [DefineToggleTemplate, ReuseToggleTemplate] = createReusableTemplate();
+const ariaLabel = computed(() => {
+  const slotText = slots.title && getSlotChildrenText(slots.title());
+  return (slotText || props.title || "Nuxt UI").trim();
+});
+watch(() => route.fullPath, () => {
+  open.value = false;
+});
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.header || {} })());
+const Menu = computed(() => ({
+  slideover: USlideover,
+  modal: UModal,
+  drawer: UDrawer
+})[props.mode]);
+const menuProps = toRef(() => defu(props.menu, {
+  content: {
+    onOpenAutoFocus: (e) => e.preventDefault()
+  }
+}, props.mode === "modal" ? { fullscreen: true, transition: false } : {}));
+function toggleOpen() {
+  open.value = !open.value;
+}
+</script>
+
+<template>
+  <DefineToggleTemplate>
+    <slot name="toggle" :open="open" :toggle="toggleOpen">
+      <UButton
+        v-if="toggle"
+        color="neutral"
+        variant="ghost"
+        :aria-label="open ? t('header.close') : t('header.open')"
+        :icon="open ? appConfig.ui.icons.close : appConfig.ui.icons.menu"
+        v-bind="typeof toggle === 'object' ? toggle : {}"
+        :class="ui.toggle({ class: props.ui?.toggle, toggleSide })"
+        @click="toggleOpen"
+      />
+    </slot>
+  </DefineToggleTemplate>
+
+  <DefineLeftTemplate>
+    <div :class="ui.left({ class: props.ui?.left })">
+      <ReuseToggleTemplate v-if="toggleSide === 'left'" />
+
+      <slot name="left">
+        <ULink :to="to" :aria-label="ariaLabel" :class="ui.title({ class: props.ui?.title })">
+          <slot name="title">
+            {{ title }}
+          </slot>
+        </ULink>
+      </slot>
+    </div>
+  </DefineLeftTemplate>
+
+  <DefineRightTemplate>
+    <div :class="ui.right({ class: props.ui?.right })">
+      <slot name="right" />
+
+      <ReuseToggleTemplate v-if="toggleSide === 'right'" />
+    </div>
+  </DefineRightTemplate>
+
+  <Primitive :as="as" v-bind="$attrs" :class="ui.root({ class: [props.ui?.root, props.class] })">
+    <slot name="top" />
+
+    <UContainer :class="ui.container({ class: props.ui?.container })">
+      <ReuseLeftTemplate />
+
+      <div :class="ui.center({ class: props.ui?.center })">
+        <slot />
+      </div>
+
+      <ReuseRightTemplate />
+    </UContainer>
+
+    <slot name="bottom" />
+  </Primitive>
+
+  <Menu
+    v-model:open="open"
+    :title="t('header.title')"
+    :description="t('header.description')"
+    v-bind="menuProps"
+    :ui="{
+  overlay: ui.overlay({ class: props.ui?.overlay }),
+  content: ui.content({ class: props.ui?.content })
+}"
+  >
+    <template #content>
+      <slot name="content">
+        <div v-if="mode !== 'drawer'" :class="ui.header({ class: props.ui?.header })">
+          <ReuseLeftTemplate />
+
+          <ReuseRightTemplate />
+        </div>
+
+        <div :class="ui.body({ class: props.ui?.body })">
+          <slot name="body" />
+        </div>
+      </slot>
+    </template>
+  </Menu>
+</template>

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

@@ -0,0 +1,68 @@
+import type { AppConfig } from '@nuxt/schema';
+import theme from '#build/ui/header';
+import type { ButtonProps, DrawerProps, ModalProps, SlideoverProps } from '../types';
+import type { ComponentConfig } from '../types/tv';
+type Header = ComponentConfig<typeof theme, AppConfig, 'header'>;
+type HeaderMode = 'modal' | 'slideover' | 'drawer';
+type HeaderMenu<T> = T extends 'modal' ? ModalProps : T extends 'slideover' ? SlideoverProps : T extends 'drawer' ? DrawerProps : never;
+export interface HeaderProps<T extends HeaderMode = HeaderMode> {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'header'
+     */
+    as?: any;
+    title?: string;
+    to?: string;
+    /**
+     * The mode of the header menu.
+     * @defaultValue 'modal'
+     */
+    mode?: T;
+    /**
+     * The props for the header menu component.
+     */
+    menu?: HeaderMenu<T>;
+    /**
+     * Customize the toggle button to open the header menu displayed when the `content` slot is used.
+     * `{ color: 'neutral', variant: 'ghost' }`{lang="ts-type"}
+     */
+    toggle?: boolean | Partial<ButtonProps>;
+    /**
+     * The side to render the toggle button on.
+     * @defaultValue 'right'
+     */
+    toggleSide?: 'left' | 'right';
+    class?: any;
+    ui?: Header['slots'];
+}
+export interface HeaderSlots {
+    title(props?: {}): any;
+    left(props?: {}): any;
+    default(props?: {}): any;
+    right(props?: {}): any;
+    toggle(props: {
+        open: boolean;
+        toggle: () => void;
+    }): any;
+    top(props?: {}): any;
+    bottom(props?: {}): any;
+    body(props?: {}): any;
+    content(props?: {}): any;
+}
+declare const _default: <T extends HeaderMode>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{
+        readonly "onUpdate:open"?: ((value: boolean) => any) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onUpdate:open"> & (HeaderProps<T> & {
+        open?: boolean;
+    }) & {}> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: HeaderSlots;
+    emit: (evt: "update:open", value: boolean) => void;
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T as K]: T[K];
+} & {};

package/dist/runtime/components/Icon.vue

@@ -6,7 +6,7 @@
 import { useForwardProps } from "reka-ui";
 import { reactivePick } from "@vueuse/core";
 const props = defineProps({
-  name: { type: String, required: true },
+  name: { type: [String, Object], required: true },
   mode: { type: String, required: false },
   size: { type: [String, Number], required: false },
   customize: { type: Function, required: false }
@@ -15,5 +15,6 @@ const iconProps = useForwardProps(reactivePick(props, "name", "mode", "size", "c
 </script>
 
 <template>
-  <Icon v-bind="iconProps" />
+  <Icon v-if="typeof name === 'string'" v-bind="iconProps" />
+  <component :is="name" v-else />
 </template>

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

@@ -1,5 +1,5 @@
 export interface IconProps {
-    name: string;
+    name: string | object;
     mode?: 'svg' | 'css';
     size?: string | number;
     customize?: (content: string, name?: string, prefix?: string, provider?: string) => string;