Skip to content

docs: add consumer migration guides for S2 components#6169

Draft
cdransf wants to merge 4 commits intomainfrom
cdransf/migration-guides
Draft

docs: add consumer migration guides for S2 components#6169
cdransf wants to merge 4 commits intomainfrom
cdransf/migration-guides

Conversation

@cdransf
Copy link
Copy Markdown
Member

@cdransf cdransf commented Apr 10, 2026

Description

Adds migration.md files for 7 components in 2nd-gen/packages/swc/components/, following the pattern established
by the avatar migration guide:

  • asset — tag/package rename, CSS vars removed (token-based), shadow DOM class changes
  • badge — tag/package rename, CSS var rename, new subtle/outline attributes, 5 new color variants
  • divider — tag/package rename, CSS var rename, shadow DOM structure change
  • icon — tag/package rename, name/src attributes removed, xxs/xxl sizes removed, slot-only SVG
  • progress-circle — tag/package rename, CSS var rename, static-color="black" added, SVG rendering change
  • status-light — tag/package rename, disabled removed, accent variant removed, 5 new color variants
  • typography — class prefix .spectrum-* → .swc-*, light/uppercase/strong-emphasized removed, new Title variant
    and prose container

Each guide includes: installation steps, quick reference table, per-change before/after examples, new features,
and accessibility notes. Follows the same per-component structure proposed in draft #6145.

Motivation and context

Application developers migrating from 1st-gen to 2nd-gen need practical, consumer-focused guidance that goes
beyond internal implementation analysis. These docs cover the day-to-day upgrade path: what to search for, what
to change, and how to validate the result.

Related issue(s)

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

  • Each migration guide is accurate and complete
    a. Open any migration.md in 2nd-gen/packages/swc/components/[component]/
    b. Follow the "Update your code" steps using a real sp-[component] usage as input
    c. Expect the before/after examples to produce a working swc-[component] with no regressions
  • Breaking changes are clearly surfaced
    a. Review the icon and status-light guides specifically — these have the most significant removals (name/src
    on icon, disabled/accent on status-light)
    b. Confirm the guidance is actionable and the "After" examples are valid 2nd-gen markup

@cdransf cdransf self-assigned this Apr 10, 2026
@cdransf cdransf added the Status:WIP PR is a work in progress or draft label Apr 10, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 10, 2026

⚠️ No Changeset found

Latest commit: bac4d74

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

github-actions bot commented Apr 10, 2026

📚 Branch Preview Links

🔍 First Generation 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-6169

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.

@cdransf cdransf force-pushed the cdransf/migration-guides branch 2 times, most recently from f12f231 to 8a6d703 Compare April 10, 2026 21:06
@cdransf cdransf force-pushed the cdransf/migration-guides branch from 8a6d703 to 5c8eff6 Compare April 10, 2026 21:11
@cdransf cdransf force-pushed the cdransf/migration-guides branch from 461b6f8 to d4220ba Compare April 10, 2026 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status:WIP PR is a work in progress or draft

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant