Skip to content

docs(tabs): update README #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.

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
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(tabs): update README #5571

wants to merge 1 commit into from
+58 −13

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?

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jun 25, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 2d6c12e

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

github-actions bot commented Jun 25, 2025 •
edited
Loading

📚 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.

@github-actions GitHub Actions
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
Rajdeepc
Rajdeepc requested changes Jun 26, 2025
View reviewed changes
packages/tabs/README.md Outdated
Comment on lines 39 to 72
## Options

<sp-table>
<sp-table-head>
<sp-table-head-cell>Property</sp-table-head-cell>
<sp-table-head-cell>Values</sp-table-head-cell>
<sp-table-head-cell>Default value</sp-table-head-cell>
</sp-table-head>
<sp-table-body>
<sp-table-row>
<sp-table-cell>label</sp-table-cell>
<sp-table-cell>text / nothing</sp-table-cell>
<sp-table-cell>–</sp-table-cell>
</sp-table-row>
<sp-table-row>
<sp-table-cell>icon</sp-table-cell>
<sp-table-cell>icon / nothing</sp-table-cell>
<sp-table-cell>nothing</sp-table-cell>
</sp-table-row>
<sp-table-row>
<sp-table-cell>is selected</sp-table-cell>
<sp-table-cell>yes / no</sp-table-cell>
<sp-table-cell>no</sp-table-cell>
</sp-table-row>
<sp-table-row>
<sp-table-cell>is disabled</sp-table-cell>
<sp-table-cell>yes / no</sp-table-cell>
<sp-table-cell>no</sp-table-cell>
</sp-table-row>
</sp-table-body>
</sp-table>
<br/>

### Variants
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure this is correct. We have H2 on Options and H3 on Variants. What does the Options suggest? Can you please verify this if this is intended?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for calling that out! I referenced @nikkimk's PR for meter (https://github.com/adobe/spectrum-web-components/pull/5484/files) and revised the heading structure to better align with what we've been doing. ✨

@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@castastrophe castastrophe Awaiting requested review from castastrophe

@nikkimk nikkimk Awaiting requested review from nikkimk

@caseyisonit caseyisonit Awaiting requested review from caseyisonit

@Rajdeepc Rajdeepc Awaiting requested review from Rajdeepc

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cdransf @Rajdeepc