@ablogcms/keyboard-shortcut

管理画面のキーボードショートカットを登録するレジストリと、登録済みショートカットの一覧を カテゴリー別に表示する KeyboardShortcutModal を提供するパッケージ。

使い方

import { registerKeyboardShortcutCategory, registerKeyboardShortcut, registerCoreShortcuts } from '@ablogcms/keyboard-shortcut';

// cmsコアのショートカットを登録
registerCoreShortcuts();

// 独自のショートカットを追加する場合
registerKeyboardShortcutCategory('my-feature', { heading: '自機能', order: 10 });
registerKeyboardShortcut('my-shortcut', {
  label: '独自の操作を実行する。',
  commands: ['Mod', 'K'],
  categoryId: 'my-feature',
  order: 1,
});

一覧表示モーダルは初期表示に不要なため、コード分割の対象として個別サブパスから遅延読み込みする。

const KeyboardShortcutModal = lazy(() => import('@ablogcms/keyboard-shortcut/keyboard-shortcut-modal'));

commands に渡す文字列は @ablogcms/lib/command の commandList に登録された ID （Mod / Shift / Alt 等）であれば、プラットフォーム（Mac/Windows）に応じた表示用の記号に 自動で正規化される。未登録の文字列はそのまま表示される。