bitboss-ui 2.1.113 → 2.1.115

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

@@ -1,373 +1,12 @@
-import { IconType } from '../../types/Icon';
-import { HTMLAttributes, InputHTMLAttributes } from 'vue';
-export type BaseSelectProps<Item> = {
-    /**
-     * Controls whether manual typing is allowed in the input field.
-     * Use `'not-mobile'` to disable typing on mobile while keeping it on desktop.
-     * @default true
-     */
-    allowWriting?: boolean | 'not-mobile';
-    /**
-     * Name of the icon to render at the right hand side of the input.
-     */
-    'append:icon'?: IconType;
-    /**
-     * Id(s) of elements describing this select for assistive technologies.
-     */
-    ariaDescribedby?: InputHTMLAttributes['aria-describedby'];
-    /**
-     * Browser autocomplete hint for the input field.
-     * @default 'off'
-     */
-    autocomplete?: InputHTMLAttributes['autocomplete'];
-    /**
-     * Focus the input automatically on mount.
-     */
-    autofocus?: InputHTMLAttributes['autofocus'];
-    /**
-     * Show a clear button whenever a value is present and the control is interactive.
-     */
-    clearable?: boolean;
-    /**
-     * Display selected values as a comma-separated string instead of individual chips.
-     * When enabled, options cannot be deselected by clicking individual chips.
-     */
-    comma?: boolean;
-    /**
-     * Apply the compact density variant.
-     */
-    compact?: boolean;
-    /**
-     * Additional dependencies that trigger item reloading when changed.
-     * @default []
-     */
-    dependencies?: any[];
-    /**
-     * Debounce delay (ms) for dependency-triggered reloads.
-     * @default 0
-     */
-    depsDebounceTime?: number;
-    /**
-     * Disables the component
-     */
-    disabled?: boolean;
-    /**
-     * Reset modelValue to `null` or empty array if it no longer matches available items (enforces coherence).
-     * For example, prevents setting v-model to a user not present in the items array.
-     */
-    enforceCoherence?: boolean;
-    /**
-     * Controls how options are filtered during search.
-     * Options are always filtered by display text, but can also match additional properties
-     * when set to a string path, array of paths, or custom function.
-     * Set to `false` to disable filtering, or `'not_stashed'` to exclude stashed items.
-     * @default () => []
-     */
-    filterBy?: string | string[] | false | 'not_stashed' | ((value: any, item: any, query: string | null) => boolean) | null;
-    groupBy?: string | ((item: Item) => string | number | symbol);
-    /**
-     * Height of group headers in the listbox (px). Defaults to 24px (compact) or 32px.
-     * Only applies when `groupBy` is set.
-     */
-    headerHeight?: number;
-    /**
-     * Apply error styling to the select.
-     */
-    hasErrors?: boolean;
-    /**
-     * Explicit id for the input element. Used to generate ids for listbox and options.
-     */
-    id?: HTMLAttributes['id'];
-    /**
-     * Array of items or function to load them asynchronously.
-     * Functions receive `(query, prefill, modelValue)` and can return a promise.
-     * Please check out {@link https://ui-components-docs.vercel.app/it/guides/fetch-data | the docs} for more information.
-     * @default []
-     */
-    items: Item[] | ((query: string, prefill: boolean, modelValue: any[]) => Promise<Item[]>) | ((query: string, prefill: boolean, modelValue: any[]) => Item[]);
-    /**
-     * Height of the options in the listbox. By default it will be 32px for the
-     * compact variant and 40px for the regular variant.
-     * If you want to set a custom height you can pass a number in pixels.
-     * Existence of this value is necessary for the options to be virtualized.
-     * @default 40
-     */
-    itemHeight?: number;
-    /**
-     * Path to item property for display text or function to extract it.
-     */
-    itemText?: string | ((item: Item) => string) | undefined;
-    /**
-     * Defines a path that returns a property of the object to use as value or a function that returns any value
-     */
-    itemValue?: string | ((item: Item) => string) | undefined;
-    /**
-     * Display the loading state styles.
-     */
-    loading?: boolean;
-    /**
-     * Message shown while items are being loaded.
-     */
-    loadingText?: string;
-    /**
-     * Maximum number of selectable items (limits selection when `multiple` is true).
-     * @default Infinity
-     */
-    max?: number;
-    /**
-     * Maximum number of selected items to show as individual labels before collapsing.
-     * @default Infinity
-     */
-    maxSelectedLabels?: number;
-    /**
-     * v-model value. Single value for single select, array for multiple select.
-     */
-    modelValue: any;
-    /**
-     * Debounce delay (ms) for modelValue change handling.
-     * @default 0
-     */
-    modelValueDebounceTime?: number;
-    /**
-     * Enable multiple item selection. When true, modelValue must be an array.
-     */
-    multiple?: boolean;
-    /**
-     * Name attribute forwarded to the input element.
-     */
-    name?: InputHTMLAttributes['name'];
-    /**
-     * Message displayed when no items are available.
-     */
-    noDataText?: string;
-    /**
-     * Placeholder text when no value is selected.
-     */
-    placeholder?: InputHTMLAttributes['placeholder'];
-    /**
-     * Controls when items are pre-loaded.
-     * `'focus'` loads on first focus, `true` loads immediately, `false` loads only on search.
-     * @default 'focus'
-     */
-    prefill?: boolean | 'focus';
-    /**
-     * Name of the icon to render at the left hand side of the input.
-     */
-    'prepend:icon'?: IconType;
-    /**
-     * Debounce delay (ms) before triggering search queries after user input stops.
-     * Useful for performance with large remote datasets.
-     * @default 500
-     */
-    queryDebounceTime?: number;
-    /**
-     * Make the input read-only while keeping the dropdown accessible.
-     */
-    readonly?: boolean;
-    /**
-     * Mark the input as required for form validation.
-     */
-    required?: boolean;
-    /**
-     * Show the dropdown chevron icon.
-     * @default true
-     */
-    showChevron?: boolean;
-    /**
-     * Accumulate selected items across searches instead of replacing them.
-     * Useful when searching large databases where selections should persist.
-     */
-    stash?: boolean;
-    /**
-     * Function to generate a summary label when selected items exceed `maxSelectedLabels`.
-     * Receives the total count and returns display text.
-     */
-    selectedLabelsFn?: (count: number) => string;
-    /**
-     * Transition duration (ms) for dropdown show/hide animations.
-     * @default 300
-     */
-    transitionDuration?: number;
-    /**
-     * Force dropdown repositioning on every animation frame (expensive, use sparingly).
-     * @default false
-     */
-    updateOnAnimationFrame?: boolean;
-};
-export type BaseSelectEvents = {
-    (e: 'blur', event: FocusEvent): void;
-    (e: 'change', event: Event): void;
-    (e: 'click', event: MouseEvent): void;
-    (e: 'focus', event: FocusEvent): void;
-    (e: 'inactive'): void;
-    (e: 'input', event: Event): void;
-    (e: 'update:modelValue', value: any): void;
-    (e: 'option:add', text: string): void;
-};
-export type BaseSelectSlots<Item> = {
-    /**
-     * Content rendered after the input area, at the end of the inner container.
-     * @param query - The current text typed in the search input.
-     * @param focus - Focuses the search input.
-     */
-    append?: (props: {
-        query: string;
-        focus: () => void;
-    }) => any;
-    /**
-     * Content rendered after the entire select control, outside the input chrome.
-     * @param query - The current text typed in the search input.
-     */
-    'append-outer'?: (props: {
-        query: string;
-    }) => any;
-    /**
-     * Replaces the default dropdown chevron/arrow icon.
-     * @param loading - Whether the component is currently loading options.
-     * @param shown - Whether the dropdown panel is currently open.
-     */
-    chevron?: (props: {
-        loading: boolean;
-        shown: boolean;
-    }) => any;
-    /**
-     * Replaces the chip rendered for each selected item when `multiple` is true.
-     * @param disabled - Whether this chip's remove action is disabled.
-     * @param hasErrors - Whether the select is in an error state.
-     * @param index - The zero-based index of this chip among the selected items.
-     * @param item - The raw selected item from the `items` prop.
-     * @param loading - Whether the component is currently loading.
-     * @param manual - Whether the item was added manually (typed by the user).
-     * @param selected - Whether this chip is in a selected state.
-     * @param text - The resolved display text for this selected item.
-     * @param value - The resolved value for this selected item.
-     */
-    chip?: (props: {
-        disabled: boolean | undefined;
-        hasErrors?: boolean;
-        index: number;
-        item: any;
-        loading: boolean;
-        manual: boolean;
-        selected: boolean | undefined;
-        text: string;
-        value: any;
-    }) => any;
-    /**
-     * Replaces the default loading indicator rendered inside the dropdown while options are fetching.
-     * @param query - The current text typed in the search input.
-     */
-    loading?: (props: {
-        query: string;
-    }) => any;
-    /**
-     * Replaces the default "no data" message rendered inside the dropdown when no options match.
-     * @param query - The current text typed in the search input.
-     * @param focus - Focuses the search input.
-     */
-    'no-data'?: (props: {
-        query: string;
-        focus: () => void;
-    }) => any;
-    /**
-     * Replaces the default option row rendered for each item in the dropdown list.
-     * @param disabled - Whether this option is disabled.
-     * @param focused - Whether this option is currently keyboard-focused.
-     * @param index - The zero-based index of this option in the list.
-     * @param hasErrors - Whether the select is in an error state.
-     * @param item - The raw item from the `items` prop.
-     * @param loading - Whether the component is currently loading.
-     * @param selected - Whether this option is currently selected.
-     * @param text - The resolved display text for this option.
-     * @param value - The resolved value for this option.
-     */
-    option?: (props: {
-        disabled: boolean;
-        focused: boolean;
-        index: number;
-        hasErrors?: boolean;
-        item: Item;
-        loading: boolean;
-        selected: boolean;
-        text: string;
-        value: any;
-    }) => any;
-    /**
-     * Replaces the default group header row rendered above options that belong to a group.
-     * @param text - The display text for this group.
-     * @param item - The raw group item from the `items` prop.
-     * @param index - The zero-based index of this group in the list.
-     * @param length - The number of options in this group.
-     * @param disabled - Whether this group is disabled.
-     */
-    group?: (props: {
-        text: string;
-        item: Item;
-        index: number;
-        length: number;
-        disabled: boolean;
-    }) => any;
-    /**
-     * Content rendered after the option list, inside the dropdown panel.
-     * @param focus - Focuses the search input.
-     */
-    'options:append'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Content rendered after the dropdown panel, outside the scrollable options area.
-     * @param focus - Focuses the search input.
-     */
-    'options:append:outer'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Content rendered before the option list, inside the dropdown panel.
-     * @param focus - Focuses the search input.
-     */
-    'options:prepend'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Content rendered before the dropdown panel, outside the scrollable options area.
-     * @param focus - Focuses the search input.
-     */
-    'options:prepend:outer'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Inline content rendered at the start of the input field area, before the selected value text.
-     */
-    prefix?: (props: object) => any;
-    /**
-     * Content rendered before the input area, at the start of the inner container.
-     * @param query - The current text typed in the search input.
-     * @param focus - Focuses the search input.
-     */
-    prepend?: (props: {
-        query: string;
-        focus: () => void;
-    }) => any;
-    /**
-     * Content rendered before the entire select control, outside the input chrome.
-     * @param query - The current text typed in the search input.
-     */
-    'prepend-outer'?: (props: {
-        query: string;
-    }) => any;
-    /**
-     * Inline content rendered at the end of the input field area, after the selected value text.
-     */
-    suffix?: (props: object) => any;
-};
+import { BaseSelectProps, BaseSelectEvents, BaseSelectSlots } from './types';
 declare const _default: <Item = any>(__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 onInput?: ((event: Event) => any) | undefined;
-        readonly "onUpdate:modelValue"?: ((value: any) => any) | undefined;
         readonly onBlur?: ((event: FocusEvent) => any) | undefined;
         readonly onChange?: ((event: Event) => any) | undefined;
         readonly onClick?: ((event: MouseEvent) => any) | undefined;
         readonly onFocus?: ((event: FocusEvent) => any) | undefined;
+        readonly "onUpdate:modelValue"?: ((value: any) => any) | undefined;
         readonly onInactive?: (() => any) | undefined;
         readonly "onOption:add"?: ((text: string) => any) | undefined;
     } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onFocus" | "onBlur" | "onChange" | "onInput" | "onClick" | "onUpdate:modelValue" | "onInactive" | "onOption:add"> & BaseSelectProps<Item> & Partial<{}>> & import('vue').PublicProps;