Skip to content

Conversation

@Rajdeepc
Copy link
Contributor

@Rajdeepc Rajdeepc commented Oct 13, 2025

Description

This PR provides a comprehensive update to all reactive controller documentation files, ensuring complete API coverage, accessibility guidance, and practical examples. This addresses the requirements for fully documenting each controller's properties, methods, events, CSS properties, tokens, and accessibility considerations.

Changes

Updated 7 documentation files:

  • color-controller.md
  • match-media.md
  • element-resolution.md
  • dependency-manager.md
  • pending-state.md
  • roving-tab-index.md
  • README.md

Added 1 documentation file:

  • system-context-controlller.md

What's New

Full API Documentation

  • Constructor signatures with parameters
  • All properties (types, descriptions)
  • All methods (parameters, returns, descriptions)
  • Lifecycle hooks and exported symbols

Accessibility

  • WCAG compliance guidelines
  • ARIA patterns and keyboard interactions
  • Screen reader support patterns
  • Links to W3C ARIA Authoring Practices and Adobe Accessibility Guidelines

Enhanced Examples

  • Added code examples across all controllers
  • Real-world use cases (forms, navigation, lazy loading, etc.)
  • Integration with other Spectrum Web Components
  • All examples include proper ARIA attributes

Other Improvements

  • Documented PendingStateController deprecation consideration
  • Noted known accessibility issues (SWC-1119, SWC-1255, SWC-459)
  • Added comprehensive controller catalog to README
  • Links to related resources and specifications

Motivation and context

The existing documentation was missing critical information:

  • Incomplete API documentation (missing properties, methods, events)
  • Limited or no accessibility guidance
  • Basic examples that didn't demonstrate real-world usage patterns
  • No links to accessibility team documentation or design specs
  • Missing information about component integration patterns
  • This update ensures developers have everything they need to implement these controllers correctly and accessibly.

Related issue(s)

  • fixes SWC-429

Screenshots (if appropriate)


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

Manual review test cases

  • Manual Test Case

    1. ✅ No linting errors
    2. ✅ Consistent formatting per workspace conventions
    3. ✅ All internal links verified

Breaking Changes

None - documentation only.

Device review

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

@Rajdeepc Rajdeepc self-assigned this Oct 13, 2025
@changeset-bot
Copy link

changeset-bot bot commented Oct 13, 2025

⚠️ No Changeset found

Latest commit: 9e6283a

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

@Rajdeepc Rajdeepc added Status: WIP PR is a work in progress or draft a11y Issues or PRs related to accessibility Documentation Issues or PRs involving changes to documentation or documentation website labels Oct 13, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 13, 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-5802

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
Copy link
Contributor

Tachometer results

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

@coveralls
Copy link
Collaborator

coveralls commented Oct 13, 2025

Pull Request Test Coverage Report for Build 18845086285

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.966%

Totals Coverage Status
Change from base Build 18844771637: 0.0%
Covered Lines: 34259
Relevant Lines: 34788

💛 - Coveralls

@Rajdeepc Rajdeepc marked this pull request as ready for review October 17, 2025 10:55
@Rajdeepc Rajdeepc requested a review from a team as a code owner October 17, 2025 10:55
@Rajdeepc Rajdeepc added Status: Ready for review PR ready for review or re-review. and removed Status: WIP PR is a work in progress or draft labels Oct 17, 2025
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.

Wow! This was quite the undertaking! Overall this is really, really good stuff. If left some comments and suggestions for changes.

@Rajdeepc Rajdeepc requested a review from nikkimk October 20, 2025 12:37
Copy link
Collaborator

@rise-erpelding rise-erpelding left a comment

Choose a reason for hiding this comment

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

Wow, this was a huge undertaking! The documentation and examples here look great overall, and I learned a lot reading them!

I left a few comments. I also see that there weren't docs for the system context resolution controller, that's probably the primary thing needing adjustment here.

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.

Love the "How it works" section of LanguageResolutionController!

I had one more suggestion. Also, do you think we should do SystemContextResolutionController?

Copy link
Collaborator

@rise-erpelding rise-erpelding left a comment

Choose a reason for hiding this comment

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

Looks great! Left one comment about the formatting where the system context resolution controller was added in the README, otherwise I think this is good to go!

Copy link
Contributor

@caseyisonit caseyisonit left a comment

Choose a reason for hiding this comment

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

this is AMAZING! i learned a ton!

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

Labels

a11y Issues or PRs related to accessibility Documentation Issues or PRs involving changes to documentation or documentation website Status: Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants