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/inserter list item component readme #25116

Conversation

JustinyAhin
Copy link
Member

Description

Added documentation for the inserter list item 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.

import { InserterListItem } from '@wordpress/block-editor';

const MyInserterListItem = () => (
<InserterListItem />
Copy link
Member Author

Choose a reason for hiding this comment

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

@ntsekouras maybe you can help me on this ... I'm having a hard time to identify what are the required props for this component.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @JustinyAhin! The InserterListItem component it's actually a single element that shows a block in quick appender and the main appender list. It's only used for now in these places with a single entry point here:

You can see from the code above, the usage of many needed props in GB core.

I'm not really sure if the composite is required and if is tightly coupled with Reakit parent there.. (import { Composite, useCompositeState } from 'reakit';

(https://reakit.io/docs/composite/). @youknowriad any input here, since I saw you made that addition for better keyboard navigation.

@JustinyAhin JustinyAhin marked this pull request as ready for review September 8, 2020 09:03
@JustinyAhin JustinyAhin added the [Type] Developer Documentation Documentation for developers label Sep 8, 2020
Base automatically changed from master to trunk March 1, 2021 15:44
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