bitboss-ui 2.1.113 → 2.1.115

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

@@ -0,0 +1,159 @@
+import { RouteLocationRaw } from 'vue-router';
+import { Placement } from '@floating-ui/vue';
+import { IconType } from '../../types/Icon';
+type Sizes = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+export type BbButtonProps = {
+    /**
+     * Tracks the loading status internally.
+     */
+    autoLoading?: boolean;
+    /**
+     * Class to apply when the link is active.
+     */
+    activeClass?: string;
+    /**
+     * Value passed to the attribute `aria-current` when the link is exact active.
+     *
+     * @defaultValue `'page'`
+     */
+    ariaCurrentValue?: 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false';
+    /**
+     * Icon to be added on the right of the text.
+     */
+    'append:icon'?: IconType;
+    /**
+     * Displays the component as full width.
+     */
+    block?: boolean;
+    data?: object;
+    /**
+     * Disables the component.
+     */
+    disabled?: boolean;
+    /**
+     * Disables the click handler while the component is loading.
+     */
+    enabledWhileLoading?: boolean;
+    /**
+     * Class to apply when the link is exact active.
+     */
+    exactActiveClass?: string;
+    /**
+     * Identifies the button as part of a button group.
+     */
+    group?: boolean;
+    headers?: object;
+    /**
+     * Returns the hyperlink's URL.
+     *
+     * Can be set, to change the URL.
+     */
+    href?: HTMLAnchorElement['href'];
+    /**
+     * Used when only an icon with no text should be displayed.
+     */
+    icon?: IconType;
+    /**
+     * Triggers a loading indicator.
+     */
+    loading?: boolean;
+    method?: 'get' | 'post' | 'put' | 'patch' | 'delete';
+    onBefore?: () => void;
+    onCancel?: () => void;
+    onCancelToken?: (cancelToken: import('axios').CancelTokenSource) => void;
+    onFinish?: () => void;
+    only?: string[];
+    onProgress?: (progress: {
+        percentage: number | undefined;
+    }) => void;
+    onStart?: () => void;
+    onSuccess?: () => void;
+    /**
+     * Icon to be added on the left of the text.
+     */
+    'prepend:icon'?: IconType;
+    preserveScroll?: boolean | ((props: {
+        [key: string]: unknown;
+    }) => boolean);
+    preserveState?: boolean | ((props: {
+        [key: string]: unknown;
+    }) => boolean) | null;
+    queryStringArrayFormat?: 'brackets' | 'indices';
+    /**
+     * Calls `router.replace` instead of `router.push`.
+     */
+    replace?: boolean;
+    /**
+     * Sets the size of the button. When the value is a string, it will be applied to all
+     * screen sizes. Otherwise, it will be applied to the screen size specified by the object.
+     *
+     * @defaultValue `'md'`
+     */
+    size?: Sizes | Partial<Record<'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | 'default', Sizes>>;
+    /**
+     * Any HTML tag corresponding to a non-void HTML element.
+     */
+    tag?: string;
+    /**
+     * Sets or retrieves the window or frame at which to target content.
+     */
+    target?: HTMLAnchorElement['target'];
+    /**
+     * Text content of the component.
+     */
+    text?: string;
+    /**
+     * Text content for a tooltip displayed on hover.
+     * When provided, a {@link BbTooltip} is lazily loaded and attached to the button.
+     */
+    tooltip?: string;
+    /**
+     * Placement of the tooltip relative to the button.
+     * Accepts any {@link Placement} value from Floating UI.
+     *
+     * @defaultValue `'top'`
+     */
+    tooltipPlacement?: Placement;
+    /**
+     * The delay in milliseconds before the tooltip is shown.
+     *
+     * @defaultValue `0`
+     */
+    tooltipTimeout?: number;
+    /**
+     * Route Location the link should navigate to when clicked on.
+     */
+    to?: RouteLocationRaw;
+    /**
+     * Value emitted when the toggle is activated.
+     *
+     * @defaultValue `true`
+     */
+    trueValue?: any;
+    /**
+     * Value emitted when the toggle is deactivated.
+     *
+     * @defaultValue `false`
+     */
+    falseValue?: any;
+    /**
+     * Gets the classification and default behavior of the button.
+     */
+    type?: HTMLButtonElement['type'];
+};
+/** Props exposed by the `tooltip` slot. */
+export type BbButtonTooltipSlotProps = {
+    /** The `tooltip` prop value, or `undefined` if not set. */
+    text: string | undefined;
+};
+export type BbButtonSlots = {
+    /**
+     * 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.
+     */
+    tooltip?: (props: BbButtonTooltipSlotProps) => any;
+};
+export {};

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

@@ -1,190 +1,32 @@
-import { BaseCheckboxEvents, BaseCheckboxIconSlotProps } from '../BaseCheckbox/types';
-import { HTMLAttributes, InputHTMLAttributes } from 'vue';
-export type BbCheckboxProps = {
-    /**
-     * Sets autofocus on page load.
-     */
-    autofocus?: InputHTMLAttributes['autofocus'];
-    /**
-     * Defines the input as checked
-     */
-    checked?: boolean | 'true' | 'false';
-    /**
-     * Define a color for the component.
-     *
-     * Either a custom color or a coded color in common HEX, RGB, etc... format.
-     */
-    color?: string;
-    /**
-     * 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;
-    /**
-     * Can be a string or an array of string containing the messages to display.
-     */
-    errors?: string | string[];
-    /**
-     * Value of the input when unchecked. It handles any kind of serializable object.
-     */
-    falseValue?: any;
-    /**
-     * 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;
-    /**
-     * Text box to be displayed near the input, usually to indicate instructions.
-     */
-    hint?: string;
-    /**
-     * The identifier of the component.
-     */
-    id?: HTMLAttributes['id'];
-    /**
-     * Sets the input in an indeterminate state.
-     */
-    indeterminate?: InputHTMLAttributes['indeterminate'];
-    /**
-     * 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 label of the element.
-     */
-    label: string;
-    /**
-     * Sets the text alignment of the label.
-     */
-    labelPosition?: 'left' | 'center' | 'right';
-    /**
-     * Used by v-model. Can be any serializable type.
-     */
-    modelValue?: any;
-    /**
-     * Defines the name of the input.
-     */
-    name?: InputHTMLAttributes['name'];
-    /**
-     * 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;
-    /**
-     * Will submit "falseValue" if the input is not checked. Otherwise "trueValue" will be submitted.
-     */
-    submitWhenFalse?: boolean;
-    /**
-     * Value of the input when checked. It handles any kind of serializable object.
-     */
-    trueValue?: any;
-};
-export type BbCheckboxEvents = BaseCheckboxEvents;
+import { BbCheckboxProps, BbCheckboxEvents, BbCheckboxSlots } from './types';
+export type { BbCheckboxProps, BbCheckboxEvents, BbCheckboxSlots };
 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;
-        /**
-         * 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;
-        /**
-         * 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;
-    };
+    slots: Readonly<BbCheckboxSlots> & BbCheckboxSlots;
     refs: {};
     rootEl: HTMLDivElement;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<BbCheckboxProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
     input: (event: Event) => any;
-    "update:modelValue": (value: any) => 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: any) => any;
 }, string, import('vue').PublicProps, Readonly<BbCheckboxProps> & Readonly<{
     onInput?: ((event: Event) => any) | undefined;
-    "onUpdate:modelValue"?: ((value: any) => 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: any) => any) | undefined;
 }>, {
     reverse: boolean;
     direction: "horizontal" | "vertical" | "auto" | string;

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

@@ -0,0 +1,130 @@
+import { HTMLAttributes, InputHTMLAttributes } from 'vue';
+import { BaseCheckboxEvents, BaseCheckboxIconSlotProps } from '../BaseCheckbox/types';
+export type BbCheckboxProps = {
+    /**
+     * Sets autofocus on page load.
+     */
+    autofocus?: InputHTMLAttributes['autofocus'];
+    /**
+     * Defines the input as checked.
+     */
+    checked?: boolean | 'true' | 'false';
+    /**
+     * Define a color for the component.
+     *
+     * Either a custom color or a coded color in common HEX, RGB, etc... format.
+     */
+    color?: string;
+    /**
+     * Direction of the layout of the component. Can either be a predefined value or a pattern separated by a space like `xx xxxxx`.
+     *
+     * @defaultValue `'auto'`
+     */
+    direction?: 'horizontal' | 'vertical' | 'auto' | string;
+    /**
+     * Disables the component.
+     */
+    disabled?: boolean;
+    /**
+     * Can be a string or an array of string containing the messages to display.
+     */
+    errors?: string | string[];
+    /**
+     * Value of the input when unchecked. It handles any kind of serializable object.
+     */
+    falseValue?: any;
+    /**
+     * 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;
+    /**
+     * Text box to be displayed near the input, usually to indicate instructions.
+     */
+    hint?: string;
+    /**
+     * The identifier of the component.
+     */
+    id?: HTMLAttributes['id'];
+    /**
+     * Sets the input in an indeterminate state.
+     */
+    indeterminate?: InputHTMLAttributes['indeterminate'];
+    /**
+     * 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 label of the element.
+     */
+    label: string;
+    /**
+     * Sets the text alignment of the label.
+     */
+    labelPosition?: 'left' | 'center' | 'right';
+    /**
+     * Used by v-model. Can be any serializable type.
+     */
+    modelValue?: any;
+    /**
+     * Defines the name of the input.
+     */
+    name?: InputHTMLAttributes['name'];
+    /**
+     * 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.
+     *
+     * @defaultValue `true`
+     */
+    reverse?: boolean;
+    /**
+     * Will submit "falseValue" if the input is not checked. Otherwise "trueValue" will be submitted.
+     */
+    submitWhenFalse?: boolean;
+    /**
+     * Value of the input when checked. It handles any kind of serializable object.
+     */
+    trueValue?: any;
+};
+/** Re-export for consumers importing events type from BbCheckbox. */
+export type BbCheckboxEvents = BaseCheckboxEvents;
+/** Props exposed by the `label` slot. */
+export type BbCheckboxLabelSlotProps = {
+    /** The `label` prop value. */
+    text: string;
+    /** Whether the checkbox is in an error state. */
+    hasErrors: boolean;
+};
+/** Props exposed by the `icon` slot. Extends BaseCheckbox icon slot with the label text. */
+export type BbCheckboxIconSlotProps = BaseCheckboxIconSlotProps & {
+    /** The `label` prop value. */
+    text: string;
+};
+export type BbCheckboxSlots = {
+    /**
+     * Replaces the default label text rendered next to the checkbox.
+     */
+    label?: (props: BbCheckboxLabelSlotProps) => any;
+    /**
+     * Replaces the default checkmark SVG inside the checkbox box. Receives `BaseCheckbox` slot
+     * attributes plus the label text.
+     */
+    icon?: (props: BbCheckboxIconSlotProps) => any;
+};