Skip to content

POC: Filter toolbar items by prop in contentOnly #71469

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.

Sign up for GitHub

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

Closed
jeryj wants to merge 13 commits into from
Closed

POC: Filter toolbar items by prop in contentOnly #71469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9d99bdd
Add filter prop to slot fills
jeryj Sep 2, 2025
eec43dc
Use filtering in block controls slots
jeryj Sep 2, 2025
c16e98b
Make filtering on slot fills private
jeryj Sep 2, 2025
be7e1b2
Simplify slot fill ts definition
jeryj Sep 2, 2025
ee6b550
Remove alignment control from write mode
jeryj Sep 3, 2025
e79ee55
Remove unneeded category=content from toolbaritem
jeryj Sep 3, 2025
2c48aee
Filter block tools in fill wrapper
jeryj Sep 3, 2025
b15e32e
Revert changes to slot fill - remove slot fill filtering from slot co…
jeryj Sep 3, 2025
e28f37b
Simplify fill filtering
jeryj Sep 3, 2025
a85db5e
Revert block-controls/slot.js
jeryj Sep 3, 2025
49024a8
Really revert slot.js
jeryj Sep 3, 2025
4232366
Use React's Children.toArray
jeryj Sep 4, 2025
df2028f
Use fillProps for filtering contentOnly block tools
jeryj Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions packages/block-editor/src/components/block-controls/fill.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
__experimentalStyleProvider as StyleProvider,
ToolbarGroup,
} from '@wordpress/components';
import { Children } from '@wordpress/element';

/**
* Internal dependencies
Expand All @@ -21,29 +22,39 @@ export default function BlockControlsFill( {
group,
__experimentalShareWithChildBlocks
);

if ( ! Fill ) {
return null;
}

const innerMarkup = (
<>
{ group === 'default' && <ToolbarGroup controls={ controls } /> }
{ children }
</>
);

return (
<StyleProvider document={ document }>
<Fill>
{ ( fillProps ) => {
// `fillProps.forwardedContext` is an array of context provider entries, provided by slot,
// that should wrap the fill markup.
const { forwardedContext = [] } = fillProps;
const { forwardedContext = [], shouldRender = () => true } =
fillProps;

// Filter children based on shouldRender callback
const childrenArray = Children.toArray( children );
const filteredChildren =
childrenArray.filter( shouldRender );

const filteredMarkup = (
<>
{ group === 'default' && (
<ToolbarGroup controls={ controls } />
) }
{ filteredChildren }
</>
);

return forwardedContext.reduce(
( inner, [ Provider, props ] ) => (
<Provider { ...props }>{ inner }</Provider>
),
innerMarkup
filteredMarkup
);
} }
</Fill>
Expand Down
15 changes: 14 additions & 1 deletion packages/block-editor/src/components/block-controls/slot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,33 @@ import warning from '@wordpress/warning';
*/
import groups from './groups';
import { unlock } from '../../lock-unlock';
import { useBlockEditingMode } from '../block-editing-mode';

const { ComponentsContext } = unlock( privateApis );

export default function BlockControlsSlot( { group = 'default', ...props } ) {
const toolbarState = useContext( ToolbarContext );
const contextState = useContext( ComponentsContext );

// Get the block editing mode for the current block
const blockEditingMode = useBlockEditingMode();

const fillProps = useMemo(
() => ( {
forwardedContext: [
[ ToolbarContext.Provider, { value: toolbarState } ],
[ ComponentsContext.Provider, { value: contextState } ],
],
shouldRender: ( element ) => {
// In content-only mode, only render elements with category="content"
if ( blockEditingMode === 'contentOnly' ) {
return element?.props?.category === 'content';
}
// In other modes, render all elements
return true;
},
} ),
[ toolbarState, contextState ]
[ toolbarState, contextState, blockEditingMode ]
);

const slotFill = groups[ group ];
Expand Down
2 changes: 1 addition & 1 deletion packages/block-editor/src/components/rich-text/format-toolbar-container.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const FormatToolbarContainer = ( { inline, editableContentElement } ) => {
// Render regular toolbar.
return (
<BlockControls group="inline">
<FormatToolbar />
<FormatToolbar category="content" />
Copy link
Copy Markdown
Contributor

@getdave getdave Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note the approach in #71058 for restricting formatting controls. If your approach is better and we can have one unified mechanism then we'd need to revert that.

Copy link
Copy Markdown
Contributor Author

@jeryj jeryj Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think they work alongside each other. This category="content" says "we want this component to show when in contentOnly mode" and yours is filtering which format controls should be shown within it.

</BlockControls>
);
};
Expand Down
31 changes: 14 additions & 17 deletions packages/block-library/src/image/image.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -714,8 +714,7 @@ export default function Image( {
const mediaReplaceFlow = isSingleSelected &&
! isEditingImage &&
! lockUrlControls && (
// For contentOnly mode, put this button in its own area so it has borders around it.
<BlockControls group={ isContentOnlyMode ? 'inline' : 'other' }>
<BlockControls group="other">
<MediaReplaceFlow
mediaId={ id }
mediaURL={ url }
Expand All @@ -726,6 +725,7 @@ export default function Image( {
onError={ onUploadError }
name={ ! url ? __( 'Add image' ) : __( 'Replace' ) }
onReset={ () => onSelectImage( undefined ) }
category="content"
Copy link
Copy Markdown
Contributor

@getdave getdave Sep 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously we can make this a private API for now via Symbols, but don't bother until we've got more feedback.

Copy link
Copy Markdown
Contributor Author

@jeryj jeryj Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I'm not worried about that specific quite yet. I want to see about the overall approach first and then get into the details.

/>
</BlockControls>
);
Expand Down Expand Up @@ -777,21 +777,18 @@ export default function Image( {
</ToolbarGroup>
</BlockControls>
) }
{ isContentOnlyMode && (
// Add some extra controls for content attributes when content only mode is active.
// With content only mode active, the inspector is hidden, so users need another way
// to edit these attributes.
<BlockControls group="block">
<ContentOnlyControls
attributes={ attributes }
setAttributes={ setAttributes }
lockAltControls={ lockAltControls }
lockAltControlsMessage={ lockAltControlsMessage }
lockTitleControls={ lockTitleControls }
lockTitleControlsMessage={ lockTitleControlsMessage }
/>
</BlockControls>
) }
{ /* Content-only controls - automatically filtered by category="content" */ }
<BlockControls group="block">
<ContentOnlyControls
category="content"
attributes={ attributes }
setAttributes={ setAttributes }
lockAltControls={ lockAltControls }
lockAltControlsMessage={ lockAltControlsMessage }
lockTitleControls={ lockTitleControls }
lockTitleControlsMessage={ lockTitleControlsMessage }
/>
</BlockControls>
<InspectorControls>
<ToolsPanel
label={ __( 'Settings' ) }
Expand Down
42 changes: 19 additions & 23 deletions packages/block-library/src/paragraph/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import {
RichText,
useBlockProps,
useSettings,
useBlockEditingMode,
} from '@wordpress/block-editor';
import { getBlockSupport } from '@wordpress/blocks';
import { formatLtr } from '@wordpress/icons';
Expand Down Expand Up @@ -117,31 +116,28 @@ function ParagraphBlock( {
} ),
style: { direction },
} );
const blockEditingMode = useBlockEditingMode();

return (
<>
{ blockEditingMode === 'default' && (
<BlockControls group="block">
<AlignmentControl
value={ align }
onChange={ ( newAlign ) =>
setAttributes( {
align: newAlign,
dropCap: hasDropCapDisabled( newAlign )
? false
: dropCap,
} )
}
/>
<ParagraphRTLControl
direction={ direction }
setDirection={ ( newDirection ) =>
setAttributes( { direction: newDirection } )
}
/>
</BlockControls>
) }
<BlockControls group="block">
<AlignmentControl
value={ align }
onChange={ ( newAlign ) =>
setAttributes( {
align: newAlign,
dropCap: hasDropCapDisabled( newAlign )
? false
: dropCap,
} )
}
/>
<ParagraphRTLControl
direction={ direction }
setDirection={ ( newDirection ) =>
setAttributes( { direction: newDirection } )
}
/>
</BlockControls>
{ isSingleSelected && (
<DropCapControl
name={ name }
Expand Down
Loading