bitboss-ui 2.1.44 → 2.1.46

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

@@ -1,75 +1,153 @@
 import { RouteLocationRaw } from 'vue-router';
 export type BaseButtonProps = {
     /**
-     * Class to apply when the link is active
+     * CSS class applied when the component renders as a router link (`to` provided)
+     * and the target route is active.
+     *
+     * When using Vue Router this mirrors the behavior of `RouterLink`'s
+     * `activeClass`.
      */
     activeClass?: string;
     /**
-     * Value passed to the attribute `aria-current` when the link is exact active.
+     * Value forwarded to the `aria-current` attribute when the component renders
+     * as a router link and the target route is an exact match.
      *
+     * Use to communicate the current location to assistive technologies.
      * @defaultValue `'page'`
      */
     ariaCurrentValue?: 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false';
     /**
-     * Displays the component as full width.
+     * Makes the component take the full available width (block-level layout).
+     * Adds the `base-btn--block` modifier class.
      */
     block?: boolean;
+    /**
+     * Request payload forwarded to Inertia when navigating via `href` in an
+     * Inertia-enabled app. Ignored when not using Inertia.
+     */
     data?: object;
     /**
-     * Disables the component
+     * Disables user interaction.
+     *
+     * - When rendering as a native button, sets the `disabled` attribute.
+     * - When rendering as a link (anchor/Inertia), removes `href`, adds
+     *   `aria-disabled="true"`, and prevents navigation while keeping focusable
+     *   semantics consistent.
      */
     disabled?: boolean;
     /**
-     * Class to apply when the link is exact active
+     * CSS class applied when the component renders as a router link and the
+     * target route is an exact match.
+     *
+     * Mirrors `RouterLink`'s `exactActiveClass` behavior.
      */
     exactActiveClass?: string;
+    /**
+     * Additional HTTP headers forwarded to Inertia when navigating via `href`
+     * in an Inertia-enabled app.
+     */
     headers?: object;
     /**
-     * Returns the hyperlink's URL.
-     *
-     * Can be set, to change the URL.
+     * Hyperlink reference used when rendering as an anchor (or as an Inertia
+     * link in Inertia-enabled apps). If provided and not disabled, the component
+     * renders as an anchor/Inertia link.
      */
     href?: HTMLAnchorElement['href'];
+    /**
+     * HTTP method used for Inertia navigation when `href` is provided in an
+     * Inertia-enabled app. Ignored otherwise.
+     */
     method?: 'get' | 'post' | 'put' | 'patch' | 'delete';
+    /**
+     * Lifecycle hook invoked by Inertia right before the request is sent.
+     */
     onBefore?: () => void;
+    /**
+     * Lifecycle hook invoked by Inertia when a request is cancelled.
+     */
     onCancel?: () => void;
+    /**
+     * Receives the Inertia cancel token source when a request is initiated.
+     * Can be used to cancel the request.
+     */
     onCancelToken?: (cancelToken: import('axios').CancelTokenSource) => void;
+    /**
+     * Lifecycle hook invoked by Inertia after the request has finished
+     * (regardless of success or error).
+     */
     onFinish?: () => void;
+    /**
+     * Limits the properties that are preserved in Inertia partial reloads.
+     */
     only?: string[];
+    /**
+     * Progress callback invoked by Inertia with the upload/download percentage
+     * when available.
+     */
     onProgress?: (progress: {
         percentage: number | undefined;
     }) => void;
+    /**
+     * Lifecycle hook invoked by Inertia when a request starts.
+     */
     onStart?: () => void;
+    /**
+     * Lifecycle hook invoked by Inertia when a request succeeds.
+     */
     onSuccess?: () => void;
+    /**
+     * Controls whether Inertia should preserve the current scroll position after
+     * navigation. Can be a boolean or a predicate receiving the visit props.
+     * @defaultValue `false`
+     */
     preserveScroll?: boolean | ((props: {
         [key: string]: unknown;
     }) => boolean);
+    /**
+     * Controls whether Inertia should preserve the current state after navigation.
+     * Can be a boolean or a predicate receiving the visit props.
+     * @defaultValue `false`
+     */
     preserveState?: boolean | ((props: {
         [key: string]: unknown;
     }) => boolean) | null;
+    /**
+     * Format to use when serializing array values into the query string for
+     * Inertia requests.
+     */
     queryStringArrayFormat?: 'brackets' | 'indices';
     /**
-     * Calls `router.replace` instead of `router.push`.
+     * Uses history replacement instead of push navigation.
+     *
+     * - With Vue Router (`to`), calls `router.replace`.
+     * - With Inertia (`href`), performs a replace visit.
      */
     replace?: boolean;
     /**
-     * Any HTML tag corresponding to a non-void HTMl element.
+     * Custom HTML tag used when rendering as a native element (neither router
+     * link nor anchor). Must correspond to a non-void HTML element.
+     * @defaultValue `'button'`
      */
     tag?: string;
     /**
-     * Sets or retrieves the window or frame at which to target content.
+     * Target browsing context for anchor/Inertia links (e.g. `_self`, `_blank`).
+     * Ignored when rendering as a native button.
      */
     target?: HTMLAnchorElement['target'];
     /**
-     * Text content of the component.
+     * Fallback text content rendered when no default slot is provided.
      */
     text?: string;
     /**
-     * Route Location the link should navigate to when clicked on.
+     * Route location to navigate to. When provided (and not disabled), the
+     * component renders as a Vue Router link.
      */
     to?: RouteLocationRaw;
     /**
-     * Gets the classification and default behavior of the button.
+     * Native `type` attribute used when rendering as a button (e.g. `button`,
+     * `submit`, `reset`).
+     *
+     * @defaultValue `'button'`
      */
     type?: HTMLButtonElement['type'];
 };

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

@@ -1,68 +1,92 @@
 import { HTMLAttributes, InputHTMLAttributes } from 'vue';
 export type BaseCheckboxProps = {
     /**
-     * Guides to the browser as to the type of information expected in the field.
+     * ID of the element that describes this checkbox for assistive technologies.
+     * Forwarded to the input as `aria-describedby`.
      */
     ariaDescribedby?: InputHTMLAttributes['aria-describedby'];
     /**
-     * Sets autofocus on page load.
+     * Automatically focuses the checkbox when the page/component loads.
+     * Use sparingly to avoid usability issues.
+     * @defaultValue `false`
      */
     autofocus?: InputHTMLAttributes['autofocus'];
     /**
-     * Defines the input as checked
+     * Forces the checkbox checked state (controlled prop). Accepts booleanish
+     * values (`true`/`false` or `'true'`/`'false'`). When omitted, the checked
+     * state is derived from `modelValue === trueValue`.
+     * @defaultValue `false`
      */
     checked?: boolean | 'true' | 'false';
     /**
-     * Define a color for the component.
-     *
-     * Either a custom color or a coded color in common HEX, RGB, etc... format.
+     * Visual color of the checkbox.
+     * - If a valid CSS color (HEX/RGB/HSL/etc.), it is applied via the `--color`
+     *   CSS variable.
+     * - Otherwise, a BEM modifier class `bb-base-checkbox--{color}` is added for
+     *   theme-based styling.
      */
     color?: string;
     /**
-     * Disables the component
+     * Disables user interaction. Also applied when `readonly` is set, since
+     * native checkboxes do not support `readonly`.
+     * @defaultValue `false`
      */
     disabled?: boolean;
     /**
-     * Value of the input when unchecked. It handles any kind of serializable object.
+     * Value submitted/emitted when the checkbox is unchecked. Accepts any
+     * serializable value. Serialized to a string for form submission.
+     * @defaultValue `false`
      */
     falseValue?: any;
     /**
-     * Define if the component should be in an error state.
-     * It usually attaches a CSS class for styling purposes.
+     * Puts the component into an error state (adds error styling class `bb-base-checkbox--errors`).
+     * @defaultValue `false`
      */
     hasErrors?: boolean;
     /**
-     * The identifier of the component.
+     * Identifier forwarded to the input.
      */
     id?: HTMLAttributes['id'];
     /**
-     * Sets the input in an indeterminate state.
+     * Renders the checkbox in the indeterminate state (neither checked nor
+     * unchecked). Note: the native `indeterminate` state resets on user click;
+     * this component re-applies it to keep UI and prop aligned.
+     * @defaultValue `false`
      */
     indeterminate?: InputHTMLAttributes['indeterminate'];
     /**
-     * Defines the name of the input.
+     * Bound value for `v-model`. When it equals `trueValue` the checkbox is
+     * considered checked, otherwise unchecked.
+     */
+    modelValue?: any;
+    /**
+     * Name attribute of the input, used during form submission.
      */
     name?: InputHTMLAttributes['name'];
     /**
-     * Sets the input in a readonly state.
+     * Puts the input in a read-only state. Since checkboxes do not support
+     * native `readonly`, the input is disabled while styled as read-only.
+     * @defaultValue `false`
      */
     readonly?: boolean;
     /**
-     * Sets the input as required.
+     * Marks the input as required for form validation.
+     * @defaultValue `false`
      */
     required?: boolean;
     /**
-     * Will submit "falseValue" if the input is not checked. Otherwise "trueValue" will be submitted.
+     * When unchecked, submits a hidden input with `falseValue` so that a value
+     * is still posted with the form. When checked, the visible input submits
+     * `trueValue` as usual.
+     * @defaultValue `false`
      */
     submitWhenFalse?: boolean;
     /**
-     * Value of the input when checked. It handles any kind of serializable object.
+     * Value submitted/emitted when the checkbox is checked. Accepts any
+     * serializable value. Serialized to a string for form submission.
+     * @defaultValue `true`
      */
     trueValue?: any;
-    /**
-     * Used by v-model. Can be any serializable type.
-     */
-    modelValue?: any;
 };
 export type BaseCheckboxEvents = {
     (e: 'blur', event: FocusEvent): void;

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

@@ -1,96 +1,129 @@
 import { HTMLAttributes, InputHTMLAttributes, MaybeRefOrGetter } from 'vue';
-import { NestedKeyOf } from '../../types/NestedKeyOf';
 import { SlotAttributes } from '../BaseCheckbox/BaseCheckbox.vue';
 export type BaseCheckboxGroupProps<T> = {
     /**
-     * Guides to the browser as to the type of information expected in the field.
+     * ID of the element that describes the entire checkbox group for assistive
+     * technologies. Forwarded to each generated input as `aria-describedby`.
      */
     ariaDescribedby?: InputHTMLAttributes['aria-describedby'];
     /**
-     * Sets autofocus on page load.
+     * Automatically focuses the first checkbox on mount when true.
+     * Applied only to the first option.
+     * @defaultValue `false`
      */
     autofocus?: InputHTMLAttributes['autofocus'];
     /**
-     * Define a color for the component.
-     *
-     * Either a custom color or a coded color in common HEX, RGB, etc... format.
+     * Visual color of the checkboxes.
+     * - If a valid CSS color (HEX/RGB/HSL/etc.), it is applied via the `--color`
+     *   CSS variable.
+     * - Otherwise, a BEM modifier class `bb-base-checkbox--{color}` is added for
+     *   theme-based styling.
      */
     color?: string;
     /**
-     * Defines an array of dependencies that will trigger actions in the component upon change.
+     * List of reactive values which, when changed, trigger items re-fetching.
+     * Useful to reload options based on external inputs.
+     * @defaultValue `[]`
      */
     dependencies?: any[];
     /**
-     * Timeout used to debounce response to changes to dependencies.
+     * Debounce delay (ms) applied when reacting to `dependencies` changes.
+     * @defaultValue `0`
      */
     depsDebounceTime?: number;
     /**
-     * Direction of the layout of the inputs inside the fieldset. It can be either `horizontal` or `vertical`
+     * Direction of the group layout.
+     * - `horizontal`: options flow in rows
+     * - `vertical`: options stack in a column
+     * @defaultValue `'horizontal'`
      */
     direction?: 'horizontal' | 'vertical';
     /**
-     * Disables the component
+     * Disables interaction for the whole group.
+     * @defaultValue `false`
      */
     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.
+     * Enforces that `modelValue` contains only values present in `items`.
+     * Incoherent values are removed and `update:modelValue` is emitted with a
+     * coherent array. Please check out {@link https://ui-components-docs.vercel.app/it/guides/coherence | the docs} for more information.
+     * @defaultValue `false`
      */
     enforceCoherence?: boolean;
     /**
-     * Define if the component should be in an error state.
-     * It usually attaches a CSS class for styling purposes.
+     * Puts the component into an error state adds the error styling class.
+     * @defaultValue `false`
      */
     hasErrors?: boolean;
     /**
-     * Visually hides the label of the input while maintaining accessibility.
+     * Visually hides the label while keeping it accessible to screen readers.
+     * @defaultValue `false`
      */
     hideLabel?: boolean;
     /**
-     * The identifier of the component.
+     * Identifier of the group. Used to derive per-option IDs
+     * for accessible labeling.
      */
     id?: HTMLAttributes['id'];
     /**
-     * Used to retrieve items can be an array or a function.
+     * Items provider. Can be:
+     * - An array of items
+     * - A sync/async function `(prefill, modelValue) => items`
+     *
+     * When a function is provided, it is invoked on prefill and when dependencies
+     * change to load options dynamically.
+     * @defaultValue `[]`
      */
     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
+     * Defines how to derive the display text from an item. Accepts a nested key path
+     * into the item or a function `(item) => string`.
+     * @example `'address.city.label'`
+     * @example `(item) => item.address.city.label`
+     * @defaultValue `JSON.stringify(item)`
      */
-    itemText?: T extends object ? NestedKeyOf<T> | ((item: T) => string) : ((item: T) => string) | undefined;
+    itemText?: T extends object ? string | ((item: T) => string) : (item: T) => string;
     /**
-     * Defines a path that returns a property of the object to use as value or a function that returns any value
+     * Defines how to derive the value from an item. Accepts a nested key path into the
+     * item or a function `(item) => any`.
+     * @example `'address.city.value'`
+     * @example `(item) => item.address.city.value`
+     * @defaultValue `JSON.stringify(item)`
      */
-    itemValue?: T extends object ? NestedKeyOf<T> | ((item: T) => string) : ((item: T) => any) | undefined;
+    itemValue?: T extends object ? string | ((item: T) => string) : (item: T) => any;
     /**
-     * String displayed while items are being loaded.
+     * Text displayed while items are loading.
+     * @defaultValue `'Loading...'`
      */
     loadingText?: string;
     /**
      * Maximum number of selectable items.
+     * @defaultValue `Infinity`
      */
     max?: number;
     /**
-     * Used by v-model. Can be an array of any serializable type.
+     * Selected values for the group. Used with `v-model`.
+     * Must be an array.
      */
     modelValue: any[];
     /**
-     * Timeout used to debounce response to changes to modelValue.
+     * Debounce delay (ms) applied when reacting to `modelValue` changes.
+     * @defaultValue `0`
      */
     modelValueDebounceTime?: number;
     /**
-     * Defines the name of the input.
+     * Name attribute applied to each input for form submission.
      */
     name?: InputHTMLAttributes['name'];
     /**
-     * String displayed when there are no items to display.
+     * Text displayed when there are no items to show.
+     * @defaultValue `'No data to display'`
      */
     noDataText?: MaybeRefOrGetter<string>;
     /**
-     * Sets the input in a readonly state.
+     * Makes all checkboxes read-only. Since checkboxes do not support native
+     * `readonly`, inputs are disabled while styled as read-only.
+     * @defaultValue `false`
      */
     readonly?: boolean;
 };
@@ -107,16 +140,7 @@ export type BaseCheckboxGroupEvents = {
     (e: 'update:modelValue', value: any): void;
 };
 export type BaseCheckboxGroupSlots<T> = {
-    prepend?: (props: object) => any;
-    loading?: (props: object) => any;
-    'no-data'?: (props: object) => any;
-    'option:prepend'?: (props: {
-        checked: boolean;
-        disabled: boolean;
-        id?: string;
-        item: T;
-        text: string;
-    }) => any;
+    append?: (props: object) => any;
     icon?: (props: SlotAttributes & {
         item: T;
         text: string;
@@ -126,6 +150,8 @@ export type BaseCheckboxGroupSlots<T> = {
         text: string;
         checked: boolean;
     }) => any;
+    loading?: (props: object) => any;
+    'no-data'?: (props: object) => any;
     'option:append'?: (props: {
         checked: boolean;
         disabled: boolean;
@@ -133,7 +159,14 @@ export type BaseCheckboxGroupSlots<T> = {
         item: T;
         text: string;
     }) => any;
-    append?: (props: object) => any;
+    'option:prepend'?: (props: {
+        checked: boolean;
+        disabled: boolean;
+        id?: string;
+        item: T;
+        text: string;
+    }) => any;
+    prepend?: (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<any & BaseCheckboxGroupProps<T> & Partial<{}>> & import('vue').PublicProps;

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

@@ -1,76 +1,88 @@
 import { HTMLAttributes, InputHTMLAttributes } from 'vue';
 import { IconType } from '../../types/Icon';
+/**
+ * Color input with hex value masking and an optional palette popover.
+ * Accepts and emits `#RRGGBB` values via v-model and supports full input chrome slots.
+ */
 export type BaseColorInputProps = {
     /**
-     * Name of the icon to be added at the end of the input.
+     * Name of the icon to render at the right hand side of the input.
      */
     'append:icon'?: IconType;
     /**
-     * Guides to the browser as to the type of information expected in the field.
+     * Id(s) of element(s) describing this input for assistive tech (space-separated).
+     * Typically includes the container hint id if used within a BaseInputContainer.
      */
     ariaDescribedby?: InputHTMLAttributes['aria-describedby'];
     /**
-     * Guides to the browser as to the type of information expected in the field.
+     * Autocomplete hint for the browser.
+     * @default 'off'
      */
     autocomplete?: InputHTMLAttributes['autocomplete'];
     /**
-     * Sets autofocus on page load.
+     * Focus the input on mount.
      */
     autofocus?: InputHTMLAttributes['autofocus'];
     /**
-     * Displays a clear button when the input has a value and is being interacted with.
+     * Show a clear button when the input has a value.
      */
     clearable?: boolean;
     /**
-     * Displays the component in a compact version.
+     * Display the component in a compact layout.
      */
     compact?: boolean;
     /**
-     * Disables the component
+     * Disable all interactions.
      */
     disabled?: boolean;
     /**
-     * Define if the component should be in an error state.
-     * It usually attaches a CSS class for styling purposes.
+     * Visually mark the component as invalid (also sets aria-invalid on the input).
      */
     hasErrors?: boolean;
     /**
-     * The identifier of the component.
+     * The id attribute for the input element. Defaults to a generated `bb_<unique>` id when omitted.
      */
     id?: HTMLAttributes['id'];
     /**
-     * Sets the component in a loading state, usually triggering some visual styles.
+     * Display the loading state.
      */
     loading?: boolean;
     /**
-     * Used my v-model
+     * v-model value: `#RRGGBB` hex string or `null` when empty.
+     * Example: `#1A2B3C`
      */
     modelValue: string | null;
     /**
-     * Defines the name of the input.
+     * Name attribute of the input.
      */
     name?: InputHTMLAttributes['name'];
     /**
-     * String displayed when there's no data.
+     * Placeholder text when there is no value.
      */
     placeholder?: InputHTMLAttributes['placeholder'];
     /**
-     * Name of the icon to be added at the start of the input.
+     * Name of the icon to render at the start of the input.
      */
     'prepend:icon'?: IconType;
     /**
-     * Sets the input in a readonly state.
+     * Make the input read-only.
      */
     readonly?: boolean;
     /**
-     * Sets the input as required.
+     * Mark the input as required.
      */
     required?: boolean;
     /**
-     * The transition duration of the floating component.
+     * Transition duration (ms) of the palette popover.
+     * @default 250
      */
     transitionDuration?: number;
 };
+/**
+ * Events emitted by the color input.
+ * - blur/change/click/focus/input/keydown/mousedown/mouseup: native input events (payload: original event)
+ * - update:modelValue: emits `#RRGGBB` when valid, `null` when cleared/invalid
+ */
 export type BaseColorInputEvents = {
     (e: 'blur', event: FocusEvent): void;
     (e: 'change', event: Event): void;
@@ -82,9 +94,13 @@ export type BaseColorInputEvents = {
     (e: 'mouseup', event: MouseEvent): void;
     (e: 'update:modelValue', value: string | null): void;
 };
+/**
+ * Slots to customize the input chrome.
+ * Use `prepend`/`append` for inline adornments; `prepend-outer`/`append-outer` for the outer container areas.
+ */
 export type BaseColorInputSlots = {
-    'append-outer'?: (props: object) => any;
     append?: (props: object) => any;
+    'append-outer'?: (props: object) => any;
     prefix?: (props: object) => any;
     prepend?: (props: object) => any;
     'prepend-outer'?: (props: object) => any;

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

@@ -9,6 +9,10 @@ export type BaseDatePickerProps = {
      * Defines the first day of the week with `0` meaning Sunday and `6` meaning Saturday
      */
     firstDayOfWeek?: (typeof it)['weekStart'];
+    /**
+     * If true the date will have a format YYYY-MM-DD instead of the default ISO string.
+     */
+    floating?: boolean;
     /**
      * The identifier of the component.
      */
@@ -20,11 +24,11 @@ export type BaseDatePickerProps = {
     /**
      * Maximum selectable date
      */
-    max?: Date | string | number;
+    max?: string;
     /**
      * Minimum selectable date
      */
-    min?: Date | string | number;
+    min?: string;
     /**
      * Used by v-model. Can be null, a single string, or an array of strings based on whether a range or single date is needed
      */
@@ -45,7 +49,7 @@ export type BaseDatePickerProps = {
      * Function that accepts a `Date` object and returns a boolean. `false` meaning the date cannot be selected
      * @param date
      */
-    selectable?: (date: Date) => boolean;
+    selectable?: (date: string) => boolean;
 };
 declare function __VLS_template(): {
     attrs: Partial<{}>;

package/dist/components/BaseDatePicker/BaseDatePickerInputDaySelector.vue.d.ts

@@ -6,13 +6,14 @@ type Props = {
     disabled: boolean;
     firstDayOfWeek: number;
     id?: HTMLAttributes['id'];
+    floating?: boolean;
     /**
      * Used by v-model. Can be null, a single string, or an array of strings based on whether a range or single date is needed
      */
     modelValue: string | string[] | null;
-    max?: Date | string | number;
-    min?: Date | string | number;
-    selectable?: (date: Date) => boolean;
+    max?: string;
+    min?: string;
+    selectable?: (date: string) => boolean;
     range?: boolean;
     multiple?: boolean;
     readonly?: boolean;