Skip to content
This repository was archived by the owner on May 24, 2024. It is now read-only.
This repository was archived by the owner on May 24, 2024. It is now read-only.

terra-section-header UX Audit #3223

@ryanthemanuel

Description

@ryanthemanuel

terra-section-header

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.

Guides

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

  • Missing Guides
  • Missing UX recommended Usage.
  • Deprecation guide

Accessibility Guides

  • Missing Accessibility Guides
    • Need some guides on how to properly construct section headers and content

Behaviours

  • Missing behaviours
    • Allow for components at the end
    • Allow for a more advanced title
  • Contains bad practice behaviours that should be removed
    • isTransparent needs to be removed

Accessibility

  • Meets wcag 2.0/section 508 standards
    • Needs to be redesigned for accessibility (e.g. screen reader doesn't announce that this is a heading)
  • Meets wcag 2.1/en 301 549 standards

Deprecation

  • Component is a bad pattern and should be deprecated.

Related Issues

Other Considerations

Need to evaluate what the intended use case is outside of known contexts (e.g. lists, tables, etc.)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions