Skip to content

docs(progress-circle): a11y audit #5466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
May 21, 2025
Merged

docs(progress-circle): a11y audit #5466

merged 2 commits into from
May 21, 2025

Conversation

TarunAdobe
Copy link
Contributor

@TarunAdobe TarunAdobe commented May 12, 2025 •
edited
Loading

Description

Improving the accessibility documentation of components.

Related issue(s)

  • SWC-399

Motivation and context

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

How has this been tested?

Review progress-circle-docs

  • Do the docs examples give enough context to test for accessibility?

  • 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? You can use the WAVE browser extension's Structure tab to review heading structure.

  • Did it pass in Desktop?

  • Did it pass in Mobile?

  • Did it pass in iPad?

Screenshots (if appropriate)

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)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • 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.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented May 12, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 71aab1c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions GitHub Actions
Copy link

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@github-actions GitHub Actions
Copy link

Tachometer results

Currently, no packages are changed by this PR...

@TarunAdobe TarunAdobe marked this pull request as ready for review May 12, 2025 09:41
@TarunAdobe TarunAdobe requested a review from a team as a code owner May 12, 2025 09:41
@TarunAdobe TarunAdobe self-assigned this May 12, 2025
@Rajdeepc Rajdeepc changed the title chore(progress-circle): docs a11y audit docs(progress-circle): a11y audit May 12, 2025
nikkimk
nikkimk reviewed May 12, 2025
View reviewed changes
packages/progress-circle/README.md Outdated
@@ -24,90 +24,116 @@ When looking to leverage the `ProgressCircle` base class as a type and/or for ex
import { ProgressCircle } from '@spectrum-web-components/progress-circle';
```

## Variants
### Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this section "Anatomy" and explain that a progress circle consists of an off-screen label and a visual indication of progress.

nikkimk
nikkimk reviewed May 12, 2025
View reviewed changes
packages/progress-circle/README.md
### Size
### Accessibility

The `<sp-progress-circle>` element implements several accessibility features:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this.

nikkimk
nikkimk requested changes May 12, 2025
View reviewed changes
Copy link
Contributor

@nikkimk nikkimk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small heading change here.

packages/progress-circle/README.md
An `sp-progress-circle` element will register itself as a `role="progressbar"` element in the accessibility tree. Any value applied to the `label` attribute will be set as the `aria-label` attribute on the host. These two attributes can be used interchangably to ensure that the `sp-progress-circle` elements in your UI correctly fulfills its responsibilities to visitors of you site of all abilities.
```html
<!-- Example with good accessibility -->
<sp-progress-circle
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this example

@TarunAdobe TarunAdobe force-pushed the ttomar/docs-audit-progress-circle branch from 0547c33 to ba6c20b Compare May 13, 2025 07:28
@TarunAdobe TarunAdobe requested a review from nikkimk May 13, 2025 15:43
nikkimk
nikkimk approved these changes May 19, 2025
View reviewed changes
Copy link
Contributor

@nikkimk nikkimk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Livid grocer throws melons (LGTM)

@TarunAdobe TarunAdobe force-pushed the ttomar/docs-audit-progress-circle branch from ba6c20b to 3e9b7a1 Compare May 19, 2025 15:42
@caseyisonit caseyisonit added the ready-for-merge Will auto-update until merged label May 19, 2025
@caseyisonit caseyisonit merged commit 921efb3 into main May 21, 2025
24 checks passed
@caseyisonit caseyisonit deleted the ttomar/docs-audit-progress-circle branch May 21, 2025 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nikkimk nikkimk nikkimk approved these changes

@Rajdeepc Rajdeepc Rajdeepc approved these changes

@caseyisonit caseyisonit caseyisonit approved these changes

Assignees

@TarunAdobe TarunAdobe

Labels
ready-for-merge Will auto-update until merged ready-for-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@TarunAdobe @nikkimk @Rajdeepc @caseyisonit