Skip to content
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

Docs: clarify isDefault usage for registerBlockStyles() #11478

Merged
merged 4 commits into from
Jan 29, 2019
Merged

Docs: clarify isDefault usage for registerBlockStyles() #11478

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4b7ddd0
Docs: Remove isDefault from registerBlockStyle
ajitbohra Nov 5, 2018
4f7ff65
Merge branch 'master' into update/docs-block-styles
ajitbohra Jan 27, 2019
492abb2
Docs: clarify isDefault usage for registerBlockStyles()
ajitbohra Jan 27, 2019
dfb51a0
Clarify isDefault
gziolo Jan 28, 2019
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
2 changes: 1 addition & 1 deletion docs/designers-developers/developers/filters/block-filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ wp.blocks.registerBlockStyle( 'core/quote', {

The example above registers a block style variation named `fancy-quote` to the `core/quote` block. When the user selects this block style variation from the styles selector, an `is-style-fancy-quote` className will be added to the block's wrapper.

By adding `isDefault: true`, you can make registered style variation to be active by default when a block is inserted.
By adding `isDefault: true` you can make the registered style variation to be used as a fallback if no style in `registerBlockType()` has been set as the default.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe something like?

By adding isDefault: true you can mark the registered style variation as the one that is active without any custom className.

(Or something in that vein, it's hard to explain :P)

ajitbohra marked this conversation as resolved.
Show resolved Hide resolved

To remove a block style variation use `wp.blocks.unregisterBlockStyle()`.

Expand Down