Skip to main contentSkip to filter inputPrimer

CommandPalette

Global search dialog component

Internal Component

This component is intended solely for use within GitHub and is not available for external use.
React
ready
Docs|Storybook|Source|Usage

Props

CommandPalette

NameDefaultDescription
open Required
boolean
onOpenChange Required
(open: boolean) => void
config Required
CommandPaletteConfig
routeContext Required
CommandPaletteRouteContext
status Required
Readonly<{ kind: "initial" | "pending" | "complete" | "error"; }>
staticResultsByPage
CommandPaletteStaticResultsByPage
localResultsByPage
CommandPaletteLocalResultsByPage
onAction
(action: CommandPaletteLocalResult) => void
actionFeedback
CommandPaletteActionFeedback
actionError
string
inputRef
React.RefObject<HTMLInputElement>
onTestAction
(action: Readonly<{ pageKey: string; resultId: string; }>) => void
returnFocusRef
any
contextualPages
ContextualPagesSource
searchProviders
SearchProvidersSource
resultGroupSettings
readonly CommandPaletteResultGroupSettings[]
helpEnabled
boolean

CommandPaletteDotcom

NameDefaultDescription
routePath
string
onReady
(ready: boolean) => void
navigate
(destination: string) => void