インストール

モジュールをインストールします

  1. npm install @wordpress/keyboard-shortcuts --save

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。もし、言語機能やAPIのサポートが限られているか、全くない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含めるべきです。

API

ShortcutProvider

  1. *パラメータ*
  2. - props `````Object`````: `````div`````に渡すプロパティ。
  3. *戻り値*
  4. - `````Element`````: コンポーネント。
  5. <a name="store"></a>
  6. ### store
  7. キーボードショートカットの名前空間のストア定義。
  8. *関連*
  9. - [https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore](https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore)
  10. *タイプ*
  11. - `````Object

useShortcut

キーボードショートカットハンドラーを添付します。

パラメータ

  • name string: ショートカット名。
  • callback Function: ショートカットコールバック。
  • options Object: ショートカットオプション。
  • options.isDisabled boolean: ショートカットを無効にするかどうか。

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主な貢献者ガイドをお読みください。