terra-form-radio UX Audit

[ryanthemanuel]

terra-form-radio

Known Aliases

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

• Has known aliases
  • Radio button
• Requires name change
  • Let's evaluate renaming this to more closely align with the design standard

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.
  • How do I deselect a radio button? You can't. Add an explicit option for None/Other/etc.
  • Defaulting is a best practice but you can choose to not default under certain circumstances (e.g. dangerous, presumptuous, controversial, etc.)

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 Radio documentation or move it into Radio Field and beef up the Radio Field documentation
  • Update to more realistic examples
    • Conditional Logic Example
    • Explicit option for "none"
• 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
  • Add an ability to add an "other checkbox" with freetext
• Contains bad practice behaviours that should be removed
  • Remove hidden label radio option. If removed, we should look into adding a bare bones radio button building block whose usage should be for creating things that look like radio buttons but are not part of a form or a field.
  • Potentially make Radio 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

[mjhenkes]

Re-organize terra form: #3195