diff --git a/packages/editor/README.md b/packages/editor/README.md index 49090369fc070e..a0769fc5bac966 100644 --- a/packages/editor/README.md +++ b/packages/editor/README.md @@ -322,7 +322,7 @@ _Returns_ ### EditorKeyboardShortcuts -Component handles the keyboard shortcuts for the editor. +Handles the keyboard shortcuts for the editor. It provides functionality for various keyboard shortcuts such as toggling editor mode, toggling distraction-free mode, undo/redo, saving the post, toggling list view, and toggling the sidebar. @@ -1616,9 +1616,9 @@ _Returns_ ### TextEditorGlobalKeyboardShortcuts -Component handles the global keyboard shortcuts for the Text editor. +Handles the keyboard shortcuts for the editor. -It provides functionality for various keyboard shortcuts such as toggling editor mode, toggling distraction-free mode, undo/redo. +It provides functionality for various keyboard shortcuts such as toggling editor mode, toggling distraction-free mode, undo/redo, saving the post, toggling list view, and toggling the sidebar. ### ThemeSupportCheck @@ -1725,7 +1725,9 @@ _Type_ ### VisualEditorGlobalKeyboardShortcuts -Undocumented declaration. +Handles the keyboard shortcuts for the editor. + +It provides functionality for various keyboard shortcuts such as toggling editor mode, toggling distraction-free mode, undo/redo, saving the post, toggling list view, and toggling the sidebar. ### Warning diff --git a/packages/editor/src/components/global-keyboard-shortcuts/index.js b/packages/editor/src/components/global-keyboard-shortcuts/index.js index f6bb76fb4708a9..a46d4b55a7bfd8 100644 --- a/packages/editor/src/components/global-keyboard-shortcuts/index.js +++ b/packages/editor/src/components/global-keyboard-shortcuts/index.js @@ -12,7 +12,7 @@ import { store as blockEditorStore } from '@wordpress/block-editor'; import { store as editorStore } from '../../store'; /** - * Component handles the keyboard shortcuts for the editor. + * Handles the keyboard shortcuts for the editor. * * It provides functionality for various keyboard shortcuts such as toggling editor mode, * toggling distraction-free mode, undo/redo, saving the post, toggling list view, diff --git a/packages/editor/src/components/index.js b/packages/editor/src/components/index.js index 0e2410e7f456d0..91dcc883d661b2 100644 --- a/packages/editor/src/components/index.js +++ b/packages/editor/src/components/index.js @@ -105,12 +105,21 @@ export { default as CharacterCount } from './character-count'; export { default as EditorProvider } from './provider'; export * from './deprecated'; + +/** + * Handles the keyboard shortcuts for the editor. + * + * It provides functionality for various keyboard shortcuts such as toggling editor mode, + * toggling distraction-free mode, undo/redo, saving the post, toggling list view, + * and toggling the sidebar. + */ export const VisualEditorGlobalKeyboardShortcuts = EditorKeyboardShortcuts; /** - * Component handles the global keyboard shortcuts for the Text editor. + * Handles the keyboard shortcuts for the editor. * * It provides functionality for various keyboard shortcuts such as toggling editor mode, - * toggling distraction-free mode, undo/redo. + * toggling distraction-free mode, undo/redo, saving the post, toggling list view, + * and toggling the sidebar. */ export const TextEditorGlobalKeyboardShortcuts = EditorKeyboardShortcuts;