@saas-ui/command-bar
Version:
Chakra UI CommandBar Component
98 lines (94 loc) • 5.18 kB
text/typescript
import * as _chakra_ui_react from '@chakra-ui/react';
import { ThemingProps, SystemStyleObjectRecord, HTMLChakraProps, ModalProps, ModalContentProps } from '@chakra-ui/react';
import * as React from 'react';
export { useCommandState } from 'cmdk';
interface CommandBarOptions {
shouldFilter?: boolean;
onFilter?(string: string, search: string): number;
value?: string;
onChange?(search: string): void;
onSelect?(value: string): void;
isOpen?: boolean;
onClose?(): void;
closeOnSelect?: boolean;
size?: ThemingProps<'SuiCommandBar'>['size'];
}
declare const useCommandBarStyles: () => SystemStyleObjectRecord;
declare const useCommandBarContext: () => {
getCommandProps: (props: any) => any;
getItemProps: (props: any) => any;
getDialogProps: (props?: any) => any;
};
type CommandBarContext = ReturnType<typeof useCommandBar>;
declare const useCommandBar: (props: CommandBarOptions) => {
getCommandProps: (props: any) => any;
getItemProps: (props: any) => any;
getDialogProps: (props?: any) => any;
};
declare const CommandBarList: _chakra_ui_react.ComponentWithAs<_chakra_ui_react.ChakraComponent<React.ForwardRefExoticComponent<{
children?: React.ReactNode;
} & Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
ref?: React.Ref<HTMLDivElement>;
} & {
asChild?: boolean;
}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
label?: string;
} & React.RefAttributes<HTMLDivElement>>, {}>, any>;
declare const CommandBarLoading: _chakra_ui_react.ComponentWithAs<_chakra_ui_react.ChakraComponent<React.ForwardRefExoticComponent<{
children?: React.ReactNode;
} & Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
ref?: React.Ref<HTMLDivElement>;
} & {
asChild?: boolean;
}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
progress?: number;
label?: string;
} & React.RefAttributes<HTMLDivElement>>, {}>, any>;
declare const CommandBarEmpty: _chakra_ui_react.ComponentWithAs<_chakra_ui_react.ChakraComponent<React.ForwardRefExoticComponent<{
children?: React.ReactNode;
} & Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
ref?: React.Ref<HTMLDivElement>;
} & {
asChild?: boolean;
}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & React.RefAttributes<HTMLDivElement>>, {}>, any>;
declare const CommandBarSeparator: _chakra_ui_react.ComponentWithAs<_chakra_ui_react.ChakraComponent<React.ForwardRefExoticComponent<Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
ref?: React.Ref<HTMLDivElement>;
} & {
asChild?: boolean;
}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
alwaysRender?: boolean;
} & React.RefAttributes<HTMLDivElement>>, {}>, any>;
declare const CommandBarGroup: _chakra_ui_react.ComponentWithAs<_chakra_ui_react.ChakraComponent<React.ForwardRefExoticComponent<{
children?: React.ReactNode;
} & Omit<Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
ref?: React.Ref<HTMLDivElement>;
} & {
asChild?: boolean;
}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild">, "value" | "heading"> & {
heading?: React.ReactNode;
value?: string;
forceMount?: boolean;
} & React.RefAttributes<HTMLDivElement>>, {}>, any>;
interface CommandBarProps extends CommandBarOptions, ThemingProps<'SuiCommandBar'> {
children: React.ReactNode;
}
declare const CommandBar: React.FC<CommandBarProps>;
declare const CommandBarContent: _chakra_ui_react.ComponentWithAs<"div", HTMLChakraProps<"div">>;
interface CommandBarInputProps extends Omit<HTMLChakraProps<'input'>, 'onChange'> {
value?: string;
onChange?(value: string): void;
}
declare const CommandBarInput: _chakra_ui_react.ComponentWithAs<"input", CommandBarInputProps>;
interface CommandBarItemProps extends Omit<HTMLChakraProps<'div'>, 'onSelect' | 'value'> {
onSelect?(value: string): void;
isDisabled?: boolean;
value?: string;
}
declare const CommandBarItem: _chakra_ui_react.ComponentWithAs<"div", CommandBarItemProps>;
interface CommandBarDialogProps extends Omit<ModalProps, 'variant' | 'isOpen' | 'onClose'> {
closeOnSelect?: boolean;
contentProps?: ModalContentProps;
overlay?: boolean;
}
declare const CommandBarDialog: _chakra_ui_react.ComponentWithAs<"div", CommandBarDialogProps>;
export { CommandBar, CommandBarContent, type CommandBarContext, CommandBarDialog, type CommandBarDialogProps, CommandBarEmpty, CommandBarGroup, CommandBarInput, type CommandBarInputProps, CommandBarItem, type CommandBarItemProps, CommandBarList, CommandBarLoading, type CommandBarOptions, type CommandBarProps, CommandBarSeparator, useCommandBar, useCommandBarContext, useCommandBarStyles };