@octans/ui 1.0.0

package/dist/components/FileInput/FileInput.vue.d.ts

@@ -0,0 +1,422 @@
+import { PropType } from 'vue';
+import { FileInputFileItemType } from './utils';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    modelValue: {
+        type: PropType<FileInputFileItemType[]>;
+        default: () => never[];
+    };
+    /**
+     * Label to display above the input.
+     */
+    label: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Error text to display beneath the input.
+     */
+    error: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Additional help text to display.
+     */
+    helpText: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders help text as raw HTML. Use with caution.
+     */
+    helpTextHtml: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * A string that defines the file types the file input should accept.
+     *
+     * This string is a comma-separated list of [unique file type specifiers](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#Unique_file_type_specifiers).
+     */
+    accept: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Maximum individual file size allowed in bytes.
+     */
+    maxBytes: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Allow multiple files to be uploaded.
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Custom file validator which should return a custom error.
+     *
+     * - All truthy results will be considered an error. If the result is
+     *  a string, it will be used as the error message.
+     * - Supports promises.
+     */
+    validator: {
+        type: FunctionConstructor;
+    };
+    /**
+     * Renders the file list in readonly mode without remove buttons or dropzone.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {}, {
+    isValidating: boolean;
+}, {
+    acceptFn(): (file: FileInputFileItemType) => boolean;
+    items(): FileInputFileItemType[];
+}, {
+    $t: typeof import('../../utils/translate').translate;
+    openDialog(_event: MouseEvent): void;
+    emitChange(files: FileInputFileItemType[]): void;
+    removeItemAt(index: number): void;
+    appendFiles(fileList: FileList): Promise<void>;
+    onChangeFiles(): void;
+    onDropZoneDrop(fileList: FileList): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    modelValue: {
+        type: PropType<FileInputFileItemType[]>;
+        default: () => never[];
+    };
+    /**
+     * Label to display above the input.
+     */
+    label: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Error text to display beneath the input.
+     */
+    error: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Additional help text to display.
+     */
+    helpText: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders help text as raw HTML. Use with caution.
+     */
+    helpTextHtml: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * A string that defines the file types the file input should accept.
+     *
+     * This string is a comma-separated list of [unique file type specifiers](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#Unique_file_type_specifiers).
+     */
+    accept: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Maximum individual file size allowed in bytes.
+     */
+    maxBytes: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Allow multiple files to be uploaded.
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Custom file validator which should return a custom error.
+     *
+     * - All truthy results will be considered an error. If the result is
+     *  a string, it will be used as the error message.
+     * - Supports promises.
+     */
+    validator: {
+        type: FunctionConstructor;
+    };
+    /**
+     * Renders the file list in readonly mode without remove buttons or dropzone.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    modelValue: FileInputFileItemType[];
+    readonly: boolean;
+    multiple: boolean;
+    accept: string;
+    maxBytes: number;
+}, {}, {
+    DropZone: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        multiple: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>, {}, {
+        isDragging: boolean;
+        error: string | null;
+    }, {}, {
+        $t: typeof import('../../utils/translate').translate;
+        onClick(event: MouseEvent): void;
+        onDrop(event: DragEvent): void;
+        onDragEnter(): void;
+    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        multiple: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>> & Readonly<{}>, {
+        multiple: boolean;
+    }, {}, {
+        Icon: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+            icon: {
+                type: StringConstructor;
+            };
+            size: {
+                type: StringConstructor;
+            };
+            contained: {
+                type: BooleanConstructor;
+            };
+            badge: {
+                type: PropType<import('../types').IconBadgeStatusType>;
+            };
+            badgeIcon: {
+                type: StringConstructor;
+            };
+            badgeColor: {
+                type: StringConstructor;
+            };
+        }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+            [key: string]: any;
+        }> | null, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+            icon: {
+                type: StringConstructor;
+            };
+            size: {
+                type: StringConstructor;
+            };
+            contained: {
+                type: BooleanConstructor;
+            };
+            badge: {
+                type: PropType<import('../types').IconBadgeStatusType>;
+            };
+            badgeIcon: {
+                type: StringConstructor;
+            };
+            badgeColor: {
+                type: StringConstructor;
+            };
+        }>> & Readonly<{}>, {
+            contained: boolean;
+        }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    }, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    ItemList: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        items: {
+            type: PropType<FileInputFileItemType[]>;
+            required: true;
+        };
+        readonly: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        items: {
+            type: PropType<FileInputFileItemType[]>;
+            required: true;
+        };
+        readonly: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>> & Readonly<{}>, {
+        readonly: boolean;
+    }, {}, {
+        Formatter: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+            type: {
+                type: StringConstructor;
+                required: true;
+            };
+            value: {
+                type: null;
+                required: true;
+            };
+            locale: {
+                type: StringConstructor;
+                default: string;
+            };
+            currency: {
+                type: StringConstructor;
+                default: string;
+            };
+        }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+            [key: string]: any;
+        }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+            type: {
+                type: StringConstructor;
+                required: true;
+            };
+            value: {
+                type: null;
+                required: true;
+            };
+            locale: {
+                type: StringConstructor;
+                default: string;
+            };
+            currency: {
+                type: StringConstructor;
+                default: string;
+            };
+        }>> & Readonly<{}>, {
+            locale: string;
+            currency: string;
+        }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+        Icon: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+            icon: {
+                type: StringConstructor;
+            };
+            size: {
+                type: StringConstructor;
+            };
+            contained: {
+                type: BooleanConstructor;
+            };
+            badge: {
+                type: PropType<import('../types').IconBadgeStatusType>;
+            };
+            badgeIcon: {
+                type: StringConstructor;
+            };
+            badgeColor: {
+                type: StringConstructor;
+            };
+        }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+            [key: string]: any;
+        }> | null, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+            icon: {
+                type: StringConstructor;
+            };
+            size: {
+                type: StringConstructor;
+            };
+            contained: {
+                type: BooleanConstructor;
+            };
+            badge: {
+                type: PropType<import('../types').IconBadgeStatusType>;
+            };
+            badgeIcon: {
+                type: StringConstructor;
+            };
+            badgeColor: {
+                type: StringConstructor;
+            };
+        }>> & Readonly<{}>, {
+            contained: boolean;
+        }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    }, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    Labelled: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        label: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        error: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpText: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpTextHtml: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpLink: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        required: {
+            type: BooleanConstructor;
+            required: false;
+        };
+    }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        label: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        error: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpText: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpTextHtml: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpLink: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        required: {
+            type: BooleanConstructor;
+            required: false;
+        };
+    }>> & Readonly<{}>, {
+        required: boolean;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    Spinner: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        color: {
+            type: StringConstructor;
+            default: string;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        color: {
+            type: StringConstructor;
+            default: string;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & Readonly<{}>, {
+        size: string;
+        color: string;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/FileInput/ItemList.vue.d.ts

@@ -0,0 +1,109 @@
+import { PropType } from 'vue';
+import { FileInputFileItemType } from './utils';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    items: {
+        type: PropType<FileInputFileItemType[]>;
+        required: true;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    items: {
+        type: PropType<FileInputFileItemType[]>;
+        required: true;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    readonly: boolean;
+}, {}, {
+    Formatter: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        type: {
+            type: StringConstructor;
+            required: true;
+        };
+        value: {
+            type: null;
+            required: true;
+        };
+        locale: {
+            type: StringConstructor;
+            default: string;
+        };
+        currency: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        type: {
+            type: StringConstructor;
+            required: true;
+        };
+        value: {
+            type: null;
+            required: true;
+        };
+        locale: {
+            type: StringConstructor;
+            default: string;
+        };
+        currency: {
+            type: StringConstructor;
+            default: string;
+        };
+    }>> & Readonly<{}>, {
+        locale: string;
+        currency: string;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    Icon: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        icon: {
+            type: StringConstructor;
+        };
+        size: {
+            type: StringConstructor;
+        };
+        contained: {
+            type: BooleanConstructor;
+        };
+        badge: {
+            type: PropType<import('../types').IconBadgeStatusType>;
+        };
+        badgeIcon: {
+            type: StringConstructor;
+        };
+        badgeColor: {
+            type: StringConstructor;
+        };
+    }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+        [key: string]: any;
+    }> | null, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        icon: {
+            type: StringConstructor;
+        };
+        size: {
+            type: StringConstructor;
+        };
+        contained: {
+            type: BooleanConstructor;
+        };
+        badge: {
+            type: PropType<import('../types').IconBadgeStatusType>;
+        };
+        badgeIcon: {
+            type: StringConstructor;
+        };
+        badgeColor: {
+            type: StringConstructor;
+        };
+    }>> & Readonly<{}>, {
+        contained: boolean;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/FileInput/index.d.ts

@@ -0,0 +1 @@
+export { default as FileInput } from './FileInput.vue';

package/dist/components/FileInput/utils.d.ts

@@ -0,0 +1,15 @@
+export type FileInputFileItemType = {
+    name: string;
+    size: number;
+    error?: string;
+    lastModified: number;
+    icon: string;
+    type?: string;
+};
+export declare function getMimeTypeInfo(mimeType: string): {
+    mimeType: string;
+    type: string;
+    icon: string;
+};
+export declare function createAcceptFileMatcher(accept: string): (file: FileInputFileItemType) => boolean;
+export declare function debugFileObject(file: File): any;