Skip to content

CommandItem

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:5

Properties

description?

optional description: string

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:11

Optional secondary description.


disabled?

optional disabled: boolean

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:21

When true, the item is rendered but cannot be selected.


group?

optional group: string

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:13

Group name for sectioning the list. Items without a group go into “default”.


icon?

optional icon: ReactNode

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:15

Leading icon.


id

id: string

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:7

Stable unique identifier — used for keys and the recent list.


keywords?

optional keywords: string[]

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:19

Extra strings used by the fuzzy matcher in addition to label/description.


label

label: string

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:9

Visible label.


onSelect()?

optional onSelect: () => void

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:23

Callback fired when this item is chosen. Falls back to top-level onSelect.

Returns

void


shortcut?

optional shortcut: string

Defined in: src/components/feedback/CommandPalette/CommandPalette.types.ts:17

Keyboard shortcut to display (e.g. “Cmd+S”).