@choice-ui/command 0.0.3

package/dist/index.d.cts

@@ -0,0 +1,130 @@
+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 { KbdKey } from '@choice-ui/kbd';
+import { ScrollAreaProps } from '@choice-ui/scroll-area';
+
+interface CommandEmptyProps extends HTMLProps<HTMLDivElement> {
+    className?: string;
+}
+
+interface CommandGroupProps extends HTMLProps<HTMLDivElement> {
+    forceMount?: boolean;
+    heading?: react__default.ReactNode;
+    value?: string;
+}
+
+interface CommandInputProps extends Omit<InputProps, "value" | "onChange" | "type"> {
+    onChange?: (search: string) => void;
+    prefixElement?: ReactNode;
+    suffixElement?: ReactNode;
+    value?: string;
+}
+
+interface CommandItemProps extends Omit<HTMLProps<HTMLDivElement>, "onSelect"> {
+    disabled?: boolean;
+    forceMount?: boolean;
+    keywords?: string[];
+    onSelect?: (value: string) => void;
+    prefixElement?: ReactNode;
+    shortcut?: {
+        keys?: ReactNode;
+        modifier?: KbdKey | KbdKey[] | undefined;
+    };
+    suffixElement?: ReactNode;
+    value?: string;
+}
+
+interface CommandListProps extends ScrollAreaProps {
+    children: React.ReactNode;
+    className?: string;
+    label?: string;
+}
+
+interface CommandLoadingProps extends react__default.HTMLAttributes<HTMLDivElement> {
+    label?: string;
+    progress?: number;
+}
+
+interface CommandDividerProps extends HTMLProps<HTMLDivElement> {
+    /** 是否始终渲染此分隔符。当禁用自动过滤功能时特别有用。 */
+    alwaysRender?: boolean;
+}
+
+type CommandFilter = (value: string, search: string, keywords?: string[]) => number;
+interface CommandProps extends Omit<react__default.HTMLAttributes<HTMLDivElement>, "onChange"> {
+    /**
+     * Optional default item value when it is initially rendered.
+     */
+    defaultValue?: string;
+    /**
+     * Optionally set to `true` to disable selection via pointer events.
+     */
+    disablePointerSelection?: boolean;
+    /**
+     * Custom filter function for whether each command menu item should matches the given search query.
+     * It should return a number between 0 and 1, with 1 being the best match and 0 being hidden entirely.
+     * By default, uses the `command-score` library.
+     */
+    filter?: CommandFilter;
+    /**
+     * Accessible label for this command menu. Not shown visibly.
+     */
+    label?: string;
+    /**
+     * Optionally set to `true` to turn on looping around when using the arrow keys.
+     */
+    loop?: boolean;
+    /**
+     * Event handler called when the selected item of the menu changes.
+     */
+    onChange?: (value: string) => void;
+    /**
+     * Optionally set to `false` to turn off the automatic filtering and sorting.
+     * If `false`, you must conditionally render valid items based on the search query yourself.
+     */
+    shouldFilter?: boolean;
+    size?: "default" | "large";
+    /**
+     * Optional controlled state of the selected command menu item.
+     */
+    value?: string;
+    variant?: "default" | "dark";
+    /**
+     * Set to `false` to disable ctrl+n/j/p/k shortcuts. Defaults to `true`.
+     */
+    vimBindings?: boolean;
+}
+type State = {
+    filtered: {
+        count: number;
+        groups: Set<string>;
+        items: Map<string, number>;
+    };
+    search: string;
+    selectedItemId?: string;
+    value: string;
+};
+
+declare const defaultFilter: CommandFilter;
+declare const Command$1: react__default.ForwardRefExoticComponent<CommandProps & react__default.RefAttributes<HTMLDivElement>>;
+
+/** Run a selector against the store state. */
+declare function useCommandState<T>(selector: (state: State) => T): T;
+
+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>>;
+    Input: react.ForwardRefExoticComponent<Omit<CommandInputProps, "ref"> & react.RefAttributes<HTMLInputElement>>;
+    Item: 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>>;
+    Value: react.ForwardRefExoticComponent<Omit<react.HTMLProps<HTMLDivElement>, "ref"> & react.RefAttributes<HTMLDivElement>>;
+    Tabs: react.ForwardRefExoticComponent<Omit<_choice_ui_tabs.TabsProps, "ref"> & react.RefAttributes<HTMLDivElement>>;
+    TabItem: react.MemoExoticComponent<react.ForwardRefExoticComponent<Omit<_choice_ui_tabs.TabItemProps, "ref"> & react.RefAttributes<HTMLElement>>>;
+};
+
+export { Command, Command$1 as CommandRoot, defaultFilter, useCommandState };

package/dist/index.d.ts

@@ -0,0 +1,130 @@
+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 { KbdKey } from '@choice-ui/kbd';
+import { ScrollAreaProps } from '@choice-ui/scroll-area';
+
+interface CommandEmptyProps extends HTMLProps<HTMLDivElement> {
+    className?: string;
+}
+
+interface CommandGroupProps extends HTMLProps<HTMLDivElement> {
+    forceMount?: boolean;
+    heading?: react__default.ReactNode;
+    value?: string;
+}
+
+interface CommandInputProps extends Omit<InputProps, "value" | "onChange" | "type"> {
+    onChange?: (search: string) => void;
+    prefixElement?: ReactNode;
+    suffixElement?: ReactNode;
+    value?: string;
+}
+
+interface CommandItemProps extends Omit<HTMLProps<HTMLDivElement>, "onSelect"> {
+    disabled?: boolean;
+    forceMount?: boolean;
+    keywords?: string[];
+    onSelect?: (value: string) => void;
+    prefixElement?: ReactNode;
+    shortcut?: {
+        keys?: ReactNode;
+        modifier?: KbdKey | KbdKey[] | undefined;
+    };
+    suffixElement?: ReactNode;
+    value?: string;
+}
+
+interface CommandListProps extends ScrollAreaProps {
+    children: React.ReactNode;
+    className?: string;
+    label?: string;
+}
+
+interface CommandLoadingProps extends react__default.HTMLAttributes<HTMLDivElement> {
+    label?: string;
+    progress?: number;
+}
+
+interface CommandDividerProps extends HTMLProps<HTMLDivElement> {
+    /** 是否始终渲染此分隔符。当禁用自动过滤功能时特别有用。 */
+    alwaysRender?: boolean;
+}
+
+type CommandFilter = (value: string, search: string, keywords?: string[]) => number;
+interface CommandProps extends Omit<react__default.HTMLAttributes<HTMLDivElement>, "onChange"> {
+    /**
+     * Optional default item value when it is initially rendered.
+     */
+    defaultValue?: string;
+    /**
+     * Optionally set to `true` to disable selection via pointer events.
+     */
+    disablePointerSelection?: boolean;
+    /**
+     * Custom filter function for whether each command menu item should matches the given search query.
+     * It should return a number between 0 and 1, with 1 being the best match and 0 being hidden entirely.
+     * By default, uses the `command-score` library.
+     */
+    filter?: CommandFilter;
+    /**
+     * Accessible label for this command menu. Not shown visibly.
+     */
+    label?: string;
+    /**
+     * Optionally set to `true` to turn on looping around when using the arrow keys.
+     */
+    loop?: boolean;
+    /**
+     * Event handler called when the selected item of the menu changes.
+     */
+    onChange?: (value: string) => void;
+    /**
+     * Optionally set to `false` to turn off the automatic filtering and sorting.
+     * If `false`, you must conditionally render valid items based on the search query yourself.
+     */
+    shouldFilter?: boolean;
+    size?: "default" | "large";
+    /**
+     * Optional controlled state of the selected command menu item.
+     */
+    value?: string;
+    variant?: "default" | "dark";
+    /**
+     * Set to `false` to disable ctrl+n/j/p/k shortcuts. Defaults to `true`.
+     */
+    vimBindings?: boolean;
+}
+type State = {
+    filtered: {
+        count: number;
+        groups: Set<string>;
+        items: Map<string, number>;
+    };
+    search: string;
+    selectedItemId?: string;
+    value: string;
+};
+
+declare const defaultFilter: CommandFilter;
+declare const Command$1: react__default.ForwardRefExoticComponent<CommandProps & react__default.RefAttributes<HTMLDivElement>>;
+
+/** Run a selector against the store state. */
+declare function useCommandState<T>(selector: (state: State) => T): T;
+
+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>>;
+    Input: react.ForwardRefExoticComponent<Omit<CommandInputProps, "ref"> & react.RefAttributes<HTMLInputElement>>;
+    Item: 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>>;
+    Value: react.ForwardRefExoticComponent<Omit<react.HTMLProps<HTMLDivElement>, "ref"> & react.RefAttributes<HTMLDivElement>>;
+    Tabs: react.ForwardRefExoticComponent<Omit<_choice_ui_tabs.TabsProps, "ref"> & react.RefAttributes<HTMLDivElement>>;
+    TabItem: react.MemoExoticComponent<react.ForwardRefExoticComponent<Omit<_choice_ui_tabs.TabItemProps, "ref"> & react.RefAttributes<HTMLElement>>>;
+};
+
+export { Command, Command$1 as CommandRoot, defaultFilter, useCommandState };