bitboss-ui 2.1.111 → 2.1.112

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

@@ -8,8 +8,14 @@ export type BbRatioProps = {
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<{
+        /**
+         * Content rendered inside the ratio container, scaled to maintain the configured aspect ratio.
+         */
         default?: (props: object) => any;
     }> & {
+        /**
+         * Content rendered inside the ratio container, scaled to maintain the configured aspect ratio.
+         */
         default?: (props: object) => any;
     };
     refs: {};

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

@@ -6,28 +6,86 @@ declare const _default: <Item = any>(__VLS_props: NonNullable<Awaited<typeof __V
     } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onUpdate:modelValue" | "onUpdate:unselectedItems"> & BbRowsProps<Item> & Partial<{}>> & import('vue').PublicProps;
     expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
     attrs: any;
-    slots: {
-        loading?(_: {
-            items: any[];
-        }): any;
-        'no-data'?(_: {
+    slots: Readonly<{
+        /**
+         * Rendered once per item in `items`. Provides the full state of a single row.
+         * @param checked - Whether this item is currently selected.
+         * @param columns - A map of column key to `{ key, label, value }` for each defined column.
+         * @param disabled - Whether this item is disabled (based on the `selectable` prop).
+         * @param index - The zero-based index of this item in the list.
+         * @param item - The raw item from the `items` prop.
+         * @param select - Selects this item.
+         * @param unselect - Deselects this item.
+         * @param value - The resolved value of this item (from `itemValue`).
+         */
+        default?: (props: {
+            checked: boolean;
+            columns: Record<string, {
+                key: string;
+                label: string;
+                value: any;
+            }>;
+            disabled: boolean;
+            index: number;
+            item: Item;
+            select: () => void;
+            unselect: () => void;
+            value: any;
+        }) => any;
+        /**
+         * Content shown while items are loading (replaces the default loading state).
+         * @param items - The current (possibly stale) list of items, useful to show a skeleton matching the previous count.
+         */
+        loading?: (props: {
+            items: Item[];
+        }) => any;
+        /**
+         * Content shown when the items list is empty and not loading.
+         * @param loading - Whether items are currently being fetched.
+         */
+        'no-data'?: (props: {
             loading: boolean;
-        }): any;
-        default?(_: {
-            key: string;
-            checked: boolean | undefined;
+        }) => any;
+    }> & {
+        /**
+         * Rendered once per item in `items`. Provides the full state of a single row.
+         * @param checked - Whether this item is currently selected.
+         * @param columns - A map of column key to `{ key, label, value }` for each defined column.
+         * @param disabled - Whether this item is disabled (based on the `selectable` prop).
+         * @param index - The zero-based index of this item in the list.
+         * @param item - The raw item from the `items` prop.
+         * @param select - Selects this item.
+         * @param unselect - Deselects this item.
+         * @param value - The resolved value of this item (from `itemValue`).
+         */
+        default?: (props: {
+            checked: boolean;
             columns: Record<string, {
                 key: string;
                 label: string;
                 value: any;
             }>;
-            disabled: boolean | undefined;
+            disabled: boolean;
             index: number;
-            item: any;
+            item: Item;
             select: () => void;
             unselect: () => void;
             value: any;
-        }): any;
+        }) => any;
+        /**
+         * Content shown while items are loading (replaces the default loading state).
+         * @param items - The current (possibly stale) list of items, useful to show a skeleton matching the previous count.
+         */
+        loading?: (props: {
+            items: Item[];
+        }) => any;
+        /**
+         * Content shown when the items list is empty and not loading.
+         * @param loading - Whether items are currently being fetched.
+         */
+        'no-data'?: (props: {
+            loading: boolean;
+        }) => any;
     };
     emit: BbRowsEvents;
 }>) => import('vue').VNode & {

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

@@ -220,28 +220,68 @@ export type BbSelectProps<T> = {
 };
 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;
@@ -253,6 +293,14 @@ export type BbSelectSlots<T> = {
         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;
@@ -260,26 +308,57 @@ export type BbSelectSlots<T> = {
         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<{

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

@@ -202,6 +202,19 @@ export type BbSelectPopoverEvents = {
     (e: 'option:add', text: string): void;
 };
 export type BbSelectPopoverSlots<Item> = {
+    /**
+     * Replaces the default trigger element that opens the select popover.
+     * @param props - Bind these onto the activator element with `v-bind="props"` to wire up the popover reference.
+     * @param shown - Whether the popover is currently open.
+     * @param disabled - Whether the select is disabled.
+     * @param readonly - Whether the select is read-only.
+     * @param loading - Whether options are currently being fetched.
+     * @param query - The current search query string.
+     * @param clear - Clears the current selection and query.
+     * @param open - Opens the popover.
+     * @param close - Closes the popover.
+     * @param toggle - Toggles the popover open/closed.
+     */
     activator?: (props: {
         props: {
             ref: (reference: unknown) => void;
@@ -216,13 +229,33 @@ export type BbSelectPopoverSlots<Item> = {
         close: () => Promise<void>;
         toggle: () => Promise<void>;
     }) => 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 search input.
+     */
     '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 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;
@@ -233,6 +266,14 @@ export type BbSelectPopoverSlots<Item> = {
         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: Item;
@@ -240,15 +281,31 @@ export type BbSelectPopoverSlots<Item> = {
         length: number;
         disabled: boolean;
     }) => any;
+    /**
+     * Content appended inside the options list, after the last option.
+     * @param focus - Focuses the internal search input.
+     */
     'options:append'?: (props: {
         focus: () => void;
     }) => any;
+    /**
+     * Content appended outside the options list container.
+     * @param focus - Focuses the internal search input.
+     */
     'options:append:outer'?: (props: {
         focus: () => void;
     }) => any;
+    /**
+     * Content prepended inside the options list, before the first option.
+     * @param focus - Focuses the internal search input.
+     */
     'options:prepend'?: (props: {
         focus: () => void;
     }) => any;
+    /**
+     * Content prepended outside the options list container.
+     * @param focus - Focuses the internal search input.
+     */
     'options:prepend:outer'?: (props: {
         focus: () => void;
     }) => any;

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

@@ -106,11 +106,21 @@ export type BbSliderEvents = BaseSliderEvents;
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<BaseSliderSlots & {
+        /**
+         * Replaces the default label text rendered above the slider.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the slider is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;
         }) => any;
     }> & BaseSliderSlots & {
+        /**
+         * Replaces the default label text rendered above the slider.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the slider is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;

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

@@ -16,6 +16,9 @@ export type BbSmoothHeightProps = {
     strategy?: 'resize' | 'mutation';
 } & NonVoidElementTag & Pick<CommonProps, 'transitionDuration'>;
 export type BbSmoothHeightSlots = {
+    /**
+     * Content whose height changes are animated with a smooth transition.
+     */
     default?: (props: object) => any;
 };
 declare function __VLS_template(): {

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

@@ -1,23 +1,61 @@
-import { SlotAttributes } from '../BaseCheckbox/BaseCheckbox.vue';
+import { BaseCheckboxIconSlotProps } from '../BaseCheckbox/types';
 import { BbCheckboxEvents, BbCheckboxProps } from '../BbCheckbox/BbCheckbox.vue';
 export type BbSwitchProps = BbCheckboxProps;
 export type BbSwitchEvents = BbCheckboxEvents;
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<{
+        /**
+         * Replaces the default label text rendered next to the switch.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the switch is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * Replaces the default toggle track visual inside the switch. Receives `BaseSwitch` slot attributes plus the label text.
+         * @param checked - Whether the switch is currently on.
+         * @param disabled - Whether the switch is disabled.
+         * @param focused - Whether the input currently has focus.
+         * @param focusVisible - Whether focus is keyboard-visible (`:focus-visible`).
+         * @param hasErrors - Whether the switch is in an error state.
+         * @param id - The `id` attribute of the underlying input.
+         * @param name - The `name` attribute of the underlying input.
+         * @param parsedValue - The switch value serialized for form submission.
+         * @param readonly - Whether the switch is read-only.
+         * @param value - The current effective value of the switch.
+         * @param text - The `label` prop value.
+         */
+        icon?: (props: BaseCheckboxIconSlotProps & {
             text: string;
         }) => any;
     }> & {
+        /**
+         * Replaces the default label text rendered next to the switch.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the switch is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * Replaces the default toggle track visual inside the switch. Receives `BaseSwitch` slot attributes plus the label text.
+         * @param checked - Whether the switch is currently on.
+         * @param disabled - Whether the switch is disabled.
+         * @param focused - Whether the input currently has focus.
+         * @param focusVisible - Whether focus is keyboard-visible (`:focus-visible`).
+         * @param hasErrors - Whether the switch is in an error state.
+         * @param id - The `id` attribute of the underlying input.
+         * @param name - The `name` attribute of the underlying input.
+         * @param parsedValue - The switch value serialized for form submission.
+         * @param readonly - Whether the switch is read-only.
+         * @param value - The current effective value of the switch.
+         * @param text - The `label` prop value.
+         */
+        icon?: (props: BaseCheckboxIconSlotProps & {
             text: string;
         }) => any;
     };

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

@@ -1,4 +1,4 @@
-import { SlotAttributes } from '../BaseCheckbox/BaseCheckbox.vue';
+import { BaseCheckboxIconSlotProps } from '../BaseCheckbox/types';
 import { BbCheckboxGroupEvents, BbCheckboxGroupProps } from '../BbCheckboxGroup/BbCheckboxGroup.vue';
 export type BbSwitchGroupProps<T> = BbCheckboxGroupProps<T>;
 export type BbSwitchGroupEvents = BbCheckboxGroupEvents;
@@ -18,9 +18,26 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
     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 switch.
+         * @param checked - Whether this option is currently selected.
+         * @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;
@@ -28,15 +45,44 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
             item: T;
             text: string;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * Replaces the default switch track visual for each option. Receives all `BaseSwitch` slot attributes plus the source item and its display text.
+         * @param checked - Whether this option is currently selected.
+         * @param disabled - Whether this option is disabled.
+         * @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 option value serialized for form submission.
+         * @param readonly - Whether this option is read-only.
+         * @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 selected.
+         */
         label?: (props: {
             item: T;
             text: string;
             checked: boolean;
         }) => any;
+        /**
+         * Content rendered after each option's switch and label.
+         * @param checked - Whether this option is currently selected.
+         * @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;
@@ -44,15 +90,40 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
             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 switch.
+         * @param checked - Whether this option is currently selected.
+         * @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;
@@ -60,15 +131,44 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
             item: T;
             text: string;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * Replaces the default switch track visual for each option. Receives all `BaseSwitch` slot attributes plus the source item and its display text.
+         * @param checked - Whether this option is currently selected.
+         * @param disabled - Whether this option is disabled.
+         * @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 option value serialized for form submission.
+         * @param readonly - Whether this option is read-only.
+         * @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 selected.
+         */
         label?: (props: {
             item: T;
             text: string;
             checked: boolean;
         }) => any;
+        /**
+         * Content rendered after each option's switch and label.
+         * @param checked - Whether this option is currently selected.
+         * @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;
@@ -76,7 +176,15 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
             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;