bitboss-ui 2.1.95 → 2.1.97

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

@@ -64,6 +64,12 @@ export type BaseSelectProps<Item> = {
      * @default () => []
      */
     filterBy?: string | string[] | false | 'not_stashed' | ((value: any, item: any, query: string | null) => boolean) | null;
+    groupBy?: string | ((item: Item) => string | number | symbol);
+    /**
+     * Height of group headers in the listbox (px). Defaults to 24px (compact) or 32px.
+     * Only applies when `groupBy` is set.
+     */
+    headerHeight?: number;
     /**
      * Apply error styling to the select.
      */
@@ -239,6 +245,13 @@ export type BaseSelectSlots<Item> = {
         text: string;
         value: any;
     }) => any;
+    group?: (props: {
+        text: string;
+        item: Item;
+        index: number;
+        length: number;
+        disabled: boolean;
+    }) => any;
     'options:append'?: (props: {
         focus: () => void;
     }) => any;

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

@@ -71,6 +71,10 @@ export type BbSelectProps<T> = {
      *
      */
     filterBy?: string | string[] | false | 'not_stashed' | ((value: any, item: T, query: string | null) => boolean) | null;
+    /**
+     * Path to item property for grouping options.
+     */
+    groupBy?: string | ((item: T) => string | number | symbol);
     /**
      * Define if the component should be in an error state.
      * It usually attaches a CSS class for styling purposes.
@@ -92,6 +96,11 @@ export type BbSelectProps<T> = {
      * Used to retrieve items can be an array or a function.
      */
     items: T[] | ((query: string, prefill: boolean, modelValue: any) => Promise<T[]>) | ((query: string, prefill: boolean, modelValue: any) => T[]);
+    /**
+     * Height of group headers in the listbox (px). Defaults to 24px (compact) or 32px.
+     * Only applies when `groupBy` is set.
+     */
+    headerHeight?: number;
     /**
      * Height of the options in the listbox. By default it will be 32px for the compact variant and 40px for the regular variant.
      * If you want to set a custom height you can pass a number in pixels. Existence of this value is necessary for the options to be virtualized.
@@ -244,6 +253,13 @@ export type BbSelectSlots<T> = {
         text: string;
         value: any;
     }) => any;
+    group?: (props: {
+        text: string;
+        item: T;
+        index: number;
+        length: number;
+        disabled: boolean;
+    }) => any;
     'options:append'?: (props: {
         focus: () => void;
     }) => any;

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

@@ -0,0 +1,56 @@
+import { Option } from '../types/Option';
+declare const _default: <Item = 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<Pick<Partial<{}> & Omit<{
+        readonly "onOption:unselected"?: ((option: Option) => any) | undefined;
+        readonly "onOption:selected"?: ((option: Option) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onOption:unselected" | "onOption:selected"> & {
+        /**
+         * Sets the listbox in a compact state.
+         */
+        compact?: boolean;
+        options: Option<Item>[];
+        open?: boolean;
+        loading?: boolean;
+        multiple?: boolean;
+        transitionDuration?: number;
+        loadingText?: string;
+        noDataText?: string;
+        optionHeight?: number;
+    } & Partial<{}>> & import('vue').PublicProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{
+        focusNext: () => void;
+        focusPrevious: () => void;
+        focusFirst: () => void;
+        focusFirstSelected: () => void;
+        focusLast: () => void;
+        focusLastSelected: () => void;
+        blur: () => void;
+        confirmOption: () => void;
+        focusByHash: (hash: Option["valueHash"]) => void;
+        getHighlighted: () => Option | undefined;
+    }>): void;
+    attrs: any;
+    slots: Partial<Record<"loading", (_: {}) => any>> & Partial<Record<"no-data", (_: {}) => any>> & {
+        'options:prepend'?(_: {}): any;
+        option?(_: {
+            disabled: boolean;
+            focused: boolean;
+            index: number;
+            item: Item;
+            selected: boolean;
+            text: string;
+            value: any;
+        }): any;
+        'options:append'?(_: {}): any;
+    };
+    emit: {
+        (e: "option:selected", option: Option): void;
+        (e: "option:unselected", option: Option): void;
+    };
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

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

@@ -0,0 +1,67 @@
+import { GroupedOptions, Option } from '../types/Option';
+declare const _default: <Item = 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<Pick<Partial<{}> & Omit<{
+        readonly "onOption:unselected"?: ((option: Option) => any) | undefined;
+        readonly "onOption:selected"?: ((option: Option) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onOption:unselected" | "onOption:selected"> & {
+        /**
+         * Sets the listbox in a compact state.
+         */
+        compact?: boolean;
+        groups: GroupedOptions[];
+        /**
+         * Height of group headers (px). Defaults to 24px (compact) or 32px.
+         */
+        headerHeight?: number;
+        loading?: boolean;
+        loadingText?: string;
+        multiple?: boolean;
+        noDataText?: string;
+        open?: boolean;
+        optionHeight?: number;
+        transitionDuration?: number;
+    } & Partial<{}>> & import('vue').PublicProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{
+        focusNext: () => void;
+        focusPrevious: () => void;
+        focusFirst: () => void;
+        focusFirstSelected: () => void;
+        focusLast: () => void;
+        focusLastSelected: () => void;
+        blur: () => void;
+        confirmOption: () => void;
+        focusByHash: (hash: Option["valueHash"]) => void;
+        getHighlighted: () => Option | undefined;
+    }>): void;
+    attrs: any;
+    slots: Partial<Record<"loading", (_: {}) => any>> & Partial<Record<"no-data", (_: {}) => any>> & {
+        'options:prepend'?(_: {}): any;
+        group?(_: {
+            text: string;
+            item: any;
+            index: number;
+            length: number;
+            disabled: boolean;
+        }): any;
+        option?(_: {
+            disabled: boolean;
+            focused: boolean;
+            index: number;
+            item: any;
+            selected: boolean;
+            text: string;
+            value: any;
+        }): any;
+        'options:append'?(_: {}): any;
+    };
+    emit: {
+        (e: "option:selected", option: Option): void;
+        (e: "option:unselected", option: Option): void;
+    };
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

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

@@ -1,14 +1,34 @@
-import { Option } from '../types/Option';
+import { GroupedOptions, Option } from '../types/Option';
+export type ListBoxExposed = {
+    focusNext: () => void;
+    focusPrevious: () => void;
+    focusFirst: () => void;
+    focusFirstSelected: () => void;
+    focusLast: () => void;
+    focusLastSelected: () => void;
+    blur: () => void;
+    confirmOption: () => void;
+    focusByHash: (hash: Option['valueHash']) => void;
+    getHighlighted: () => Option | undefined;
+};
 declare const _default: <Item = 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<Pick<Partial<{}> & Omit<{
         readonly "onOption:unselected"?: ((option: Option) => any) | undefined;
         readonly "onOption:selected"?: ((option: Option) => any) | undefined;
     } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onOption:unselected" | "onOption:selected"> & {
+        compact?: boolean;
         /**
-         * Sets the listbox in a compact state.
+         * Flat option list. Used when `groups` is not provided.
          */
-        compact?: boolean;
-        options: Option<Item>[];
+        options?: Option<Item>[];
+        /**
+         * Grouped option list. When provided, the grouped listbox is rendered.
+         */
+        groups?: GroupedOptions[];
+        /**
+         * Height of group headers in the listbox (px).
+         */
+        headerHeight?: number;
         open?: boolean;
         loading?: boolean;
         multiple?: boolean;
@@ -18,20 +38,36 @@ declare const _default: <Item = any>(__VLS_props: NonNullable<Awaited<typeof __V
         optionHeight?: number;
     } & Partial<{}>> & import('vue').PublicProps;
     expose(exposed: import('vue').ShallowUnwrapRef<{
-        focusNext: () => void;
-        focusPrevious: () => Promise<void>;
-        focusFirst: () => void;
-        focusFirstSelected: () => void;
-        focusLast: () => void;
-        focusLastSelected: () => void;
-        blur: () => void;
-        confirmOption: () => void;
-        focusByHash: (hash: Option["valueHash"]) => void;
-        getHighlighted: () => Option<Item> | undefined;
+        focusNext: () => void | undefined;
+        focusPrevious: () => void | undefined;
+        focusFirst: () => void | undefined;
+        focusFirstSelected: () => void | undefined;
+        focusLast: () => void | undefined;
+        focusLastSelected: () => void | undefined;
+        blur: () => void | undefined;
+        confirmOption: () => void | undefined;
+        focusByHash: (hash: Option["valueHash"]) => void | undefined;
+        getHighlighted: () => Option | undefined;
     }>): void;
     attrs: any;
-    slots: Partial<Record<"loading", (_: {}) => any>> & Partial<Record<"no-data", (_: {}) => any>> & {
+    slots: {
+        'options:prepend'?(_: {}): any;
         'options:prepend'?(_: {}): any;
+        loading?(_: {}): any;
+        loading?(_: {}): any;
+        'no-data'?(_: {}): any;
+        'no-data'?(_: {}): any;
+        'options:append'?(_: {}): any;
+        'options:append'?(_: {}): any;
+        option?(_: {
+            disabled: boolean;
+            focused: boolean;
+            index: number;
+            item: any;
+            selected: boolean;
+            text: string;
+            value: any;
+        }): any;
         option?(_: {
             disabled: boolean;
             focused: boolean;
@@ -41,7 +77,13 @@ declare const _default: <Item = any>(__VLS_props: NonNullable<Awaited<typeof __V
             text: string;
             value: any;
         }): any;
-        'options:append'?(_: {}): any;
+        group?(_: {
+            text: string;
+            item: any;
+            index: number;
+            length: number;
+            disabled: boolean;
+        }): any;
     };
     emit: {
         (e: "option:selected", option: Option): void;

package/dist/composables/useListboxFocus.d.ts

@@ -0,0 +1,19 @@
+import { MaybeRefOrGetter } from 'vue';
+import { Option } from '../types/Option';
+interface UseListboxFocusOptions {
+    disabled?: MaybeRefOrGetter<boolean>;
+}
+export declare function useListboxFocus(options: MaybeRefOrGetter<Option[]>, { disabled }?: UseListboxFocusOptions): {
+    focusedIndex: import('vue').Ref<number | null, number | null>;
+    canFocus: import('vue').ComputedRef<boolean>;
+    focusNext: () => void;
+    focusPrevious: () => void;
+    focusFirst: () => void;
+    focusLast: () => void;
+    focusFirstSelected: () => void;
+    focusLastSelected: () => void;
+    focusByHash: (hash: Option["valueHash"]) => void;
+    blur: () => void;
+    getHighlighted: () => Option | undefined;
+};
+export {};