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.

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

Merged

Conversation

JustinyAhin
Copy link
Member

Description

Added documentation for the block mover component (see #22891)

How has this been tested?

N/A, documentation only

Types of changes

Documentation

Checklist:

  • [n/a] My code is tested.
  • [n/a] My code follows the WordPress code style.
  • [n/a] My code follows the accessibility standards.
  • [n/a] My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@JustinyAhin
Copy link
Member Author

@youknowriad I was wondering where a contributor relatively new to some components (me 😀) can find docs about it.
For instance, for this particular one, I had to search through the code to find where some of the props are used; and guess what others do 😀.

@youknowriad
Copy link
Contributor

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`
Copy link
Contributor

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.

@JustinyAhin JustinyAhin marked this pull request as ready for review August 28, 2020 13:31
@JustinyAhin JustinyAhin requested a review from ellatrix as a code owner August 28, 2020 13:31

```jsx
import { BlockMover } from '@wordpress/block-editor';
<BlockMover clientIds={ [ clientId ] } />
Copy link
Contributor

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?)

Copy link
Member Author

Choose a reason for hiding this comment

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

Looks fine I think.

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@youknowriad youknowriad merged commit a4e381b into WordPress:master Aug 31, 2020
@github-actions github-actions bot added this to the Gutenberg 8.9 milestone Aug 31, 2020
@JustinyAhin JustinyAhin deleted the add/block-mover-component-readme branch August 31, 2020 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants