インポート
コードをコピー
import { CommandPalette } from '@k8ordo/ui';使い方
labelとkeywordsを、大文字と小文字を区別せずに絞り込みます。↓と↑で移動し、端では反対側へ回ります。Enterかクリックでパレットを閉じてからonSelectを呼びます。フォーカスは検索欄に置いたままです。同じgroupの項目は見出しの下にまとまり、shortcutのキーはKbdで添えます。
縦書きプレビューに切り替え
CommandK
コードをコピー
const [isOpen, setIsOpen] = useState(false);
<CommandPalette
isOpen={isOpen}
onClose={() => setIsOpen(false)}
items={[
{
id: 'new-file',
label: 'New file',
group: 'File',
shortcut: ['⌘', 'N'],
onSelect: createFile,
},
{
id: 'theme',
label: 'Toggle theme',
group: 'View',
keywords: ['dark', 'light'],
onSelect: toggleTheme,
},
]}
/>キーでの開閉
開閉はModalと同じくisOpenとonCloseで行います。⌘KやCtrl+Kのようなキーは、アプリ側で割り当てます。閉じるとフォーカスは開く前の場所へ戻り、次に開いたときは空の検索から始まります。
コードをコピー
useEffect(() => {
const listener = (event: KeyboardEvent) => {
if ((event.metaKey || event.ctrlKey) && event.key === 'k') {
event.preventDefault();
setIsOpen(true);
}
};
document.addEventListener('keydown', listener);
return () => {
document.removeEventListener('keydown', listener);
};
}, []);Props
items- Type:
readonly CommandPaletteItem[] - Default: -
aria-label?- Type:
string - Default: -
defaultOpen?- Type:
boolean - Default: -
isOpen?- Type:
boolean - Default: -
onClose?- Type:
() => void - Default: -
placeholder?- Type:
string - Default: -
ref?- Type:
Ref<HTMLDialogElement> - Default: -
| Prop | Type | Default |
|---|---|---|
items | readonly CommandPaletteItem[] | - |
aria-label? | string | - |
defaultOpen? | boolean | - |
isOpen? | boolean | - |
onClose? | () => void | - |
placeholder? | string | - |
ref? | Ref<HTMLDialogElement> | - |
ラベルやプレースホルダーなど、このコンポーネントが描く文言は、propsで指定しないと文言辞書から読まれます。差し替え方は次を見てください: コンポーネントの文言