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

Add steps component #696

Merged
merged 7 commits into from
Oct 10, 2024
Merged

Add steps component #696

merged 7 commits into from
Oct 10, 2024

Conversation

ellynliu
Copy link
Contributor

@ellynliu ellynliu commented Oct 9, 2024

Task: task-[work-item-number]

Link: preview

Add the steps component

Testing

  1. http://localhost:1111/components/steps.html
  2. Review changes

Additional information

[Optional]

Contributor checklist

  • Did you update the description of this pull request with a review link and test steps?
  • Did you submit a changeset? Changesets are required for all code changes.
  • Does your pull request implement complex UI logic (js/ts)? Consider adding an integration test to test your user flow.
  • Does your pull request add a new page to the documentation site? Add your new page for automated accessibility testing in /integration/tests/accessibility.

@ellynliu ellynliu requested a review from a team as a code owner October 9, 2024 21:08
Copy link

changeset-bot bot commented Oct 9, 2024

🦋 Changeset detected

Latest commit: 2cc4d51

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@microsoft/atlas-site Minor
@microsoft/atlas-css Minor

Not sure what this means? Click here to learn what changesets are.

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

border-radius: $border-radius-rounded;
background-color: $secondary;

&.step-selected {
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about something like step-current instead to indicate current progress? Feel free to resolve if you don't see a difference.

<div class="step"></div>
<div class="step step-selected"></div>
</div>
```
Copy link
Contributor

@wibjorn wibjorn Oct 10, 2024

Choose a reason for hiding this comment

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

I'm thinking that that our examples need to be paired with some element containing the description of the current state of the steps: such as <p class="visually-hidden">Step 1 of 5</p>.

Then I think we could add something like at the bottom. But we should also have the main example contain the accessible markup too.

## Accessibility concerns

Although the step component is not interactive, it is also not entirely presentational. Thus, it's recommended that you put `aria-hidden` on the component, while including a `aria-hidden` element that communicates the current state of the user's progress through the steps.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nit to @wibjorn's suggestion, this should be

-while including a `aria-hidden` element that communicates the current state of the user's progress through the steps.
+while including a `visually-hidden` element that communicates the current state of the user's progress through the steps.

Copy link
Contributor

Choose a reason for hiding this comment

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

like the nit

Copy link
Contributor

Choose a reason for hiding this comment

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

since I was exactly wrong :D

wibjorn
wibjorn previously approved these changes Oct 10, 2024
@ellynliu ellynliu merged commit ad81e9f into main Oct 10, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants