Block API: Add block visibility control support and UI #71203
Next
Next commit
Block API: Add block visibility control support and UI
- Loading branch information
commit 6436944dfa438f7f4eb1c2796bbec18d9cbbee6f
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,27 @@ | ||
| <?php | ||
| /** | ||
| * Block visibility block support flag. | ||
| * | ||
| * @package gutenberg | ||
| */ | ||
|
|
||
| /** | ||
| * Render nothing if the block is hidden. | ||
| * | ||
| * @param string $block_content The block content. | ||
| * @param array $block The block. | ||
| * | ||
| * @return string The block content. | ||
| */ | ||
| function gutenberg_render_block_visibility_support( $block_content, $block ) { | ||
| if ( isset( $block['attrs']['metadata']['blockVisibility'] ) && false === $block['attrs']['metadata']['blockVisibility'] ) { | ||
| return ''; | ||
| } | ||
|
|
||
| return $block_content; | ||
| } | ||
|
|
||
| if ( function_exists( 'wp_render_block_visibility_support' ) ) { | ||
| remove_filter( 'render_block', 'wp_render_block_visibility_support' ); | ||
| } | ||
| add_filter( 'render_block', 'gutenberg_render_block_visibility_support', 10, 2 ); |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,3 @@ | ||
| export { default as BlockVisibilityMenuItem } from './menu-item'; | ||
| export { default as BlockVisibilityToolbar } from './toolbar'; | ||
| export { default as useBlockVisibility } from './use-block-visibility'; |
This file contains hidden or 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,47 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { __ } from '@wordpress/i18n'; | ||
| import { MenuItem } from '@wordpress/components'; | ||
| import { seen, unseen } from '@wordpress/icons'; | ||
| import { useSelect, useDispatch } from '@wordpress/data'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { cleanEmptyObject } from '../../hooks/utils'; | ||
| import { store as blockEditorStore } from '../../store'; | ||
|
|
||
| export default function BlockVisibilityMenuItem( { clientIds } ) { | ||
| const { updateBlockAttributes } = useDispatch( blockEditorStore ); | ||
| const blocks = useSelect( | ||
| ( select ) => { | ||
| return select( blockEditorStore ).getBlocksByClientId( clientIds ); | ||
| }, | ||
| [ clientIds ] | ||
| ); | ||
|
|
||
| const hasHiddenBlock = blocks.some( | ||
| ( block ) => block.attributes.metadata?.blockVisibility === false | ||
| ); | ||
|
|
||
| const toggleBlockVisibility = () => { | ||
| blocks.forEach( ( block ) => { | ||
| updateBlockAttributes( block.clientId, { | ||
| metadata: cleanEmptyObject( { | ||
| ...block.attributes?.metadata, | ||
| blockVisibility: hasHiddenBlock ? undefined : false, | ||
| } ), | ||
| } ); | ||
| } ); | ||
| }; | ||
t-hamano marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| return ( | ||
| <MenuItem | ||
| icon={ hasHiddenBlock ? seen : unseen } | ||
| onClick={ toggleBlockVisibility } | ||
| > | ||
| { hasHiddenBlock ? __( 'Show' ) : __( 'Hide' ) } | ||
| </MenuItem> | ||
| ); | ||
| } | ||
This file contains hidden or 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,61 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { __ } from '@wordpress/i18n'; | ||
| import { ToolbarButton, ToolbarGroup } from '@wordpress/components'; | ||
| import { useRef, useEffect } from '@wordpress/element'; | ||
| import { seen, unseen } from '@wordpress/icons'; | ||
| import { useDispatch } from '@wordpress/data'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import useBlockVisibility from './use-block-visibility'; | ||
| import { store as blockEditorStore } from '../../store'; | ||
|
|
||
| export default function BlockVisibilityToolbar( { clientId } ) { | ||
| const { canToggleBlockVisibility, isBlockVisible } = | ||
| useBlockVisibility( clientId ); | ||
|
|
||
| const hasBlockVisibilityButtonShownRef = useRef( false ); | ||
| const { updateBlockAttributes } = useDispatch( blockEditorStore ); | ||
|
|
||
| // If the block visibility button has been shown, we don't want to | ||
| // remove it from the toolbar until the toolbar is rendered again | ||
| // without it. Removing it beforehand can cause focus loss issues. | ||
| // It needs to return focus from whence it came, and to do that, | ||
| // we need to leave the button in the toolbar. | ||
| useEffect( () => { | ||
| if ( ! isBlockVisible ) { | ||
| hasBlockVisibilityButtonShownRef.current = true; | ||
| } | ||
| }, [ isBlockVisible ] ); | ||
|
|
||
| if ( isBlockVisible && ! hasBlockVisibilityButtonShownRef.current ) { | ||
| return null; | ||
| } | ||
|
|
||
| const label = isBlockVisible ? __( 'Hide' ) : __( 'Show' ); | ||
|
|
||
| return ( | ||
| <> | ||
| <ToolbarGroup className="block-editor-block-lock-toolbar"> | ||
| <ToolbarButton | ||
| disabled={ ! canToggleBlockVisibility } | ||
| icon={ isBlockVisible ? seen : unseen } | ||
| label={ label } | ||
| onClick={ () => { | ||
| const newBlockVisibility = ! isBlockVisible; | ||
| updateBlockAttributes( [ clientId ], { | ||
| metadata: { | ||
| blockVisibility: newBlockVisibility | ||
| ? undefined | ||
| : false, | ||
| }, | ||
| } ); | ||
| } } | ||
| /> | ||
| </ToolbarGroup> | ||
| </> | ||
| ); | ||
| } |
Oops, something went wrong.
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.
Maybe we should change this to
visibilityand the block part, which seems redundant.P.S. The block editor already uses similar terminology,
isBlockVisibleandsetBlockVisibility, to track if the block is visible in the canvas viewport. It would be nice to avoid confusion, but I can't think of better terminology.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 forgot about
isBlockVisible- thanks for pointing it out. I originally suggested something other than visibility as it's too close the name of a CSS property, and could clash semantically if it block supports ever gets it.We could remove the ambiguity and select a different word. The current
isBlockVisibletells the system whether the block is visible, whereas we're talking about a user-driven setting. What does the user want to do? temporarily hide blocks (otherwise they'd be deleted) and to stop them rendering on the frontend. It's a bit nuanced, swinging between _ prevent from being seen_ and switch off.Some alternatives
There might be a PhD thesis here somewhere 😆
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 don't have a strong opinion on which terminology (
visibilityorblockVisibility) is better, but the existingisBlockVisibleis indeed confusing. There is a proposal to rename the API: #71203 (comment)