[Documentation] add examples for core/blocks actions
#42637
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
19 tasks
|
Size Change: +266 B (0%) Total Size: 1.26 MB
ℹ️ View Unchanged
|
gziolo
reviewed
Jul 25, 2022
| import { useDispatch } from '@wordpress/data'; | ||
|
|
||
| const ExampleComponent = () => { | ||
| const { addBlockTypes } = useDispatch( blocksStore ); |
There was a problem hiding this comment.
I'm not sure if we should continue promoting this action because the process of registering a block type has more steps, and it's only one of them. I would say it's an internal API that gets executed with registerBlockType from @wordpress/blocks.
There was a problem hiding this comment.
Might be a good candidate for @ignore, agreed?
| return ( | ||
| <Button | ||
| onClick={ () => | ||
| removeBlockTypes( [ 'core/cover', 'core/heading' ] ) |
There was a problem hiding this comment.
Similar to addBlockTypes this might be treated as an internal API. Technically, it's perfectly fine to use it directly, but it might change with time.
|
@gziolo I'm starting to think that perhaps any actions that have a corresponding member in the |
Yes, it's very likely you are correct. We would have to check existing docs and code in the repository to confirm that. Well, we can always update recommendations to what you proposed if that makes the most sense. For selectors, we probably should do the opposite and promote using |
…@ignore. Add instructions to the Actions section where to find the apporpriate functions.
|
@gziolo I've done a pass adding |
gziolo
reviewed
Jul 27, 2022
There was a problem hiding this comment.
I checked all current actions, and you are correct that all of them are used internally by public APIs from @wordpress/blocks`.
I'm still not 100% sure whether we should completely remove <!-- START TOKEN(Autogenerated actions|../../../packages/blocks/src/store/actions.js) --> from the document. All actions are ignored at the moment, but maybe in the future we start using some new actions directly from the store 🤷🏻♂️
The good news is that most of the examples can be used with the public API of @wordpress/blocks with small editions.
One more thing, I'm curious what do you think about replacing:
Ignored from documentation as it's internal to the data store.
with something like:
Ignored from documentation as the recommended usage for this action through
methodNamefrom@wordpress/blocks.
| - `Object`: Action object. | ||
|
|
||
| <!-- END TOKEN(Autogenerated actions|../../../packages/blocks/src/store/actions.js) --> | ||
| The actions in this package shouldn't be used directly. Instead, use the functions listed in the public API [here](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-blocks/) |
There was a problem hiding this comment.
According to contributing guides https://github.com/WordPress/gutenberg/tree/trunk/docs/contributors/documentation#using-links this link should look as follows:
Suggested change
| The actions in this package shouldn't be used directly. Instead, use the functions listed in the public API [here](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-blocks/) | |
| The actions in this package shouldn't be used directly. Instead, use the functions listed in the public API [here](/packages/blocks/README.md) |
The rest will magically happen behind the scenes.
| @@ -717,231 +717,4 @@ _Returns_ | |||
|
|
|||
| ## Actions | |||
|
|
|||
| <!-- START TOKEN(Autogenerated actions|../../../packages/blocks/src/store/actions.js) --> | |||
|
|
|||
| ### addBlockCollection | |||
There was a problem hiding this comment.
Used by registerBlockCollection.
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### addBlockStyles |
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### addBlockTypes |
There was a problem hiding this comment.
Used indirectly by registerBlockType.
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### addBlockVariations |
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### setDefaultBlockName |
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### setFreeformFallbackBlockName |
There was a problem hiding this comment.
Used by setFreeformContentHandlerName.
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### setGroupingBlockName |
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### setUnregisteredFallbackBlockName |
There was a problem hiding this comment.
Used by setUnregisteredTypeHandlerName.
|
|
||
| - `Object`: Action object. | ||
|
|
||
| ### updateCategory |
@gziolo I really like this suggestion. It will point those that like to source code dive in the corrected direction. I'll make those updates and revert the removal of the tokens today. |
…on. Revert the removal of the tokens and add the correct link per contribution practices.
gziolo
approved these changes
Jul 27, 2022
|
Changed to 'Developer Documentation' (from User Documentation)
|
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 examples for the actions in core/blocks. Part of #42125