@leaflink/stash 48.3.1 → 48.4.1

package/dist/TextEditor.vue.d.ts

@@ -0,0 +1,191 @@
+import { AllowedComponentProps } from 'vue';
+import { ComponentCustomProps } from 'vue';
+import { ComponentOptionsMixin } from 'vue';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { PropType } from 'vue';
+import Quill from 'quill';
+import Toolbar from 'quill/modules/toolbar';
+import { VNodeProps } from 'vue';
+
+declare type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+
+declare type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
+declare const _default: DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<TextEditorProps>, {
+    modelValue: string;
+    placeholder: string;
+    isReadOnly: boolean;
+    addBottomSpace: boolean;
+    errorText: undefined;
+    hintText: undefined;
+    id: undefined;
+    isRequired: boolean;
+    label: undefined;
+    showOptionalInLabel: boolean;
+    controls: () => never[];
+    handlers: () => {};
+}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    blur: (editor: Quill) => void;
+    focus: (editor: Quill) => void;
+    "update:model-value": (value: string) => void;
+}, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<TextEditorProps>, {
+    modelValue: string;
+    placeholder: string;
+    isReadOnly: boolean;
+    addBottomSpace: boolean;
+    errorText: undefined;
+    hintText: undefined;
+    id: undefined;
+    isRequired: boolean;
+    label: undefined;
+    showOptionalInLabel: boolean;
+    controls: () => never[];
+    handlers: () => {};
+}>>> & {
+    onFocus?: ((editor: Quill) => any) | undefined;
+    onBlur?: ((editor: Quill) => any) | undefined;
+    "onUpdate:model-value"?: ((value: string) => any) | undefined;
+}, {
+    id: string;
+    label: string;
+    placeholder: string;
+    controls: TextEditorControls;
+    isRequired: boolean;
+    addBottomSpace: boolean;
+    errorText: string;
+    hintText: string;
+    isReadOnly: boolean;
+    showOptionalInLabel: boolean;
+    modelValue: string;
+    handlers: TextEditorControlHandlerMap;
+}, {}>;
+export default _default;
+
+declare type IconName = typeof iconNames[number];
+
+declare const iconNames: readonly ["action-dots", "activity", "alert-bell", "archive", "arrow-down", "arrow-left", "arrow-right", "arrow-up", "badge-discount", "badge-seller-elite", "badge-seller-power", "badge-seller-verified", "book-customer", "building-office", "bulk-add", "calendar-reschedule", "calendar", "caret-down", "caret-up", "cart-active", "cart-plus", "change-log", "check", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "circle-check", "circle-close", "circle-dollar", "circle-info", "circle-partial", "circle-percent", "circle-question-mark", "circle-status", "circle-warning", "clipboard-checkmark", "clipboard-inventory", "close", "combine", "compass", "contact", "contract", "copy", "credit-card", "credit-profile", "dashboard", "document-accept", "document-invoice", "document-recieved", "document-sent", "document-view", "document", "dolly", "download", "edit", "ellipsis", "envelope-open", "envelope", "export", "figma", "file-csv", "file", "filter-funnel", "filter-line", "flag", "folder", "folder-bar-graph", "folder-orders", "font-bold", "font-clear-format", "font-italic", "font-underline", "gear", "github", "globe", "graph-bar-chart", "graph-line-chart", "graph-pie-chart", "hazard", "hazard-outline", "headset-agent", "headset-mic", "heart-filled", "heart-outline", "help-question-mark", "hide", "history", "image", "keyboard-return", "license-approved", "license-certificate", "lightbulb", "link-add", "link-unlink", "link", "list-bulleted", "list-items", "list-numbered", "loading-big", "loading-small", "location", "lock-unlock", "lock", "logo-facebook", "logo-instagram", "logo-linkedin", "logo-ll", "logo-metrc", "logo-plaid", "logo-x", "logo-youtube", "logout", "medical", "megaphone-sound", "megaphone", "menu", "message-dispute", "message-reply", "message", "minus", "mj-leaf", "money", "note-add", "note", "open-in-new", "paperclip", "performance", "phone", "plus", "preview", "print", "product-menu-manage", "product-menu-search", "product-menu", "queue-add", "queue", "recent", "refresh", "register", "reply", "report-download", "sample", "save", "scale-law", "scale-weight", "search", "seed-cycle", "share", "shop-bag-browse", "shop-bag-reorder", "shop-bag", "shop-basket", "shop-cart-add", "shop-cart", "show", "sign-dollar", "sign-percent", "sort", "split", "star-filled", "star-outline", "storefront", "submit", "swap-horizontal", "swap-vertical", "tag-star", "tag", "test-results", "ticket-star", "ticket", "tool-dropper", "tool-wrench", "transfer", "trashcan", "truck", "upload", "user-add", "user-admin", "user-check", "user", "view-card", "view-detailed", "view-list", "warehouse", "working"];
+
+declare const TEXT_EDITOR_ALLOWED_CONTROLS: readonly ["bold", "italic", "underline", "link", "divider", "list"];
+
+export declare type TextEditorAllowedControlName = typeof TEXT_EDITOR_ALLOWED_CONTROLS[number];
+
+export declare type TextEditorControl = (TextEditorAllowedControlName | TextEditorControlObject)[];
+
+export declare type TextEditorControlHandler = (this: Toolbar, value: any) => void;
+
+export declare type TextEditorControlHandlerMap = {
+    [key in TextEditorAllowedControlName]?: TextEditorControlHandler;
+};
+
+export declare type TextEditorControlMatrix = (TextEditorAllowedControlName | TextEditorControlObject)[][];
+
+export declare type TextEditorControlObject = {
+    [key in TextEditorAllowedControlName]?: unknown;
+};
+
+/**
+ * Toolbar Controls used to configure the Editor options.
+ * @see https://quilljs.com/docs/modules/toolbar/#controls
+ *
+ * @example ['bold', 'italic', 'underline', { list: 'bullet' }]
+ *
+ * @example Grouping: [
+ *  ['bold', 'italic', 'underline', 'clean'],
+ *  [{ list: 'ordered' }, { list: 'bullet' }],
+ *  ['link', 'divider'],
+ * ]
+ */
+export declare type TextEditorControls = TextEditorControl | TextEditorControlMatrix;
+
+export declare interface TextEditorFormat {
+    name: TextEditorAllowedControlName;
+    icon?: IconName;
+    value?: string;
+}
+
+export declare type TextEditorFormatGroups = TextEditorFormat[][];
+
+/**
+ * The text editor icon map property can be either an IconName or an object with a key being some TextEditorAllowedControlName values
+ * @see https://quilljs.com/docs/modules/toolbar/#container for more options and compare with the TextEditorAllowedControlName
+ */
+export declare type TextEditorIconMap = {
+    [key in TextEditorAllowedControlName]: IconName | {
+        [x: string]: IconName;
+    };
+};
+
+export declare interface TextEditorProps {
+    /**
+     * The model value.
+     */
+    modelValue?: string;
+    /**
+     * Placeholder text to display when the editor is empty.
+     */
+    placeholder?: string;
+    /**
+     * A set of custom toolbar controls to pass to the Quill editor.
+     */
+    controls?: TextEditorControls;
+    /**
+     * An object map of custom handlers to pass to the Quill editor.
+     */
+    handlers?: TextEditorControlHandlerMap;
+    /**
+     * Adds spacing under the field that is consistent whether hint/error text is displayed.
+     */
+    addBottomSpace?: boolean;
+    /**
+     * Error text to display. Replaces `hintText` (if provided) & adds error styling.
+     */
+    errorText?: string;
+    /**
+     * Displays text below the input; hidden when the isReadOnly prop is truthy.
+     */
+    hintText?: string;
+    /**
+     * ID for the Label and Input; must be unique
+     */
+    id?: string;
+    /**
+     * Whether it's a readonly field.
+     */
+    isReadOnly?: boolean;
+    /**
+     * Whether the field is required.
+     */
+    isRequired?: boolean;
+    /**
+     * Label to render above the input.
+     */
+    label?: string;
+    /**
+     * Show "(optional)" to the right of the label text
+     */
+    showOptionalInLabel?: boolean;
+    /**
+     * Whether the field is disabled.
+     */
+    isDisabled?: boolean;
+}
+
+export { }