bitboss-ui 2.1.113 → 2.1.115

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

@@ -0,0 +1,182 @@
+import { HTMLAttributes, InputHTMLAttributes } from 'vue';
+import { NestedKeyOf } from '../../types/NestedKeyOf';
+import { BaseRadioGroupEvents, BaseRadioGroupOptionAffixSlotProps, BaseRadioGroupLabelSlotProps, BaseRadioGroupIconSlotProps } from '../BaseRadioGroup/types';
+export type BbRadioGroupProps<T> = {
+    /**
+     * Sets autofocus on page load.
+     */
+    autofocus?: InputHTMLAttributes['autofocus'];
+    /**
+     * Define a color for the component.
+     *
+     * Either a custom color or a coded color in common HEX, RGB, etc... format.
+     */
+    color?: string;
+    /**
+     * Sets the component in a compact state.
+     */
+    compact?: boolean;
+    /**
+     * Defines an array of dependencies that will trigger actions in the component upon change.
+     */
+    dependencies?: any[];
+    /**
+     * Timeout used to debounce response to changes to dependencies.
+     */
+    depsDebounceTime?: number;
+    /**
+     * Direction of the layout of the component. Can either be a predefined value or a pattern separated by a space like `xx xxxxx`.
+     */
+    direction?: 'horizontal' | 'vertical' | 'auto' | string;
+    /**
+     * Disables the component.
+     */
+    disabled?: boolean;
+    /**
+     * If coherence is enforced the input cannot have a modelValue that is incoherent with its current items.
+     *
+     * e.g. You cannot set v-model to a user that is not present in the items passed.
+     *
+     * modelValue will be reset upon incoherence.
+     */
+    enforceCoherence?: boolean;
+    /**
+     * Can be a string or an array of string containing the messages to display.
+     */
+    errors?: string | string[];
+    /**
+     * Define if the component should be in an error state.
+     * It usually attaches a CSS class for styling purposes.
+     */
+    hasErrors?: boolean;
+    /**
+     * Visually hides the label of the input while maintaining accessibility.
+     */
+    hideLabel?: boolean;
+    /**
+     * Visually hides the legend of the fieldset while maintaining accessibility.
+     */
+    hideLegend?: boolean;
+    /**
+     * Text box to be displayed near the input, usually to indicate instructions.
+     */
+    hint?: string;
+    /**
+     * The identifier of the component.
+     */
+    id?: HTMLAttributes['id'];
+    /**
+     * Defines the direction of the inputs in the fieldset.
+     */
+    inputDirection?: 'horizontal' | 'vertical';
+    /**
+     * Sets the alignment of the input. Since inputs are inline block they can be aligned just as text can.
+     *
+     * @defaultValue `'left'`
+     */
+    inputPosition?: 'left' | 'center' | 'right';
+    /**
+     * Used to retrieve items; can be an array or a function.
+     */
+    items: T[] | ((prefill: boolean, modelValue?: any[]) => Promise<T[]>) | ((prefill: boolean, modelValue?: any[]) => T[]);
+    /**
+     * Defines a path that returns a property of the object to use as text or a function that returns a string.
+     */
+    itemText?: T extends object ? NestedKeyOf<T> | ((item: T) => string) : ((item: T) => string) | undefined;
+    /**
+     * Defines a path that returns a property of the object to use as value or a function that returns any value.
+     */
+    itemValue?: T extends object ? NestedKeyOf<T> | ((item: T) => string) : ((item: T) => any) | undefined;
+    /**
+     * Sets the text alignment of the label.
+     */
+    labelPosition?: 'left' | 'center' | 'right';
+    /**
+     * Text content of the legend.
+     */
+    legend: string;
+    /**
+     * String displayed while items are being loaded.
+     */
+    loadingText?: string;
+    /**
+     * Used by v-model. Can be any serializable type.
+     */
+    modelValue: any;
+    /**
+     * Timeout used to debounce response to changes to modelValue.
+     */
+    modelValueDebounceTime?: number;
+    /**
+     * Defines the name of the input.
+     */
+    name: InputHTMLAttributes['name'];
+    /**
+     * String displayed when there are no items to display.
+     */
+    noDataText?: string;
+    /**
+     * Keeps the hint displayed.
+     */
+    persistentHint?: boolean;
+    /**
+     * Sets the input in a readonly state.
+     */
+    readonly?: boolean;
+    /**
+     * Sets the input as required.
+     */
+    required?: boolean;
+    /**
+     * Reverses the layout. Applicable in every direction the order of the label and the input is swapped.
+     */
+    reverse?: boolean;
+};
+/** Re-export for consumers importing events type from BbRadioGroup. */
+export type BbRadioGroupEvents = BaseRadioGroupEvents;
+/** Props exposed by the `legend` slot. */
+export type BbRadioGroupLegendSlotProps = {
+    /** The `legend` prop value. */
+    text: string;
+    /** Whether the group is in an error state. */
+    hasErrors: boolean;
+};
+export type BbRadioGroupSlots<T> = {
+    /**
+     * Content rendered before the first option, inside the options container.
+     */
+    prepend?: (props: object) => any;
+    /**
+     * Content shown while options are loading (replaces the default loading text).
+     */
+    loading?: (props: object) => any;
+    /**
+     * Content shown when no options are available (replaces the default "no data" text).
+     */
+    'no-data'?: (props: object) => any;
+    /**
+     * Content rendered before each option's 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;
+    /**
+     * Replaces the default fieldset legend text for the group.
+     */
+    legend?: (props: BbRadioGroupLegendSlotProps) => any;
+};

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

@@ -1,114 +1,11 @@
-import { BaseRatingEvents, BaseRatingSlots } from '../BaseRating/BaseRating.vue';
-import { BbIconProps } from '../BbIcon/BbIcon.vue';
-import { HTMLAttributes, InputHTMLAttributes } from 'vue';
-export type BbRatingProps = {
-    /**
-     * 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;
-    /**
-     * Sets the component in a compact state.
-     */
-    compact?: boolean;
-    /**
-     * Disables the component
-     */
-    disabled?: boolean;
-    /**
-     * Direction of the layout of the component. Can either be a predefined value or a pattern separated by a space like `xx xxxxx`.
-     */
-    direction?: 'horizontal' | 'vertical' | 'auto' | string;
-    /**
-     * Can be a string or an array of string containing the messages to display.
-     */
-    errors?: string | string[];
-    /**
-     * Define if the component should be in an error state.
-     * It usually attaches a CSS class for styling purposes.
-     */
-    hasErrors?: boolean;
-    /**
-     * Visually hides the legend of the fieldset while maintaining accessibility.
-     */
-    hideLegend?: boolean;
-    /**
-     * Text box to be displayed near the input, usually to indicate instructions.
-     */
-    hint?: string;
-    /**
-     * The identifier of the component.
-     */
-    id?: HTMLAttributes['id'];
-    /**
-     * Sets the slignment of the input. Since inputs are inline block they can be aligned just as text can.
-     */
-    inputPosition?: 'left' | 'center' | 'right';
-    /**
-     * Text content of the legend.
-     */
-    legend: string;
-    /**
-     * Sets the text alignment of the legend.
-     */
-    legendPosition?: 'left' | 'center' | 'right';
-    /**
-     * Used by v-model
-     */
-    modelValue: null | number;
-    /**
-     * Defines the name of the input.
-     */
-    name: string;
-    /**
-     * Keeps the hint displayed.
-     */
-    persistentHint?: boolean;
-    /**
-     * Sets the input in a readonly state.
-     */
-    readonly?: boolean;
-    /**
-     * Sets the input as required.
-     */
-    required?: boolean;
-    /**
-     * Reverses the layout. Applicable in every direction the order of the label and the input is swapped.
-     */
-    reverse?: boolean;
-    /**
-     * Maximum number of stars to render and maximum value of the component
-     */
-    stars?: number;
-} & Pick<BbIconProps, 'size'>;
-export type BbRatingEvents = BaseRatingEvents;
+import { BbRatingProps, BbRatingEvents, BbRatingSlots } from './types';
+export type { BbRatingProps, BbRatingEvents, BbRatingSlots };
 declare function __VLS_template(): {
     attrs: Partial<{}>;
-    slots: Readonly<BaseRatingSlots & {
-        /**
-         * Replaces the default fieldset legend text rendered above the rating stars.
-         * @param text - The `legend` prop value.
-         * @param hasErrors - Whether the rating is in an error state.
-         */
-        legend?: (props: {
-            text: string;
-            hasErrors: boolean;
-        }) => any;
-    }> & BaseRatingSlots & {
-        /**
-         * Replaces the default fieldset legend text rendered above the rating stars.
-         * @param text - The `legend` prop value.
-         * @param hasErrors - Whether the rating is in an error state.
-         */
-        legend?: (props: {
-            text: string;
-            hasErrors: boolean;
-        }) => any;
+    slots: Readonly<import('../BaseRating/types').BaseRatingSlots & {
+        legend?: (props: import('./types').BbRatingLegendSlotProps) => any;
+    }> & import('../BaseRating/types').BaseRatingSlots & {
+        legend?: (props: import('./types').BbRatingLegendSlotProps) => any;
     };
     refs: {};
     rootEl: HTMLDivElement;
@@ -116,25 +13,25 @@ declare function __VLS_template(): {
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<BbRatingProps, {}, {}, {}, {}, 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<BbRatingProps> & 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;
 }>, {
     inputPosition: "left" | "center" | "right";

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

@@ -0,0 +1,105 @@
+import { HTMLAttributes, InputHTMLAttributes } from 'vue';
+import { BaseRatingEvents, BaseRatingSlots } from '../BaseRating/types';
+import { BbIconProps } from '../BbIcon/types';
+export type BbRatingProps = {
+    /**
+     * 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;
+    /**
+     * Sets the component in a compact state.
+     */
+    compact?: boolean;
+    /**
+     * Disables the component.
+     */
+    disabled?: boolean;
+    /**
+     * Direction of the layout of the component. Can either be a predefined value or a pattern separated by a space like `xx xxxxx`.
+     */
+    direction?: 'horizontal' | 'vertical' | 'auto' | string;
+    /**
+     * Can be a string or an array of string containing the messages to display.
+     */
+    errors?: string | string[];
+    /**
+     * Define if the component should be in an error state.
+     * It usually attaches a CSS class for styling purposes.
+     */
+    hasErrors?: boolean;
+    /**
+     * Visually hides the legend of the fieldset while maintaining accessibility.
+     */
+    hideLegend?: boolean;
+    /**
+     * Text box to be displayed near the input, usually to indicate instructions.
+     */
+    hint?: string;
+    /**
+     * The identifier of the component.
+     */
+    id?: HTMLAttributes['id'];
+    /**
+     * Sets the alignment of the input. Since inputs are inline block they can be aligned just as text can.
+     *
+     * @defaultValue `'left'`
+     */
+    inputPosition?: 'left' | 'center' | 'right';
+    /**
+     * Text content of the legend.
+     */
+    legend: string;
+    /**
+     * Sets the text alignment of the legend.
+     */
+    legendPosition?: 'left' | 'center' | 'right';
+    /**
+     * Used by v-model.
+     */
+    modelValue: null | number;
+    /**
+     * Defines the name of the input.
+     */
+    name: string;
+    /**
+     * Keeps the hint displayed.
+     */
+    persistentHint?: boolean;
+    /**
+     * Sets the input in a readonly state.
+     */
+    readonly?: boolean;
+    /**
+     * Sets the input as required.
+     */
+    required?: boolean;
+    /**
+     * Reverses the layout. Applicable in every direction the order of the label and the input is swapped.
+     */
+    reverse?: boolean;
+    /**
+     * Maximum number of stars to render and maximum value of the component.
+     */
+    stars?: number;
+} & Pick<BbIconProps, 'size'>;
+/** Re-export for consumers importing events type from BbRating. */
+export type BbRatingEvents = BaseRatingEvents;
+/** Props exposed by the `legend` slot. */
+export type BbRatingLegendSlotProps = {
+    /** The `legend` prop value. */
+    text: string;
+    /** Whether the rating is in an error state. */
+    hasErrors: boolean;
+};
+export type BbRatingSlots = BaseRatingSlots & {
+    /**
+     * Replaces the default fieldset legend text rendered above the rating stars.
+     */
+    legend?: (props: BbRatingLegendSlotProps) => any;
+};

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

@@ -1,23 +1,8 @@
-import { NonVoidElementTag } from '../../types/CommonProps';
-export type BbRatioProps = {
-    /**
-     * The ratio the component should maintain. It should be passed as number as in `16/9`.
-     */
-    ratio?: number;
-} & NonVoidElementTag;
+import { BbRatioProps, BbRatioSlots } from './types';
+export type { BbRatioProps, BbRatioSlots };
 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;
-    };
+    slots: Readonly<BbRatioSlots> & BbRatioSlots;
     refs: {};
     rootEl: any;
 };

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

@@ -0,0 +1,15 @@
+import { NonVoidElementTag } from '../../types/CommonProps';
+export type BbRatioProps = {
+    /**
+     * The ratio the component should maintain. It should be passed as a number as in `16/9`.
+     *
+     * @defaultValue `1`
+     */
+    ratio?: number;
+} & NonVoidElementTag;
+export type BbRatioSlots = {
+    /**
+     * Content rendered inside the ratio container, scaled to maintain the configured aspect ratio.
+     */
+    default?: (props: object) => any;
+};