Make parts of the BlockNavigationList overridable using slots #21948
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { Children, cloneElement, useContext } from '@wordpress/element'; | ||
| import { Fill, Slot } from '@wordpress/components'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import BlockNavigationListItem from './list-item'; | ||
| import { BlockNavigationContext } from './list'; | ||
| import { BlockListBlockContext } from '../block-list/block'; | ||
|
|
||
| const BlockNavigationBranch = ( { children, ...props } ) => { | ||
| const { withBlockNavigationSlots } = useContext( BlockNavigationContext ); | ||
| if ( ! withBlockNavigationSlots ) { | ||
| return ( | ||
| <li> | ||
| <BlockNavigationListItem { ...props } /> | ||
| { children } | ||
| </li> | ||
| ); | ||
| } | ||
|
|
||
| return ( | ||
| <li> | ||
| <BlockNavigationListItemSlot blockId={ props.block.clientId }> | ||
| { ( fills ) => { | ||
| if ( ! fills.length ) { | ||
| return <BlockNavigationListItem { ...props } />; | ||
| } | ||
|
|
||
| return Children.map( fills, ( fill ) => | ||
| cloneElement( fill, { | ||
| ...props, | ||
| ...fill.props, | ||
| } ) | ||
| ); | ||
| } } | ||
| </BlockNavigationListItemSlot> | ||
| { children } | ||
| </li> | ||
| ); | ||
| }; | ||
|
|
||
| export default BlockNavigationBranch; | ||
|
|
||
| const listItemSlotName = ( blockId ) => `BlockNavigationList-item-${ blockId }`; | ||
|
|
||
| export const BlockNavigationListItemSlot = ( { blockId, ...props } ) => ( | ||
| <Slot { ...props } name={ listItemSlotName( blockId ) } /> | ||
| ); | ||
|
|
||
| export const BlockNavigationListItemFill = ( props ) => { | ||
| const { clientId } = useContext( BlockListBlockContext ); | ||
| return <Fill { ...props } name={ listItemSlotName( clientId ) } />; | ||
| }; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /** | ||
| * External dependencies | ||
| */ | ||
| import classnames from 'classnames'; | ||
|
|
||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { Button, VisuallyHidden } from '@wordpress/components'; | ||
| import { | ||
| __experimentalGetBlockLabel as getBlockLabel, | ||
| getBlockType, | ||
| } from '@wordpress/blocks'; | ||
| import { __ } from '@wordpress/i18n'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import BlockIcon from '../block-icon'; | ||
|
|
||
| export default function BlockNavigationListItem( { | ||
| block, | ||
| onClick, | ||
| isSelected, | ||
| wrapperComponent: WrapperComponent, | ||
| children, | ||
| } ) { | ||
| const blockType = getBlockType( block.name ); | ||
|
|
||
| return ( | ||
| <div className="block-editor-block-navigation__item"> | ||
|
There was a problem hiding this comment. I just noticed some of the class names don't seem to be right after moving the code around. The root element should have the class name |
||
| <WrapperComponent | ||
| className={ classnames( | ||
| 'block-editor-block-navigation__item-button', | ||
| { | ||
| 'is-selected': isSelected, | ||
| } | ||
| ) } | ||
| onClick={ onClick } | ||
| > | ||
| <BlockIcon icon={ blockType.icon } showColors /> | ||
| { children | ||
| ? children | ||
| : getBlockLabel( blockType, block.attributes ) } | ||
| { isSelected && ( | ||
| <VisuallyHidden as="span"> | ||
| { __( '(selected block)' ) } | ||
| </VisuallyHidden> | ||
| ) } | ||
| </WrapperComponent> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| BlockNavigationListItem.defaultProps = { | ||
| onClick: () => {}, | ||
| wrapperComponent: ( props ) => <Button { ...props } />, | ||
| }; | ||
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
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.
I think it'd be good to make this
__experimentalWithBlockNavigationSlots, as it's a publicly exported prop, and it's hard to say what the future is, this may default totrueat some point at which point we'd want to remove it gracefully without having to support backwards compatibility.