feat(colorwheel): S2 migration #3390

cdransf · 2024-11-12T19:43:17Z

Description

CSS-1020

This change migrates the colorwheel component to S2. It adds the --spectrum-colorwheel-border-color-rgb and --spectrum-colorwheel-border-opacity custom properties. It updates --spectrum-colorwheel-border-color to leverage these tokens in an rgba(...) function.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Run Storybook locally or open the link for the PR.
Navigate to the colorwheel component.
Verify that no regressions are visible.

Regression testing

Validate:

The documentation pages for at least two other components are still loading, including:

The pages render correctly, are accessible, and are responsive.

If components have been modified, VRTs have been run on this branch:

VRTs have been run and looked at.
Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

To-do list

I have read the contribution guidelines.
I have updated relevant storybook stories and templates.
I have tested these changes in Windows High Contrast mode.
If my change impacts other components, I have tested to make sure they don't break.
If my change impacts documentation, I have updated the documentation accordingly.
✨ This pull request is ready to merge. ✨

changeset-bot · 2024-11-12T19:43:22Z

🦋 Changeset detected

Latest commit: 0579096

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@spectrum-css/colorwheel	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2024-11-12T19:46:18Z

🚀 Deployed on https://pr-3390--spectrum-css.netlify.app

github-actions · 2024-11-12T19:49:09Z

File metrics

Summary

Total size: 1.38 MB^*

Package	Size	Minified	Gzipped
colorwheel	5.55 KB	5.20 KB	1.36 KB

colorwheel

Filename	Head	Minified	Gzipped	Compared to base
index.css	5.55 KB	5.20 KB	1.36 KB	🔴 ⬆ 0.89 KB
metadata.json	2.05 KB	-	-	🔴 ⬆ 0.15 KB

* Size is the sum of all main files for packages in the library.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

marissahuysentruyt

A few questions for you, as usual!

I wonder if we need to refactor the color-wheel-width and color-wheel-minimum-width tokens from our custom tokens/dist. Those values change based on the platform (desktop/mobile), but the designs don't say anything about any size changes between desktop and mobile. In other components, they have noted the size differences. It might be something worth checking with design on. 🤷‍♀️
Do we need to adjust .spectrum-ColorWheel-border at all so that our border is actually transparent, against the color wheel, instead of outside of the color wheel? I'm not sure if the clip path is the right place, but maybe that custom property needs some tweaking? I think S2 would be the place to fix this! (because it's also not like that in main, but looking at S1 designs, it should have been).

Ours (effectively, has a gray border):

In Figma (where the border is "on top" of the color wheel):

Happy to pair on any of my comments if two heads are better than one! 👍

components/colorwheel/index.css

cdransf · 2024-11-14T00:11:58Z

A few questions for you, as usual!

I wonder if we need to refactor the color-wheel-width and color-wheel-minimum-width tokens from our custom tokens/dist. Those values change based on the platform (desktop/mobile), but the designs don't say anything about any size changes between desktop and mobile. In other components, they have noted the size differences. It might be something worth checking with design on. 🤷‍♀️

Do we need to adjust .spectrum-ColorWheel-border at all so that our border is actually transparent, against the color wheel, instead of outside of the color wheel? I'm not sure if the clip path is the right place, but maybe that custom property needs some tweaking? I think S2 would be the place to fix this! (because it's also not like that in main, but looking at S1 designs, it should have been).

Ours (effectively, has a gray border):

In Figma (where the border is "on top" of the color wheel): ...

Happy to pair on any of my comments if two heads are better than one! 👍

I started a thread in the implementations channel about the first question — I'll go ahead and run with design's preference.

Since the border is rendered by the clip path but is associated with the div that wraps the color wheel node, I'm not sure we can fix it by adjusting the clip path (to your point). If we reduce the dimensions of the div or reduce the size of the clip path the "border" would disappear since it would render behind the color wheel. Could we render an inset border and attach it to the color wheel node directly? (Pending design approval and input.) ✨

jawinn

Nice work adding the custom size version.
A few questions and suggestions here:

components/colorwheel/stories/colorwheel.stories.js

components/colorwheel/stories/colorwheel.test.js

components/colorwheel/stories/colorwheel.stories.js

components/colorwheel/index.css

jawinn · 2025-02-17T23:48:15Z

components/colorwheel/index.css

+	inset-block: var(--mod-colorwheel-border-width, var(--spectrum-colorwheel-border-width));
+	inset-inline: var(--mod-colorwheel-border-width, var(--spectrum-colorwheel-border-width));


Do you know why this element is inset by the border width originally, and whether we still need this?

I don't know why it was set this way, but we do need it as the conic gradient/wheel content does not display without it.

components/colorwheel/index.css

jawinn

🎉 This should be good to go once things are cleared up in spectrum-two (build issue and all story descriptions not appearing).

marissahuysentruyt

OOOOOOh man, this looks really excellent! Thanks for sticking this one out with all of the high contrast things, and the transparent borders. They all look fabulous!

I left a few non-blocking comments. The one comment I left about the mods listed in the changeset is the only one I'm thinking that maybe we should updated before merging. I'll approve anyways, and leave the rest up to you! Great job on this.

.changeset/giant-windows-smoke.md

components/colorwheel/stories/colorwheel.stories.js

- chore(colorwheel): update property name - chore(colorwheel): wip inset borders - chore(colorwheel): fix lint violations - chore(colorwheel): move mod declarations - chore(colorwheel): drop unused property + update metadata - chore(colorwheel): remove underlying border node + class - chore(colorwheel): remove unused property - fix(colorwheel): add missing mod - fix(colorwheel): comments for updated before spacing/positioning - fix(colorwheel): adopt proper token for border opacity - fix(colorwheel): remove inset border on disabled state - fix(colorwheel): remove global token reference - chore(colorwheel): highlight removed/added mods - chore(colorwheel): update copyright year - chore(colorwheel): add color loupe to default story - fix(colorwheel): correct WHC disabled background color value - chore(colorwheel): update test heading - fix(colorwheel): typos - chore(colorwheel): update token usage - chore(colorwheel): add without loupe test - chore(colorwheel): restore WHC styles - chore(colorwheel): move isWithColorLoupe property - fix(colorwheel): whc disabled background - fix(colorwheel): improve interior border styles - fix(colorwheel): token/classnames in story; remove unnecessary margin - chore(colorwheel): fix inset borders + improve comments - chore(colorwheel): update changeset - chore(colorwheel): add note re --spectrum-color-wheel-color-area-margin token - chore(colorwheel): restore missing mods; naming consistency - chore(colorwheel): add sizing stories - chore(colorwheel): restore comment - chore(colorwheel): inset shorthand - chore(colorwheel): remove unnecessary colorwheel template + story - chore(colorwheel): remove unnecessary custom sizing story from sidebar - chore(colorwheel): add custom sizing test - chore(colorwheel): move comment to docs - fix(colorwheel): after pseudo selector disabled state - fix(colorwheel): remove problematic border width mod - fix(colorwheel): typos + drop sentence

cdransf added size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. skip_vrt Add to a PR to skip running VRT (but still pass the action) ready-for-review labels Nov 12, 2024

cdransf requested review from pfulton, castastrophe, rise-erpelding and marissahuysentruyt November 12, 2024 19:43

cdransf self-assigned this Nov 12, 2024

cdransf changed the title ~~feat(colorwheel): s2 migration~~ feat(colorwheel): S2 migration Nov 12, 2024

marissahuysentruyt reviewed Nov 13, 2024

View reviewed changes

components/colorwheel/index.css Show resolved Hide resolved

components/colorwheel/index.css Show resolved Hide resolved

components/colorwheel/index.css Outdated Show resolved Hide resolved

components/colorwheel/index.css Show resolved Hide resolved

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from eaf2611 to 3a12421 Compare November 14, 2024 00:15

cdransf added the blocked See description and comments for what is blocking this issue label Nov 14, 2024

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 2 times, most recently from 99a6ad6 to f3be898 Compare November 20, 2024 22:30

cdransf requested a review from marissahuysentruyt November 26, 2024 16:41

cdransf removed the blocked See description and comments for what is blocking this issue label Nov 26, 2024

castastrophe force-pushed the spectrum-two branch 3 times, most recently from cdb180d to 27d01df Compare December 4, 2024 14:54

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 2 times, most recently from 7ce5746 to 7af66a2 Compare December 10, 2024 15:18

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 3 times, most recently from 9cb357e to 70603e0 Compare December 19, 2024 22:38

castastrophe force-pushed the spectrum-two branch 2 times, most recently from c93daf7 to e393c32 Compare December 27, 2024 18:11

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from 9a4683d to ffdbd82 Compare February 13, 2025 21:56

jawinn suggested changes Feb 17, 2025

View reviewed changes

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 4 times, most recently from 1d680c5 to 680c7e9 Compare February 21, 2025 23:42

cdransf requested a review from jawinn February 22, 2025 00:30

castastrophe force-pushed the spectrum-two branch 5 times, most recently from d5e72d4 to 0f14273 Compare February 24, 2025 22:39

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from 680c7e9 to e06bb78 Compare February 25, 2025 00:21

castastrophe force-pushed the spectrum-two branch from 3499231 to ad861d0 Compare February 25, 2025 20:24

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from e06bb78 to caa2a45 Compare February 25, 2025 20:39

jawinn approved these changes Feb 25, 2025

View reviewed changes

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from caa2a45 to 896416d Compare February 26, 2025 22:45

marissahuysentruyt approved these changes Feb 27, 2025

View reviewed changes

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 2 times, most recently from 666c7bf to 84403b2 Compare February 27, 2025 17:07

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from 84403b2 to 0579096 Compare February 27, 2025 17:55

cdransf merged commit b9f61e4 into spectrum-two Feb 27, 2025
12 checks passed

cdransf deleted the cdransf/s2-colorwheel-migration branch February 27, 2025 18:04

github-actions bot mentioned this pull request Feb 27, 2025

chore: release (next) #3583

Merged

cdransf added size-5 L ~30-42hrs; lots of effort or complexity, most of a sprint needed to complete. and removed size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. labels Feb 28, 2025

castastrophe mentioned this pull request Apr 15, 2025

feat(tokens,card): update to @adobe/[email protected] #3669

Merged

12 tasks

This was referenced May 16, 2025

chore(swatch,menu,swatchgroup): fix reverted metadata assets #3752

Merged

chore: merge latest updates from main #3777

Merged

		inset-block: var(--mod-colorwheel-border-width, var(--spectrum-colorwheel-border-width));
		inset-inline: var(--mod-colorwheel-border-width, var(--spectrum-colorwheel-border-width));

feat(colorwheel): S2 migration #3390

feat(colorwheel): S2 migration #3390

Uh oh!

Conversation

cdransf commented Nov 12, 2024

Description

How and where has this been tested?

Validation steps

Regression testing

To-do list

Uh oh!

changeset-bot bot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

File metrics

Summary

colorwheel

Uh oh!

marissahuysentruyt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cdransf commented Nov 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jawinn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jawinn Feb 17, 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!

cdransf Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jawinn left a comment

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

changeset-bot bot commented Nov 12, 2024 •

edited

Loading

github-actions bot commented Nov 12, 2024 •

edited

Loading

github-actions bot commented Nov 12, 2024 •

edited

Loading

cdransf commented Nov 14, 2024 •

edited

Loading

jawinn Feb 17, 2025 •

edited

Loading

marissahuysentruyt left a comment •

edited

Loading