bitboss-ui 2.1.113 → 2.1.115

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

@@ -1,381 +1,13 @@
-import { BaseSelectEvents } from '../BaseSelect/BaseSelect.vue';
-import { NestedKeyOf } from '../../types/NestedKeyOf';
-import { HTMLAttributes, InputHTMLAttributes } from 'vue';
-import { IconType } from '../../types/Icon';
-export type BbSelectProps<T> = {
-    /**
-     * Allows typing into the input.
-     */
-    allowWriting?: boolean | 'not-mobile';
-    /**
-     * Name of the icon to be added at the end of the input.
-     */
-    'append:icon'?: IconType;
-    /**
-     * Guides to the browser as to the type of information expected in the field.
-     */
-    autocomplete?: InputHTMLAttributes['autocomplete'];
-    /**
-     * Sets autofocus on page load.
-     */
-    autofocus?: InputHTMLAttributes['autofocus'];
-    /**
-     * Displays a clear button when the input has a value and is being interacted with.
-     */
-    clearable?: boolean;
-    /**
-     * Sets the display model for selected values to a list
-     * of comma separated string. In this mode the user
-     * cannot deselect an option by pressing the close button.
-     */
-    comma?: boolean;
-    /**
-     * Sets the component in a compact mode.
-     */
-    compact?: boolean;
-    /**
-     * Defines an array of dependencies that will trigger actions in the component upon change.
-     */
-    dependencies?: any[];
-    /**
-     * Timeout used to debounce response to changes to dependencies.
-     */
-    depsDebounceTime?: number;
-    /**
-     * Direction of the layout of the component. Can either be a predefined value or a pattern separated by a space like `xx xxxxx`.
-     */
-    direction?: 'horizontal' | 'vertical' | 'auto' | string;
-    /**
-     * Disables the component
-     */
-    disabled?: boolean;
-    /**
-     * If coherence is enforce the input cannot have a modelValue the is incoherent with its current items.
-     *
-     * e.g. You cannot set v-model to a user that is not present in the items passed.
-     *
-     * modelValue will be reset upon incoherence.
-     */
-    enforceCoherence?: boolean;
-    /**
-     * Can be a string or an array of string containing the messages to display.
-     */
-    errors?: string | string[];
-    /**
-     * Defines how the filtering should work.
-     * In any case options are always filtered by the text displayed but
-     * they can also take into account other properties of the
-     * passed elements when this property is a string or an array of string.
-     * E.g. items could be a list of users and you can filter users by email or phone by passing `['email', 'phone']`
-     * You can also pass false to not filter anything or a function for more granular control.
-     *
-     */
-    filterBy?: string | string[] | false | 'not_stashed' | ((value: any, item: T, query: string | null) => boolean) | null;
-    /**
-     * Path to item property for grouping options.
-     */
-    groupBy?: string | ((item: T) => string | number | symbol);
-    /**
-     * Define if the component should be in an error state.
-     * It usually attaches a CSS class for styling purposes.
-     */
-    hasErrors?: boolean;
-    /**
-     * Visually hides the label of the input while maintaining accessibility.
-     */
-    hideLabel?: boolean;
-    /**
-     * Text box to be displayed near the input, usually to indicate instructions.
-     */
-    hint?: string;
-    /**
-     * The identifier of the component.
-     */
-    id?: HTMLAttributes['id'];
-    /**
-     * Used to retrieve items can be an array or a function.
-     */
-    items: T[] | ((query: string, prefill: boolean, modelValue: any) => Promise<T[]>) | ((query: string, prefill: boolean, modelValue: any) => T[]);
-    /**
-     * Height of group headers in the listbox (px). Defaults to 24px (compact) or 32px.
-     * Only applies when `groupBy` is set.
-     */
-    headerHeight?: number;
-    /**
-     * 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;
-    /**
-     * Defines a path that returns a property of the object to use as text or a function that returns a string
-     */
-    itemText?: T extends object ? NestedKeyOf<T> | ((item: T) => string) : ((item: T) => string) | undefined;
-    /**
-     * Defines a path that returns a property of the object to use as value or a function that returns any value
-     */
-    itemValue?: T extends object ? NestedKeyOf<T> | ((item: T) => any) : ((item: T) => any) | undefined;
-    /**
-     * Text content of the label of the element.
-     */
-    label: string;
-    /**
-     * Sets the text alignment of the label.
-     */
-    labelPosition?: 'left' | 'center' | 'right';
-    /**
-     * Sets the component in a loading state, usually triggering some visual styles.
-     */
-    loading?: boolean;
-    /**
-     * String displayed while items are being loaded.
-     */
-    loadingText?: string;
-    /**
-     * Maximum number of selectable items when the multiple flag is set.
-     */
-    max?: number;
-    /**
-     * Maximum number of selectable items when the multiple flag is set.
-     */
-    maxSelectedLabels?: number;
-    /**
-     * Used by v-model. Can be any serializable type.
-     */
-    modelValue: any;
-    /**
-     * Timeout used to debounce response to changes to modelValue.
-     */
-    modelValueDebounceTime?: number;
-    /**
-     * Allows the selection of multiple items.
-     */
-    multiple?: boolean;
-    /**
-     * Defines the name of the input.
-     */
-    name?: InputHTMLAttributes['name'];
-    /**
-     * String displayed when there are no items to display.
-     */
-    noDataText?: string;
-    /**
-     * Keeps the hint displayed.
-     */
-    persistentHint?: boolean;
-    /**
-     * String displayed when there's no data.
-     */
-    placeholder?: InputHTMLAttributes['placeholder'];
-    /**
-     * Defines the prefill strategy for the input. By default the input will prefill
-     * on focus. It can also always prefill with `true` and only prefill on search with `false`.
-     */
-    prefill?: boolean | 'focus';
-    /**
-     * Name of the icon to be added at the start of the input.
-     */
-    'prepend:icon'?: IconType;
-    /**
-     * Sets the input as required.
-     */
-    required?: boolean;
-    /**
-     * Time to wait when the users stops writing in the input before querying data.
-     * Especially useful when searching live data on big datasets.
-     */
-    queryDebounceTime?: number;
-    /**
-     * Sets the input in a readonly state.
-     */
-    readonly?: boolean;
-    /**
-     * Reverses the layout. Applicable in every direction the order of the label and the input is swapped.
-     */
-    reverse?: boolean;
-    /**
-     * Function that returns a string to be displayed when the number of selected labels is greater than maxSelectedLabels.
-     * @param count - Number of selected labels.
-     */
-    selectedLabelsFn?: (count: number) => string;
-    /**
-     * If true, the chevron will be shown.
-     */
-    showChevron?: boolean;
-    /**
-     * Adds a stash to accumulate selected values. Especially
-     * useful when searching in a big database of items.
-     * E.g. if you search for "John" and then search for "Richard"
-     * you either always return the previous items or you stash them passing `true` to this option.
-     */
-    stash?: boolean;
-    /**
-     * How long the transition has to last in milliseconds
-     */
-    transitionDuration?: number;
-    /**
-     * Pass `true` if the dropdown is not updating following movement in the UI, like in modals. Very expensive so use with care.
-     */
-    updateOnAnimationFrame?: boolean;
-};
-export type BbSelectEvents = BaseSelectEvents;
-export type BbSelectSlots<T> = {
-    /**
-     * Content appended inside the input field, after the value area.
-     * @param query - The current search query string.
-     * @param focus - Focuses the internal input element.
-     */
-    append?: (props: {
-        query: string;
-        focus: () => void;
-    }) => any;
-    /**
-     * Content appended outside the input field wrapper.
-     * @param query - The current search query string.
-     */
-    'append-outer'?: (props: {
-        query: string;
-    }) => any;
-    /**
-     * Replaces the default dropdown chevron icon.
-     * @param loading - Whether options are currently being fetched.
-     * @param shown - Whether the options dropdown is open.
-     */
-    chevron?: (props: {
-        loading: boolean;
-        shown: boolean;
-    }) => any;
-    /**
-     * Replaces the default label text rendered above the input.
-     * @param text - The `label` prop value.
-     * @param hasErrors - Whether the input is in an error state.
-     */
-    label?: (props: {
-        text: string;
-        hasErrors: boolean;
-    }) => any;
-    /**
-     * Content shown inside the options dropdown while items are loading.
-     * @param query - The current search query string.
-     */
-    loading?: (props: {
-        query: string;
-    }) => any;
-    /**
-     * Content shown when no options match the query or the list is empty.
-     * @param query - The current search query string.
-     * @param focus - Focuses the internal input element.
-     */
-    'no-data'?: (props: {
-        query: string;
-        focus: () => void;
-    }) => any;
-    /**
-     * Replaces the default rendering of each option row in the dropdown.
-     * @param disabled - Whether this option is disabled.
-     * @param focused - Whether this option currently has keyboard focus.
-     * @param index - 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 items are still being fetched.
-     * @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: T;
-        loading: boolean;
-        selected: boolean;
-        text: string;
-        value: any;
-    }) => any;
-    /**
-     * Replaces the default group header rendered above grouped options.
-     * @param text - The display text for this group.
-     * @param item - The raw group item.
-     * @param index - Zero-based index of the first option in this group.
-     * @param length - Number of options in this group.
-     * @param disabled - Whether all options in this group are disabled.
-     */
-    group?: (props: {
-        text: string;
-        item: T;
-        index: number;
-        length: number;
-        disabled: boolean;
-    }) => any;
-    /**
-     * Content appended inside the options list, after the last option.
-     * @param focus - Focuses the internal input element.
-     */
-    'options:append'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Content appended outside the options list container.
-     * @param focus - Focuses the internal input element.
-     */
-    'options:append:outer'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Content prepended inside the options list, before the first option.
-     * @param focus - Focuses the internal input element.
-     */
-    'options:prepend'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Content prepended outside the options list container.
-     * @param focus - Focuses the internal input element.
-     */
-    'options:prepend:outer'?: (props: {
-        focus: () => void;
-    }) => any;
-    /**
-     * Content rendered as an inline prefix inside the input field.
-     */
-    prefix?: (props: object) => any;
-    /**
-     * Content prepended inside the input field, before the value area.
-     * @param query - The current search query string.
-     * @param focus - Focuses the internal input element.
-     */
-    prepend?: (props: {
-        query: string;
-        focus: () => void;
-    }) => any;
-    /**
-     * Content prepended outside the input field wrapper.
-     * @param query - The current search query string.
-     */
-    'prepend-outer'?: (props: {
-        query: string;
-    }) => any;
-    /**
-     * Content rendered as an inline suffix inside the input field.
-     */
-    suffix?: (props: object) => any;
-};
 declare const _default: <T = 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 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"> & BbSelectProps<T> & Partial<{}>> & import('vue').PublicProps;
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<({
+        readonly [x: `on${Capitalize<string>}`]: ((...args: unknown[] & []) => any) | undefined;
+    } | {
+        readonly [x: `on${Capitalize<any>}`]: ((...args: any) => any) | undefined;
+    }) & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, `on${Capitalize<string>}` & `on${Capitalize<any>}`> & BbSelectProps<T> & Partial<{}>> & import('vue').PublicProps;
     expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
     attrs: any;
-    slots: Readonly<BbSelectSlots<T>> & BbSelectSlots<T>;
-    emit: BaseSelectEvents;
+    slots: any;
+    emit: any;
 }>) => import('vue').VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };