@bazza-ui/react 0.1.0-canary.15 → 0.1.0-canary.17

package/dist/use-listbox-item-NzZuY34-.d.ts

@@ -1,212 +0,0 @@
-import * as React from 'react';
-
-interface GroupPositional {
-    first?: boolean;
-    last?: boolean;
-    firstInGroup?: boolean;
-    lastInGroup?: boolean;
-    firstGroup?: boolean;
-    lastGroup?: boolean;
-}
-interface GroupContextValue {
-    groupId?: string;
-    positional?: GroupPositional;
-}
-declare const GroupContext: React.Context<GroupContextValue | null>;
-declare function useGroupContext(): GroupContextValue | null;
-
-interface ItemContextValue {
-    /** Unique ID for this item (for DOM id attribute) */
-    id: string;
-    /** Whether the item is highlighted */
-    highlighted: boolean;
-    /** Whether the item is disabled */
-    disabled: boolean;
-    /** Keyboard shortcut for this item */
-    shortcut?: string;
-}
-declare const ItemContext: React.Context<ItemContextValue | null>;
-declare function useItemContext(): ItemContextValue;
-declare function useMaybeItemContext(): ItemContextValue | null;
-
-/**
- * Aim guard refs for submenu navigation.
- * Optional - only needed for popup menus with submenus.
- */
-interface AimGuardRefs {
-    /** Whether aim guard is currently active */
-    aimGuardActiveRef: React.RefObject<boolean>;
-    /** The depth at which aim guard is active (null when not guarding) */
-    guardedDepthRef: React.RefObject<number | null>;
-}
-/**
- * Parameters for the useListboxItem hook.
- */
-interface UseListboxItemParams {
-    /**
-     * Explicit unique identifier for this item in the store.
-     * Takes highest priority for item registration.
-     * Used by data-first APIs to ensure consistent IDs.
-     */
-    id?: string;
-    /**
-     * Unique value for this item used as identifier and for filtering.
-     * If not provided, will be inferred from textContent.
-     * Used for registration when `id` is not provided.
-     */
-    value?: string;
-    /**
-     * Additional keywords to match against when filtering.
-     * Useful for aliases or synonyms.
-     */
-    keywords?: string[];
-    /**
-     * Whether this item is disabled.
-     * Disabled items are not selectable and are skipped during keyboard navigation.
-     */
-    disabled?: boolean;
-    /**
-     * Whether this item can be activated via Enter or click.
-     * Non-activatable items remain highlightable.
-     * @default true
-     */
-    activatable?: boolean;
-    /**
-     * Whether to force render this item regardless of filter results.
-     * @default false
-     */
-    forceMount?: boolean;
-    /**
-     * Keyboard shortcut to trigger this item.
-     * When the menu is focused and the user presses this key, the item will be selected.
-     * Should be a single character (e.g., "1", "a", etc.).
-     */
-    shortcut?: string;
-    /**
-     * Forces this row's relative order during score-based sorting.
-     * Lower values appear earlier.
-     * @default 0
-     */
-    forceOrder?: number;
-    /**
-     * Overrides this row's computed fuzzy-match score.
-     * Useful for pinning or manually ranking rows in score-based views.
-     */
-    forceScore?: number;
-    /**
-     * Whether this item is a submenu trigger (for store registration).
-     * @default false
-     */
-    isSubmenuTrigger?: boolean;
-    /**
-     * Callback when this item is selected (via click or Enter key).
-     * For simple items, pass this directly. For checkbox/radio items,
-     * use registerSelect() to register a dynamic handler.
-     */
-    onSelect?: () => void;
-    /**
-     * Whether selecting this item should close the menu.
-     * @default true
-     */
-    closeOnClick?: boolean;
-    /**
-     * Callback invoked after selection occurs (via click).
-     * Called with the item's ID. The consumer handles any
-     * post-selection behavior like closing menus.
-     */
-    onAfterSelect?: (itemId: string) => void;
-    /**
-     * Children (used for text content inference when value is not provided).
-     */
-    children?: React.ReactNode;
-    /**
-     * Optional aim guard refs for popup menu navigation.
-     * When provided, pointer move events will respect the aim guard.
-     */
-    aimGuard?: AimGuardRefs;
-}
-/**
- * Return value from the useListboxItem hook.
- */
-interface UseListboxItemReturn {
-    /** Unique ID for this item (DOM ID for aria-activedescendant) */
-    id: string;
-    /**
-     * Store identifier for this item.
-     * Use this when calling store methods like setHighlightedId, registerSubmenuOpen, etc.
-     * This is the `value` prop (or inferred from textContent).
-     */
-    storeId: string;
-    /** Ref to attach to the item element */
-    ref: React.RefObject<HTMLDivElement | null>;
-    /** Callback ref that tracks the mounted row element for positional attributes. Merge into the rendered element's ref. */
-    rowRef: (element: HTMLElement | null) => void;
-    /** Positional state among visible rows (all false in virtualized mode). */
-    positional: {
-        first: boolean;
-        last: boolean;
-        firstInGroup: boolean;
-        lastInGroup: boolean;
-    };
-    /** Whether item is currently highlighted */
-    isHighlighted: boolean;
-    /** Whether item should be rendered (passes filter) */
-    isVisible: boolean;
-    /** Context value to provide to children via ItemContext.Provider */
-    contextValue: ItemContextValue;
-    /**
-     * Event handlers to spread on the element.
-     * These handle click, pointer move, and pointer down events.
-     */
-    handlers: {
-        onClick: React.MouseEventHandler<HTMLDivElement>;
-        onPointerMove: React.PointerEventHandler<HTMLDivElement>;
-        onPointerDown: React.PointerEventHandler<HTMLDivElement>;
-    };
-    /**
-     * Register a custom onSelect handler.
-     * This is useful for checkbox/radio items where the select behavior
-     * needs to be customized (e.g., toggle checked state).
-     * Returns an unregister function.
-     */
-    registerSelect: (handler: (() => void) | undefined) => () => void;
-}
-/**
- * Hook that provides all shared logic for navigatable/highlightable listbox items.
- *
- * This hook handles:
- * - Item registration with the listbox store
- * - Highlight state management (keyboard and pointer)
- * - Filter/search visibility
- * - Scroll into view on keyboard navigation
- * - Click, pointer move, and pointer down event handlers
- * - Optional aim guard integration (for submenu navigation)
- *
- * @example
- * ```tsx
- * function CustomItem(props) {
- *   const item = useListboxItem({
- *     value: props.value,
- *     disabled: props.disabled,
- *     onSelect: props.onSelect,
- *   })
- *
- *   if (!item.isVisible) return null
- *
- *   return (
- *     <ItemContext.Provider value={item.contextValue}>
- *       <div
- *         ref={item.ref}
- *         {...item.handlers}
- *         data-highlighted={item.isHighlighted || undefined}
- *       >
- *         {props.children}
- *       </div>
- *     </ItemContext.Provider>
- *   )
- * }
- * ```
- */
-declare function useListboxItem(params: UseListboxItemParams): UseListboxItemReturn;
-
-export { type AimGuardRefs as A, type GroupContextValue as G, type ItemContextValue as I, type UseListboxItemParams as U, useMaybeItemContext as a, type GroupPositional as b, GroupContext as c, useGroupContext as d, ItemContext as e, type UseListboxItemReturn as f, useListboxItem as g, useItemContext as u };