ui/build/command/types

Interfaces

CommandClientConfig

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:17

Properties

error?

optional error?: string | null;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:19

isLoading?

optional isLoading?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:18

---

CommandDialogProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:119

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:123

onOpenChange?

optional onOpenChange?: (open) => void;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:122

Parameters

Parameter	Type
open	boolean

Returns

void

open?

optional open?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:120

value?

optional value?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:121

---

CommandEmptyProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:110

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:111

show?

optional show?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:112

---

CommandGroupHeadingProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:95

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:96

---

CommandGroupItemsProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:98

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:99

---

CommandGroupProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:91

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:93

heading?

optional heading?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:92

---

CommandInfiniteLoadingConfig

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:26

Properties

hasMore

hasMore: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:28

onLoadMore

onLoadMore: (info) => void;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:29

Parameters

Parameter	Type
info	{ lastVisibleIndex: number; loadedCount: number; }
info.lastVisibleIndex	number
info.loadedCount	number

Returns

void

total

total: number;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:27

---

CommandInputProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:101

Extends

• ConfirmationProps<Omit<HTMLAttributes<HTMLInputElement>, "prefix" | "aria-label">>

Properties

aria-label?

optional aria-label?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:104

disabled?

optional disabled?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:105

outerClass?

optional outerClass?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:108

placeholder?

optional placeholder?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:103

prefix?

optional prefix?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:106

suffix?

optional suffix?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:107

value?

optional value?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:102

---

CommandListProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:70

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:71

clientConfig?

optional clientConfig?: CommandClientConfig;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:87

gap?

optional gap?: number;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:74

infiniteLoading?

optional infiniteLoading?: CommandInfiniteLoadingConfig;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:89

itemHeight?

optional itemHeight?: number;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:72

itemSnippet?

optional itemSnippet?: Snippet<[{
  index: number;
  isIndicator: boolean;
  isSelected: boolean;
  item: {
   [key: string]: unknown;
     description?: string;
     disabled?: boolean;
     groupId?: string;
     href?: string;
     keywords?: readonly string[];
     label?: string;
     value: string;
  };
}]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:75

loadMoreThreshold?

optional loadMoreThreshold?: number;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:86

overscan?

optional overscan?: number;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:73

placeholderSnippet?

optional placeholderSnippet?: Snippet<[{
  index: number;
}]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:83

serverConfig?

optional serverConfig?: CommandServerConfig;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:88

---

CommandLoadingProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:116

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:117

---

CommandRootProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:52

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

Properties

activeValue?

optional activeValue?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:55

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:65

columns?

optional columns?: any;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:59

disableNavigation?

optional disableNavigation?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:66

filter?

optional filter?: FilterFunction;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:58

gap?

optional gap?: any;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:68

Space between the input, list and footer.

items?

optional items?: object[];

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:53

Index Signature

[key: string]: unknown

description?

readonly optional description?: string;

disabled?

readonly optional disabled?: boolean;

groupId?

readonly optional groupId?: string;

href?

readonly optional href?: string;

keywords?

readonly optional keywords?: readonly string[];

label?

readonly optional label?: string;

value

readonly value: string;

onIndicatorKeydown?

optional onIndicatorKeydown?: (event, context) => boolean | void;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:61

Parameters

Parameter	Type
event	KeyboardEvent
context	{ indicatorValue: string | null; items: object[]; }
context.indicatorValue	string | null
context.items	object[]

Returns

boolean | void

onValueChange?

optional onValueChange?: (value) => void;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:60

Parameters

Parameter	Type
value	string

Returns

void

searchValue?

optional searchValue?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:56

shouldFilter?

optional shouldFilter?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:57

value?

optional value?: string | string[];

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:54

---

CommandSeparatorProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:114

Extends

• ConfirmationProps<HTMLAttributes<HTMLDivElement>>

---

CommandServerConfig

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:21

Properties

error?

optional error?: string | Error | null;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:24

isLoading?

optional isLoading?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:23

onSearch

onSearch: (query) => void;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:22

Parameters

Parameter	Type
query	string

Returns

void

---

CommandShortcutProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:125

Extends

• ConfirmationProps<HTMLAttributes<HTMLSpanElement>>

Properties

children?

optional children?: Snippet<[]>;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:126

---

CommandStateProps

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:42

Properties

activeValue?

readonly optional activeValue?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:46

columns?

optional columns?: any;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:49

filterFn?

optional filterFn?: FilterFunction;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:48

items?

readonly optional items?: object[];

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:43

Index Signature

[key: string]: unknown

description?

readonly optional description?: string;

disabled?

readonly optional disabled?: boolean;

groupId?

readonly optional groupId?: string;

href?

readonly optional href?: string;

keywords?

readonly optional keywords?: readonly string[];

label?

readonly optional label?: string;

value

readonly value: string;

onChange?

optional onChange?: (value) => void;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:50

Parameters

Parameter	Type
value	string

Returns

void

searchValue?

readonly optional searchValue?: string;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:44

shouldFilter

shouldFilter: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:47

value?

readonly optional value?: string | string[];

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:45

---

TInfiniteLoadingConfig

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:34

Properties

handleInfiniteLoad

handleInfiniteLoad: (info) => void;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:37

Parameters

Parameter	Type
info	{ lastVirtualIndex: number; loadedCount: number; }
info.lastVirtualIndex	number
info.loadedCount	number

Returns

void

hasMore

hasMore: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:36

total

total: number;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:35

Type Aliases

CommandItemData

type CommandItemData = typeof CommandItemDataSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:15

---

FilterFunction

type FilterFunction = (value, search, keywords?) => number;

Defined in: apps/website/.api-docs-entry/ui/build/command/types.d.ts:16

Parameters

Parameter	Type
value	string
search	string
keywords?	readonly string[]

Returns

number