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

Update Panel Component Documentation #9836

Merged
merged 6 commits into from Sep 25, 2018

Conversation

Projects
None yet
3 participants
@milesdelliott
Contributor

milesdelliott commented Sep 12, 2018

Description

Expands on the existing Panel Documentation with greater information about the props. I was unsure about how much detail to include about using the whole Panel (which is used less often as I understand it) versus using it within the InspectorControls panel, so I included information about both. There is still some possibility of confusion on when to use Panel versus just PanelBody however.

How has this been tested?

Example components have been tested with a dummy component to ensure they work out of the box

Types of changes

Just a documentation update to address #9107

milesdelliott added some commits Sep 12, 2018

Update Panel Docs
Add more information about how to use with InspsectorControls

@Soean Soean added the Documentation label Sep 13, 2018

@gziolo gziolo added this to the 4.0 milestone Sep 25, 2018

@gziolo

gziolo approved these changes Sep 25, 2018

I added a few visual tweaks to make it look similar to other documentation files I'm familiar with.

I removed the example for InspectorControls as it is part of another npm package and is only confusing for those who want only to use the components listed in this file.

Thanks for your contribution 👍

@gziolo gziolo merged commit 563053d into WordPress:master Sep 25, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@milesdelliott

This comment has been minimized.

Show comment
Hide comment
@milesdelliott

milesdelliott Sep 25, 2018

Contributor

Thanks!

Contributor

milesdelliott commented Sep 25, 2018

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment