Skip to content

docs(tabs): update a11y docs #5571

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 7 commits into
base: main
Choose a base branch
from
Open

docs(tabs): update a11y docs #5571

wants to merge 7 commits into from

Conversation

cdransf
Copy link
Member

@cdransf cdransf commented Jun 25, 2025

Description

Improving the accessibility documentation of components.

Related issue(s)

SWC-412

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

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

Copy link

changeset-bot bot commented Jun 25, 2025

⚠️ No Changeset found

Latest commit: 1b4f2e1

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

Copy link

github-actions bot commented Jun 25, 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-5571

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

Tachometer results

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

@cdransf cdransf force-pushed the cdransf/tabs-docs-audit branch 2 times, most recently from dda064c to 0b6b332 Compare June 25, 2025 19:58
@cdransf cdransf marked this pull request as ready for review June 25, 2025 19:59
@cdransf cdransf requested a review from a team as a code owner June 25, 2025 19:59
@Rajdeepc Rajdeepc changed the title feat(tabs/README.md): documentation updates docs(tabs): update README Jun 26, 2025
@cdransf cdransf force-pushed the cdransf/tabs-docs-audit branch from 0b6b332 to 2d6c12e Compare June 26, 2025 14:55
@cdransf cdransf requested a review from Rajdeepc June 26, 2025 17:06
@Rajdeepc Rajdeepc changed the title docs(tabs): update README docs(tabs): update a11y docs Jul 3, 2025
@Rajdeepc Rajdeepc added the ready-for-merge Will auto-update until merged label Jul 7, 2025
@cdransf cdransf force-pushed the cdransf/tabs-docs-audit branch 3 times, most recently from 06917f0 to f0b7e78 Compare July 8, 2025 19:20
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.

Thanks for taking this one on. Here are some changes I'd suggest.

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 teeny-tiny change and we're good to go. The very first heading should be ## Overview instead of ## Description. DM me when you want me to re-review and I'll approve it.

@cdransf cdransf requested a review from nikkimk July 10, 2025 16:50
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.

Lots of questions! I think this is probably good to go, but there's quite a bit of repetitive docs that I want your opinion on if we need.

Comment on lines -210 to -211
## Vertical Tabs

Copy link
Collaborator

Choose a reason for hiding this comment

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

Was there more to delete in this section? Or should we update this documentation to talk about the direction="vertical" property? Right now there's lots of duplicate content, but the sp-tabs` demos are different/vertical.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@cdransf just wanted to double check on this comment. Any thoughts on updating the docs here to mention the direction="vertical" stuff?

Copy link
Member Author

@cdransf cdransf Jul 11, 2025

Choose a reason for hiding this comment

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

Oops, yep! Adding:

Vertical tabs should be used when horizontal space is more generous and when the list of sections is greater than can be presented to the user in a horizontal format. Vertical tabs are enabled by setting the direction attribute to vertical on sp-tabs.

@cdransf cdransf force-pushed the cdransf/tabs-docs-audit branch from 5100ebb to 6ad949d Compare July 11, 2025 16:50
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.

I left a screenshot and a slack message for you about the funky placement of quiet/quiet+compact.

Comment on lines -210 to -211
## Vertical Tabs

Copy link
Collaborator

Choose a reason for hiding this comment

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

@cdransf just wanted to double check on this comment. Any thoughts on updating the docs here to mention the direction="vertical" stuff?

@cdransf cdransf self-assigned this Jul 11, 2025
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