Skip to content
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.

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

fix(a11y): timeline steps should have a list structure #1421

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

andyfeds
Copy link
Contributor

@andyfeds andyfeds commented Jun 4, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • If applicable, have a visual design approval

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Due to the absence of semantic tags <ul> and <li> in the angular version of the timeline component, screen readers do not announce the number of steps in the timeline.

Issue Number: CDE-1181

What is the new behavior?

Added aria roles: role="list" to the timeline container and role="listitem" to each timeline step so that screen readers consider the timeline as a list and announce the number of steps.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@andyfeds andyfeds requested a review from a team June 4, 2024 09:42
@andyfeds andyfeds self-assigned this Jun 4, 2024
Copy link
Contributor

github-actions bot commented Jun 4, 2024

👋 @andyfeds,

  • 🙏 The Clarity team thanks you for opening a pull request
  • 🎉 The build for this PR has succeeded
  • 🔍 The PR is now ready for review
  • 🍿 In the meantime, view a preview of this PR
  • 🖐 You can always follow up here. If you're a VMware employee, you can also reach us on our internal Clarity Support space

Thank you,

🤖 Clarity Release Bot

@andyfeds andyfeds changed the title fix(a11y): timeline -angular version of component does not allow <ul> <li> fix(a11y): timeline steps should have a list structure Jun 4, 2024
@andyfeds andyfeds merged commit 29d18fc into vmware-clarity:main Jun 5, 2024
7 checks passed
github-actions bot pushed a commit that referenced this pull request Jun 5, 2024
## PR Checklist

Please check if your PR fulfills the following requirements:

- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] If applicable, have a visual design approval

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

- [x] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other... Please describe:

## What is the current behavior?
Due to the absence of semantic tags `<ul>` and `<li>` in the angular
version of the timeline component, screen readers do not announce the
number of steps in the timeline.
<!-- Please describe the current behavior that you are modifying, or
link to a relevant issue. -->

Issue Number: [CDE-1181](https://jira.eng.vmware.com/browse/CDE-1181)

## What is the new behavior?
Added aria roles: `role="list"` to the timeline container and
`role="listitem"` to each timeline step so that screen readers consider
the timeline as a list and announce the number of steps.
## Does this PR introduce a breaking change?

- [ ] Yes
- [x] No

<!-- If this PR contains a breaking change, please describe the impact
and migration path for existing applications below. -->

## Other information

Co-authored-by: Andrea Fernandes <andreaf1@vmware.com>
(cherry picked from commit 29d18fc)
andyfeds added a commit that referenced this pull request Jun 5, 2024
…6.x) (#1424)

Backport 29d18fc from #1421. <br> ## PR
Checklist

Please check if your PR fulfills the following requirements:

- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
- [ ] If applicable, have a visual design approval

## PR Type

What kind of change does this PR introduce?

&lt;!-- Please check the one that applies to this PR using
&quot;x&quot;. --&gt;

- [x] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other... Please describe:

## What is the current behavior?
Due to the absence of semantic tags `&lt;ul&gt;` and `&lt;li&gt;` in the
angular version of the timeline component, screen readers do not
announce the number of steps in the timeline.
&lt;!-- Please describe the current behavior that you are modifying, or
link to a relevant issue. --&gt;

Issue Number: [CDE-1181](https://jira.eng.vmware.com/browse/CDE-1181)

## What is the new behavior?
Added aria roles: `role=&quot;list&quot;` to the timeline container and
`role=&quot;listitem&quot;` to each timeline step so that screen readers
consider the timeline as a list and announce the number of steps.
## Does this PR introduce a breaking change?

- [ ] Yes
- [x] No

&lt;!-- If this PR contains a breaking change, please describe the
impact and migration path for existing applications below. --&gt;

## Other information

Co-authored-by: Andrea A Fernandes <andy2890@gmail.com>
Copy link
Contributor

Hi there 👋, this is an automated message. To help Clarity keep track of discussions, we automatically lock closed PRs after 14 days. Please look for another open issue or open a new issue with updated details and reference this one as necessary.

@github-actions github-actions bot locked and limited conversation to collaborators Jun 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants