Examples
Code
React
Preact/React documentation for Storybook
Style customization
The following CSS variables can be overridden to customize Form components:
Guidance
- Inline errors are built in to all design-system form fields but can be used on their own to create custom fields.
- Inline errors should sit either directly above or below the input, depending on the theme defaults.
- Visually align inline validation messages with the input fields, so people using screen magnifiers can read them quickly.
- The form field should have an
aria-describedby
attribute that references theid
of the error message.
Content
- Describe what the user still needs to do in a mandatory field that has been left incomplete or unanswered, or answered incorrectly.
- Repeat what the form label is asking the user to do, but with slightly more detail.
- Use the fewest words possible (i.e., don't use "please").
- Use sentence case.
- End with a period.
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.