Overview
Brief introduction to the technical detail of the component, avoid duplicating content from “Usage & guidelines” section.
Basic usage
Importing the component
Provide instructions for importing the component and its related styles.
[Code block]
Global configuration (if relevant)
Show how to register the component globally within an application.
[Code block]
Example usage
Include a simple usage example that demonstrates how to implement the component in its most basic form.
[Code block]
Component playground and props
Embed the default Storybook story with controls (to include the props documentation).
Accessibility
Include accessibility guidance, things to document:
- Keyboard interaction
- Aria roles and labels
- Screenreader experience
- Implementation considerations
Internationalisation
Include relevant i18n info, for example:
- Right-to-left
- Long labels / custom labels
SEO
Key SEO considerations:
- Server rendering
- Semantic markup
- Structured data