bitboss-ui 2.1.113 → 2.1.115

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

@@ -0,0 +1,240 @@
+import { InputHTMLAttributes, HTMLAttributes } from 'vue';
+import { NestedKeyOf } from '../../types/NestedKeyOf';
+import { BaseRadioIconSlotProps } from '../BaseRadio/types';
+/**
+ * Props for the radio group component that renders a list of radio options from items.
+ */
+export type BaseRadioGroupProps<T = any> = {
+    /**
+     * Id(s) of elements describing this group for assistive technologies.
+     */
+    ariaDescribedby?: InputHTMLAttributes['aria-describedby'];
+    /**
+     * Focus the first radio on mount.
+     */
+    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;
+    /**
+     * Additional dependencies that trigger item reloading when changed.
+     */
+    dependencies?: any[];
+    /**
+     * Debounce delay (ms) for dependency-triggered reloads.
+     * @defaultValue `0`
+     */
+    depsDebounceTime?: number;
+    /**
+     * Direction of the layout of the inputs inside the fieldset.
+     * @defaultValue `'horizontal'`
+     */
+    direction?: 'horizontal' | 'vertical';
+    /**
+     * Disable all radios in the group.
+     */
+    disabled?: boolean;
+    /**
+     * Reset modelValue to `null` if it no longer matches available items (enforces coherence).
+     */
+    enforceCoherence?: boolean;
+    /**
+     * Apply error styling to the group.
+     */
+    hasErrors?: boolean;
+    /**
+     * Hide the visual label while keeping it accessible.
+     */
+    hideLabel?: boolean;
+    /**
+     * Explicit id for the fieldset. Used to generate ids for individual radios.
+     */
+    id?: HTMLAttributes['id'];
+    /**
+     * Array of items or function to load them asynchronously.
+     * @defaultValue `[]`
+     */
+    items: T[] | ((prefill: boolean, modelValue?: any[]) => Promise<T[]>) | ((prefill: boolean, modelValue?: any[]) => T[]);
+    /**
+     * Path to item property for display text or function to extract it.
+     */
+    itemText?: T extends object ? NestedKeyOf<T> | ((item: T) => string) : ((item: T) => string) | undefined;
+    /**
+     * Path to item property for value or function to extract it.
+     */
+    itemValue?: T extends object ? NestedKeyOf<T> | ((item: T) => string) : ((item: T) => any) | undefined;
+    /**
+     * Message shown while items are loading.
+     */
+    loadingText?: string;
+    /**
+     * Used by v-model. Can be any serializable type.
+     */
+    modelValue: any;
+    /**
+     * Debounce delay (ms) for modelValue change handling.
+     * @defaultValue `0`
+     */
+    modelValueDebounceTime?: number;
+    /**
+     * Shared name for all radios in the group (required for grouping).
+     */
+    name: InputHTMLAttributes['name'];
+    /**
+     * Message displayed when no items are available.
+     */
+    noDataText?: string;
+    /**
+     * Make all radios read-only.
+     */
+    readonly?: boolean;
+    /**
+     * Mark at least one radio as required.
+     */
+    required?: boolean;
+};
+export type BaseRadioGroupEvents = {
+    /**
+     * Emitted when one of the generated radio inputs loses focus.
+     * Forwards the original DOM `FocusEvent`.
+     */
+    (e: 'blur', event: FocusEvent): void;
+    /**
+     * Emitted when a radio option is selected.
+     * Forwards the original DOM `Event` from the radio input.
+     */
+    (e: 'change', event: Event): void;
+    /**
+     * Emitted when one of the generated radio inputs is clicked.
+     * Forwards the original DOM `MouseEvent`.
+     */
+    (e: 'click', event: MouseEvent): void;
+    /**
+     * Emitted when one of the generated radio inputs receives focus.
+     * Forwards the original DOM `FocusEvent`.
+     */
+    (e: 'focus', event: FocusEvent): void;
+    /**
+     * Emitted when focus/click moves outside the group after it was active.
+     * Useful for validation-on-blur flows at group level.
+     */
+    (e: 'inactive'): void;
+    /**
+     * Emitted on native input events from generated radio inputs.
+     * Forwards the original DOM `Event`.
+     */
+    (e: 'input', event: Event): void;
+    /**
+     * Emitted for keyboard interaction on generated radio inputs.
+     * Forwards the original DOM `KeyboardEvent`.
+     */
+    (e: 'keydown', event: KeyboardEvent): void;
+    /**
+     * Emitted when a pointing device button is pressed over a radio input.
+     * Forwards the original DOM `MouseEvent`.
+     */
+    (e: 'mousedown', event: MouseEvent): void;
+    /**
+     * Emitted when a pointing device button is released over a radio input.
+     * Forwards the original DOM `MouseEvent`.
+     */
+    (e: 'mouseup', event: MouseEvent): void;
+    /**
+     * Emitted with the newly selected value when the selection changes.
+     */
+    (e: 'update:modelValue', value: any): void;
+};
+/**
+ * Props exposed by option affix slots (`option:prepend` / `option:append`).
+ */
+export type BaseRadioGroupOptionAffixSlotProps<T = any> = {
+    /**
+     * Whether this option is currently selected.
+     */
+    checked: boolean;
+    /**
+     * Whether this option is disabled.
+     */
+    disabled: boolean;
+    /**
+     * The `id` of this option's input, if set.
+     */
+    id?: string;
+    /**
+     * The raw item from the `items` prop.
+     */
+    item: T;
+    /**
+     * The display text for this option.
+     */
+    text: string;
+};
+/**
+ * Props exposed by the `label` slot for each option.
+ */
+export type BaseRadioGroupLabelSlotProps<T = any> = {
+    /**
+     * The raw item from the `items` prop.
+     */
+    item: T;
+    /**
+     * The resolved display text for this option.
+     */
+    text: string;
+    /**
+     * Whether this option is currently selected.
+     */
+    checked: boolean;
+};
+/**
+ * Props exposed by the `icon` slot for each option. Extends `BaseRadioIconSlotProps`
+ * with the source item and its display text.
+ */
+export type BaseRadioGroupIconSlotProps<T = any> = BaseRadioIconSlotProps & {
+    /**
+     * The raw item from the `items` prop.
+     */
+    item: T;
+    /**
+     * The display text resolved for this option.
+     */
+    text: string;
+};
+export type BaseRadioGroupSlots<T = 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 radio button.
+     */
+    'option:prepend'?: (props: BaseRadioGroupOptionAffixSlotProps<T>) => any;
+    /**
+     * Replaces the default radio dot icon for each option. Receives all `BaseRadio`
+     * slot attributes plus the source item and its display text.
+     */
+    icon?: (props: BaseRadioGroupIconSlotProps<T>) => any;
+    /**
+     * Replaces the default label text for each option.
+     */
+    label?: (props: BaseRadioGroupLabelSlotProps<T>) => any;
+    /**
+     * Content rendered after each option's radio button and label.
+     */
+    'option:append'?: (props: BaseRadioGroupOptionAffixSlotProps<T>) => any;
+    /**
+     * Content rendered after the last option, inside the options container.
+     */
+    append?: (props: object) => any;
+};

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

@@ -1,105 +1,4 @@
-import { InputHTMLAttributes, HTMLAttributes } from 'vue';
-import { BbIconProps } from '../BbIcon/BbIcon.vue';
-/**
- * Props for the star rating input component with customizable star count and visual feedback.
- */
-export type BaseRatingProps = {
-    /**
-     * Id(s) of elements describing this rating input for assistive technologies.
-     */
-    ariaDescribedby?: InputHTMLAttributes['aria-describedby'];
-    /**
-     * 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;
-    /**
-     * Disable all interactions with the rating.
-     */
-    disabled?: boolean;
-    /**
-     * Apply error styling to the rating.
-     */
-    hasErrors?: boolean;
-    /**
-     * Explicit id for the rating container. Used to generate ids for individual stars.
-     */
-    id?: HTMLAttributes['id'];
-    /**
-     * v-model value: the selected rating (1 to `stars`) or `null` for no selection.
-     */
-    modelValue: null | number;
-    /**
-     * Shared name attribute for all star radio inputs (required for grouping).
-     */
-    name: Exclude<InputHTMLAttributes['name'], undefined>;
-    /**
-     * Make the rating read-only while keeping it visible.
-     */
-    readonly?: boolean;
-    /**
-     * Mark the rating as required.
-     */
-    required?: boolean;
-    /**
-     * Maximum number of stars to render and maximum selectable rating value.
-     * @default 5
-     */
-    stars?: number;
-} & Pick<BbIconProps, 'size'>;
-/**
- * Events emitted by `BaseRating`.
- * - Native events (`blur`, `change`, etc.) are forwarded from the star inputs.
- * - `inactive`: fired when focus leaves the rating.
- * - `update:modelValue`: emitted with the selected rating (1 to `stars`) or `null` when cleared.
- */
-export type BaseRatingEvents = {
-    (e: 'blur', event: FocusEvent): void;
-    (e: 'change', event: Event): void;
-    (e: 'click', event: MouseEvent): void;
-    (e: 'focus', event: FocusEvent): void;
-    (e: 'inactive'): void;
-    (e: 'input', event: Event): void;
-    (e: 'keydown', event: KeyboardEvent): void;
-    (e: 'mousedown', event: MouseEvent): void;
-    (e: 'mouseup', event: MouseEvent): void;
-    (e: 'update:modelValue', value: number | null): void;
-};
-/**
- * Slots for customizing the rating appearance.
- * - `icon`: replace individual star visuals with state and value bindings.
- * - `prepend` / `append`: wrap the entire rating with additional content.
- */
-export type BaseRatingSlots = {
-    /**
-     * Replaces the default star SVG for each rating option.
-     * @param checked - Whether this star is filled (i.e. the rating value is ≥ this star's value).
-     * @param disabled - Whether the rating is disabled.
-     * @param id - The `id` of this star's underlying radio input.
-     * @param size - The rendered size of the icon in pixels, from the `size` prop.
-     * @param value - The numeric value this star represents (1-based).
-     */
-    icon?: (props: {
-        checked: boolean;
-        disabled: boolean;
-        id?: string;
-        size: number | undefined;
-        value: number;
-    }) => any;
-    /**
-     * Content rendered before the row of rating stars.
-     */
-    prepend?: (props: object) => any;
-    /**
-     * Content rendered after the row of rating stars.
-     */
-    append?: (props: object) => any;
-};
+import { BaseRatingProps, BaseRatingSlots } from './types';
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: Readonly<BaseRatingSlots> & BaseRatingSlots;
@@ -111,25 +10,25 @@ declare function __VLS_template(): {
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<BaseRatingProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
     input: (event: Event) => any;
-    "update:modelValue": (value: number | null) => any;
-    keydown: (event: KeyboardEvent) => any;
     blur: (event: FocusEvent) => any;
     change: (event: Event) => any;
     click: (event: MouseEvent) => any;
     focus: (event: FocusEvent) => any;
+    keydown: (event: KeyboardEvent) => any;
     mousedown: (event: MouseEvent) => any;
     mouseup: (event: MouseEvent) => any;
+    "update:modelValue": (value: number | null) => any;
     inactive: () => any;
 }, string, import('vue').PublicProps, Readonly<BaseRatingProps> & Readonly<{
     onInput?: ((event: Event) => any) | undefined;
-    "onUpdate:modelValue"?: ((value: number | null) => any) | undefined;
-    onKeydown?: ((event: KeyboardEvent) => any) | undefined;
     onBlur?: ((event: FocusEvent) => any) | undefined;
     onChange?: ((event: Event) => any) | undefined;
     onClick?: ((event: MouseEvent) => any) | undefined;
     onFocus?: ((event: FocusEvent) => any) | undefined;
+    onKeydown?: ((event: KeyboardEvent) => any) | undefined;
     onMousedown?: ((event: MouseEvent) => any) | undefined;
     onMouseup?: ((event: MouseEvent) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: number | null) => any) | undefined;
     onInactive?: (() => any) | undefined;
 }>, {
     stars: number;

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

@@ -0,0 +1,144 @@
+import { InputHTMLAttributes, HTMLAttributes } from 'vue';
+import { BbIconProps } from '../BbIcon/BbIcon.vue';
+/**
+ * Props for the star rating input component with customizable star count and visual feedback.
+ */
+export type BaseRatingProps = {
+    /**
+     * Id(s) of elements describing this rating input for assistive technologies.
+     */
+    ariaDescribedby?: InputHTMLAttributes['aria-describedby'];
+    /**
+     * 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;
+    /**
+     * Disable all interactions with the rating.
+     */
+    disabled?: boolean;
+    /**
+     * Apply error styling to the rating.
+     */
+    hasErrors?: boolean;
+    /**
+     * Explicit id for the rating container. Used to generate ids for individual stars.
+     */
+    id?: HTMLAttributes['id'];
+    /**
+     * v-model value: the selected rating (1 to `stars`) or `null` for no selection.
+     */
+    modelValue: null | number;
+    /**
+     * Shared name attribute for all star radio inputs (required for grouping).
+     */
+    name: Exclude<InputHTMLAttributes['name'], undefined>;
+    /**
+     * Make the rating read-only while keeping it visible.
+     */
+    readonly?: boolean;
+    /**
+     * Mark the rating as required.
+     */
+    required?: boolean;
+    /**
+     * Maximum number of stars to render and maximum selectable rating value.
+     * @defaultValue `5`
+     */
+    stars?: number;
+} & Pick<BbIconProps, 'size'>;
+export type BaseRatingEvents = {
+    /**
+     * Emitted when a star input loses focus.
+     * Forwards the original DOM `FocusEvent`.
+     */
+    (e: 'blur', event: FocusEvent): void;
+    /**
+     * Emitted when the selected rating changes.
+     * Forwards the original DOM `Event`.
+     */
+    (e: 'change', event: Event): void;
+    /**
+     * Emitted when a star input receives a click.
+     * Forwards the original DOM `MouseEvent`.
+     */
+    (e: 'click', event: MouseEvent): void;
+    /**
+     * Emitted when a star input gains focus.
+     * Forwards the original DOM `FocusEvent`.
+     */
+    (e: 'focus', event: FocusEvent): void;
+    /**
+     * Emitted when focus/click moves outside the rating after it was active.
+     */
+    (e: 'inactive'): void;
+    /**
+     * Emitted on native input events from the star inputs.
+     * Forwards the original DOM `Event`.
+     */
+    (e: 'input', event: Event): void;
+    /**
+     * Emitted for keyboard interaction on a star input.
+     * Forwards the original DOM `KeyboardEvent`.
+     */
+    (e: 'keydown', event: KeyboardEvent): void;
+    /**
+     * Emitted when a pointing device button is pressed over a star input.
+     * Forwards the original DOM `MouseEvent`.
+     */
+    (e: 'mousedown', event: MouseEvent): void;
+    /**
+     * Emitted when a pointing device button is released over a star input.
+     * Forwards the original DOM `MouseEvent`.
+     */
+    (e: 'mouseup', event: MouseEvent): void;
+    /**
+     * Emitted with the selected rating (1 to `stars`) when clicked, or `null` when
+     * clicking the already-selected star deselects it.
+     */
+    (e: 'update:modelValue', value: number | null): void;
+};
+/**
+ * Props exposed by the `icon` slot for each rating star.
+ */
+export type BaseRatingIconSlotProps = {
+    /**
+     * Whether this star is filled (i.e. the rating value is ≥ this star's value).
+     */
+    checked: boolean;
+    /**
+     * Whether the rating is disabled.
+     */
+    disabled: boolean;
+    /**
+     * The `id` of this star's underlying radio input.
+     */
+    id?: string;
+    /**
+     * The rendered size of the icon in pixels, from the `size` prop.
+     */
+    size: number | undefined;
+    /**
+     * The numeric value this star represents (1-based).
+     */
+    value: number;
+};
+export type BaseRatingSlots = {
+    /**
+     * Replaces the default star SVG for each rating option.
+     */
+    icon?: (props: BaseRatingIconSlotProps) => any;
+    /**
+     * Content rendered before the row of rating stars.
+     */
+    prepend?: (props: object) => any;
+    /**
+     * Content rendered after the row of rating stars.
+     */
+    append?: (props: object) => any;
+};