You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds a consumer-facing migration guide for Progress Bar, documenting how application developers upgrade from Spectrum 1 <sp-progress-bar> to Spectrum 2 <swc-progress-bar>. The guide is a single new MDX page rendered in Storybook at Progress Bar/Migration guide.
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
Migration guide renders and reads correctly in Storybook
Run Storybook for the 2nd-gen workspace and open Progress Bar / Migration guide
Confirm the page renders with no MDX errors and both callouts (the amber breaking-change note and the red "do not target internals" note) display
Expect all in-page anchor links (e.g. "see step 3", "see step 5", "see Styling") to jump to the correct sections
Code and API references match the migrated component
Cross-check the "What changed", "Added", and "Removed" tables against <swc-progress-bar> (2nd-gen/packages/swc/components/progress-bar/)
Confirm every documented attribute, slot, and --swc-linear-progress-* custom property exists on the component
Expect no stale or hallucinated API (e.g. value, label-position, static-color, accessible-label, value-label, description slot)
Device review
Did it pass in Desktop?
Did it pass in (emulated) Mobile?
Did it pass in (emulated) iPad?
Accessibility testing checklist
Keyboard (required) — The migration guide is a static documentation page with no interactive parts of its own beyond standard in-page anchor links.
Open Progress Bar / Migration guide in Storybook
Tab through the page and activate the in-page anchor links with Enter
Expect focus order to be logical, the focus indicator to be visible, and each link to move focus to the correct section; no focus traps
Screen reader (required) — Verify document structure and that the documented a11y guidance is correct.
Navigate the page with a screen reader (VoiceOver / NVDA) using heading navigation
Confirm headings are announced in a correct, non-skipping hierarchy and the tables are announced as tables with readable cells
Confirm the guide's a11y instructions are accurate: name is provided via the label slot or accessible-label, indeterminate bars use accessible-label, and role="progressbar" / aria-value* are set internally (not on the host)
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
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a consumer-facing migration guide for Progress Bar, documenting how application developers upgrade from Spectrum 1
<sp-progress-bar>to Spectrum 2<swc-progress-bar>. The guide is a single new MDX page rendered in Storybook atProgress Bar/Migration guide.Related issue(s)
Screenshots (if appropriate)
Author's checklist
Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
Migration guide renders and reads correctly in Storybook
Code and API references match the migrated component
<swc-progress-bar>(2nd-gen/packages/swc/components/progress-bar/)--swc-linear-progress-*custom property exists on the componentvalue,label-position,static-color,accessible-label,value-label,descriptionslot)Device review
Accessibility testing checklist
Keyboard (required) — The migration guide is a static documentation page with no interactive parts of its own beyond standard in-page anchor links.
Screen reader (required) — Verify document structure and that the documented a11y guidance is correct.
labelslot oraccessible-label, indeterminate bars useaccessible-label, androle="progressbar"/aria-value*are set internally (not on the host)