@wordpress/keycodes

インストール

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

npm install @wordpress/keycodes --save

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

使用法

``````bash
import { DOWN, ENTER } from '@wordpress/keycodes';
// [...]
onKeyDown( event ) {
   const { keyCode } = event;
   if ( keyCode === DOWN ) {
   alert( 'You pressed the down arrow!' );
   } else if ( keyCode === ENTER ) {
   alert( 'You pressed the enter key!' );
   } else {
   alert( 'You pressed another key.' );
   }
}
`

API

ALT

ALTキーのキーコード。

BACKSPACE

BACKSPACEキーのキーコード。

COMMAND

COMMAND/METAキーのキーコード。

CTRL

CTRLキーのキーコード。

DELETE

DELETEキーのキーコード。

displayShortcut

ショートカットを表示するための関数を含むオブジェクト。

使用法

// Assuming macOS:
displayShortcut.primary( 'm' );
// "⌘M"

タイプ

• WPModifierHandler<WPKeyHandler<string>>ショートカットを表示するための関数のキー付きマップ。
  

displayShortcutList

表示用のキーボードショートカットのコードの部分の配列を返します。

使用法

// Assuming macOS:
displayShortcutList.primary( 'm' );
// [ "⌘", "M" ]

タイプ

• WPModifierHandler<WPKeyHandler<string[]>>ショートカットシーケンスのための関数のキー付きマップ。
  

DOWN

DOWNキーのキーコード。

END

ENDキーのキーコード。

ENTER

ENTERキーのキーコード。

ESCAPE

ESCAPEキーのキーコード。

F10

F10キーのキーコード。

HOME

HOMEキーのキーコード。

isAppleOS

プラットフォームがMacOSの場合はtrueを返します。

パラメータ

• _window Window?: デフォルトのウィンドウオブジェクト; DIテストに使用されます。

戻り値

• boolean: MacOSの場合はtrue; それ以外はfalse。
  

isKeyboardEvent

事前定義されたショートカットの組み合わせに一致するかどうかを確認するための関数を含むオブジェクト。

使用法

// Assuming an event for ⌘M key press:
isKeyboardEvent.primary( event, 'm' );
// true

タイプ

• WPModifierHandler<WPEventKeyHandler>イベントに一致させるための関数のキー付きマップ。
  

LEFT

LEFTキーのキーコード。

modifiers

プラットフォームに応じて利用可能な修飾子を返す関数を含むオブジェクト。

タイプ

• WPModifierHandler< ( isApple: () => boolean ) => WPModifierPart[]>
  

PAGEDOWN

PAGEDOWNキーのキーコード。

PAGEUP

PAGEUPキーのキーコード。

rawShortcut

生のショートカットを取得するための関数を含むオブジェクト。

これらはKeyboardShortcutsを使用するユーザー向けです。

使用法

// Assuming macOS:
rawShortcut.primary( 'm' );
// "meta+m""

タイプ

• WPModifierHandler<WPKeyHandler<string>>生のショートカットのための関数のキー付きマップ。
  

RIGHT

RIGHTキーのキーコード。

SHIFT

SHIFTキーのキーコード。

shortcutAriaLabel

キーボードショートカットのためのariaラベルを返す関数を含むオブジェクト。

使用法

// Assuming macOS:
shortcutAriaLabel.primary( '.' );
// "Command + Period"

タイプ

• WPModifierHandler<WPKeyHandler<string>>ショートカットARIAラベルのための関数のキー付きマップ。
  

SPACE

SPACEキーのキーコード。

TAB

TABキーのキーコード。

UP

UPキーのキーコード。

ZERO

ZEROキーのキーコード。

このパッケージへの貢献

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

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な[https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md]をお読みください。