-
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
Adds the block hierarchy navigation menu to the header #10545
Merged
Merged
Changes from 17 commits
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
fceb875
Adds the block hierarchy navivation menu to the header
youknowriad 8eee332
Avoid auto-selecting inner blocks when selecting the parent block
youknowriad 94a20dd
Show block hierarchy for container blocks
youknowriad a110a3b
highlight the selected block
youknowriad be61554
Add a unit test for the newly added selector
youknowriad b1bbd5e
Adding an e2e test
youknowriad 4fcaff2
Replace block names by block titles
youknowriad e1b402c
Fix unit tests
youknowriad 3d4c28f
Fix e2e tests
youknowriad 5779576
Update the selector docs
youknowriad 7ea0064
Tweak the design of the block navigation menu
youknowriad ba32da1
Compress the block hierarchy tree
youknowriad 083d2df
Update inner column block icon.
mtias b22412a
Avoid showing the parent block's borders if a child block is selected
youknowriad 5fc0693
Simplify the menu's label
youknowriad b67a487
Tweak the selected block's style
youknowriad d55686c
Darker text color for the selected block
youknowriad e8af488
Memoize the block parent's selectors
youknowriad a014263
Adding root level block navigation
youknowriad e1fea28
Adding a keyboard shortcut to open the navigation menu
youknowriad ca407ed
Avoid wrapping function descriptions
youknowriad c81b4a7
Use Path for a mobile-friendly SVG
youknowriad affb3b3
Extract inner blocks check to a dom utility
youknowriad 67e8451
Fix unit tests
youknowriad b6099fa
Fix e2e tests
youknowriad 0ad245e
Add aria-label to block navigation list to improve context with keybo…
tofumatt 9909857
Use the label prop to label the MenuGroup
youknowriad e70e5fb
Use access + b shortcut to avoid ambiguity
youknowriad 82394d3
Add role="presentation" to the items that should be invisible a11y wise
youknowriad 2b796a7
Fix unit tests
youknowriad a1c039d
change shortcuts, improve tests, and show empty navigator when no blo…
tofumatt 45b7686
Tweak tests; use o instead of l
tofumatt 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
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
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
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
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
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
54 changes: 54 additions & 0 deletions
54
packages/editor/src/components/block-hierarchy/dropdown.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,54 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { IconButton, Dropdown, SVG } from '@wordpress/components'; | ||
import { withSelect } from '@wordpress/data'; | ||
import { __ } from '@wordpress/i18n'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import BlockHierarchy from './'; | ||
|
||
const menuIcon = ( | ||
<SVG xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20"> | ||
<path d="M5 5H3v2h2V5zm3 8h11v-2H8v2zm9-8H6v2h11V5zM7 11H5v2h2v-2zm0 8h2v-2H7v2zm3-2v2h11v-2H10z" /> | ||
</SVG> | ||
); | ||
|
||
function BlockHierarchyDropdown( { rootClientId, selectedBlockClientId, countInnerBlocks } ) { | ||
if ( rootClientId === selectedBlockClientId && countInnerBlocks === 0 ) { | ||
return null; | ||
} | ||
|
||
return ( | ||
<Dropdown | ||
renderToggle={ ( { isOpen, onToggle } ) => ( | ||
<IconButton | ||
icon={ menuIcon } | ||
aria-expanded={ isOpen } | ||
onClick={ onToggle } | ||
label={ __( 'Block Hierarchy' ) } | ||
/> | ||
) } | ||
renderContent={ ( { onClose } ) => ( | ||
<BlockHierarchy onSelect={ onClose } /> | ||
) } | ||
/> | ||
); | ||
} | ||
|
||
export default withSelect( ( select ) => { | ||
const { | ||
getSelectedBlockClientId, | ||
getBlockHierarchyRootClientId, | ||
getBlockCount, | ||
} = select( 'core/editor' ); | ||
const selectedBlockClientId = getSelectedBlockClientId(); | ||
const rootClientId = selectedBlockClientId && getBlockHierarchyRootClientId( selectedBlockClientId ); | ||
return { | ||
countInnerBlocks: rootClientId ? getBlockCount( rootClientId ) : 0, | ||
rootClientId, | ||
selectedBlockClientId, | ||
}; | ||
} )( BlockHierarchyDropdown ); |
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,89 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import { map, noop } from 'lodash'; | ||
import classnames from 'classnames'; | ||
|
||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { withSelect, withDispatch } from '@wordpress/data'; | ||
import { MenuItem, MenuGroup } from '@wordpress/components'; | ||
import { getBlockType } from '@wordpress/blocks'; | ||
import { compose } from '@wordpress/compose'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import BlockIcon from '../block-icon'; | ||
|
||
function BlockHierarchyList( { blocks, selectedBlockClientId, selectBlock } ) { | ||
return ( | ||
<ul className="editor-block-hierarchy__list"> | ||
{ map( blocks, ( block ) => { | ||
const blockType = getBlockType( block.name ); | ||
return ( | ||
<li key={ block.clientId }> | ||
<div role="presentation" className="editor-block-hierarchy__item"> | ||
<MenuItem | ||
className={ classnames( 'editor-block-hierarchy__item-button', { | ||
'is-selected': block.clientId === selectedBlockClientId, | ||
} ) } | ||
onClick={ () => selectBlock( block.clientId ) } | ||
isSelected={ block.clientId === selectedBlockClientId } | ||
> | ||
<BlockIcon icon={ blockType.icon } showColors /> | ||
{ blockType.title } | ||
</MenuItem> | ||
</div> | ||
{ !! block.innerBlocks && !! block.innerBlocks.length && ( | ||
<BlockHierarchyList | ||
blocks={ block.innerBlocks } | ||
selectedBlockClientId={ selectedBlockClientId } | ||
selectBlock={ selectBlock } | ||
/> | ||
) } | ||
</li> | ||
); | ||
} ) } | ||
</ul> | ||
); | ||
} | ||
|
||
function BlockHierarchy( { rootBlock, selectedBlockClientId, selectBlock } ) { | ||
if ( ! rootBlock ) { | ||
return null; | ||
} | ||
return ( | ||
<MenuGroup> | ||
<BlockHierarchyList | ||
blocks={ [ rootBlock ] } | ||
selectedBlockClientId={ selectedBlockClientId } | ||
selectBlock={ selectBlock } | ||
/> | ||
</MenuGroup> | ||
); | ||
} | ||
|
||
export default compose( | ||
withSelect( ( select ) => { | ||
const { | ||
getSelectedBlockClientId, | ||
getBlockHierarchyRootClientId, | ||
getBlock, | ||
} = select( 'core/editor' ); | ||
const selectedBlockClientId = getSelectedBlockClientId(); | ||
return { | ||
rootBlock: selectedBlockClientId ? getBlock( getBlockHierarchyRootClientId( selectedBlockClientId ) ) : null, | ||
selectedBlockClientId, | ||
}; | ||
} ), | ||
withDispatch( ( dispatch, { onSelect = noop } ) => { | ||
return { | ||
selectBlock( clientId ) { | ||
dispatch( 'core/editor' ).selectBlock( clientId ); | ||
onSelect( clientId ); | ||
}, | ||
}; | ||
} ) | ||
)( BlockHierarchy ); |
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,66 @@ | ||
$tree-border-width: 2px; | ||
$tree-item-height: 36px; | ||
|
||
.editor-block-hierarchy__list { | ||
padding: 0; | ||
margin: 0; | ||
} | ||
|
||
.editor-block-hierarchy__list .editor-block-hierarchy__list { | ||
margin-top: 2px; | ||
border-left: $tree-border-width solid $light-gray-900; | ||
margin-left: 1em; | ||
|
||
.editor-block-hierarchy__list { | ||
margin-left: 1.5em; | ||
} | ||
|
||
.editor-block-hierarchy__item { | ||
position: relative; | ||
|
||
&::before { | ||
position: absolute; | ||
left: 0; | ||
background: $light-gray-900; | ||
width: 0.5em; | ||
height: $tree-border-width; | ||
content: ""; | ||
top: calc(50% - #{ $tree-border-width / 2 }); | ||
} | ||
} | ||
|
||
.editor-block-hierarchy__item-button { | ||
margin-left: 0.8em; | ||
width: calc(100% - 0.8em); | ||
} | ||
|
||
& > li:last-child { | ||
position: relative; | ||
&::after { | ||
position: absolute; | ||
content: ""; | ||
background: $white; | ||
top: ($tree-item-height + $tree-border-width ) / 2; | ||
bottom: 0; | ||
left: -$tree-border-width; | ||
width: $tree-border-width; | ||
} | ||
} | ||
} | ||
|
||
.editor-block-hierarchy__item-button { | ||
padding: 6px; | ||
display: flex; | ||
align-items: center; | ||
border-radius: 4px; | ||
|
||
.editor-block-icon { | ||
margin-right: 6px; | ||
} | ||
|
||
&.is-selected, | ||
&.is-selected:focus { | ||
color: $dark-gray-700; | ||
background: $light-gray-300; | ||
} | ||
} |
Oops, something went wrong.
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.
Nitpick but (arguably) we don't need to wrap prose text in markdown files. It makes them harder to diff/edit/change over multiple lines and the alignment probably matters less, no? 🤷♂️