Skip to content

Commit

Permalink
Documentation: add VisualEditorGlobalKeyboardShortcuts docs (#62710)
Browse files Browse the repository at this point in the history
  • Loading branch information
ntsekouras authored Jun 20, 2024
1 parent 7201eec commit 5738e9b
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
10 changes: 6 additions & 4 deletions packages/editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
13 changes: 11 additions & 2 deletions packages/editor/src/components/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;

0 comments on commit 5738e9b

Please sign in to comment.