Skip to content

docs(button-group): consumer migration guide from sp- to swc-#6335

Draft
Rajdeepc wants to merge 1 commit into
rajdeepc/feat-button-group-migrationfrom
rajdeepc/docs-button-group-consumer-migration
Draft

docs(button-group): consumer migration guide from sp- to swc-#6335
Rajdeepc wants to merge 1 commit into
rajdeepc/feat-button-group-migrationfrom
rajdeepc/docs-button-group-consumer-migration

Conversation

@Rajdeepc
Copy link
Copy Markdown
Contributor

@Rajdeepc Rajdeepc commented May 25, 2026 •
edited
Loading

Summary

Adds a consumer-facing migration guide at 2nd-gen/packages/swc/components/button-group/migration.md documenting how to migrate from <sp-button-group> (1st-gen) to <swc-button-group> (2nd-gen).

What's covered

  • Tag name find-and-replace (sp-button-group → swc-button-group)
  • Import path changes (@spectrum-web-components/button-group → @adobe/spectrum-wc)
  • All breaking API changes with before/after code examples:
    • vertical boolean → orientation string property
    • CSS custom properties renamed (--mod-buttongroup-* → --swc-button-group-*)
    • Default size behavior change (now defaults to m)
    • Shadow DOM structure change
  • New features documentation (align, disabled, automatic ARIA)
  • Deprecated patterns resolved (directional spacing consolidated to single gap)
  • Complete end-to-end migration example
  • Migration checklist

Dependencies

Test plan

  • Markdown renders correctly in Storybook docs

  • All code examples are syntactically valid

  • Before/after examples accurately reflect the API differences

  • Reviewed by at least one engineer for clarity and completeness

  • Fixes SWC-2077, SWC-2078

@cursoragent
docs(button-group): add consumer migration guide from sp- to swc-
e102805 
Covers tag rename, breaking API changes (vertical → orientation,
CSS custom properties, default size), new features (align, disabled,
role="group"), deprecated patterns resolved, and a full before/after
migration example with checklist.

Co-authored-by: Cursor <cursoragent@cursor.com>
@Rajdeepc Rajdeepc requested a review from a team as a code owner May 25, 2026 10:32
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 25, 2026

⚠️ No Changeset found

Latest commit: e102805

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 marked this pull request as draft May 25, 2026 10:34
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 25, 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-6335

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.

@Rajdeepc Rajdeepc added Status:WIP PR is a work in progress or draft do-not-merge NO MERGE-Y! labels May 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

do-not-merge NO MERGE-Y! Status:WIP PR is a work in progress or draft

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Rajdeepc