Block Editor: Add README for BlockControls
#52366
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
tyxla
added
[Type] Developer Documentation
mburridge
reviewed
Jul 6, 2023
| @@ -0,0 +1,89 @@ | |||
| # BlockControls | |||
|
|
|||
| When the user selects a particular block, a toolbar positioned above the selected block displays a set of control buttons. Certain block-level controls are automatically included in the toolbar under specific circumstances. For example, there is a control for converting the block into a different type or when the focused element is a RichText component. | |||
There was a problem hiding this comment.
a toolbar positioned above the selected block
It can optionally be displayed in the top toolbar of the editor. Dunno if this is worth mentioning. 🤷♂️
There was a problem hiding this comment.
Yeah, well I guess it's not a huge miss. As I mentioned, this is a first pass and it can definitely be expanded further to contain the Slot and Fill usages and maybe a few more examples, but I've tried to make a compromise and have something useful with a few additional links to start with. It's better than nothing 😉
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.
What?
This PR adds a basic README for the
BlockControlscomponent.Fixes #52061.
Why?
Part of #22891 where we aim to document all block editor components.
How?
Just adding a README. I'm keeping it simple - there are a few more scenarios with the underlying
SlotandFillthat could be documented, but I think this is a good first pass.Testing Instructions
Not needed.
Testing Instructions for Keyboard
None.
Screenshots or screencast
None.