@choice-ui/command 0.0.3 → 0.0.4

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as _choice_ui_tabs from '@choice-ui/tabs';
 import * as react from 'react';
 import react__default, { HTMLProps, ReactNode } from 'react';
-import { InputProps } from '@choice-ui/input';
+import { TextFieldProps } from '@choice-ui/text-field';
 import { KbdKey } from '@choice-ui/kbd';
 import { ScrollAreaProps } from '@choice-ui/scroll-area';
 
@@ -10,12 +10,27 @@ interface CommandEmptyProps extends HTMLProps<HTMLDivElement> {
 }
 
 interface CommandGroupProps extends HTMLProps<HTMLDivElement> {
+    /**
+     * Whether to force mount the group.
+     * @default false
+     */
     forceMount?: boolean;
+    /**
+     * The heading of the group.
+     */
     heading?: react__default.ReactNode;
+    /**
+     * The value of the group.
+     */
     value?: string;
+    /**
+     * Whether the group is hidden.
+     * @default false
+     */
+    hidden?: boolean;
 }
 
-interface CommandInputProps extends Omit<InputProps, "value" | "onChange" | "type"> {
+interface CommandInputProps extends Omit<TextFieldProps, "value" | "onChange" | "type"> {
     onChange?: (search: string) => void;
     prefixElement?: ReactNode;
     suffixElement?: ReactNode;
@@ -43,12 +58,23 @@ interface CommandListProps extends ScrollAreaProps {
 }
 
 interface CommandLoadingProps extends react__default.HTMLAttributes<HTMLDivElement> {
+    /**
+     * The label of the loading.
+     * @default "Loading..."
+     */
     label?: string;
+    /**
+     * The progress of the loading.
+     * @default undefined
+     */
     progress?: number;
 }
 
 interface CommandDividerProps extends HTMLProps<HTMLDivElement> {
-    /** 是否始终渲染此分隔符。当禁用自动过滤功能时特别有用。 */
+    /**
+     * Whether to always render this divider. Useful when automatic filtering is disabled.
+     * @default false
+     */
     alwaysRender?: boolean;
 }
 
@@ -85,17 +111,40 @@ interface CommandProps extends Omit<react__default.HTMLAttributes<HTMLDivElement
      * If `false`, you must conditionally render valid items based on the search query yourself.
      */
     shouldFilter?: boolean;
+    /**
+     * The size of the command menu.
+     * @default "default"
+     */
     size?: "default" | "large";
     /**
      * Optional controlled state of the selected command menu item.
      */
     value?: string;
+    /**
+     * The variant of the command menu.
+     * @default "default"
+     */
     variant?: "default" | "dark";
     /**
      * Set to `false` to disable ctrl+n/j/p/k shortcuts. Defaults to `true`.
      */
     vimBindings?: boolean;
 }
+type Context = {
+    filter: () => boolean;
+    getDisablePointerSelection: () => boolean;
+    group: (id: string) => () => void;
+    inputId: string;
+    item: (id: string, groupId?: string) => () => void;
+    label?: string;
+    labelId: string;
+    listId: string;
+    listInnerRef: react__default.MutableRefObject<HTMLDivElement | null>;
+    size?: "default" | "large";
+    store: Store;
+    value: (id: string, value?: string, keywords?: string[]) => void;
+    variant?: "default" | "dark";
+};
 type State = {
     filtered: {
         count: number;
@@ -106,19 +155,31 @@ type State = {
     selectedItemId?: string;
     value: string;
 };
+type Store = {
+    emit: () => void;
+    setState: <K extends keyof State>(key: K, value: State[K], opts?: unknown) => void;
+    snapshot: () => State;
+    subscribe: (callback: () => void) => () => void;
+};
 
 declare const defaultFilter: CommandFilter;
 declare const Command$1: react__default.ForwardRefExoticComponent<CommandProps & react__default.RefAttributes<HTMLDivElement>>;
 
+declare const useCommand: () => Context;
+
 /** Run a selector against the store state. */
 declare function useCommandState<T>(selector: (state: State) => T): T;
 
+declare function useValue(id: string, ref: react__default.RefObject<HTMLElement>, deps: (string | react__default.ReactNode | react__default.RefObject<HTMLElement>)[], aliases?: string[]): react__default.MutableRefObject<string | undefined>;
+
+declare function commandScore(string: string, abbreviation: string, aliases?: string[]): number;
+
 declare const Command: react.ForwardRefExoticComponent<CommandProps & react.RefAttributes<HTMLDivElement>> & {
     Empty: react.ForwardRefExoticComponent<Omit<CommandEmptyProps, "ref"> & react.RefAttributes<HTMLDivElement>>;
     Footer: react.ForwardRefExoticComponent<Omit<react.HTMLProps<HTMLDivElement>, "ref"> & react.RefAttributes<HTMLDivElement>>;
-    Group: react.ForwardRefExoticComponent<Omit<CommandGroupProps, "ref"> & react.RefAttributes<HTMLDivElement>>;
+    Group: react.MemoExoticComponent<react.ForwardRefExoticComponent<Omit<CommandGroupProps, "ref"> & react.RefAttributes<HTMLDivElement>>>;
     Input: react.ForwardRefExoticComponent<Omit<CommandInputProps, "ref"> & react.RefAttributes<HTMLInputElement>>;
-    Item: react.ForwardRefExoticComponent<Omit<CommandItemProps, "ref"> & react.RefAttributes<HTMLDivElement>>;
+    Item: react.MemoExoticComponent<react.ForwardRefExoticComponent<Omit<CommandItemProps, "ref"> & react.RefAttributes<HTMLDivElement>>>;
     List: react.ForwardRefExoticComponent<CommandListProps & react.RefAttributes<HTMLDivElement>>;
     Loading: react.ForwardRefExoticComponent<CommandLoadingProps & react.RefAttributes<HTMLDivElement>>;
     Divider: react.ForwardRefExoticComponent<Omit<CommandDividerProps, "ref"> & react.RefAttributes<HTMLDivElement>>;
@@ -127,4 +188,4 @@ declare const Command: react.ForwardRefExoticComponent<CommandProps & react.RefA
     TabItem: react.MemoExoticComponent<react.ForwardRefExoticComponent<Omit<_choice_ui_tabs.TabItemProps, "ref"> & react.RefAttributes<HTMLElement>>>;
 };
 
-export { Command, Command$1 as CommandRoot, defaultFilter, useCommandState };
+export { Command, type CommandDividerProps, type CommandGroupProps, type CommandInputProps, type CommandItemProps, type CommandListProps, type CommandLoadingProps, type CommandProps, Command$1 as CommandRoot, commandScore, defaultFilter, useCommand, useCommandState, useValue };