chore(badge): refactor with abstracted base class #5648

TarunAdobe · 2025-07-30T09:34:55Z

Overview

This PR refactors the sp-badge component to separate its base logic from rendering code, following the technical specifications for the Swan migration preparation. This is a purely internal change with no customer impact.

Changes Made

File Structure Changes

Created: New packages/badge/src/Badge.base.ts as the base class for Badge component.

Code Separation

BadgeBase (Abstract Base Class)

Location: packages/badge/src/Badge.base.ts
Contains:
- Property declarations
- All base functionality except rendering

Badge (Concrete Class)

Location: packages/badge/src/Badge.ts
Contains:
- Class that extends BadgeBase
- Rendering logic (render() method)
- Styles import and declaration

Impact

Customer Impact

None - This is a purely internal refactoring
Public API remains identical
No visual or behavioural changes
No breaking changes

Developer Impact

None - Existing imports and usage patterns continue to work
import { Badge } from '@spectrum-web-components/badge' still works
All existing component usage remains valid

Related issue(s)

fixes 981

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 Testing
- Component renders correctly in Storybook
- All variants (horizontal/vertical) work as expected
- All sizes (s, m, l) display properly
- ARIA attributes are set correctly
Automated Testing
- All existing tests pass
- No new tests needed (no functional changes)

Device review

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

Migration Preparation

This refactoring prepares the badge component for future migration to the Swan architecture by:

Separating concerns - Base logic vs. rendering logic
Preserving git history - Base logic in Badge.base.ts will carry forward
Maintaining compatibility - Public API unchanged
Following established patterns - Consistent with other component refactoring

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

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 · 2025-07-30T13:39:16Z

Tachometer results

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

blunteshwar

Can you resolve at the failing tests for badge

The tests were failing for badge

blunteshwar

Can you resolve at the failing tests for badge

nikkimk

Nice work, including the PR description (which I totally copied for my component btw). Left two suggestion that will fix your tests, if you commit them.

packages/badge/src/Badge.base.ts

nikkimk

Lost gold treasure map (LGTM)

Rajdeepc · 2025-08-04T06:38:30Z

packages/badge/package.json

+        "./src/Badge.base.js": {
+            "default": "./src/Badge.base.js",
+            "development": "./src/Badge.base.dev.js"


We don't need to add this now as this would change the existing API contract.

blunteshwar

Shouldn't we add export * from './Badge.base.js'; in index.ts file as well so that we could use/import objects exported by BadgeBase in stories and tests.

Rajdeepc · 2025-08-12T12:13:51Z

packages/badge/src/Badge.ts

-export const BADGE_VARIANTS = [
-    'accent',
-    'neutral',
-    'informative',
-    'positive',
-    'negative',
-    'notice',
-    'fuchsia',
-    'indigo',
-    'magenta',
-    'purple',
-    'seafoam',
-    'yellow',
-    'gray',
-    'red',
-    'orange',
-    'chartreuse',
-    'celery',
-    'green',
-    'cyan',
-    'blue',
-] as const;
-export type BadgeVariant = (typeof BADGE_VARIANTS)[number];
-export const FIXED_VALUES = [
-    'inline-start',
-    'inline-end',
-    'block-start',
-    'block-end',
-] as const;
-export type FixedValues = (typeof FIXED_VALUES)[number];


This update will result in a BREAKING CHANGE for consumers who are importing directly from Badge.ts. To keep our downstream teams unblocked let’s re-export these constants from the current module. This way, we can maintain backward compatibility in the short term.
In Badge.ts please add this above any other code which uses these symbols

export { BADGE_VARIANTS, BadgeVariant, FIXED_VALUES, FixedValues } from './Badge.base.js';

Rajdeepc · 2025-08-12T14:04:42Z

packages/badge/src/Badge.base.ts

+export type FixedValues = (typeof FIXED_VALUES)[number];
+
+/**
+ * @element sp-badge-base class


You are missing JS docs statements on icon slot and text label. Can we add here?

Rajdeepc

Good work! Once the CI is happy ready to land this

TarunAdobe requested a review from a team as a code owner July 30, 2025 09:34

github-actions bot reviewed Jul 30, 2025

View reviewed changes

packages/badge/package.json Outdated Show resolved Hide resolved

TarunAdobe force-pushed the ttomar/badge-refractor branch from 1657c9f to 7f38617 Compare July 30, 2025 13:34

blunteshwar previously approved these changes Jul 30, 2025

View reviewed changes

blunteshwar requested changes Jul 30, 2025

View reviewed changes

nikkimk requested changes Jul 30, 2025

View reviewed changes

packages/badge/src/Badge.base.ts Outdated Show resolved Hide resolved

packages/badge/src/Badge.base.ts Outdated Show resolved Hide resolved

nikkimk changed the base branch from main to spectrum-two-phase-zero July 30, 2025 21:24

TarunAdobe force-pushed the ttomar/badge-refractor branch from 7f38617 to 6fba948 Compare July 31, 2025 09:04

TarunAdobe requested review from blunteshwar and nikkimk July 31, 2025 09:16

nikkimk approved these changes Jul 31, 2025

View reviewed changes

blunteshwar mentioned this pull request Aug 4, 2025

chore(alert-banner): refactor AlertBanner to extend AlertBannerBase #5664

Merged

19 tasks

blunteshwar approved these changes Aug 4, 2025

View reviewed changes

Rajdeepc requested changes Aug 4, 2025

View reviewed changes

Rajdeepc changed the title ~~chore(badge): abstract base class logic~~ chore(badge): refactor with abstracted base class Aug 4, 2025

Rajdeepc added ready-for-review SWAN refactor labels Aug 4, 2025

blunteshwar requested changes Aug 4, 2025

View reviewed changes

TarunAdobe force-pushed the ttomar/badge-refractor branch from 6fba948 to eda83ff Compare August 8, 2025 13:31

TarunAdobe requested review from blunteshwar and Rajdeepc August 8, 2025 13:32

Rajdeepc requested changes Aug 12, 2025

View reviewed changes

TarunAdobe force-pushed the ttomar/badge-refractor branch 2 times, most recently from b408287 to def26e8 Compare August 12, 2025 13:39

Rajdeepc requested changes Aug 12, 2025

View reviewed changes

chore(badge): abstract base class logic

a412244

TarunAdobe force-pushed the ttomar/badge-refractor branch from a8ccbe9 to a412244 Compare August 12, 2025 14:07

Rajdeepc approved these changes Aug 12, 2025

View reviewed changes

Merge branch 'spectrum-two-phase-zero' into ttomar/badge-refractor

2f7ad09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(badge): refactor with abstracted base class #5648

chore(badge): refactor with abstracted base class #5648

TarunAdobe commented Jul 30, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

Uh oh!

github-actions bot commented Jul 30, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 30, 2025

Uh oh!

blunteshwar left a comment •

edited

Loading

Uh oh!

blunteshwar left a comment

Uh oh!

nikkimk left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

nikkimk left a comment

Uh oh!

Rajdeepc Aug 4, 2025

Uh oh!

blunteshwar left a comment •

edited

Loading

Uh oh!

Rajdeepc Aug 12, 2025 •

edited

Loading

Uh oh!

Rajdeepc Aug 12, 2025

Uh oh!

Rajdeepc left a comment

Uh oh!

Uh oh!

chore(badge): refactor with abstracted base class #5648

Are you sure you want to change the base?

chore(badge): refactor with abstracted base class #5648

Conversation

TarunAdobe commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Changes Made

File Structure Changes

Code Separation

Impact

Customer Impact

Developer Impact

Related issue(s)

Screenshots (if appropriate)

Author's checklist

Reviewer's checklist

Manual review test cases

Device review

Migration Preparation

Related

Uh oh!

changeset-bot bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

Uh oh!

github-actions bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Branch Preview

🔍 Visual Regression Test Results

Uh oh!

github-actions bot commented Jul 30, 2025

Tachometer results

Uh oh!

blunteshwar left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blunteshwar left a comment

Choose a reason for hiding this comment

Uh oh!

nikkimk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nikkimk left a comment

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

blunteshwar left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Aug 12, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TarunAdobe commented Jul 30, 2025 •

edited

Loading

changeset-bot bot commented Jul 30, 2025 •

edited

Loading

github-actions bot commented Jul 30, 2025 •

edited

Loading

blunteshwar left a comment •

edited

Loading

nikkimk left a comment •

edited

Loading

blunteshwar left a comment •

edited

Loading

Rajdeepc Aug 12, 2025 •

edited

Loading