Refactor based on code review feedback

- Introduce new TextEditorGlobalShortcuts component that implements the save shortcut - Rename EditorGlobalShortcuts to VisualEditorGlobalShortcuts - Add a deprecated version of EditorGlobalShortcuts - Update CHANGELOG
WordPress · Feb 1, 2019 · eed9e67 · eed9e67
1 parent 4347f89
commit eed9e67
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 19 deletions.
diff --git a/packages/edit-post/src/components/text-editor/index.js b/packages/edit-post/src/components/text-editor/index.js
@@ -1,7 +1,11 @@
 /**
  * WordPress dependencies
  */
-import { PostTextEditor, PostTitle, EditorSaveKeyboardShortcut } from '@wordpress/editor';
+import {
+	PostTextEditor,
+	PostTitle,
+	TextEditorGlobalKeyboardShortcuts,
+} from '@wordpress/editor';
 import { IconButton } from '@wordpress/components';
 import { withDispatch, withSelect } from '@wordpress/data';
 import { __ } from '@wordpress/i18n';
@@ -21,7 +25,7 @@ function TextEditor( { onExit, isRichEditingEnabled } ) {
 					>
 						{ __( 'Exit Code Editor' ) }
 					</IconButton>
-					<EditorSaveKeyboardShortcut />
+					<TextEditorGlobalKeyboardShortcuts />
 				</div>
 			)	}
 			<div className="edit-post-text-editor__body">

diff --git a/packages/edit-post/src/components/visual-editor/index.js b/packages/edit-post/src/components/visual-editor/index.js
@@ -7,7 +7,7 @@ import {
 	PostTitle,
 	WritingFlow,
 	ObserveTyping,
-	EditorGlobalKeyboardShortcuts,
+	VisualEditorGlobalKeyboardShortcuts,
 	BlockSelectionClearer,
 	MultiSelectScrollIntoView,
 	_BlockSettingsMenuFirstItem,
@@ -23,7 +23,7 @@ import PluginBlockSettingsMenuGroup from '../block-settings-menu/plugin-block-se
 function VisualEditor() {
 	return (
 		<BlockSelectionClearer className="edit-post-visual-editor editor-styles-wrapper">
-			<EditorGlobalKeyboardShortcuts />
+			<VisualEditorGlobalKeyboardShortcuts />
 			<CopyHandler />
 			<MultiSelectScrollIntoView />
 			<WritingFlow>

diff --git a/packages/editor/CHANGELOG.md b/packages/editor/CHANGELOG.md
@@ -1,16 +1,17 @@
 ## 9.1.0 (Unreleased)
 
-### New Feature
+### New Features
 
 - Added `createCustomColorsHOC` for creating a higher order `withCustomColors` component.
+- Added a new `TextEditorGlobalKeyboardShortcuts` component.
 
-### Bug Fixes
+### Deprecations
 
-- BlockSwitcher will now consistently render an icon for block multi-selections.
+- `EditorGlobalKeyboardShortcuts` has been deprecated in favor of `VisualEditorGlobalKeyboardShortcuts`.
 
-### New feature
+### Bug Fixes
 
-- Added new `EditorSaveKeyboardShortcut` component, which was refactored out from the `EditorGlobalKeyboardShortcuts` component.
+- BlockSwitcher will now consistently render an icon for block multi-selections.
 
 ### Internal
 

diff --git a/packages/editor/src/components/block-settings-menu/index.js b/packages/editor/src/components/block-settings-menu/index.js
@@ -15,7 +15,7 @@ import { withDispatch } from '@wordpress/data';
 /**
  * Internal dependencies
  */
-import { shortcuts } from '../editor-global-keyboard-shortcuts';
+import { shortcuts } from '../global-keyboard-shortcuts/visual-editor-shortcuts';
 import BlockActions from '../block-actions';
 import BlockModeToggle from './block-mode-toggle';
 import ReusableBlockConvertButton from './reusable-block-convert-button';

diff --git a/...hortcuts/editor-save-keyboard-shortcut.js → ...lobal-keyboard-shortcuts/save-shortcut.js b/...hortcuts/editor-save-keyboard-shortcut.js → ...lobal-keyboard-shortcuts/save-shortcut.js
@@ -6,7 +6,7 @@ import { rawShortcut } from '@wordpress/keycodes';
 import { compose } from '@wordpress/compose';
 import { withSelect, withDispatch } from '@wordpress/data';
 
-export function EditorSaveKeyboardShortcut( { onSave } ) {
+export function SaveShortcut( { onSave } ) {
 	return (
 		<KeyboardShortcuts
 			bindGlobal
@@ -49,4 +49,4 @@ export default compose( [
 			},
 		};
 	} ),
-] )( EditorSaveKeyboardShortcut );
+] )( SaveShortcut );
diff --git a/packages/editor/src/components/global-keyboard-shortcuts/text-editor-shortcuts.js b/packages/editor/src/components/global-keyboard-shortcuts/text-editor-shortcuts.js
@@ -0,0 +1,10 @@
+/**
+ * Internal dependencies
+ */
+import SaveShortcut from './save-shortcut';
+
+export default function TextEditorGlobalKeyboardShortcuts() {
+	return (
+		<SaveShortcut />
+	);
+}
diff --git a/...editor-global-keyboard-shortcuts/index.js → ...oard-shortcuts/visual-editor-shortcuts.js b/...editor-global-keyboard-shortcuts/index.js → ...oard-shortcuts/visual-editor-shortcuts.js
@@ -11,12 +11,13 @@ import { KeyboardShortcuts } from '@wordpress/components';
 import { withSelect, withDispatch } from '@wordpress/data';
 import { rawShortcut, displayShortcut } from '@wordpress/keycodes';
 import { compose } from '@wordpress/compose';
+import deprecated from '@wordpress/deprecated';
 
 /**
  * Internal dependencies
  */
 import BlockActions from '../block-actions';
-import EditorSaveKeyboardShortcut from './editor-save-keyboard-shortcut';
+import SaveShortcut from './save-shortcut';
 
 const preventDefault = ( event ) => {
 	event.preventDefault();
@@ -42,7 +43,7 @@ export const shortcuts = {
 	},
 };
 
-class EditorGlobalKeyboardShortcuts extends Component {
+class VisualEditorGlobalKeyboardShortcuts extends Component {
 	constructor() {
 		super( ...arguments );
 
@@ -105,7 +106,7 @@ class EditorGlobalKeyboardShortcuts extends Component {
 						escape: this.clearMultiSelection,
 					} }
 				/>
-				<EditorSaveKeyboardShortcut />
+				<SaveShortcut />
 				{ selectedBlockClientIds.length > 0 && (
 					<BlockActions clientIds={ selectedBlockClientIds }>
 						{ ( { onDuplicate, onRemove, onInsertAfter, onInsertBefore } ) => (
@@ -136,7 +137,7 @@ class EditorGlobalKeyboardShortcuts extends Component {
 	}
 }
 
-export default compose( [
+const EnhancedVisualEditorGlobalKeyboardShortcuts = compose( [
 	withSelect( ( select ) => {
 		const {
 			getBlockOrder,
@@ -176,4 +177,15 @@ export default compose( [
 			onRemove: removeBlocks,
 		};
 	} ),
-] )( EditorGlobalKeyboardShortcuts );
+] )( VisualEditorGlobalKeyboardShortcuts );
+
+export default EnhancedVisualEditorGlobalKeyboardShortcuts;
+
+export function EditorGlobalKeyboardShortcuts() {
+	deprecated( 'EditorGlobalKeyboardShortcuts', {
+		alternative: 'VisualEditorGlobalKeyboardShortcuts',
+		plugin: 'Gutenberg',
+	} );
+
+	return <EnhancedVisualEditorGlobalKeyboardShortcuts />;
+}
diff --git a/packages/editor/src/components/index.js b/packages/editor/src/components/index.js
@@ -36,8 +36,11 @@ export { default as URLPopover } from './url-popover';
 export { default as AutosaveMonitor } from './autosave-monitor';
 export { default as DocumentOutline } from './document-outline';
 export { default as DocumentOutlineCheck } from './document-outline/check';
-export { default as EditorGlobalKeyboardShortcuts } from './editor-global-keyboard-shortcuts';
-export { default as EditorSaveKeyboardShortcut } from './editor-global-keyboard-shortcuts/editor-save-keyboard-shortcut';
+export {
+	default as VisualEditorGlobalKeyboardShortcuts,
+	EditorGlobalKeyboardShortcuts,
+} from './global-keyboard-shortcuts/visual-editor-shortcuts';
+export { default as TextEditorGlobalKeyboardShortcuts } from './global-keyboard-shortcuts/text-editor-shortcuts';
 export { default as EditorHistoryRedo } from './editor-history/redo';
 export { default as EditorHistoryUndo } from './editor-history/undo';
 export { default as EditorNotices } from './editor-notices';