Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: add VisualEditorGlobalKeyboardShortcuts docs #62710

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Documentation: add VisualEditorGlobalKeyboardShortcuts docs #62710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/editor/README.md
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion packages/editor/src/components/global-keyboard-shortcuts/index.js
View file
Open in desktop
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
View file
Open in desktop
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;
Loading