terra-form-checkbox UX Audit

[ryanthemanuel]

terra-form-checkbox

Known Aliases

Document any known aliases of the component, decide if another name makes more sense.

• Has known aliases
• Requires name change

Design Standard Doc

Any documentation needed to be added to terra-ui describing the make up and usage of the component
Any doc examples that need to be updated?

• Missing design standard documentation linkage.
  • Solitary checkboxes can exist for things like "accept terms and conditions"
  • May need to provide guidance in DS around when the user can select a maximum or min number of items

Guides

Any guides needed to be added to terra-ui describing the usage of this component when used with other components.

• Missing Guides
  • Possibly hide the Checkbox documentation or move it into Checkbox Field and beef up the Checkbox Field documentation
• Missing UX recommended Usage.
• Deprecation guide

Accessibility Guides

• Missing Accessibility Guides
  • Potentially add a general guide for what it means for this component to be accessible

Behaviours

• Missing behaviours
  • Potentially add a separate checkbox component that is designed to be used outside of a form
  • Add an ability to add an "other checkbox" with freetext
• Contains bad practice behaviours that should be removed
  • Remove hidden label checkbox option
  • Potentially make Checkbox Field is the default export

Accessibility

• Meets wcag 2.0/section 508 standards
  • Needs aria-live around for invalid state
  • Evaluate "described by". Might not be necessary if it is wrapped in a field set.
• Meets wcag 2.1/en 301 549 standards

Deprecation

• Component is a bad pattern and should be deprecated.

Related Issues

Other Considerations

Checkboxes that are baked into components should not use this (e.g. checkboxes in a table column with indeterminate states, etc.)

[mjhenkes]

Re-organize terra form: #3195