use-command-palette 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+import { InputHTMLAttributes, RefCallback } from 'react';
+
+interface CommandItem {
+    id: string;
+    label: string;
+    keywords?: string[];
+    group?: string;
+    disabled?: boolean;
+    children?: CommandItem[];
+    [key: string]: unknown;
+}
+interface GroupedItems {
+    group: string | undefined;
+    items: CommandItem[];
+}
+interface UseCommandPaletteOptions {
+    items: CommandItem[];
+    onSelect: (item: CommandItem) => void;
+    filterFn?: (items: CommandItem[], query: string) => CommandItem[] | Promise<CommandItem[]>;
+    defaultOpen?: boolean;
+    /** Pass a value to enable controlled mode; omit for uncontrolled */
+    isOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    hotkey?: string | string[];
+    closeOnSelect?: boolean;
+    animationDuration?: number;
+    recent?: {
+        enabled: boolean;
+        max?: number;
+        storageKey?: string;
+    };
+}
+interface ContainerProps {
+    role: 'dialog';
+    'aria-modal': true;
+    'aria-label': string;
+}
+interface ListProps {
+    role: 'listbox';
+    id: string;
+}
+interface ItemProps {
+    role: 'option';
+    'aria-selected': boolean;
+    'aria-disabled': boolean;
+    onClick: () => void;
+    onMouseEnter: () => void;
+    id: string;
+}
+type InputPropsOverrides = Omit<InputHTMLAttributes<HTMLInputElement>, 'value' | 'onChange' | 'onKeyDown' | 'role' | 'autoComplete' | 'aria-expanded' | 'aria-controls' | 'aria-activedescendant'>;
+interface InputProps extends InputPropsOverrides {
+    ref: RefCallback<HTMLInputElement>;
+    value: string;
+    onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onKeyDown: (e: React.KeyboardEvent<HTMLInputElement>) => void;
+    role: 'combobox';
+    'aria-expanded': boolean;
+    'aria-controls': string;
+    'aria-activedescendant': string | undefined;
+    autoComplete: 'off';
+}
+type AnimationState = 'entering' | 'entered' | 'exiting' | 'exited';
+interface AnnouncerProps {
+    'aria-live': 'polite';
+    'aria-atomic': true;
+    style: React.CSSProperties;
+}
+interface UseCommandPaletteReturn {
+    isOpen: boolean;
+    query: string;
+    highlightedIndex: number;
+    filteredItems: CommandItem[];
+    groupedItems: GroupedItems[];
+    isLoading: boolean;
+    isMounted: boolean;
+    animationState: AnimationState;
+    recentItems: CommandItem[];
+    currentPage: CommandItem | null;
+    breadcrumb: CommandItem[];
+    canGoBack: boolean;
+    announcement: string;
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    setQuery: (query: string) => void;
+    selectItem: (item: CommandItem) => void;
+    highlightIndex: (index: number) => void;
+    goToPage: (item: CommandItem) => void;
+    goBack: () => void;
+    getContainerProps: () => ContainerProps;
+    getListProps: () => ListProps;
+    getItemProps: (args: {
+        index: number;
+        item: CommandItem;
+    }) => ItemProps;
+    getInputProps: (overrides?: InputPropsOverrides) => InputProps;
+    getAnnouncerProps: () => AnnouncerProps;
+}
+
+declare function useCommandPalette({ items, onSelect, filterFn, defaultOpen, isOpen: controlledIsOpen, onOpenChange, hotkey, closeOnSelect, animationDuration, recent, }: UseCommandPaletteOptions): UseCommandPaletteReturn;
+
+declare function useRegisterCommands(commands: CommandItem[], deps: unknown[]): void;
+
+declare function useRegisteredCommands(): {
+    commands: CommandItem[];
+};
+
+type Listener = () => void;
+declare class CommandRegistry {
+    private store;
+    private listeners;
+    register(key: string, commands: CommandItem[]): void;
+    unregister(key: string): void;
+    getAll(): CommandItem[];
+    subscribe(listener: Listener): () => void;
+    private notify;
+}
+declare const registry: CommandRegistry;
+
+/**
+ * Scores how well `query` matches `text` using fuzzy matching.
+ *
+ * Scoring tiers:
+ *  - Exact substring at a word boundary  → highest  (150)
+ *  - Exact substring elsewhere            → high     (100 - small position penalty)
+ *  - Fuzzy (chars in order, not adjacent) → lower    (accumulates per-char points)
+ *
+ * Returns `null` when there is no match at all.
+ */
+declare function fuzzyScore(text: string, query: string): number | null;
+
+export { type AnimationState, type AnnouncerProps, type CommandItem, type ContainerProps, type GroupedItems, type InputProps, type InputPropsOverrides, type ItemProps, type ListProps, type UseCommandPaletteOptions, type UseCommandPaletteReturn, fuzzyScore, registry, useCommandPalette, useRegisterCommands, useRegisteredCommands };