bitboss-ui 2.1.113 → 2.1.115

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

@@ -1,241 +1,23 @@
-import { BaseButtonProps } from '../BaseButton/BaseButton.vue';
-import { CommonProps } from '../../types/CommonProps';
-import { IconType } from '../../types/Icon';
-export type DropdownTrigger = 'click' | 'contextMenu';
-export type BbDropdownProps = Pick<CommonProps, 'arrowPadding' | 'disabled' | 'eager' | 'id' | 'offset' | 'padding' | 'transitionDuration'> & {
-    /**
-     * Position of the dropdown relative to the activator.
-     * Use `'cursor'` to anchor at the mouse/touch coordinates (hides arrow).
-     */
-    placement?: CommonProps['placement'] | 'cursor';
-    /**
-     * External activator element or component ref.
-     * When provided, the activator slot is not rendered and event listeners
-     * are attached programmatically to the referenced element.
-     */
-    activator?: HTMLElement | Record<string, any> | null;
-    /**
-     * Constrains the dropdown within a bounding element.
-     * Accepts an HTMLElement, a Vue component ref, or a CSS selector string.
-     */
-    boundary?: HTMLElement | Record<string, any> | string | null;
-    /**
-     * Array used to render each dropdown button.
-     * They can act as `button`, as `a`, or as `router-link`
-     * as they are based on the functionality provided by
-     * `BaseButton`
-     */
-    items: Item[];
-    /**
-     * Name of the theme to apply to the component. It creates a CSS class with the name of the theme.
-     * @deprecated since the popover is local you should use a normal css class applied to the top level element
-     */
-    theme?: string;
-    /**
-     * Interaction(s) that open the dropdown.
-     * Accepts a single trigger or an array to combine them.
-     * - `'click'` — left-click / tap (default)
-     * - `'contextMenu'` — right-click on desktop, long-press on mobile
-     * @default 'click'
-     */
-    trigger?: DropdownTrigger | DropdownTrigger[];
-    /**
-     * Width of the dropdown in pixels, percentage, or 'auto' to fit content.
-     */
-    width?: number | string;
-};
-export type Item = Omit<BaseButtonProps, 'block' | 'tag' | 'type'> & {
-    /**
-     * Click handler of the item.
-     */
-    onClick?: (...args: any[]) => any;
-    /**
-     * Key used to identify the element.
-     */
-    key: string;
-    /**
-     * Icon to be displayed before the text.
-     */
-    'prepend:icon'?: IconType;
-    /**
-     * Icon to be displayed after the text.
-     */
-    'append:icon'?: IconType;
-};
-export type MappedItem = Item & {
-    /**
-     * Identifier of the element among it's siblings.
-     */
-    id: string;
-    /**
-     * Keydown event used to handle accessibility.
-     */
-    onKeydown: (event: KeyboardEvent) => void;
-};
+import { BbDropdownProps, BbDropdownSlots, Item, MappedItem, DropdownTrigger } from './types';
+export type { BbDropdownProps, BbDropdownSlots, Item, MappedItem, DropdownTrigger, };
 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;
-            };
-            disabled?: boolean;
-            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;
-            item: BbDropdownProps["items"][number];
-            open: boolean;
-            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;
-            item: BbDropdownProps["items"][number];
-            open: boolean;
-            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;
-            placement: BbDropdownProps["placement"];
-        }) => any;
+        activator?: (props: import('./types').BbDropdownActivatorSlotProps) => any;
+        prepend?: (props: import('./types').BbDropdownEdgeSlotProps) => any;
+        'item:prepend'?: (props: import('./types').BbDropdownItemSlotProps) => any;
+        'item:append'?: (props: import('./types').BbDropdownItemSlotProps) => any;
+        append?: (props: import('./types').BbDropdownEdgeSlotProps) => any;
     } & {
-        [key: string]: (props: {
-            disabled?: MappedItem["disabled"];
-            index: number;
-            item: BbDropdownProps["items"][number];
-            open: boolean;
-            placement: BbDropdownProps["placement"];
-            text: MappedItem["text"];
-        }) => any;
+        [key: string]: (props: import('./types').BbDropdownItemSlotProps) => 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;
-            };
-            disabled?: boolean;
-            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;
-            item: BbDropdownProps["items"][number];
-            open: boolean;
-            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;
-            item: BbDropdownProps["items"][number];
-            open: boolean;
-            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;
-            placement: BbDropdownProps["placement"];
-        }) => any;
+        activator?: (props: import('./types').BbDropdownActivatorSlotProps) => any;
+        prepend?: (props: import('./types').BbDropdownEdgeSlotProps) => any;
+        'item:prepend'?: (props: import('./types').BbDropdownItemSlotProps) => any;
+        'item:append'?: (props: import('./types').BbDropdownItemSlotProps) => any;
+        append?: (props: import('./types').BbDropdownEdgeSlotProps) => any;
     } & {
-        [key: string]: (props: {
-            disabled?: MappedItem["disabled"];
-            index: number;
-            item: BbDropdownProps["items"][number];
-            open: boolean;
-            placement: BbDropdownProps["placement"];
-            text: MappedItem["text"];
-        }) => any;
+        [key: string]: (props: import('./types').BbDropdownItemSlotProps) => any;
     };
     refs: {
         popover: ({
@@ -276,7 +58,7 @@ declare function __VLS_template(): {
             $el: any;
             $options: import('vue').ComponentOptionsBase<Readonly<{
                 modelValue?: boolean;
-            } & Pick<CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
+            } & Pick<import('../../types/CommonProps').CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
                 anchor?: any;
                 boundary?: HTMLElement | Record<string, any> | string | null;
                 dialog?: boolean;
@@ -319,7 +101,7 @@ declare function __VLS_template(): {
             flip: boolean;
         }> & Omit<Readonly<{
             modelValue?: boolean;
-        } & Pick<CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
+        } & Pick<import('../../types/CommonProps').CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
             anchor?: any;
             boundary?: HTMLElement | Record<string, any> | string | null;
             dialog?: boolean;
@@ -329,20 +111,16 @@ declare function __VLS_template(): {
         }> & Readonly<{
             "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
         }>, "transitionDuration" | "padding" | "tag" | "flip"> & import('vue').ShallowUnwrapRef<{}> & {} & import('@vue/runtime-core').ComponentCustomProperties & {} & {
-            $slots: Readonly<{
-                default?: (props: object) => any;
-            }> & {
-                default?: (props: object) => any;
-            };
+            $slots: Readonly<import('../CommonPopover/types').CommonPopoverSlots> & import('../CommonPopover/types').CommonPopoverSlots;
         }) | null;
     };
     rootEl: any;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<BbDropdownProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<BbDropdownProps> & Readonly<{}>, {
-    width: number | string;
     transitionDuration: number;
     theme: string;
+    width: number | string;
     arrowPadding: number;
     offset: number;
     padding: number;
@@ -387,7 +165,7 @@ declare const __VLS_component: import('vue').DefineComponent<BbDropdownProps, {}
         $el: any;
         $options: import('vue').ComponentOptionsBase<Readonly<{
             modelValue?: boolean;
-        } & Pick<CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
+        } & Pick<import('../../types/CommonProps').CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
             anchor?: any;
             boundary?: HTMLElement | Record<string, any> | string | null;
             dialog?: boolean;
@@ -430,7 +208,7 @@ declare const __VLS_component: import('vue').DefineComponent<BbDropdownProps, {}
         flip: boolean;
     }> & Omit<Readonly<{
         modelValue?: boolean;
-    } & Pick<CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
+    } & Pick<import('../../types/CommonProps').CommonProps, "eager" | "transitionDuration" | "arrowPadding" | "offset" | "padding" | "placement"> & {
         anchor?: any;
         boundary?: HTMLElement | Record<string, any> | string | null;
         dialog?: boolean;
@@ -440,11 +218,7 @@ 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: Readonly<{
-            default?: (props: object) => any;
-        }> & {
-            default?: (props: object) => any;
-        };
+        $slots: Readonly<import('../CommonPopover/types').CommonPopoverSlots> & import('../CommonPopover/types').CommonPopoverSlots;
     }) | null;
 }, any>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;

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

@@ -0,0 +1,147 @@
+import { BaseButtonProps } from '../BaseButton/types';
+import { CommonProps } from '../../types/CommonProps';
+import { IconType } from '../../types/Icon';
+export type DropdownTrigger = 'click' | 'contextMenu';
+export type Item = Omit<BaseButtonProps, 'block' | 'tag' | 'type'> & {
+    /**
+     * Click handler of the item.
+     */
+    onClick?: (...args: any[]) => any;
+    /**
+     * Key used to identify the element.
+     */
+    key: string;
+    /**
+     * Icon to be displayed before the text.
+     */
+    'prepend:icon'?: IconType;
+    /**
+     * Icon to be displayed after the text.
+     */
+    'append:icon'?: IconType;
+};
+export type MappedItem = Item & {
+    /**
+     * Identifier of the element among its siblings.
+     */
+    id: string;
+    /**
+     * Keydown event used to handle accessibility.
+     */
+    onKeydown: (event: KeyboardEvent) => void;
+};
+export type BbDropdownProps = Pick<CommonProps, 'arrowPadding' | 'disabled' | 'eager' | 'id' | 'offset' | 'padding' | 'transitionDuration'> & {
+    /**
+     * Position of the dropdown relative to the activator.
+     * Use `'cursor'` to anchor at the mouse/touch coordinates (hides arrow).
+     *
+     * @defaultValue `'bottom'`
+     */
+    placement?: CommonProps['placement'] | 'cursor';
+    /**
+     * External activator element or component ref.
+     * When provided, the activator slot is not rendered and event listeners
+     * are attached programmatically to the referenced element.
+     */
+    activator?: HTMLElement | Record<string, any> | null;
+    /**
+     * Constrains the dropdown within a bounding element.
+     * Accepts an HTMLElement, a Vue component ref, or a CSS selector string.
+     */
+    boundary?: HTMLElement | Record<string, any> | string | null;
+    /**
+     * Array used to render each dropdown button.
+     * They can act as `button`, as `a`, or as `router-link`
+     * as they are based on the functionality provided by `BaseButton`.
+     */
+    items: Item[];
+    /**
+     * Name of the theme to apply to the component. It creates a CSS class with the name of the theme.
+     *
+     * @deprecated since the popover is local you should use a normal css class applied to the top level element
+     * @defaultValue `'default'`
+     */
+    theme?: string;
+    /**
+     * Interaction(s) that open the dropdown.
+     * Accepts a single trigger or an array to combine them.
+     * - `'click'` — left-click / tap (default)
+     * - `'contextMenu'` — right-click on desktop, long-press on mobile
+     *
+     * @defaultValue `'click'`
+     */
+    trigger?: DropdownTrigger | DropdownTrigger[];
+    /**
+     * Width of the dropdown in pixels, percentage, or 'auto' to fit content.
+     *
+     * @defaultValue `'auto'`
+     */
+    width?: number | string;
+};
+/** Props spread onto the activator element to wire up the floating-UI anchor reference. */
+export type BbDropdownActivatorProps = {
+    /** Ref callback to register the activator element. */
+    ref: (reference: unknown) => void;
+};
+/** Props exposed by the `activator` slot. */
+export type BbDropdownActivatorSlotProps = {
+    /** Spread onto the trigger element to wire the floating-UI anchor reference. */
+    props: BbDropdownActivatorProps;
+    /** Whether the dropdown is globally disabled. */
+    disabled?: boolean;
+    /** Whether the dropdown panel is currently open. */
+    open: boolean;
+    /** The current placement of the dropdown panel. */
+    placement: BbDropdownProps['placement'];
+};
+/** Props exposed by the `prepend`, `append` slots. */
+export type BbDropdownEdgeSlotProps = {
+    /** Whether the dropdown is globally disabled. */
+    disabled?: boolean;
+    /** Whether the dropdown panel is currently open. */
+    open: boolean;
+    /** The current placement of the dropdown panel. */
+    placement: BbDropdownProps['placement'];
+};
+/** Props exposed by the `item:prepend` and `item:append` slots, and named item slots. */
+export type BbDropdownItemSlotProps = {
+    /** Whether this item is disabled. */
+    disabled?: MappedItem['disabled'];
+    /** The zero-based index of this item. */
+    index: number;
+    /** The raw item object from the `items` prop. */
+    item: BbDropdownProps['items'][number];
+    /** Whether the dropdown panel is currently open. */
+    open: boolean;
+    /** The current placement of the dropdown panel. */
+    placement: BbDropdownProps['placement'];
+    /** The resolved display text for this item. */
+    text: MappedItem['text'];
+};
+export type BbDropdownSlots = {
+    /**
+     * The element that triggers the dropdown to open. Spread `props` onto your trigger element.
+     */
+    activator?: (props: BbDropdownActivatorSlotProps) => any;
+    /**
+     * Content rendered before the first item in the dropdown panel.
+     */
+    prepend?: (props: BbDropdownEdgeSlotProps) => any;
+    /**
+     * Content rendered before each dropdown item's default button content.
+     */
+    'item:prepend'?: (props: BbDropdownItemSlotProps) => any;
+    /**
+     * Content rendered after each dropdown item's default button content.
+     */
+    'item:append'?: (props: BbDropdownItemSlotProps) => any;
+    /**
+     * Content rendered after the last item in the dropdown panel.
+     */
+    append?: (props: BbDropdownEdgeSlotProps) => any;
+} & {
+    /**
+     * Named slot for a specific item, identified by `item.key`. Replaces the item's default label content.
+     */
+    [key: string]: (props: BbDropdownItemSlotProps) => any;
+};