@wordpress/keyboard-shortcuts

Keyboard shortcuts 是一个通用软件包，允许注册和修改快捷键。

安装

安装该模块

npm install @wordpress/keyboard-shortcuts --save

此软件包假定你的代码将在 ES2015+ 环境中运行。如果你使用的环境对此类语言特性和 API 的支持有限或完全不支持，则应在你的代码中包含 @wordpress/babel-preset-default 中附带的 polyfill。

API

ShortcutProvider

处理通过 useShortcut 添加到上下文中的回调。添加 Provider 可以注册上下文快捷键，这些快捷键仅在界面的某一部分获得焦点时处于活动状态。

参数

• props ShortcutProviderProps：要传递给 div 的 props。

返回值

• 组件。

store

键盘快捷键命名空间的 store 定义。

相关

• https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore

useShortcut

附加键盘快捷键处理程序。

参数

• name string：快捷键名称。
• callback ( event: KeyboardEvent ) => void：快捷键回调。
• options UseShortcutOptions：快捷键选项。
• options.isDisabled UseShortcutOptions[ 'isDisabled' ]：是否禁用快捷键。

为此软件包做贡献

这是一个独立软件包，属于 Gutenberg 项目。该项目以 monorepo 形式组织。它由多个自包含的软件包组成，每个包都有特定用途。此 monorepo 中的软件包会发布到 npm，并被 WordPress 以及其他软件项目使用。

如需了解更多关于为此软件包或整个 Gutenberg 项目做贡献的信息，请阅读项目的主要 贡献者指南。