-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Add UI commands to the post editor #51900
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
packages/edit-post/src/hooks/commands/use-common-commands.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { useSelect, useDispatch } from '@wordpress/data'; | ||
import { __, isRTL } from '@wordpress/i18n'; | ||
import { | ||
code, | ||
cog, | ||
drawerLeft, | ||
drawerRight, | ||
blockDefault, | ||
} from '@wordpress/icons'; | ||
import { useCommand } from '@wordpress/commands'; | ||
import { store as preferencesStore } from '@wordpress/preferences'; | ||
import { store as interfaceStore } from '@wordpress/interface'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import { store as editPostStore } from '../../store'; | ||
|
||
export default function useCommonCommands() { | ||
const { openGeneralSidebar, closeGeneralSidebar, switchEditorMode } = | ||
useDispatch( editPostStore ); | ||
const { editorMode, activeSidebar } = useSelect( | ||
( select ) => ( { | ||
activeSidebar: select( interfaceStore ).getActiveComplementaryArea( | ||
editPostStore.name | ||
), | ||
editorMode: select( editPostStore ).getEditorMode(), | ||
} ), | ||
[] | ||
); | ||
const { toggle } = useDispatch( preferencesStore ); | ||
|
||
useCommand( { | ||
name: 'core/open-settings-sidebar', | ||
label: __( 'Toggle settings sidebar' ), | ||
icon: isRTL() ? drawerLeft : drawerRight, | ||
callback: ( { close } ) => { | ||
close(); | ||
if ( activeSidebar === 'edit-post/document' ) { | ||
closeGeneralSidebar(); | ||
} else { | ||
openGeneralSidebar( 'edit-post/document' ); | ||
} | ||
}, | ||
} ); | ||
|
||
useCommand( { | ||
name: 'core/open-block-inspector', | ||
label: __( 'Toggle block inspector' ), | ||
icon: blockDefault, | ||
callback: ( { close } ) => { | ||
close(); | ||
if ( activeSidebar === 'edit-post/block' ) { | ||
closeGeneralSidebar(); | ||
} else { | ||
openGeneralSidebar( 'edit-post/block' ); | ||
} | ||
}, | ||
} ); | ||
|
||
useCommand( { | ||
name: 'core/toggle-distraction-free', | ||
label: __( 'Toggle distraction free' ), | ||
icon: cog, | ||
callback: ( { close } ) => { | ||
toggle( 'core/edit-post', 'distractionFree' ); | ||
close(); | ||
}, | ||
} ); | ||
|
||
useCommand( { | ||
name: 'core/toggle-spotlight-mode', | ||
label: __( 'Toggle spotlight mode' ), | ||
icon: cog, | ||
callback: ( { close } ) => { | ||
toggle( 'core/edit-post', 'focusMode' ); | ||
close(); | ||
}, | ||
} ); | ||
|
||
useCommand( { | ||
name: 'core/toggle-top-toolbar', | ||
label: __( 'Toggle top toolbar' ), | ||
icon: cog, | ||
callback: ( { close } ) => { | ||
toggle( 'core/edit-post', 'fixedToolbar' ); | ||
close(); | ||
}, | ||
} ); | ||
|
||
useCommand( { | ||
name: 'core/toggle-code-editor', | ||
label: __( 'Toggle code editor' ), | ||
icon: code, | ||
callback: ( { close } ) => { | ||
switchEditorMode( editorMode === 'visual' ? 'text' : 'visual' ); | ||
close(); | ||
}, | ||
} ); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed that we're inconsistent with the command names in edit post and site packages. Some times we have the names like here and others like:
core/edit-site/reset-global-styles
. I mean it makes sense to have the extra prefix for core commands, but probably we should keep it simple for commands that only load in each editor. WDYT?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, after we add all the commands I think we should make a single PR to clean all the names. If not for allowing "unregistration" of commands from third-party plugins, I would remove these names entirely :P