Skip to content

docs(tab): update tab docs and a11y #5586

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

aramos-adobe
Copy link

@aramos-adobe aramos-adobe commented Jul 7, 2025

Description

Ensure the full API is documented, including each property, slot, method, event, CSS property, and tokens in the component and along with accessibility concerns and/or decisions, linking to accessibility team documentation where applicable for the tab component.

Related issue(s)

  • SWC-414

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

@aramos-adobe aramos-adobe requested a review from a team as a code owner July 7, 2025 11:49
Copy link

changeset-bot bot commented Jul 7, 2025

⚠️ No Changeset found

Latest commit: d1c887e

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

@aramos-adobe aramos-adobe self-assigned this Jul 7, 2025
Copy link

github-actions bot commented Jul 7, 2025

📚 Branch Preview

🔍 Visual Regression Test Results

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

Deployed to Azure Blob Storage: pr-5586

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.

Copy link

github-actions bot commented Jul 7, 2025

Tachometer results

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

@Rajdeepc
Copy link
Contributor

Rajdeepc commented Jul 7, 2025

@aramos-adobe before adding the ready for review tag, could you please take a moment to ensure the description is clear and that the developer checklist has been followed? This will really help make the review process smoother for everyone. Appreciate your efforts and congrats on your PR first contribution. Woohoo!!

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.

Some minor changes, but overall all looking good. I like the details you've added to the docs.

Copy link
Collaborator

@marissahuysentruyt marissahuysentruyt left a comment

Choose a reason for hiding this comment

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

Nice work on this! I think there's some documentation changes that need to be made to clear up the focused state section. To me, they conflicted with the accessibility portion at the bottom, but I left some comments to try to connect my thoughts.

Comment on lines 45 to 47
slot="icon"
label="Checking your work"
aria-label="Tab w/ checkmark"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd have to check with Nikki again, but would we want the label and aria-label to be the same, that way screen reader users get the same experience & information?

When I tested this in Safari, VoiceOver also announces: "Tab w slash checkmark" instead of what this was probably going for "Tab with checkmark."

Copy link
Collaborator

Choose a reason for hiding this comment

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

Or maybe the aria-label replaces label on sp-tab?

Copy link
Author

Choose a reason for hiding this comment

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

Now that I think of it, it makes sense to have only the aria-label exist for icon only situations and it should be on sp-tab

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants