@vc-shell/framework 1.0.69 → 1.0.71

package/dist/ui/components/molecules/vc-select/vc-select.vue.d.ts

@@ -1,5 +1,8 @@
-export type OptionProp = ((option: string | Record<string, unknown>) => string) | string | undefined;
-export interface Props {
+export type OptionProp<T> = ((option: T) => string) | string | undefined;
+declare const _default: <T extends Record<string, any>, P extends {
+    results?: T[];
+    totalCount?: number;
+}>(__VLS_props: {
     /**
      * Name of select
      */
@@ -58,24 +61,21 @@ export interface Props {
      * Available options that the user can select from.
      * Default value: []
      */
-    options?: ((keyword?: string, skip?: number, ids?: string[]) => Promise<{
-        results?: object[];
-        totalCount?: number;
-    }>) | unknown[];
+    options?: T[] | ((keyword?: string, skip?: number, ids?: string[]) => Promise<P>);
     /**
      * Property of option which holds the 'value'
      * Default value: id
      * @param option The current option being processed
      * @returns Value of the current option
      */
-    optionValue?: OptionProp;
+    optionValue?: OptionProp<T | P["results"][number]>;
     /**
      * Property of option which holds the 'label'
      * Default value: title
      * @param option The current option being processed
      * @returns Label of the current option
      */
-    optionLabel?: OptionProp;
+    optionLabel?: OptionProp<T | P["results"][number]>;
     /**
      * @requires optionValue
      * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionValue**
@@ -85,7 +85,7 @@ export interface Props {
      * @param option The current option being processed
      * @returns Value of the current option
      */
-    displayValue?: OptionProp;
+    displayValue?: OptionProp<T | P["results"][number]>;
     /**
      * @requires optionLabel
      * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionLabel**
@@ -95,7 +95,7 @@ export interface Props {
      * @param option The current option being processed
      * @returns Label of the current option
      */
-    displayLabel?: OptionProp;
+    displayLabel?: OptionProp<T | P["results"][number]>;
     /**
      * Update model with the value of the selected option instead of the whole option
      */
@@ -121,116 +121,640 @@ export interface Props {
      * Input search activation
      */
     searchable?: boolean;
-}
-export interface Emits {
-    /**
-     * Emitted when the component needs to change the model; Is also used by v-model
-     */
-    (event: "update:modelValue", inputValue: any): void;
-    /**
-     * Emitted when user wants to filter a value
-     */
-    (event: "search", inputValue: string): void;
-    /**
-     * Emitted when the select options list is hidden
-     */
-    (event: "close"): void;
-}
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
-    optionValue: string;
-    optionLabel: string;
-    debounce: number;
-    clearable: boolean;
-    name: string;
-    autofocus: boolean;
-    emitValue: boolean;
-    mapOptions: boolean;
-    placeholder: string;
-    options: () => any[];
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (inputValue: any) => void;
-} & {
-    search: (inputValue: string) => void;
-} & {
-    close: () => void;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
-    optionValue: string;
-    optionLabel: string;
-    debounce: number;
-    clearable: boolean;
-    name: string;
-    autofocus: boolean;
-    emitValue: boolean;
-    mapOptions: boolean;
-    placeholder: string;
-    options: () => any[];
-}>>> & {
-    "onUpdate:modelValue"?: (inputValue: any) => any;
-    onClose?: () => any;
-    onSearch?: (inputValue: string) => any;
-}, {
-    name: string;
-    placeholder: string;
-    options: unknown[] | ((keyword?: string, skip?: number, ids?: string[]) => Promise<{
-        results?: object[];
-        totalCount?: number;
-    }>);
-    clearable: boolean;
-    debounce: string | number;
-    emitValue: boolean;
-    optionValue: OptionProp;
-    optionLabel: OptionProp;
-    mapOptions: boolean;
-}>, {
-    control: (_: {
-        toggleHandler: () => Promise<void>;
-    }) => any;
-    prepend: (_: {}) => any;
-    'prepend-inner': (_: {}) => any;
-    'selected-item': (_: {
-        index: any;
-        opt: any;
-        selected: boolean;
-        toggleOption: (opt: {
-            [x: string]: string;
-        }) => void;
-        removeAtIndex: (index: number) => void;
-    } & {
-        key: number;
-    }) => any;
-    'append-inner': (_: {}) => any;
-    error: (_: {}) => any;
-    hint: (_: {}) => any;
-    append: (_: {}) => any;
-    'no-options': (_: {}) => any;
-    option: (_: {
-        index: number;
-        opt: any;
-        selected: boolean;
-        label: any;
-        toggleOption: (opt: {
-            [x: string]: string;
-        }) => void;
-    }) => any;
-}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
+} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: Pick<{
+    props: {
+        /**
+         * Name of select
+         */
+        name?: string;
+        /**
+         * Model of the component; Must be Array if using 'multiple' prop; Use this property with a listener for 'update:modelValue' event OR use v-model directive
+         */
+        modelValue?: any;
+        /**
+         * Try to map labels of model from 'options' Array; If you are using emit-value you will probably need to use map-options to display the label text in the select field rather than the value;
+         * Default value: true
+         */
+        mapOptions?: boolean;
+        /**
+         * Does field have validation errors?
+         */
+        error?: boolean;
+        /**
+         * Validation error message (gets displayed only if 'error' is set to 'true')
+         */
+        errorMessage?: string;
+        /**
+         * Select label
+         */
+        label?: string;
+        /**
+         * Select description (hint) text below input component
+         */
+        hint?: string;
+        /**
+         * Prefix
+         */
+        prefix?: string;
+        /**
+         * Suffix
+         */
+        suffix?: string;
+        /**
+         * Signals the user a process is in progress by displaying a spinner
+         */
+        loading?: boolean;
+        /**
+         * Appends clearable icon when a value is set;
+         * When clicked, model becomes null
+         */
+        clearable?: boolean;
+        /**
+         * Put component in disabled mode
+         */
+        disabled?: boolean;
+        /**
+         * Allow multiple selection; Model must be Array
+         */
+        multiple?: boolean;
+        /**
+         * Available options that the user can select from.
+         * Default value: []
+         */
+        options?: T[] | ((keyword?: string, skip?: number, ids?: string[]) => Promise<P>);
+        /**
+         * Property of option which holds the 'value'
+         * Default value: id
+         * @param option The current option being processed
+         * @returns Value of the current option
+         */
+        optionValue?: OptionProp<T | P["results"][number]>;
+        /**
+         * Property of option which holds the 'label'
+         * Default value: title
+         * @param option The current option being processed
+         * @returns Label of the current option
+         */
+        optionLabel?: OptionProp<T | P["results"][number]>;
+        /**
+         * @requires optionValue
+         * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionValue**
+         *
+         * Property of option which holds the 'value'
+         * Default value: id
+         * @param option The current option being processed
+         * @returns Value of the current option
+         */
+        displayValue?: OptionProp<T | P["results"][number]>;
+        /**
+         * @requires optionLabel
+         * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionLabel**
+         *
+         * Property of option which holds the 'label'
+         * Default value: title
+         * @param option The current option being processed
+         * @returns Label of the current option
+         */
+        displayLabel?: OptionProp<T | P["results"][number]>;
+        /**
+         * Update model with the value of the selected option instead of the whole option
+         */
+        emitValue?: boolean;
+        /**
+         * Debounce the search input update with an amount of milliseconds
+         * Default value: 500
+         */
+        debounce?: number | string;
+        /**
+         * Input placeholder text
+         */
+        placeholder?: string;
+        /**
+         * Input tooltip information
+         */
+        tooltip?: string;
+        /**
+         * Input required state
+         */
+        required?: boolean;
+        /**
+         * Input search activation
+         */
+        searchable?: boolean;
     };
-};
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? P[K] & {
-        default: D[K];
-    } : P[K];
-};
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
+    expose(exposed: {}): void;
+    attrs: any;
+    slots: {
+        /**
+         * Custom select control
+         */
+        control: (scope: {
+            toggleHandler: () => void;
+        }) => any;
+        /**
+         * Prepend inner field
+         */
+        "prepend-inner": (props: any) => any;
+        /**
+         * Append to inner field
+         */
+        "append-inner": (props: any) => any;
+        /**
+         * Prepend outer field
+         */
+        prepend: (props: any) => any;
+        /**
+         * Append outer field
+         */
+        append: (props: any) => any;
+        /**
+         * What should the menu display after filtering options and none are left to be displayed
+         * @param scope
+         */
+        "no-option": (props: any) => any;
+        /**
+         * Slot for errors
+         */
+        error: (props: any) => any;
+        /**
+         * Slot for hint text
+         */
+        hint: (props: any) => any;
+        /**
+         * Override default selection slot
+         * @param scope
+         */
+        "selected-item": (scope: {
+            /**
+             * Selection index
+             */
+            index: number;
+            /**
+             * Selected option -- its value is taken from model
+             */
+            opt: T | P["results"][number];
+            /**
+             * Always true -- passed as prop
+             */
+            selected: boolean;
+            /**
+             * Remove selected option located at specific index
+             * @param index Index at which to remove selection
+             */
+            removeAtIndex: (index: number) => void;
+        }) => any;
+        /**
+         * Override default selection slot;
+         */
+        option: (scope: {
+            /**
+             * Option index
+             */
+            index: number;
+            /**
+             * Option -- its value is taken from 'options' prop
+             */
+            opt: T | P["results"][number];
+            /**
+             * Is option selected
+             */
+            selected: boolean;
+            /**
+             * Add/remove option from model
+             * @param opt Option to add to model
+             */
+            toggleOption: (opt: any) => void;
+        }) => any;
+    };
+    emit: {
+        (event: "update:modelValue", inputValue: string | (T | P["results"][number]) | (string | (T | P["results"][number]))[]): void;
+        (event: "search", inputValue: string): void;
+        (event: "close"): void;
+    };
+}, "slots" | "attrs" | "emit">, __VLS_setup?: {
+    props: {
+        /**
+         * Name of select
+         */
+        name?: string;
+        /**
+         * Model of the component; Must be Array if using 'multiple' prop; Use this property with a listener for 'update:modelValue' event OR use v-model directive
+         */
+        modelValue?: any;
+        /**
+         * Try to map labels of model from 'options' Array; If you are using emit-value you will probably need to use map-options to display the label text in the select field rather than the value;
+         * Default value: true
+         */
+        mapOptions?: boolean;
+        /**
+         * Does field have validation errors?
+         */
+        error?: boolean;
+        /**
+         * Validation error message (gets displayed only if 'error' is set to 'true')
+         */
+        errorMessage?: string;
+        /**
+         * Select label
+         */
+        label?: string;
+        /**
+         * Select description (hint) text below input component
+         */
+        hint?: string;
+        /**
+         * Prefix
+         */
+        prefix?: string;
+        /**
+         * Suffix
+         */
+        suffix?: string;
+        /**
+         * Signals the user a process is in progress by displaying a spinner
+         */
+        loading?: boolean;
+        /**
+         * Appends clearable icon when a value is set;
+         * When clicked, model becomes null
+         */
+        clearable?: boolean;
+        /**
+         * Put component in disabled mode
+         */
+        disabled?: boolean;
+        /**
+         * Allow multiple selection; Model must be Array
+         */
+        multiple?: boolean;
+        /**
+         * Available options that the user can select from.
+         * Default value: []
+         */
+        options?: T[] | ((keyword?: string, skip?: number, ids?: string[]) => Promise<P>);
+        /**
+         * Property of option which holds the 'value'
+         * Default value: id
+         * @param option The current option being processed
+         * @returns Value of the current option
+         */
+        optionValue?: OptionProp<T | P["results"][number]>;
+        /**
+         * Property of option which holds the 'label'
+         * Default value: title
+         * @param option The current option being processed
+         * @returns Label of the current option
+         */
+        optionLabel?: OptionProp<T | P["results"][number]>;
+        /**
+         * @requires optionValue
+         * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionValue**
+         *
+         * Property of option which holds the 'value'
+         * Default value: id
+         * @param option The current option being processed
+         * @returns Value of the current option
+         */
+        displayValue?: OptionProp<T | P["results"][number]>;
+        /**
+         * @requires optionLabel
+         * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionLabel**
+         *
+         * Property of option which holds the 'label'
+         * Default value: title
+         * @param option The current option being processed
+         * @returns Label of the current option
+         */
+        displayLabel?: OptionProp<T | P["results"][number]>;
+        /**
+         * Update model with the value of the selected option instead of the whole option
+         */
+        emitValue?: boolean;
+        /**
+         * Debounce the search input update with an amount of milliseconds
+         * Default value: 500
+         */
+        debounce?: number | string;
+        /**
+         * Input placeholder text
+         */
+        placeholder?: string;
+        /**
+         * Input tooltip information
+         */
+        tooltip?: string;
+        /**
+         * Input required state
+         */
+        required?: boolean;
+        /**
+         * Input search activation
+         */
+        searchable?: boolean;
+    };
+    expose(exposed: {}): void;
+    attrs: any;
+    slots: {
+        /**
+         * Custom select control
+         */
+        control: (scope: {
+            toggleHandler: () => void;
+        }) => any;
+        /**
+         * Prepend inner field
+         */
+        "prepend-inner": (props: any) => any;
+        /**
+         * Append to inner field
+         */
+        "append-inner": (props: any) => any;
+        /**
+         * Prepend outer field
+         */
+        prepend: (props: any) => any;
+        /**
+         * Append outer field
+         */
+        append: (props: any) => any;
+        /**
+         * What should the menu display after filtering options and none are left to be displayed
+         * @param scope
+         */
+        "no-option": (props: any) => any;
+        /**
+         * Slot for errors
+         */
+        error: (props: any) => any;
+        /**
+         * Slot for hint text
+         */
+        hint: (props: any) => any;
+        /**
+         * Override default selection slot
+         * @param scope
+         */
+        "selected-item": (scope: {
+            /**
+             * Selection index
+             */
+            index: number;
+            /**
+             * Selected option -- its value is taken from model
+             */
+            opt: T | P["results"][number];
+            /**
+             * Always true -- passed as prop
+             */
+            selected: boolean;
+            /**
+             * Remove selected option located at specific index
+             * @param index Index at which to remove selection
+             */
+            removeAtIndex: (index: number) => void;
+        }) => any;
+        /**
+         * Override default selection slot;
+         */
+        option: (scope: {
+            /**
+             * Option index
+             */
+            index: number;
+            /**
+             * Option -- its value is taken from 'options' prop
+             */
+            opt: T | P["results"][number];
+            /**
+             * Is option selected
+             */
+            selected: boolean;
+            /**
+             * Add/remove option from model
+             * @param opt Option to add to model
+             */
+            toggleOption: (opt: any) => void;
+        }) => any;
+    };
+    emit: {
+        (event: "update:modelValue", inputValue: string | (T | P["results"][number]) | (string | (T | P["results"][number]))[]): void;
+        (event: "search", inputValue: string): void;
+        (event: "close"): void;
+    };
+}) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> & {
+    __ctx?: {
+        props: {
+            /**
+             * Name of select
+             */
+            name?: string;
+            /**
+             * Model of the component; Must be Array if using 'multiple' prop; Use this property with a listener for 'update:modelValue' event OR use v-model directive
+             */
+            modelValue?: any;
+            /**
+             * Try to map labels of model from 'options' Array; If you are using emit-value you will probably need to use map-options to display the label text in the select field rather than the value;
+             * Default value: true
+             */
+            mapOptions?: boolean;
+            /**
+             * Does field have validation errors?
+             */
+            error?: boolean;
+            /**
+             * Validation error message (gets displayed only if 'error' is set to 'true')
+             */
+            errorMessage?: string;
+            /**
+             * Select label
+             */
+            label?: string;
+            /**
+             * Select description (hint) text below input component
+             */
+            hint?: string;
+            /**
+             * Prefix
+             */
+            prefix?: string;
+            /**
+             * Suffix
+             */
+            suffix?: string;
+            /**
+             * Signals the user a process is in progress by displaying a spinner
+             */
+            loading?: boolean;
+            /**
+             * Appends clearable icon when a value is set;
+             * When clicked, model becomes null
+             */
+            clearable?: boolean;
+            /**
+             * Put component in disabled mode
+             */
+            disabled?: boolean;
+            /**
+             * Allow multiple selection; Model must be Array
+             */
+            multiple?: boolean;
+            /**
+             * Available options that the user can select from.
+             * Default value: []
+             */
+            options?: T[] | ((keyword?: string, skip?: number, ids?: string[]) => Promise<P>);
+            /**
+             * Property of option which holds the 'value'
+             * Default value: id
+             * @param option The current option being processed
+             * @returns Value of the current option
+             */
+            optionValue?: OptionProp<T | P["results"][number]>;
+            /**
+             * Property of option which holds the 'label'
+             * Default value: title
+             * @param option The current option being processed
+             * @returns Label of the current option
+             */
+            optionLabel?: OptionProp<T | P["results"][number]>;
+            /**
+             * @requires optionValue
+             * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionValue**
+             *
+             * Property of option which holds the 'value'
+             * Default value: id
+             * @param option The current option being processed
+             * @returns Value of the current option
+             */
+            displayValue?: OptionProp<T | P["results"][number]>;
+            /**
+             * @requires optionLabel
+             * @description Similar to optionValue, but used only for displaying selection result in rare cases. **Can't be used without optionLabel**
+             *
+             * Property of option which holds the 'label'
+             * Default value: title
+             * @param option The current option being processed
+             * @returns Label of the current option
+             */
+            displayLabel?: OptionProp<T | P["results"][number]>;
+            /**
+             * Update model with the value of the selected option instead of the whole option
+             */
+            emitValue?: boolean;
+            /**
+             * Debounce the search input update with an amount of milliseconds
+             * Default value: 500
+             */
+            debounce?: number | string;
+            /**
+             * Input placeholder text
+             */
+            placeholder?: string;
+            /**
+             * Input tooltip information
+             */
+            tooltip?: string;
+            /**
+             * Input required state
+             */
+            required?: boolean;
+            /**
+             * Input search activation
+             */
+            searchable?: boolean;
+        };
+        expose(exposed: {}): void;
+        attrs: any;
+        slots: {
+            /**
+             * Custom select control
+             */
+            control: (scope: {
+                toggleHandler: () => void;
+            }) => any;
+            /**
+             * Prepend inner field
+             */
+            "prepend-inner": (props: any) => any;
+            /**
+             * Append to inner field
+             */
+            "append-inner": (props: any) => any;
+            /**
+             * Prepend outer field
+             */
+            prepend: (props: any) => any;
+            /**
+             * Append outer field
+             */
+            append: (props: any) => any;
+            /**
+             * What should the menu display after filtering options and none are left to be displayed
+             * @param scope
+             */
+            "no-option": (props: any) => any;
+            /**
+             * Slot for errors
+             */
+            error: (props: any) => any;
+            /**
+             * Slot for hint text
+             */
+            hint: (props: any) => any;
+            /**
+             * Override default selection slot
+             * @param scope
+             */
+            "selected-item": (scope: {
+                /**
+                 * Selection index
+                 */
+                index: number;
+                /**
+                 * Selected option -- its value is taken from model
+                 */
+                opt: T | P["results"][number];
+                /**
+                 * Always true -- passed as prop
+                 */
+                selected: boolean;
+                /**
+                 * Remove selected option located at specific index
+                 * @param index Index at which to remove selection
+                 */
+                removeAtIndex: (index: number) => void;
+            }) => any;
+            /**
+             * Override default selection slot;
+             */
+            option: (scope: {
+                /**
+                 * Option index
+                 */
+                index: number;
+                /**
+                 * Option -- its value is taken from 'options' prop
+                 */
+                opt: T | P["results"][number];
+                /**
+                 * Is option selected
+                 */
+                selected: boolean;
+                /**
+                 * Add/remove option from model
+                 * @param opt Option to add to model
+                 */
+                toggleOption: (opt: any) => void;
+            }) => any;
+        };
+        emit: {
+            (event: "update:modelValue", inputValue: string | (T | P["results"][number]) | (string | (T | P["results"][number]))[]): void;
+            (event: "search", inputValue: string): void;
+            (event: "close"): void;
+        };
     };
 };
+export default _default;
 //# sourceMappingURL=vc-select.vue.d.ts.map