-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Add/block mover component readme #24851
Add/block mover component readme #24851
Conversation
@youknowriad I was wondering where a contributor relatively new to some components (me 😀) can find docs about it. |
These components in general are components that are not meant to be used by third-party developpers a lot, it's for advanced developpers that want to build their own editors. so right now, they are not really documented anywhere. In fact the work you're doing is the first attempt at this which is great. |
The orientation of the block movers, vertical or horizontal. | ||
|
||
- Type: `String` | ||
- Required: `No` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe all the props aside clientIds
are props provided by the interal withSelect which means you should remove them from the README.
|
||
```jsx | ||
import { BlockMover } from '@wordpress/block-editor'; | ||
<BlockMover clientIds={ [ clientId ] } /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we do the same as BlockBreadcrumb here (wrapping?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine I think.
…b.com/JustinyAhin/gutenberg into add/block-mover-component-readme
…/JustinyAhin/gutenberg into add/block-mover-component-readme
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Description
Added documentation for the block mover component (see #22891)
How has this been tested?
N/A, documentation only
Types of changes
Documentation
Checklist: