Command

Commandは、任意項目を一覧表示し、選択かつ処理実行できるコンポーネントです。

プロパティ

Commandは、以下のプロパティをサポートしています。

名前 デフォルト値 説明
class string 追加したいカスタムクラスを渡します。
sections CommandSection[] 階層の配列を渡します。
emptyView Snippet<[]> 表示するメニューが空の場合に表示するレイアウトを渡します。
onClick (item: CommandMenu, section: CommandSection) => void メニューが選択されたときのコールバック関数を渡します。
startContent Snippet<[CommandMenu, CommandSection]> 各メニューの左側に配置するコンテンツを渡します。
autofocus boolean false Inputをオートフォーカスするかどうか。

CommandSection

CommandSectionは、各階層の情報を表すオブジェクトです。

名前 デフォルト値 説明
label string セクションごとのラベルです。
menus CommandMenu[] セクションごとの選択肢です。

CommandMenu

CommandMenuは、メニューの情報を表すオブジェクトです。

名前 デフォルト値 説明
id any メニューの一意な識別子です。
label string メニューのラベルです。
disabled boolean false 操作できるかどうか。
shortcutText string メニュー右側に表示するテキスト。

インストールの手順

以下のコンポーネントのコードを、使いたいプロジェクトにコピー&ペーストします。
パスは実際のプロジェクトの構成にあわせて更新します。

依存コンポーネント

Commandを使うときは、以下のコンポーネントもダウンロードが必要です。

使い方


サンプル

Default

特に操作が行われていない、デフォルトの状態です。

Disabled

選択不可の選択肢が含まれている状態です。

Empty

メニューが空の状態です。

onClick

コールバック関数で値を受け取ることができます。