@nuxt/ui 4.0.0-alpha.0 → 4.0.0-alpha.2

package/dist/runtime/components/Error.d.vue.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/Error.vue.d.ts

@@ -34,7 +34,7 @@ export interface ErrorSlots {
     message(props?: {}): any;
     links(props?: {}): any;
 }
-declare const _default: __VLS_WithSlots<import("vue").DefineComponent<ErrorProps, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<ErrorProps> & Readonly<{}>, {
+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;

package/dist/runtime/components/FieldGroup.d.vue.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/FieldGroup.vue.d.ts

@@ -23,7 +23,7 @@ export interface FieldGroupProps {
 export interface FieldGroupSlots {
     default(props?: {}): any;
 }
-declare const _default: __VLS_WithSlots<import("vue").DefineComponent<FieldGroupProps, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<FieldGroupProps> & Readonly<{}>, {
+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;

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

@@ -0,0 +1,166 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { UseFileDialogReturn } from '@vueuse/core';
+import theme from '#build/ui/file-upload';
+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> {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'div'
+     */
+    as?: any;
+    id?: string;
+    name?: string;
+    /**
+     * The icon to display.
+     * @defaultValue appConfig.ui.icons.upload
+     * @IconifyIcon
+     */
+    icon?: IconProps['name'];
+    label?: string;
+    description?: string;
+    /**
+     * @defaultValue 'primary'
+     */
+    color?: FileUpload['variants']['color'];
+    /**
+     * The `button` variant is only available when `multiple` is `false`.
+     * @defaultValue 'area'
+     */
+    variant?: FileUpload['variants']['variant'];
+    /**
+     * @defaultValue 'md'
+     */
+    size?: FileUpload['variants']['size'];
+    /**
+     * The layout of how files are displayed.
+     * Only works when `variant` is `area`.
+     * @defaultValue 'list'
+     */
+    layout?: FileUpload['variants']['layout'];
+    /**
+     * The position of the files.
+     * Only works when `variant` is `area` and when `layout` is `list`.
+     * @defaultValue 'outside'
+     */
+    position?: FileUpload['variants']['position'];
+    /** Highlight the ring color like a focus state. */
+    highlight?: boolean;
+    /**
+     * Specifies the allowed file types for the input. Provide a comma-separated list of MIME types or file extensions (e.g., "image/png,application/pdf,.jpg").
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept
+     * @defaultValue '*'
+     */
+    accept?: string;
+    multiple?: M & boolean;
+    /**
+     * Reset the file input when the dialog is opened.
+     * @defaultValue false
+     */
+    reset?: boolean;
+    /**
+     * Create a zone that allows the user to drop files onto it.
+     * @defaultValue true
+     */
+    dropzone?: boolean;
+    /**
+     * Make the dropzone interactive when the user is clicking on it.
+     * @defaultValue true
+     */
+    interactive?: boolean;
+    required?: boolean;
+    disabled?: boolean;
+    /**
+     * The icon to display for the file.
+     * @defaultValue appConfig.ui.icons.file
+     * @IconifyIcon
+     */
+    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"}
+     * When `layout` is `list`, the default is `{ color: 'neutral', variant: 'link' }`{lang="ts-type"}
+     */
+    fileDelete?: boolean | Partial<ButtonProps>;
+    /**
+     * The icon displayed to delete a file.
+     * @defaultValue appConfig.ui.icons.close
+     * @IconifyIcon
+     */
+    fileDeleteIcon?: IconProps['name'];
+    class?: any;
+    ui?: FileUpload['slots'];
+}
+export interface FileUploadEmits {
+    change: [event: Event];
+}
+type FileUploadFiles<M> = (M extends true ? File[] : File) | null;
+export interface FileUploadSlots<M extends boolean = false> {
+    'default'(props: {
+        open: UseFileDialogReturn['open'];
+        removeFile: (index?: number) => void;
+    }): any;
+    'leading'(props?: {}): any;
+    'label'(props?: {}): any;
+    'description'(props?: {}): any;
+    'actions'(props: {
+        files?: FileUploadFiles<M>;
+        open: UseFileDialogReturn['open'];
+        removeFile: (index?: number) => void;
+    }): any;
+    'files'(props: {
+        files?: FileUploadFiles<M>;
+    }): any;
+    'files-top'(props: {
+        files?: FileUploadFiles<M>;
+        open: UseFileDialogReturn['open'];
+        removeFile: (index?: number) => void;
+    }): any;
+    'files-bottom'(props: {
+        files?: FileUploadFiles<M>;
+        open: UseFileDialogReturn['open'];
+        removeFile: (index?: number) => void;
+    }): any;
+    'file'(props: {
+        file: File;
+        index: number;
+    }): any;
+    'file-leading'(props: {
+        file: File;
+        index: number;
+    }): any;
+    'file-name'(props: {
+        file: File;
+        index: number;
+    }): any;
+    'file-size'(props: {
+        file: File;
+        index: number;
+    }): any;
+    'file-trailing'(props: {
+        file: File;
+        index: number;
+    }): any;
+}
+declare const _default: <M extends boolean = false>(__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 onChange?: ((event: Event) => any) | undefined;
+        readonly "onUpdate:modelValue"?: ((value: (M extends true ? File[] : File) | null | undefined) => any) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onChange" | "onUpdate:modelValue"> & (FileUploadProps<M> & {
+        modelValue?: (M extends true ? File[] : File) | null;
+    }) & {}> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{
+        inputRef: import("vue").Ref<HTMLInputElement | undefined, HTMLInputElement | undefined>;
+        dropzoneRef: import("vue").Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
+    }>): void;
+    attrs: any;
+    slots: FileUploadSlots<M>;
+    emit: ((evt: "change", event: Event) => void) & ((evt: "update:modelValue", value: (M extends true ? File[] : File) | null | undefined) => 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/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,13 +34,13 @@ 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 }
 });
-const emits = defineEmits(["update:modelValue", "change"]);
+const emits = defineEmits(["change"]);
 const slots = defineSlots();
 const modelValue = defineModel({ type: null });
 const appConfig = useAppConfig();
@@ -193,6 +193,7 @@ defineExpose({
       <component
         :is="variant === 'button' ? 'button' : 'div'"
         ref="dropzoneRef"
+        :type="variant === 'button' ? 'button' : void 0"
         :role="variant === 'button' ? void 0 : 'button'"
         :data-dragging="isDragging"
         :class="ui.base({ class: props.ui?.base })"

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

@@ -1,7 +1,7 @@
 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 { 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,13 +88,12 @@ export interface FileUploadProps<M extends boolean = false> {
      * @defaultValue appConfig.ui.icons.close
      * @IconifyIcon
      */
-    fileDeleteIcon?: string;
+    fileDeleteIcon?: IconProps['name'];
     class?: any;
     ui?: FileUpload['slots'];
 }
-export interface FileUploadEmits<M extends boolean = false> {
-    'update:modelValue': [payload: M extends true ? File[] : File | null];
-    'change': [event: Event];
+export interface FileUploadEmits {
+    change: [event: Event];
 }
 type FileUploadFiles<M> = (M extends true ? File[] : File) | null;
 export interface FileUploadSlots<M extends boolean = false> {
@@ -147,17 +146,17 @@ export interface FileUploadSlots<M extends boolean = false> {
 declare const _default: <M extends boolean = false>(__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 onChange?: ((event: Event) => any) | undefined;
-        readonly "onUpdate:modelValue"?: ((...args: unknown[]) => any) | undefined;
+        readonly "onUpdate:modelValue"?: ((value: (M extends true ? File[] : File) | null | undefined) => any) | undefined;
     } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onChange" | "onUpdate:modelValue"> & (FileUploadProps<M> & {
         modelValue?: (M extends true ? File[] : File) | null;
-    }) & Partial<{}>> & import("vue").PublicProps;
+    }) & {}> & import("vue").PublicProps;
     expose(exposed: import("vue").ShallowUnwrapRef<{
         inputRef: import("vue").Ref<HTMLInputElement | undefined, HTMLInputElement | undefined>;
         dropzoneRef: import("vue").Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
     }>): void;
     attrs: any;
     slots: FileUploadSlots<M>;
-    emit: (((evt: "change", event: Event) => void) & ((evt: "update:modelValue", payload: M extends true ? File[] : File | null) => void)) & ((evt: "update:modelValue", value: (M extends true ? File[] : File) | null | undefined) => void);
+    emit: ((evt: "change", event: Event) => void) & ((evt: "update:modelValue", value: (M extends true ? File[] : File) | null | undefined) => void);
 }>) => import("vue").VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };

package/dist/runtime/components/Footer.d.vue.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/Footer.vue.d.ts

@@ -18,7 +18,7 @@ export interface FooterSlots {
     top(props?: {}): any;
     bottom(props?: {}): any;
 }
-declare const _default: __VLS_WithSlots<import("vue").DefineComponent<FooterProps, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<FooterProps> & Readonly<{}>, {
+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;

package/dist/runtime/components/FooterColumns.d.vue.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/FooterColumns.vue.d.ts

@@ -1,6 +1,6 @@
 import type { AppConfig } from '@nuxt/schema';
 import theme from '#build/ui/footer-columns';
-import type { LinkProps } from '../types';
+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'> {
@@ -8,7 +8,7 @@ export interface FooterColumnLink extends Omit<LinkProps, 'custom'> {
     /**
      * @IconifyIcon
      */
-    icon?: string;
+    icon?: IconProps['name'];
     class?: any;
     ui?: Pick<FooterColumns['slots'], 'item' | 'link' | 'linkLabel' | 'linkLabelExternalIcon' | 'linkLeadingIcon'>;
 }
@@ -43,7 +43,7 @@ export interface FooterColumnsSlots<T extends FooterColumnLink = FooterColumnLin
     '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> & Partial<{}>> & import("vue").PublicProps;
+    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>;

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

@@ -0,0 +1,114 @@
+import type { FormSchema, FormError, FormInputEvents, FormErrorEvent, FormSubmitEvent, FormErrorWithId, InferInput, FormData } from '../types/form';
+export type FormProps<S extends FormSchema, T extends boolean = true, N extends boolean = false> = {
+    id?: string | number;
+    /** Schema to validate the form state. Supports Standard Schema objects, Yup, Joi, and Superstructs. */
+    schema?: S;
+    /** An object representing the current state of the form. */
+    state?: N extends false ? Partial<InferInput<S>> : never;
+    /**
+     * Custom validation function to validate the form state.
+     * @param state - The current state of the form.
+     * @returns A promise that resolves to an array of FormError objects, or an array of FormError objects directly.
+     */
+    validate?: (state: Partial<InferInput<S>>) => Promise<FormError[]> | FormError[];
+    /**
+     * The list of input events that trigger the form validation.
+     * @remarks The form always validates on submit.
+     * @defaultValue `['blur', 'change', 'input']`
+     */
+    validateOn?: FormInputEvents[];
+    /** Disable all inputs inside the form. */
+    disabled?: boolean;
+    /**
+     * Path of the form's state within it's parent form.
+     * Used for nesting forms. Only available if `nested` is true.
+     */
+    name?: N extends true ? string : never;
+    /**
+     * Delay in milliseconds before validating the form on input events.
+     * @defaultValue `300`
+     */
+    validateOnInputDelay?: number;
+    /**
+     * If true, applies schema transformations on submit.
+     * @defaultValue `true`
+     */
+    transform?: T;
+    /**
+     * If true, this form will attach to its parent Form and validate at the same time.
+     * @defaultValue `false`
+     */
+    nested?: N;
+    /**
+     * When `true`, all form elements will be disabled on `@submit` event.
+     * This will cause any focused input elements to lose their focus state.
+     * @defaultValue `true`
+     */
+    loadingAuto?: boolean;
+    class?: any;
+    onSubmit?: ((event: FormSubmitEvent<FormData<S, T>>) => void | Promise<void>) | (() => void | Promise<void>);
+};
+export interface FormEmits<S extends FormSchema, T extends boolean = true> {
+    submit: [event: FormSubmitEvent<FormData<S, T>>];
+    error: [event: FormErrorEvent];
+}
+export interface FormSlots {
+    default(props: {
+        errors: FormError[];
+        loading: boolean;
+    }): any;
+}
+declare const _default: <S extends FormSchema, T extends boolean = true, N extends boolean = false>(__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 onError?: ((event: FormErrorEvent) => any) | undefined;
+        readonly onSubmit?: ((event: FormSubmitEvent<FormData<S, T>>) => any) | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onSubmit" | "onError"> & FormProps<S, T, N> & {}> & import("vue").PublicProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{
+        validate: {
+            <T_1 extends boolean>(opts: {
+                name?: keyof InferInput<S> | (keyof InferInput<S>)[] | undefined;
+                silent?: false | undefined;
+                nested?: boolean;
+                transform?: T_1 | undefined;
+            }): Promise<FormData<S, T_1>>;
+            <T_1 extends boolean>(opts: {
+                name?: keyof InferInput<S> | (keyof InferInput<S>)[] | undefined;
+                silent?: true | undefined;
+                nested?: boolean;
+                transform?: T_1 | undefined;
+            }): Promise<FormData<S, T_1> | false>;
+        };
+        errors: import("vue").Ref<{
+            id?: string | undefined;
+            name?: string | undefined;
+            message: string;
+        }[], FormErrorWithId[] | {
+            id?: string | undefined;
+            name?: string | undefined;
+            message: string;
+        }[]>;
+        setErrors(errs: FormError[], name?: keyof InferInput<S> | string | RegExp): void;
+        submit(): Promise<void>;
+        getErrors(name?: keyof InferInput<S> | string | RegExp): {
+            id?: string | undefined;
+            name?: string | undefined;
+            message: string;
+        }[];
+        clear(name?: keyof InferInput<S> | string | RegExp): void;
+        disabled: import("vue").ComputedRef<boolean>;
+        loading: import("vue").Ref<boolean, boolean>;
+        dirty: import("vue").ComputedRef<boolean>;
+        dirtyFields: ReadonlySet<import("vue").DeepReadonly<import("@vue/reactivity").UnwrapRefSimple<keyof InferInput<S>>>>;
+        blurredFields: ReadonlySet<import("vue").DeepReadonly<import("@vue/reactivity").UnwrapRefSimple<keyof InferInput<S>>>>;
+        touchedFields: ReadonlySet<import("vue").DeepReadonly<import("@vue/reactivity").UnwrapRefSimple<keyof InferInput<S>>>>;
+    }>): void;
+    attrs: any;
+    slots: FormSlots;
+    emit: ((evt: "error", event: FormErrorEvent) => void) & ((evt: "submit", event: FormSubmitEvent<FormData<S, T>>) => void);
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T as K]: T[K];
+} & {};