Examples
Code
React
Preact/React documentation for Storybook
Style customization
The following CSS variables can be overridden to customize Form components:
Guidance
- Hints are built in to all design-system form fields but can be used on their own to create custom fields.
- Use hint text for supporting contextual help that is always visible.
- Hint text should sit between a form label and the input.
- Use lower visual style (i.e., lighter gray than the form label or the input option) so it won't compete for users' attention with the field label.
- Use hint text to indicate which inputs are optional when there are more required fields than optional.
- Hint text can also appear after an input box when the text is being used to show the value someone should be entering in the field (e.g., income amount input box displays text after the input box to highlight the amount should be "monthly income".)
Content
- Use when appropriate to support a field label.
- Describe how to best answer the question/form label.
- Use the fewest words possible (i.e. don't use "please").
- Use sentence case.
- End with a period.
- Be consistent with phrase and sentence structure.
Learn More
Component maturity
This component meets 100% of our maturity criteria.
What does this mean?
Each component is tested against the following items to gauge the component's maturity. When using incomplete components, consider the unmet criteria as applied to your product.
For more information about how we tested and validated our work for each checklist item, read our component maturity documentation.
- Complete
Color:Â Meets AA color contrast standards for accessibility and color blindness.
- Complete
Forced Colors Mode (FCM):Â While using FCM the components text is legible and improves readability.
- Complete
WCAG 2.1 Level AA Conformance:Â All Axe checks for WCAG AA compliance have passed.
- Complete
Screen readers:Â VoiceOver, NVDA, and JAWS screen readers provide concise communication and interaction.
- Not applicable
Keyboard navigation:Â Component is fully navigable with a keyboard.
Accessibility
- Complete
Storybook:Â Component has stories to cover all defined props.
- Complete
Responsive:Â Component designed to work in all responsive breakpoints.
- Complete
Spanish translations:Â Includes Spanish translations for default text content.
Code
- Complete
Code:Â Tokens implemented in code.
- Complete
Design:Â Tokens implemented in the Sketch.