bitboss-ui 2.1.92 → 2.1.94

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

@@ -1,5 +1,69 @@
 import { CommonProps } from '../../types/CommonProps';
-export type BbTabItem = Pick<CommonProps, 'disabled'> & {
+/**
+ * Inertia-specific options shared between `BbTabProps` (component-level defaults)
+ * and `BbTabItem` (per-item overrides). Item values always win over component values.
+ */
+export type BbTabInertiaOptions = {
+    /**
+     * Additional HTTP headers forwarded to Inertia when navigation is triggered.
+     * Only meaningful in an Inertia context.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Limits which server-side props are refreshed during a partial Inertia reload.
+     * Only meaningful in an Inertia context.
+     */
+    only?: string[];
+    /**
+     * Inertia lifecycle hook — fired just before the request is sent.
+     * Return `false` to cancel the visit.
+     */
+    onBefore?: () => boolean | void;
+    /**
+     * Inertia lifecycle hook — fired when the request is cancelled.
+     */
+    onCancel?: () => void;
+    /**
+     * Inertia lifecycle hook — fired after the visit finishes (success or error).
+     */
+    onFinish?: () => void;
+    /**
+     * Inertia lifecycle hook — fired when the server returns validation errors.
+     */
+    onError?: (errors: Record<string, string>) => void;
+    /**
+     * Inertia lifecycle hook — fired when upload/download progress is available.
+     */
+    onProgress?: (progress: {
+        percentage: number | undefined;
+    }) => void;
+    /**
+     * Inertia lifecycle hook — fired when the request starts.
+     */
+    onStart?: () => void;
+    /**
+     * Inertia lifecycle hook — fired when the visit completes successfully.
+     */
+    onSuccess?: () => void;
+    /**
+     * Controls whether Inertia preserves the scroll position after navigation.
+     * Only meaningful in an Inertia context.
+     */
+    preserveScroll?: boolean | ((props: Record<string, unknown>) => boolean);
+    /**
+     * Controls whether Inertia preserves the current component state after navigation.
+     * Only meaningful in an Inertia context.
+     */
+    preserveState?: boolean | ((props: Record<string, unknown>) => boolean) | null;
+    /**
+     * Uses history replacement instead of push navigation.
+     */
+    replace?: boolean;
+};
+export type BbTabEvents = {
+    (e: 'update:modelValue', value: string): void;
+};
+export type BbTabItem<K extends string = string> = Pick<CommonProps, 'disabled'> & BbTabInertiaOptions & {
     /**
      * Used to render a tab even when not visible.
      * It's useful if you want the content of a tab in the DOM
@@ -7,16 +71,28 @@ export type BbTabItem = Pick<CommonProps, 'disabled'> & {
      * even when not visible for SEO purposes.
      */
     eager?: boolean;
+    /**
+     * Destination URL for this tab. In an Inertia context the tab button renders
+     * as an Inertia Link that navigates to this URL on click.
+     */
+    href?: string;
     /**
      * String that identifies the tab.
      */
-    key: string;
+    key: K;
     /**
      * Label to use as the tab text.
      */
     label?: string;
+    /**
+     * When true and in an Inertia context, triggers a real server-side Inertia
+     * visit (via `router.visit`) instead of a client-only `history.pushState`.
+     * All other Inertia options (`headers`, `only`, `preserveScroll`, etc.) and
+     * lifecycle hooks are forwarded to that visit.
+     */
+    server?: boolean;
 };
-export type BbTabProps = Pick<CommonProps, 'disabled' | 'eager' | 'id'> & {
+export type BbTabProps<K extends string = string> = Pick<CommonProps, 'disabled' | 'eager' | 'id'> & BbTabInertiaOptions & {
     /**
      * Enables transitions vertically
      */
@@ -32,11 +108,11 @@ export type BbTabProps = Pick<CommonProps, 'disabled' | 'eager' | 'id'> & {
     /**
      * Array of items that define the tabs in the component.
      */
-    items: BbTabItem[];
+    items: BbTabItem<K>[];
     /**
      * The current tab. Used by v-model.
      */
-    modelValue?: null | BbTabItem['key'];
+    modelValue?: null | BbTabItem<K>['key'];
     /**
      * Synchronizes the current tab with the url.
      */
@@ -49,34 +125,26 @@ export type BbTabProps = Pick<CommonProps, 'disabled' | 'eager' | 'id'> & {
      * Replaces history rather than pushing it when changing tab.
      */
     replace?: boolean;
+    /**
+     * When true and in an Inertia context, triggers a real server-side Inertia
+     * visit (via `router.visit`) instead of a client-only `history.pushState`.
+     * All other Inertia options (`headers`, `only`, `preserveScroll`, etc.) and
+     * lifecycle hooks are forwarded to that visit.
+     */
+    server?: boolean;
 };
-declare const props: Readonly<{
-    id: import('vue').HTMLAttributes["id"];
-    disabled: boolean;
-    eager: boolean;
-    items: BbTabItem[];
-    modelValue: null | BbTabItem["key"];
-    navigation: boolean;
-    replace: boolean;
-}> & {
-    readonly animateX: boolean;
-    readonly animateY: boolean;
-    readonly direction: "horizontal" | "vertical";
-    readonly querykey: string;
-} & {
-    readonly replace: boolean;
-    readonly disabled: boolean;
-    readonly eager: boolean;
-    readonly navigation: boolean;
-    readonly animateX: boolean;
-    readonly animateY: boolean;
-};
-export type BbTabEvents = {
-    (e: 'update:modelValue', value: (typeof props.items)[number]['key']): void;
-};
-declare const goTo: (target: "first" | "previous" | "next" | "last") => void;
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
+declare const _default: <K extends string = string>(__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 "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onUpdate:modelValue"> & BbTabProps<K> & Partial<{}>> & import('vue').PublicProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{
+        isFirst: import('vue').ComputedRef<boolean>;
+        isLast: import('vue').ComputedRef<boolean>;
+        current: [K | null] extends [import('vue').Ref<any, any>] ? import('@vue/shared').IfAny<import('vue').Ref<any, any> & K, import('vue').Ref<import('vue').Ref<any, any> & K, import('vue').Ref<any, any> & K>, import('vue').Ref<any, any> & K> : import('vue').Ref<import('vue').UnwrapRef<K> | null, K | import('vue').UnwrapRef<K> | null>;
+        currentIndex: import('vue').ComputedRef<number>;
+        goTo: (target: "first" | "previous" | "next" | "last") => void;
+    }>): void;
+    attrs: any;
     slots: Readonly<{
         'header:prepend'?: (props: {
             isScrolling: boolean;
@@ -97,21 +165,19 @@ declare function __VLS_template(): {
             selected: boolean;
             text: BbTabItem["label"];
             value: string;
-            goTo: typeof goTo;
-        }) => any;
-    } & {
-        [key: string]: (props: {
-            current: string | null;
-            currentIndex: number;
-            disabled: boolean;
-            isFirst: boolean;
-            isLast: boolean;
-            selected: boolean;
-            text: BbTabItem["label"];
-            value: string;
-            goTo: typeof goTo;
+            goTo: (target: "first" | "previous" | "next" | "last") => void;
         }) => any;
-    }> & {
+    } & Partial<Record<K | `label-${K}`, (props: {
+        current: string | null;
+        currentIndex: number;
+        disabled: boolean;
+        isFirst: boolean;
+        isLast: boolean;
+        selected: boolean;
+        text: BbTabItem["label"];
+        value: string;
+        goTo: (target: "first" | "previous" | "next" | "last") => void;
+    }) => any>>> & {
         'header:prepend'?: (props: {
             isScrolling: boolean;
             left: boolean;
@@ -131,51 +197,24 @@ declare function __VLS_template(): {
             selected: boolean;
             text: BbTabItem["label"];
             value: string;
-            goTo: typeof goTo;
-        }) => any;
-    } & {
-        [key: string]: (props: {
-            current: string | null;
-            currentIndex: number;
-            disabled: boolean;
-            isFirst: boolean;
-            isLast: boolean;
-            selected: boolean;
-            text: BbTabItem["label"];
-            value: string;
-            goTo: typeof goTo;
+            goTo: (target: "first" | "previous" | "next" | "last") => void;
         }) => any;
-    };
-    refs: {
-        tabs: HTMLDivElement;
-        tablist: HTMLUListElement;
-    };
-    rootEl: HTMLDivElement;
+    } & Partial<Record<K | `label-${K}`, (props: {
+        current: string | null;
+        currentIndex: number;
+        disabled: boolean;
+        isFirst: boolean;
+        isLast: boolean;
+        selected: boolean;
+        text: BbTabItem["label"];
+        value: string;
+        goTo: (target: "first" | "previous" | "next" | "last") => void;
+    }) => any>>;
+    emit: BbTabEvents;
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<BbTabProps, {
-    isFirst: import('vue').ComputedRef<boolean>;
-    isLast: import('vue').ComputedRef<boolean>;
-    current: import('vue').Ref<string | null, string | null>;
-    currentIndex: import('vue').ComputedRef<number>;
-    goTo: (target: "first" | "previous" | "next" | "last") => void;
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
-    "update:modelValue": (value: string) => any;
-}, string, import('vue').PublicProps, Readonly<BbTabProps> & Readonly<{
-    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
-}>, {
-    direction: "horizontal" | "vertical";
-    querykey: string;
-    animateX: boolean;
-    animateY: boolean;
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
-    tabs: HTMLDivElement;
-    tablist: HTMLUListElement;
-}, HTMLDivElement>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/composables/useQuery.d.ts

@@ -0,0 +1,15 @@
+export type QueryArrayFormat = 'comma' | 'repeat' | 'bracket';
+export type QueryValue = string | string[];
+export interface UseQueryOptions {
+    arrayFormat?: QueryArrayFormat;
+}
+/**
+ * Parses a query string into a plain object.
+ * Supports repeated keys, comma arrays and bracket notation arrays.
+ */
+export declare const parseQueryString: (queryString: string, { arrayFormat }?: UseQueryOptions) => Record<string, QueryValue>;
+/**
+ * Returns the query object from the active runtime context.
+ * Uses Inertia page url when available, otherwise falls back to browser location.
+ */
+export declare const useQuery: (options?: UseQueryOptions) => Record<string, QueryValue>;