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

Expand documentation to include InspectorControls code examples #4478

Closed
danielbachhuber opened this issue Jan 15, 2018 · 2 comments
Closed
Assignees
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers

Comments

@danielbachhuber
Copy link
Member

I'm working on a demo ES5 Countdown Timer block at the moment. It needs two control elements: label and countdown_date.

Because the latter is a computed value, I want to create a TextControl (or similar) to input the date. However, only BlockControls are documented so I spent a fair amount of time in confusion until I realized there's an InspectorControls API too. It would be nice to have this documented.

@danielbachhuber danielbachhuber added the [Type] Developer Documentation Documentation for developers label Jan 15, 2018
@mtias mtias added this to the Documentation & Handbook milestone Oct 7, 2018
@chrisvanpatten chrisvanpatten changed the title Expand documentation to include usage examples of InspectorControls Expand documentation to include InspectorControls code examples Nov 6, 2018
@chrisvanpatten chrisvanpatten added the Good First Issue An issue that's suitable for someone looking to contribute for the first time label Nov 6, 2018
@chrisvanpatten
Copy link
Contributor

chrisvanpatten commented Nov 6, 2018

This should be an easy one — we have the documentation already, just need some code examples.

https://github.com/WordPress/gutenberg/blob/master/docs/blocks/block-controls-toolbars-and-inspector.md

Possibly volunteering @ajitbohra for this one, if you're interested? 😅

@ajitbohra
Copy link
Member

@chrisvanpatten will do documentation sprint in the next couple of day will add this to my list.

Seems like probably have worked on this but forget to push!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time [Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

6 participants