Examples
Code
React
Preact/React documentation for Storybook
Style customization
The following CSS variables can be overridden to customize Form components:
Guidance
- Labels/Legends are built in to all design-system form fields but can be used on their own to create custom fields.
- Label/Legend text should be short and in sentence case.
- Avoid colons at the end of labels and legends.
- Don't place links or other interactive text in labels or legends. Those should go in the hint text.
- Don't use a field's placeholder attribute as the primary way to label the field.
Label
- Each form field should have a clear, brief, and descriptive label.
- Labels should have a
for
attribute, referencing the corresponding input's uniqueid
attribute. Only one label can be associated to each unique form element. - Labels should be placed above their fields.
Legend
- Use a single legend for fieldset (this is required). One example of a common use of fieldset and legend is a question with radio button options for answers. The question text and radio buttons are wrapped in a fieldset, with the question itself being inside the legend tag.
Content
- Describe what the user needs to do when the field is selected.
- Use a phrase or complete sentence.
- Start with an action verb and pair it with a noun to help it be clearer. Example:
Enter your age.
- Use the fewest words possible (i.e. don't use "please").
- Use sentence case.
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.