spectrum-web-components icon indicating copy to clipboard operation
spectrum-web-components copied to clipboard

docs: accessibility improvements

Open nikkimk opened this issue 6 months ago • 3 comments

Description

Improving the accessibility documentation of components.

Related issue(s)

  • #4210

Motivation and context

Documentation should provide more information and examples that demonstrate how to use the components accessibly.

How has this been tested?

  • [ ] <sp-picker>

    1. Review picker docs
  • [ ] <sp-menu>

    1. Review menu docs
    2. Review menu-group docs
    3. Review menu-item docs
  • [ ] <sp-help-text>

    1. Review help text docs
  • [ ] <sp-button>

    1. Review button docs
  • [ ] <sp-button-group>

    1. Review button group docs
  • [ ] <sp-action-button>

    1. Review action button docs
  • [ ] <sp-action-bar>

    1. Review action bar docs
  • [ ] <sp-action-group>

    1. Review button docs
  • [ ] <sp-action-menu>

    1. Review action button docs
  • [ ] Are the examples accessible?

  • [ ] Do the docs examples and text provide information on how to use the component accessibly?

  • [ ] If the component is to be used in the context of another component, do the examples include how that component is used accessibly in that context?

  • [ ] Are the docs headings logical and consistent across these components?

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [x] Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • [x] I have signed the Adobe Open Source CLA.
  • [x] My code follows the code style of this project.
  • [x] If my change required a change to the documentation, I have updated the documentation in this pull request.
  • [x] I have read the CONTRIBUTING document.
  • [ ] I have added tests to cover my changes. N/A
  • [ ] All new and existing tests passed.
  • [x] I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

nikkimk avatar Aug 06 '24 14:08 nikkimk