@indielayer/ui 1.18.1 → 2.1.0

package/lib/components/upload/Upload.vue.d.ts

@@ -5,54 +5,118 @@ declare const validators: {
     size: string[];
 };
 declare const uploadProps: {
-    placeholder: StringConstructor;
-    accept: StringConstructor;
-    multiple: BooleanConstructor;
-    maxFiles: (StringConstructor | NumberConstructor)[];
-    maxFileSize: (StringConstructor | NumberConstructor)[];
+    placeholder: {
+        type: StringConstructor;
+        description: string;
+    };
+    accept: {
+        type: StringConstructor;
+        description: string;
+    };
+    multiple: import("vue").Prop<boolean | undefined>;
+    maxFiles: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    maxFileSize: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
     variant: {
         type: PropType<"box">;
         default: string;
+        description: string;
+    };
+    action: {
+        type: StringConstructor;
+        description: string;
+    };
+    headers: {
+        type: PropType<Record<string, string>>;
+        description: string;
     };
-    action: StringConstructor;
-    headers: PropType<Record<string, string>>;
     method: {
         type: PropType<"POST" | "PUT">;
         default: string;
+        description: string;
     };
-    withCredentials: BooleanConstructor;
+    withCredentials: import("vue").Prop<boolean | undefined>;
     fileFormDataName: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     modelValue: {
         readonly type: PropType<string | number | boolean | object | any[] | undefined>;
         readonly default: undefined;
+        readonly description: "Bound value (v-model).";
+    };
+    id: {
+        readonly type: StringConstructor;
+        readonly description: "Native id attribute for the input element.";
+    };
+    name: {
+        readonly type: StringConstructor;
+        readonly description: "Native name attribute for form submission.";
+    };
+    readonly: {
+        readonly type: BooleanConstructor;
+        readonly description: "Makes the field read-only without disabling it.";
+    };
+    required: {
+        readonly type: BooleanConstructor;
+        readonly description: "Marks the field as required for validation.";
     };
-    id: StringConstructor;
-    name: StringConstructor;
-    readonly: BooleanConstructor;
-    required: BooleanConstructor;
     validateOnInput: {
         readonly type: BooleanConstructor;
         readonly default: true;
+        readonly description: "Runs validation on each input event when true.";
+    };
+    label: {
+        readonly type: StringConstructor;
+        readonly description: "Visible label text for the field.";
+    };
+    helper: {
+        readonly type: StringConstructor;
+        readonly description: "Helper text shown below the field.";
+    };
+    error: {
+        readonly type: StringConstructor;
+        readonly description: "External error message; overrides rule errors when set.";
+    };
+    hideFooter: {
+        readonly type: BooleanConstructor;
+        readonly description: "Hides the footer area (helper / error).";
     };
-    label: StringConstructor;
-    helper: StringConstructor;
-    error: StringConstructor;
-    hideFooter: BooleanConstructor;
     rules: {
         readonly type: ArrayConstructor;
         readonly default: () => never[];
+        readonly description: "Validation rule functions or rule descriptors.";
+    };
+    tooltip: {
+        readonly type: StringConstructor;
+        readonly description: "Optional tooltip text next to the label.";
+    };
+    skipFormRegistry: {
+        readonly type: BooleanConstructor;
+        readonly description: "Skips registering this field with a parent x-form.";
+    };
+    disabled: {
+        readonly type: BooleanConstructor;
+        readonly description: "Disables interaction and applies disabled styling.";
+    };
+    loading: {
+        readonly type: BooleanConstructor;
+        readonly description: "Shows a loading indicator and blocks interaction.";
+    };
+    loadingLabel: {
+        readonly type: StringConstructor;
+        readonly description: "Accessible label announced while loading.";
     };
-    tooltip: StringConstructor;
-    skipFormRegistry: BooleanConstructor;
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    loadingLabel: StringConstructor;
     loadingStatus: {
         readonly type: PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
 };
 export type UploadFile = {
@@ -68,54 +132,118 @@ type InternalClasses = 'wrapper' | 'input';
 export interface UploadTheme extends ThemeComponent<UploadProps, InternalClasses> {
 }
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    placeholder: StringConstructor;
-    accept: StringConstructor;
-    multiple: BooleanConstructor;
-    maxFiles: (StringConstructor | NumberConstructor)[];
-    maxFileSize: (StringConstructor | NumberConstructor)[];
+    placeholder: {
+        type: StringConstructor;
+        description: string;
+    };
+    accept: {
+        type: StringConstructor;
+        description: string;
+    };
+    multiple: import("vue").Prop<boolean | undefined>;
+    maxFiles: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    maxFileSize: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
     variant: {
         type: PropType<"box">;
         default: string;
+        description: string;
+    };
+    action: {
+        type: StringConstructor;
+        description: string;
+    };
+    headers: {
+        type: PropType<Record<string, string>>;
+        description: string;
     };
-    action: StringConstructor;
-    headers: PropType<Record<string, string>>;
     method: {
         type: PropType<"POST" | "PUT">;
         default: string;
+        description: string;
     };
-    withCredentials: BooleanConstructor;
+    withCredentials: import("vue").Prop<boolean | undefined>;
     fileFormDataName: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     modelValue: {
         readonly type: PropType<string | number | boolean | object | any[] | undefined>;
         readonly default: undefined;
+        readonly description: "Bound value (v-model).";
+    };
+    id: {
+        readonly type: StringConstructor;
+        readonly description: "Native id attribute for the input element.";
+    };
+    name: {
+        readonly type: StringConstructor;
+        readonly description: "Native name attribute for form submission.";
+    };
+    readonly: {
+        readonly type: BooleanConstructor;
+        readonly description: "Makes the field read-only without disabling it.";
+    };
+    required: {
+        readonly type: BooleanConstructor;
+        readonly description: "Marks the field as required for validation.";
     };
-    id: StringConstructor;
-    name: StringConstructor;
-    readonly: BooleanConstructor;
-    required: BooleanConstructor;
     validateOnInput: {
         readonly type: BooleanConstructor;
         readonly default: true;
+        readonly description: "Runs validation on each input event when true.";
+    };
+    label: {
+        readonly type: StringConstructor;
+        readonly description: "Visible label text for the field.";
+    };
+    helper: {
+        readonly type: StringConstructor;
+        readonly description: "Helper text shown below the field.";
+    };
+    error: {
+        readonly type: StringConstructor;
+        readonly description: "External error message; overrides rule errors when set.";
+    };
+    hideFooter: {
+        readonly type: BooleanConstructor;
+        readonly description: "Hides the footer area (helper / error).";
     };
-    label: StringConstructor;
-    helper: StringConstructor;
-    error: StringConstructor;
-    hideFooter: BooleanConstructor;
     rules: {
         readonly type: ArrayConstructor;
         readonly default: () => never[];
+        readonly description: "Validation rule functions or rule descriptors.";
+    };
+    tooltip: {
+        readonly type: StringConstructor;
+        readonly description: "Optional tooltip text next to the label.";
+    };
+    skipFormRegistry: {
+        readonly type: BooleanConstructor;
+        readonly description: "Skips registering this field with a parent x-form.";
+    };
+    disabled: {
+        readonly type: BooleanConstructor;
+        readonly description: "Disables interaction and applies disabled styling.";
+    };
+    loading: {
+        readonly type: BooleanConstructor;
+        readonly description: "Shows a loading indicator and blocks interaction.";
+    };
+    loadingLabel: {
+        readonly type: StringConstructor;
+        readonly description: "Accessible label announced while loading.";
     };
-    tooltip: StringConstructor;
-    skipFormRegistry: BooleanConstructor;
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    loadingLabel: StringConstructor;
     loadingStatus: {
         readonly type: PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
 }>, {
     focus: () => void | undefined;
@@ -124,54 +252,118 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     validate: (val?: any) => boolean;
     setError: (val: string) => void;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, string[], string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    placeholder: StringConstructor;
-    accept: StringConstructor;
-    multiple: BooleanConstructor;
-    maxFiles: (StringConstructor | NumberConstructor)[];
-    maxFileSize: (StringConstructor | NumberConstructor)[];
+    placeholder: {
+        type: StringConstructor;
+        description: string;
+    };
+    accept: {
+        type: StringConstructor;
+        description: string;
+    };
+    multiple: import("vue").Prop<boolean | undefined>;
+    maxFiles: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
+    maxFileSize: {
+        type: (StringConstructor | NumberConstructor)[];
+        description: string;
+    };
     variant: {
         type: PropType<"box">;
         default: string;
+        description: string;
+    };
+    action: {
+        type: StringConstructor;
+        description: string;
+    };
+    headers: {
+        type: PropType<Record<string, string>>;
+        description: string;
     };
-    action: StringConstructor;
-    headers: PropType<Record<string, string>>;
     method: {
         type: PropType<"POST" | "PUT">;
         default: string;
+        description: string;
     };
-    withCredentials: BooleanConstructor;
+    withCredentials: import("vue").Prop<boolean | undefined>;
     fileFormDataName: {
         type: StringConstructor;
         default: string;
+        description: string;
     };
     modelValue: {
         readonly type: PropType<string | number | boolean | object | any[] | undefined>;
         readonly default: undefined;
+        readonly description: "Bound value (v-model).";
+    };
+    id: {
+        readonly type: StringConstructor;
+        readonly description: "Native id attribute for the input element.";
+    };
+    name: {
+        readonly type: StringConstructor;
+        readonly description: "Native name attribute for form submission.";
+    };
+    readonly: {
+        readonly type: BooleanConstructor;
+        readonly description: "Makes the field read-only without disabling it.";
+    };
+    required: {
+        readonly type: BooleanConstructor;
+        readonly description: "Marks the field as required for validation.";
     };
-    id: StringConstructor;
-    name: StringConstructor;
-    readonly: BooleanConstructor;
-    required: BooleanConstructor;
     validateOnInput: {
         readonly type: BooleanConstructor;
         readonly default: true;
+        readonly description: "Runs validation on each input event when true.";
+    };
+    label: {
+        readonly type: StringConstructor;
+        readonly description: "Visible label text for the field.";
+    };
+    helper: {
+        readonly type: StringConstructor;
+        readonly description: "Helper text shown below the field.";
+    };
+    error: {
+        readonly type: StringConstructor;
+        readonly description: "External error message; overrides rule errors when set.";
+    };
+    hideFooter: {
+        readonly type: BooleanConstructor;
+        readonly description: "Hides the footer area (helper / error).";
     };
-    label: StringConstructor;
-    helper: StringConstructor;
-    error: StringConstructor;
-    hideFooter: BooleanConstructor;
     rules: {
         readonly type: ArrayConstructor;
         readonly default: () => never[];
+        readonly description: "Validation rule functions or rule descriptors.";
+    };
+    tooltip: {
+        readonly type: StringConstructor;
+        readonly description: "Optional tooltip text next to the label.";
+    };
+    skipFormRegistry: {
+        readonly type: BooleanConstructor;
+        readonly description: "Skips registering this field with a parent x-form.";
+    };
+    disabled: {
+        readonly type: BooleanConstructor;
+        readonly description: "Disables interaction and applies disabled styling.";
+    };
+    loading: {
+        readonly type: BooleanConstructor;
+        readonly description: "Shows a loading indicator and blocks interaction.";
+    };
+    loadingLabel: {
+        readonly type: StringConstructor;
+        readonly description: "Accessible label announced while loading.";
     };
-    tooltip: StringConstructor;
-    skipFormRegistry: BooleanConstructor;
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    loadingLabel: StringConstructor;
     loadingStatus: {
         readonly type: PropType<import("../loader/Loader.vue").LoaderStatus>;
         readonly default: "active";
+        readonly description: "Loader visual status (for example active or indeterminate).";
     };
 }>> & Readonly<{
     [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;
@@ -187,16 +379,30 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<im
     rules: unknown[];
     skipFormRegistry: boolean;
     variant: "box";
-    multiple: boolean;
     method: "POST" | "PUT";
-    withCredentials: boolean;
     fileFormDataName: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
     box?(_: {
         isOver: boolean;
     }): any;
     files?(_: {
-        files: (string | number | boolean | object | any[] | undefined) & UploadFile[];
+        files: (string | number | boolean | object | any[] | undefined) & {
+            file: {
+                readonly lastModified: number;
+                readonly name: string;
+                readonly webkitRelativePath: string;
+                readonly size: number;
+                readonly type: string;
+                arrayBuffer: () => Promise<ArrayBuffer>;
+                slice: (start?: number | undefined, end?: number | undefined, contentType?: string | undefined) => Blob;
+                stream: () => ReadableStream<Uint8Array>;
+                text: () => Promise<string>;
+            };
+            completed: boolean;
+            response?: any;
+            progress: number;
+            error: string;
+        }[];
     }): any;
     removeIcon?(_: {}): any;
 }>;