Add a function to register a block style variation #7997
Merged
Conversation
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
youknowriad
added
the
[Feature] Extensibility
noisysocks
previously requested changes
Jul 18, 2018
blocks/api/registration.js
Outdated
| @@ -330,3 +330,25 @@ export const getChildBlockNames = ( blockName ) => { | |||
| export const hasChildBlocks = ( blockName ) => { | |||
| return select( 'core/blocks' ).hasChildBlocks( blockName ); | |||
| }; | |||
|
|
|||
| /** | |||
| * Registers a new block style variation for the given block | |||
There was a problem hiding this comment.
Missing a period (.) at the end of the sentence here.
blocks/api/registration.js
Outdated
| * Registers a new block style variation for the given block | ||
| * | ||
| * @param {string} blockName Block type name. | ||
| * @param {Object} styleVariation Block style variation. |
There was a problem hiding this comment.
Should we document what properties this object has?
@param {Object} styleVariation Object containing `name` which is the class name applied to the block and `label` which identifies the variation to the user.
mtias
reviewed
Jul 18, 2018
blocks/api/registration.js
Outdated
| * @param {string} blockName Block type name. | ||
| * @param {Object} styleVariation Block style variation. | ||
| */ | ||
| export const registerBlockStyleVariation = ( blockName, styleVariation ) => { |
There was a problem hiding this comment.
registerBlockStyle seems simpler to me
tofumatt
reviewed
Jul 18, 2018
blocks/api/registration.js
Outdated
| /** | ||
| * Registers a new block style variation for the given block | ||
| * | ||
| * @param {string} blockName Block type name. |
There was a problem hiding this comment.
Block type name might actually be slightly confusing comment here because it implies blocks can have types and that’s what this is? That’s how I read it. It would be better to just say “name of block”. Maybe even provide an example like “Name of block (example: “latest-posts”).”
tofumatt
approved these changes
Jul 18, 2018
blocks/api/registration.js
Outdated
| * @param {Object} styleVariation Object containing `name` which is the class name applied to the block and `label` which identifies the variation to the user. | ||
| */ | ||
| export const registerBlockStyle = ( blockName, styleVariation ) => { | ||
| addFilter( 'blocks.registerBlockType', blockName + '/' + styleVariation.name, ( settings, name ) => { |
There was a problem hiding this comment.
Nitpick: We could use template strings here.
|
We should add this to the docs, see #8145 |
youknowriad
force-pushed
the
add/block-styles-variation
branch
from
2431e02
to
bd0c215
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a helper function to easily add a new block style variation as this is a common extensibility pattern.
Testing instructions
wp.blocks. registerBlockStyle( 'core/paragraph', { name: 'big', label: 'Big Style' })registerCoreBlocks)Related #7551