# CommandPaletteProps

Source: /tuil/docs/reference/components/overlays/command-palette-props
Locale: en

CommandPaletteProps component contract.



{/* Generated by tooling/docs/generate-reference.ts. */}

## Type [#type]

```ts
export interface CommandPaletteProps {
  readonly open?: boolean;
  readonly defaultOpen?: boolean;
  readonly onOpenChange?: (open: boolean) => void | Promise<void>;
  readonly commands?: readonly Command[];
  readonly placeholder?: string;
  readonly hotkey?: string;
}
```

## Members [#members]

| Member         | Type                                                      | Required | Description                                                                                            | Related types                                          |
| -------------- | --------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |
| `open`         | `boolean \| undefined`                                    | No       | The `open` member uses the `boolean \| undefined` contract.                                            | —                                                      |
| `defaultOpen`  | `boolean \| undefined`                                    | No       | The `defaultOpen` member uses the `boolean \| undefined` contract.                                     | —                                                      |
| `onOpenChange` | `((open: boolean) => void \| Promise<void>) \| undefined` | No       | The `onOpenChange` member uses the `((open: boolean) => void \| Promise<void>) \| undefined` contract. | —                                                      |
| `commands`     | `readonly Command<unknown>[] \| undefined`                | No       | The `commands` member uses the `readonly Command<unknown>[] \| undefined` contract.                    | [`Command`](/tuil/docs/reference/packages/core/api/command) |
| `placeholder`  | `string \| undefined`                                     | No       | The `placeholder` member uses the `string \| undefined` contract.                                      | —                                                      |
| `hotkey`       | `string \| undefined`                                     | No       | The `hotkey` member uses the `string \| undefined` contract.                                           | —                                                      |

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/registry/feedback/overlays.tsx)