Gutenberg component documentation template

README.md

ComponentNameControl

Component description

Table of contents

1. Design guidelines
2. Development guidelines
3. Related components

Design guidelines

Usage

When to use a ComponentNameControl

• Describe when the component should be used
• Also, try providing a few examples of when it might be appropriate to use this component

Do: Describe an example of how this component should be used, with a screenshot

Don’t: Describe an example of how this component should not be used, with a screenshot

Behavior

Describe how the component behaves.

Content Guidelines

If the component accepts labels or other defined text, describe how those strings should be written, with clear "dos" and don'ts".

Development guidelines

Usage

Description of usage example

// Your code example

Description of another usage example

// Your other code example

Props

• The set of props accepted by the component will be specified below.
• Additional notes about the component props, if necessary

propName

The prop description goes here.

• Type: String
• Required: No

Related components

• List of related components, with links