Update: Allow blocks with supports align to have a default alignment #9338
Conversation
jorgefilipecosta
changed the title
packages/editor/src/hooks/align.js
Outdated
| @@ -23,6 +23,9 @@ import { BlockControls, BlockAlignmentToolbar } from '../components'; | |||
| * @return {Object} Filtered block settings | |||
| */ | |||
| export function addAttribute( settings ) { | |||
| if ( has( settings, [ 'attributes', 'align' ] ) ) { | |||
There was a problem hiding this comment.
Should we also check if it has a proper type === string?
gziolo
added
the
[Feature] Block API
jorgefilipecosta
force-pushed
the
update/allow-blocks-with-supports-align-to-have-default
branch
from
032c003 to
ddda54a
Compare
jorgefilipecosta
deleted the
update/allow-blocks-with-supports-align-to-have-default
branch
| @@ -23,6 +23,10 @@ import { BlockControls, BlockAlignmentToolbar } from '../components'; | |||
| * @return {Object} Filtered block settings | |||
| */ | |||
| export function addAttribute( settings ) { | |||
| // allow blocks to specify their own attribute definition with default values if needed. | |||
| if ( get( settings.attributes, [ 'align', 'type' ] ) === 'string' ) { | |||
There was a problem hiding this comment.
Why do we specifically check the type? Would it be okay for us to override the attribute definition if it was a type other than string ? Would has( settings.attributes, [ 'align' ] ) not have been sufficient?
There was a problem hiding this comment.
We are checking the type because when using the align hook the hook is the one setting the align value and the hook sets a string, so specifying an attribute with a different type would not work correctly.
When setting supports align the expectation is that the hook will work properly so in this case for the hook to work properly we need to change the align attribute, I think it is acceptable.
Description
Supports align option allow blocks to have an alignment option (toolbar, attributes, and class names in the editor and save) with just one line. That is awesome to avoid duplicate code.
But if we need a block with supports align but also have a default alignment (e.g: right) that was not possible.
This Pr's makes sure blocks can use supports align and have a default alignment. To do that blocks have to provide their own align attribute definition with the default option set.
How has this been tested?
I used the following test block https://gist.github.com/jorgefilipecosta/d3cc0a9937ac1105e0a0537efd0e615b and checked the default align right is applied.