bitboss-ui 2.1.111 → 2.1.112

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

@@ -142,17 +142,25 @@ type __VLS_PublicProps = {
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<{
+        /**
+         * Primary content rendered inside the button. Falls back to the `text` prop when empty.
+         */
         default?: (props: object) => any;
         /**
          * Custom content for the tooltip. Falls back to the {@link BbButtonProps.tooltip | tooltip} prop text.
+         * @param text - The `tooltip` prop value, or `undefined` if not set.
          */
         tooltip?: (props: {
             text: string | undefined;
         }) => any;
     }> & {
+        /**
+         * Primary content rendered inside the button. Falls back to the `text` prop when empty.
+         */
         default?: (props: object) => any;
         /**
          * Custom content for the tooltip. Falls back to the {@link BbButtonProps.tooltip | tooltip} prop text.
+         * @param text - The `tooltip` prop value, or `undefined` if not set.
          */
         tooltip?: (props: {
             text: string | undefined;

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

@@ -1,4 +1,4 @@
-import { BaseCheckboxEvents, SlotAttributes } from '../BaseCheckbox/BaseCheckbox.vue';
+import { BaseCheckboxEvents, BaseCheckboxIconSlotProps } from '../BaseCheckbox/types';
 import { HTMLAttributes, InputHTMLAttributes } from 'vue';
 export type BbCheckboxProps = {
     /**
@@ -101,19 +101,63 @@ export type BbCheckboxEvents = BaseCheckboxEvents;
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<{
+        /**
+         * Replaces the default label text rendered next to the checkbox.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the checkbox is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * Replaces the default checkmark SVG inside the checkbox box. Receives `BaseCheckbox` slot
+         * attributes plus the label text.
+         * @param checked - Whether the checkbox is currently checked.
+         * @param disabled - Whether the checkbox is disabled.
+         * @param falseValue - The value emitted when unchecked.
+         * @param focused - Whether the input currently has focus.
+         * @param focusVisible - Whether focus is keyboard-visible (`:focus-visible`).
+         * @param hasErrors - Whether the checkbox 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 `trueValue` serialized for form submission.
+         * @param readonly - Whether the checkbox is read-only.
+         * @param trueValue - The value emitted when checked.
+         * @param value - The current effective value.
+         * @param text - The `label` prop value.
+         */
+        icon?: (props: BaseCheckboxIconSlotProps & {
             text: string;
         }) => any;
     }> & {
+        /**
+         * Replaces the default label text rendered next to the checkbox.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the checkbox is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * Replaces the default checkmark SVG inside the checkbox box. Receives `BaseCheckbox` slot
+         * attributes plus the label text.
+         * @param checked - Whether the checkbox is currently checked.
+         * @param disabled - Whether the checkbox is disabled.
+         * @param falseValue - The value emitted when unchecked.
+         * @param focused - Whether the input currently has focus.
+         * @param focusVisible - Whether focus is keyboard-visible (`:focus-visible`).
+         * @param hasErrors - Whether the checkbox 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 `trueValue` serialized for form submission.
+         * @param readonly - Whether the checkbox is read-only.
+         * @param trueValue - The value emitted when checked.
+         * @param value - The current effective value.
+         * @param text - The `label` prop value.
+         */
+        icon?: (props: BaseCheckboxIconSlotProps & {
             text: string;
         }) => any;
     };

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

@@ -1,7 +1,7 @@
 import { BaseCheckboxGroupEvents } from '../BaseCheckboxGroup/BaseCheckboxGroup.vue';
 import { HTMLAttributes, InputHTMLAttributes } from 'vue';
 import { NestedKeyOf } from '../../types/NestedKeyOf';
-import { SlotAttributes } from '../BaseCheckbox/BaseCheckbox.vue';
+import { BaseCheckboxIconSlotProps } from '../BaseCheckbox/types';
 export type BbCheckboxGroupProps<T> = {
     /**
      * Sets autofocus on page load.
@@ -148,9 +148,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 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;
@@ -158,15 +175,46 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
             item: T;
             text: string;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * 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;
@@ -174,15 +222,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 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;
@@ -190,15 +263,46 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
             item: T;
             text: string;
         }) => any;
-        icon?: (props: SlotAttributes & {
+        /**
+         * 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;
@@ -206,7 +310,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;

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

@@ -15,8 +15,14 @@ export type BbChipEvents = {
 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;
     };
     refs: {};

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

@@ -12,8 +12,16 @@ export type BbCollapsibleProps = Pick<CommonProps, 'eager' | 'transitionDuration
 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;
     };
     refs: {};

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

@@ -115,6 +115,11 @@ export type BbColorInputProps = {
 };
 export type BbColorInputEvents = BaseColorInputEvents;
 export type BbColorInputSlots = BaseColorInputSlots & {
+    /**
+     * Replaces the default label text rendered above the color input.
+     * @param text - The `label` prop value.
+     * @param hasErrors - Whether the input is in an error state.
+     */
     label?: (props: {
         text: string;
         hasErrors: boolean;
@@ -123,11 +128,21 @@ export type BbColorInputSlots = BaseColorInputSlots & {
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<BaseColorInputSlots & {
+        /**
+         * Replaces the default label text rendered above the color input.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the input is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;
         }) => any;
     }> & BaseColorInputSlots & {
+        /**
+         * Replaces the default label text rendered above the color input.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the input is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;

package/dist/components/BbConfirm/BbConfirmPortal.vue.d.ts

@@ -1,10 +1,25 @@
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: {
-        default?(_: {
-            yes: () => Promise<void>;
-            no: () => Promise<void>;
-        }): any;
+    slots: Readonly<{
+        /**
+         * Content teleported into `.bb-confirm__teleport` when a confirmation is pending.
+         * @param yes - Confirms the dialog (resolves the pending confirmation with `true`).
+         * @param no - Cancels the dialog (resolves the pending confirmation with `false`).
+         */
+        default?: (props: {
+            yes: () => void;
+            no: () => void;
+        }) => any;
+    }> & {
+        /**
+         * Content teleported into `.bb-confirm__teleport` when a confirmation is pending.
+         * @param yes - Confirms the dialog (resolves the pending confirmation with `true`).
+         * @param no - Cancels the dialog (resolves the pending confirmation with `false`).
+         */
+        default?: (props: {
+            yes: () => void;
+            no: () => void;
+        }) => any;
     };
     refs: {};
     rootEl: any;

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

@@ -142,23 +142,69 @@ export type BbDatePickerInputEvents = BaseDatePickerInputEvents;
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<{
+        /**
+         * Content rendered before the entire date picker control, outside the input chrome.
+         */
         'prepend-outer'?: (props: object) => any;
+        /**
+         * Content rendered before the date fields, at the start of the inner container.
+         */
         prepend?: (props: object) => any;
+        /**
+         * Inline content rendered at the start of the input field area, before the date fields.
+         */
         prefix?: (props: object) => any;
+        /**
+         * Content rendered after the date fields, at the end of the inner container (before the calendar toggle button).
+         */
         append?: (props: object) => any;
+        /**
+         * Content rendered after the entire date picker control, outside the input chrome.
+         */
         'append-outer'?: (props: object) => any;
+        /**
+         * Inline content rendered at the end of the input field area, after the date fields.
+         */
         suffix?: (props: object) => any;
+        /**
+         * Replaces the default label text rendered above the date picker.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the input is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;
         }) => any;
     }> & {
+        /**
+         * Content rendered before the entire date picker control, outside the input chrome.
+         */
         'prepend-outer'?: (props: object) => any;
+        /**
+         * Content rendered before the date fields, at the start of the inner container.
+         */
         prepend?: (props: object) => any;
+        /**
+         * Inline content rendered at the start of the input field area, before the date fields.
+         */
         prefix?: (props: object) => any;
+        /**
+         * Content rendered after the date fields, at the end of the inner container (before the calendar toggle button).
+         */
         append?: (props: object) => any;
+        /**
+         * Content rendered after the entire date picker control, outside the input chrome.
+         */
         'append-outer'?: (props: object) => any;
+        /**
+         * Inline content rendered at the end of the input field area, after the date fields.
+         */
         suffix?: (props: object) => any;
+        /**
+         * Replaces the default label text rendered above the date picker.
+         * @param text - The `label` prop value.
+         * @param hasErrors - Whether the input is in an error state.
+         */
         label?: (props: {
             text: string;
             hasErrors: boolean;

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

@@ -75,6 +75,13 @@ export type MappedItem = Item & {
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<{
+        /**
+         * The element that triggers the dropdown to open. Spread `props` onto your trigger element.
+         * @param props - Spread onto the trigger element to wire the floating-UI anchor reference.
+         * @param disabled - Whether the dropdown is globally disabled.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         */
         activator?: (props: {
             props: {
                 ref: (reference: unknown) => void;
@@ -83,11 +90,26 @@ declare function __VLS_template(): {
             open: boolean;
             placement: BbDropdownProps["placement"];
         }) => any;
+        /**
+         * Content rendered before the first item in the dropdown panel.
+         * @param disabled - Whether the dropdown is globally disabled.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         */
         prepend?: (props: {
             disabled?: boolean;
             open: boolean;
             placement: BbDropdownProps["placement"];
         }) => any;
+        /**
+         * Content rendered before each dropdown item's default button content.
+         * @param disabled - Whether this item is disabled.
+         * @param index - The zero-based index of this item.
+         * @param item - The raw item object from the `items` prop.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         * @param text - The resolved display text for this item.
+         */
         'item:prepend'?: (props: {
             disabled?: MappedItem["disabled"];
             index: number;
@@ -96,6 +118,15 @@ declare function __VLS_template(): {
             placement: BbDropdownProps["placement"];
             text: MappedItem["text"];
         }) => any;
+        /**
+         * Content rendered after each dropdown item's default button content.
+         * @param disabled - Whether this item is disabled.
+         * @param index - The zero-based index of this item.
+         * @param item - The raw item object from the `items` prop.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         * @param text - The resolved display text for this item.
+         */
         'item:append'?: (props: {
             disabled?: MappedItem["disabled"];
             index: number;
@@ -104,6 +135,12 @@ declare function __VLS_template(): {
             placement: BbDropdownProps["placement"];
             text: MappedItem["text"];
         }) => any;
+        /**
+         * Content rendered after the last item in the dropdown panel.
+         * @param disabled - Whether the dropdown is globally disabled.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         */
         append?: (props: {
             disabled?: boolean;
             open: boolean;
@@ -119,6 +156,13 @@ declare function __VLS_template(): {
             text: MappedItem["text"];
         }) => any;
     }> & {
+        /**
+         * The element that triggers the dropdown to open. Spread `props` onto your trigger element.
+         * @param props - Spread onto the trigger element to wire the floating-UI anchor reference.
+         * @param disabled - Whether the dropdown is globally disabled.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         */
         activator?: (props: {
             props: {
                 ref: (reference: unknown) => void;
@@ -127,11 +171,26 @@ declare function __VLS_template(): {
             open: boolean;
             placement: BbDropdownProps["placement"];
         }) => any;
+        /**
+         * Content rendered before the first item in the dropdown panel.
+         * @param disabled - Whether the dropdown is globally disabled.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         */
         prepend?: (props: {
             disabled?: boolean;
             open: boolean;
             placement: BbDropdownProps["placement"];
         }) => any;
+        /**
+         * Content rendered before each dropdown item's default button content.
+         * @param disabled - Whether this item is disabled.
+         * @param index - The zero-based index of this item.
+         * @param item - The raw item object from the `items` prop.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         * @param text - The resolved display text for this item.
+         */
         'item:prepend'?: (props: {
             disabled?: MappedItem["disabled"];
             index: number;
@@ -140,6 +199,15 @@ declare function __VLS_template(): {
             placement: BbDropdownProps["placement"];
             text: MappedItem["text"];
         }) => any;
+        /**
+         * Content rendered after each dropdown item's default button content.
+         * @param disabled - Whether this item is disabled.
+         * @param index - The zero-based index of this item.
+         * @param item - The raw item object from the `items` prop.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         * @param text - The resolved display text for this item.
+         */
         'item:append'?: (props: {
             disabled?: MappedItem["disabled"];
             index: number;
@@ -148,6 +216,12 @@ declare function __VLS_template(): {
             placement: BbDropdownProps["placement"];
             text: MappedItem["text"];
         }) => any;
+        /**
+         * Content rendered after the last item in the dropdown panel.
+         * @param disabled - Whether the dropdown is globally disabled.
+         * @param open - Whether the dropdown panel is currently open.
+         * @param placement - The current placement of the dropdown panel.
+         */
         append?: (props: {
             disabled?: boolean;
             open: boolean;
@@ -255,8 +329,10 @@ declare function __VLS_template(): {
         }> & Readonly<{
             "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
         }>, "transitionDuration" | "padding" | "tag" | "flip"> & import('vue').ShallowUnwrapRef<{}> & {} & import('@vue/runtime-core').ComponentCustomProperties & {} & {
-            $slots: {
-                default?(_: {}): any;
+            $slots: Readonly<{
+                default?: (props: object) => any;
+            }> & {
+                default?: (props: object) => any;
             };
         }) | null;
     };
@@ -364,8 +440,10 @@ declare const __VLS_component: import('vue').DefineComponent<BbDropdownProps, {}
     }> & Readonly<{
         "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
     }>, "transitionDuration" | "padding" | "tag" | "flip"> & import('vue').ShallowUnwrapRef<{}> & {} & import('@vue/runtime-core').ComponentCustomProperties & {} & {
-        $slots: {
-            default?(_: {}): any;
+        $slots: Readonly<{
+            default?: (props: object) => any;
+        }> & {
+            default?: (props: object) => any;
         };
     }) | null;
 }, any>;