bitboss-ui 2.1.113 → 2.1.115

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

@@ -1,330 +1,13 @@
-import { BaseCheckboxGroupEvents } from '../BaseCheckboxGroup/types';
-import { HTMLAttributes, InputHTMLAttributes } from 'vue';
-import { NestedKeyOf } from '../../types/NestedKeyOf';
-import { BaseCheckboxIconSlotProps } from '../BaseCheckbox/types';
-export type BbCheckboxGroupProps<T> = {
-    /**
-     * Sets autofocus on page load.
-     */
-    autofocus?: InputHTMLAttributes['autofocus'];
-    /**
-     * Define a color for the component.
-     *
-     * Either a custom color or a coded color in common HEX, RGB, etc... format.
-     */
-    color?: string;
-    /**
-     * Displays the component in a compact version.
-     */
-    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[];
-    /**
-     * 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;
-    /**
-     * Visually hides the legend of the fieldset while maintaining accessibility.
-     */
-    hideLegend?: boolean;
-    /**
-     * Text box to be displayed near the input, usually to indicate instructions.
-     */
-    hint?: string;
-    /**
-     * The identifier of the component.
-     */
-    id?: HTMLAttributes['id'];
-    /**
-     * Defines the direction of the inputs in the fieldset
-     */
-    inputDirection?: 'horizontal' | 'vertical';
-    /**
-     * Sets the slignment of the input. Since inputs are inline block they can be aligned just as text can.
-     */
-    inputPosition?: 'left' | 'center' | 'right';
-    /**
-     * Used to retrieve items can be an array or a function.
-     */
-    items: T[] | ((prefill: boolean, modelValue?: any[]) => Promise<T[]>) | ((prefill: boolean, modelValue?: any[]) => T[]);
-    /**
-     * 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) => string) : ((item: T) => any) | undefined;
-    /**
-     * Sets the text alignment of the label.
-     */
-    labelPosition?: 'left' | 'center' | 'right';
-    /**
-     * Text content of the legend.
-     */
-    legend: string;
-    /**
-     * String displayed while items are being loaded.
-     */
-    loadingText?: string;
-    /**
-     * Maximum number of selected items.
-     */
-    max?: number;
-    /**
-     * Used by v-model. Can be an array of any serializable type.
-     */
-    modelValue: any[];
-    /**
-     * Timeout used to debounce response to changes to modelValue.
-     */
-    modelValueDebounceTime?: number;
-    /**
-     * 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;
-    /**
-     * 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;
-};
-export type BbCheckboxGroupEvents = BaseCheckboxGroupEvents;
 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 onKeydown?: ((event: KeyboardEvent) => 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 onMousedown?: ((event: MouseEvent) => any) | undefined;
-        readonly onMouseup?: ((event: MouseEvent) => any) | undefined;
-        readonly onInactive?: (() => any) | undefined;
-    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onFocus" | "onBlur" | "onChange" | "onInput" | "onKeydown" | "onClick" | "onMousedown" | "onMouseup" | "onUpdate:modelValue" | "onInactive"> & BbCheckboxGroupProps<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>}`> & BbCheckboxGroupProps<T> & Partial<{}>> & import('vue').PublicProps;
     expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
     attrs: any;
-    slots: Readonly<{
-        /**
-         * Content rendered before the first option, inside the options container.
-         */
-        prepend?: (props: object) => any;
-        /**
-         * Content shown while options are loading (replaces the default loading text).
-         */
-        loading?: (props: object) => any;
-        /**
-         * Content shown when no options are available (replaces the default "no data" text).
-         */
-        'no-data'?: (props: object) => any;
-        /**
-         * Content rendered before each option's checkbox.
-         * @param checked - Whether this option is currently checked.
-         * @param disabled - Whether this option is disabled.
-         * @param id - The `id` of this option's input, if set.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The display text for this option.
-         */
-        'option:prepend'?: (props: {
-            checked: boolean;
-            disabled: boolean;
-            id?: string;
-            item: T;
-            text: string;
-        }) => any;
-        /**
-         * Replaces the default checkmark icon for each checkbox option.
-         * @param checked - Whether this option is currently checked.
-         * @param disabled - Whether this option is disabled.
-         * @param falseValue - The unchecked value for this option.
-         * @param focused - Whether this option's input currently has focus.
-         * @param focusVisible - Whether focus is keyboard-visible (`:focus-visible`).
-         * @param hasErrors - Whether the group is in an error state.
-         * @param id - The `id` of this option's input.
-         * @param name - The `name` of this option's input.
-         * @param parsedValue - The `trueValue` serialized for form submission.
-         * @param readonly - Whether this option is read-only.
-         * @param trueValue - The checked value for this option.
-         * @param value - The current effective value for this option.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The display text resolved for this option.
-         */
-        icon?: (props: BaseCheckboxIconSlotProps & {
-            item: T;
-            text: string;
-        }) => any;
-        /**
-         * Replaces the default label text for each option.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The resolved display text for this option.
-         * @param checked - Whether this option is currently checked.
-         */
-        label?: (props: {
-            item: T;
-            text: string;
-            checked: boolean;
-        }) => any;
-        /**
-         * Content rendered after each option's checkbox and label.
-         * @param checked - Whether this option is currently checked.
-         * @param disabled - Whether this option is disabled.
-         * @param id - The `id` of this option's input, if set.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The display text for this option.
-         */
-        'option:append'?: (props: {
-            checked: boolean;
-            disabled: boolean;
-            id?: string;
-            item: T;
-            text: string;
-        }) => any;
-        /**
-         * Content rendered after the last option, inside the options container.
-         */
-        append?: (props: object) => any;
-        /**
-         * Replaces the default fieldset legend text for the group.
-         * @param text - The `legend` prop value.
-         * @param hasErrors - Whether the group is in an error state.
-         */
-        legend?: (props: {
-            text: string;
-            hasErrors: boolean;
-        }) => any;
-    }> & {
-        /**
-         * Content rendered before the first option, inside the options container.
-         */
-        prepend?: (props: object) => any;
-        /**
-         * Content shown while options are loading (replaces the default loading text).
-         */
-        loading?: (props: object) => any;
-        /**
-         * Content shown when no options are available (replaces the default "no data" text).
-         */
-        'no-data'?: (props: object) => any;
-        /**
-         * Content rendered before each option's checkbox.
-         * @param checked - Whether this option is currently checked.
-         * @param disabled - Whether this option is disabled.
-         * @param id - The `id` of this option's input, if set.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The display text for this option.
-         */
-        'option:prepend'?: (props: {
-            checked: boolean;
-            disabled: boolean;
-            id?: string;
-            item: T;
-            text: string;
-        }) => any;
-        /**
-         * Replaces the default checkmark icon for each checkbox option.
-         * @param checked - Whether this option is currently checked.
-         * @param disabled - Whether this option is disabled.
-         * @param falseValue - The unchecked value for this option.
-         * @param focused - Whether this option's input currently has focus.
-         * @param focusVisible - Whether focus is keyboard-visible (`:focus-visible`).
-         * @param hasErrors - Whether the group is in an error state.
-         * @param id - The `id` of this option's input.
-         * @param name - The `name` of this option's input.
-         * @param parsedValue - The `trueValue` serialized for form submission.
-         * @param readonly - Whether this option is read-only.
-         * @param trueValue - The checked value for this option.
-         * @param value - The current effective value for this option.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The display text resolved for this option.
-         */
-        icon?: (props: BaseCheckboxIconSlotProps & {
-            item: T;
-            text: string;
-        }) => any;
-        /**
-         * Replaces the default label text for each option.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The resolved display text for this option.
-         * @param checked - Whether this option is currently checked.
-         */
-        label?: (props: {
-            item: T;
-            text: string;
-            checked: boolean;
-        }) => any;
-        /**
-         * Content rendered after each option's checkbox and label.
-         * @param checked - Whether this option is currently checked.
-         * @param disabled - Whether this option is disabled.
-         * @param id - The `id` of this option's input, if set.
-         * @param item - The raw item from the `items` prop.
-         * @param text - The display text for this option.
-         */
-        'option:append'?: (props: {
-            checked: boolean;
-            disabled: boolean;
-            id?: string;
-            item: T;
-            text: string;
-        }) => any;
-        /**
-         * Content rendered after the last option, inside the options container.
-         */
-        append?: (props: object) => any;
-        /**
-         * Replaces the default fieldset legend text for the group.
-         * @param text - The `legend` prop value.
-         * @param hasErrors - Whether the group is in an error state.
-         */
-        legend?: (props: {
-            text: string;
-            hasErrors: boolean;
-        }) => any;
-    };
-    emit: BaseCheckboxGroupEvents;
+    slots: any;
+    emit: any;
 }>) => import('vue').VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };

package/dist/components/BbCheckboxGroup/types.d.ts

@@ -0,0 +1,189 @@
+import { HTMLAttributes, InputHTMLAttributes } from 'vue';
+import { NestedKeyOf } from '../../types/NestedKeyOf';
+import { BaseCheckboxGroupEvents, BaseCheckboxGroupIconSlotProps, BaseCheckboxGroupLabelSlotProps, BaseCheckboxGroupOptionAffixSlotProps } from '../BaseCheckboxGroup/types';
+export type BbCheckboxGroupProps<T> = {
+    /**
+     * Sets autofocus on page load.
+     */
+    autofocus?: InputHTMLAttributes['autofocus'];
+    /**
+     * Define a color for the component.
+     *
+     * Either a custom color or a coded color in common HEX, RGB, etc... format.
+     */
+    color?: string;
+    /**
+     * Displays the component in a compact version.
+     */
+    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 enforced the input cannot have a modelValue that 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[];
+    /**
+     * 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;
+    /**
+     * Visually hides the legend of the fieldset while maintaining accessibility.
+     */
+    hideLegend?: boolean;
+    /**
+     * Text box to be displayed near the input, usually to indicate instructions.
+     */
+    hint?: string;
+    /**
+     * The identifier of the component.
+     */
+    id?: HTMLAttributes['id'];
+    /**
+     * Defines the direction of the inputs in the fieldset.
+     */
+    inputDirection?: 'horizontal' | 'vertical';
+    /**
+     * Sets the alignment of the input. Since inputs are inline block they can be aligned just as text can.
+     *
+     * @defaultValue `'left'`
+     */
+    inputPosition?: 'left' | 'center' | 'right';
+    /**
+     * Used to retrieve items; can be an array or a function.
+     */
+    items: T[] | ((prefill: boolean, modelValue?: any) => Promise<T[]>) | ((prefill: boolean, modelValue?: any) => T[]);
+    /**
+     * 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) => string) : ((item: T) => any) | undefined;
+    /**
+     * Sets the text alignment of the label.
+     */
+    labelPosition?: 'left' | 'center' | 'right';
+    /**
+     * Text content of the legend.
+     */
+    legend: string;
+    /**
+     * String displayed while items are being loaded.
+     */
+    loadingText?: string;
+    /**
+     * Maximum number of selected items.
+     */
+    max?: number;
+    /**
+     * Used by v-model. Can be an array of any serializable type.
+     */
+    modelValue: any;
+    /**
+     * Enables multi-selection behavior.
+     * When true, `modelValue` must be an array.
+     * When false, `modelValue` should be a single value.
+     *
+     * @defaultValue `true`
+     */
+    multiple?: boolean;
+    /**
+     * Timeout used to debounce response to changes to modelValue.
+     */
+    modelValueDebounceTime?: number;
+    /**
+     * 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;
+    /**
+     * 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;
+};
+/** Re-export for consumers importing events type from BbCheckboxGroup. */
+export type BbCheckboxGroupEvents = BaseCheckboxGroupEvents;
+/** Props exposed by the `legend` slot. */
+export type BbCheckboxGroupLegendSlotProps = {
+    /** The `legend` prop value. */
+    text: string;
+    /** Whether the group is in an error state. */
+    hasErrors: boolean;
+};
+export type BbCheckboxGroupSlots<T> = {
+    /**
+     * Content rendered before the first option, inside the options container.
+     */
+    prepend?: (props: object) => any;
+    /**
+     * Content shown while options are loading (replaces the default loading text).
+     */
+    loading?: (props: object) => any;
+    /**
+     * Content shown when no options are available (replaces the default "no data" text).
+     */
+    'no-data'?: (props: object) => any;
+    /**
+     * Content rendered before each option's checkbox.
+     */
+    'option:prepend'?: (props: BaseCheckboxGroupOptionAffixSlotProps<T>) => any;
+    /**
+     * Replaces the default checkmark icon for each checkbox option.
+     */
+    icon?: (props: BaseCheckboxGroupIconSlotProps<T>) => any;
+    /**
+     * Replaces the default label text for each option.
+     */
+    label?: (props: BaseCheckboxGroupLabelSlotProps<T>) => any;
+    /**
+     * Content rendered after each option's checkbox and label.
+     */
+    'option:append'?: (props: BaseCheckboxGroupOptionAffixSlotProps<T>) => any;
+    /**
+     * Content rendered after the last option, inside the options container.
+     */
+    append?: (props: object) => any;
+    /**
+     * Replaces the default fieldset legend text for the group.
+     */
+    legend?: (props: BbCheckboxGroupLegendSlotProps) => any;
+};

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

@@ -1,38 +1,16 @@
-import { CommonProps } from '../../types/CommonProps';
-export type BbChipProps = Pick<CommonProps, 'text'> & {
-    /**
-     * Renders a button with a close icon. Used to indicate the possibility of deleting the item.
-     */
-    clearable?: boolean;
-    /**
-     * The label the clearing button must have
-     */
-    clearableLabel?: string;
-};
-export type BbChipEvents = {
-    (e: 'click:clear', event: MouseEvent): void;
-};
+import { BbChipProps, BbChipEvents, BbChipSlots } from './types';
+export type { BbChipProps, BbChipEvents, BbChipSlots };
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: Readonly<{
-        /**
-         * The chip's label content. Rendered inside the chip alongside the optional clear button.
-         */
-        default?: (props: object) => any;
-    }> & {
-        /**
-         * The chip's label content. Rendered inside the chip alongside the optional clear button.
-         */
-        default?: (props: object) => any;
-    };
+    slots: Readonly<BbChipSlots> & BbChipSlots;
     refs: {};
     rootEl: HTMLSpanElement;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<BbChipProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-    "click:clear": (...args: any[]) => void;
+declare const __VLS_component: import('vue').DefineComponent<BbChipProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    "click:clear": (event: MouseEvent) => any;
 }, string, import('vue').PublicProps, Readonly<BbChipProps> & Readonly<{
-    "onClick:clear"?: ((...args: any[]) => any) | undefined;
+    "onClick:clear"?: ((event: MouseEvent) => any) | undefined;
 }>, {
     clearable: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLSpanElement>;

package/dist/components/BbChip/types.d.ts

@@ -0,0 +1,23 @@
+import { CommonProps } from '../../types/CommonProps';
+export type BbChipProps = Pick<CommonProps, 'text'> & {
+    /**
+     * Renders a button with a close icon. Used to indicate the possibility of deleting the item.
+     *
+     * @defaultValue `true`
+     */
+    clearable?: boolean;
+    /**
+     * The label the clearing button must have.
+     */
+    clearableLabel?: string;
+};
+export type BbChipEvents = {
+    /** Emitted when the clear button is clicked. Forwards the original DOM `MouseEvent`. */
+    (e: 'click:clear', event: MouseEvent): void;
+};
+export type BbChipSlots = {
+    /**
+     * The chip's label content. Rendered inside the chip alongside the optional clear button.
+     */
+    default?: (props: object) => any;
+};

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

@@ -1,29 +1,8 @@
-import { CommonProps } from '../../types/CommonProps';
-export type BbCollapsibleProps = Pick<CommonProps, 'eager' | 'transitionDuration'> & {
-    /**
-     * Used by v-model to trigger opening / closing the collapsible
-     */
-    modelValue: boolean;
-    /**
-     * Any HTML tag corresponding to a non-void HTMl element.
-     */
-    tag?: string;
-};
+import { BbCollapsibleProps, BbCollapsibleSlots } from './types';
+export type { BbCollapsibleProps, BbCollapsibleSlots };
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: Readonly<{
-        /**
-         * The collapsible body content that is shown or hidden based on `modelValue`.
-         * When `eager` is false, the content is not rendered until the first open.
-         */
-        default?: (props: object) => any;
-    }> & {
-        /**
-         * The collapsible body content that is shown or hidden based on `modelValue`.
-         * When `eager` is false, the content is not rendered until the first open.
-         */
-        default?: (props: object) => any;
-    };
+    slots: Readonly<BbCollapsibleSlots> & BbCollapsibleSlots;
     refs: {};
     rootEl: any;
 };

package/dist/components/BbCollapsible/types.d.ts

@@ -0,0 +1,20 @@
+import { CommonProps } from '../../types/CommonProps';
+export type BbCollapsibleProps = Pick<CommonProps, 'eager' | 'transitionDuration'> & {
+    /**
+     * Used by v-model to trigger opening / closing the collapsible.
+     */
+    modelValue: boolean;
+    /**
+     * Any HTML tag corresponding to a non-void HTML element.
+     *
+     * @defaultValue `'div'`
+     */
+    tag?: string;
+};
+export type BbCollapsibleSlots = {
+    /**
+     * The collapsible body content that is shown or hidden based on `modelValue`.
+     * When `eager` is false, the content is not rendered until the first open.
+     */
+    default?: (props: object) => any;
+};