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: 02a3f15

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.66 MB^*
Total change (Δ): 🔴 ⬆ 1.39 KB (0.08%)

Table reports on changes to a package's main file.

Package	Size	Minified	Gzipped	Δ
colorwheel	6.07 KB	-	-	🔴 ⬆ 1.39 KB

colorwheel

Filename	Head	Minified	Gzipped	Compared to base
index.css	6.07 KB	-	-	🔴 ⬆ 1.39 KB
metadata.json	2.11 KB	-	-	🔴 ⬆ 0.20 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.) ✨

marissahuysentruyt

Thanks for working on this! I left some ideas and comments about some of the CSS changes. I did want to run something by you...

What do you think of adjusting the default template for this component? In Figma for S1, it looks like the default did not have the color loupe, but in Figma now, the S2 color wheel has the color loupe as the default. Should we update our default story to reflect that change?

I think at the minimum maybe we should show a story with a color loupe on the docs page, and add the corresponding controls. Any thoughts on that?

components/colorwheel/index.css

.changeset/giant-windows-smoke.md

components/colorwheel/index.css

marissahuysentruyt

Oh! Do we need to revisit the disabled color wheel in high contrast mode? This is what I see on Assistiv Labs. Is this intended? Should there be any sort of background color for the wheel?

cdransf · 2025-01-30T20:28:50Z

Oh! Do we need to revisit the disabled color wheel in high contrast mode? This is what I see on Assistiv Labs. Is this intended? Should there be any sort of background color for the wheel?

Addressed this in c84834: Canvas needed to be CanvasText.

marissahuysentruyt

Nice work! It's so close! I have some smaller suggestions to "leave it better than we found it" for the CSS. I also totally didn't dig into the WHCM stuff initially, and suggested changes that deviated too far from what prod has, so I tried to suggest more accurate changes this time. 🤦‍♀️

In the index.css, could you refactor the min-inline-size so we aren't using the token directly in the style definition? This wasn't something you introduced, but I figured maybe we could fix it up so it matches what our preferences are. Maybe something like
--spectrum-colorwheel-min-inline-size: var(--spectrum-color-wheel-minimum-width)? And then use the min-inline-size custom property in the style definition.

Last but not least, do you think we have any tests to add? I was thinking it wouldn't be a terrible idea to throw a quick isWithColorLoupe: false test into the tests file.

components/colorwheel/index.css

marissahuysentruyt · 2025-02-03T20:12:39Z

components/colorwheel/index.css

-		--highcontrast-colorwheel-border-color-disabled: GrayText;
-		--highcontrast-colorwheel-fill-color-disabled: Canvas;


I totally spoke too soon on the WHCM stuff! I left an updated (more thought-through 😬 ) idea that should replicate what's on prod better now.

Looks like we still need the gradient itself, and then I have a better idea how to replicate this disabled state now:
(this is production when I test in AssistivLabs)

Hmm — took a look at current state in Assistiv and it looks better, but I'm not sure if it's exactly what we want?

Yeah....I think there's a discrepancy between Canvas and CanvasText. I believe swapping this --highcontrast-colorwheel-fill-color-disabled: Canvas; instead of CanvasText should get rid of that white background in the disabled wheel.

components/colorwheel/index.css

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

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 5b042e8 to c01a26b Compare January 28, 2025 15:51

cdransf requested a review from marissahuysentruyt January 28, 2025 20:03

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from 4552560 to dea94d8 Compare January 29, 2025 18:08

marissahuysentruyt requested changes Jan 29, 2025

View reviewed changes

marissahuysentruyt reviewed Jan 29, 2025

View reviewed changes

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 3 times, most recently from 378549e to f2aafaa Compare January 30, 2025 15:48

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 3 times, most recently from c9d910f to 086faac Compare February 3, 2025 16:30

cdransf requested a review from marissahuysentruyt February 3, 2025 16:31

marissahuysentruyt requested changes Feb 4, 2025

View reviewed changes

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 2 times, most recently from a984eb6 to 61d7526 Compare February 4, 2025 22:12

castastrophe force-pushed the spectrum-two branch 2 times, most recently from 56c6806 to 793571c Compare February 5, 2025 17:33

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from 1f3d572 to eb8c57f Compare February 5, 2025 19:20

cdransf requested a review from marissahuysentruyt February 5, 2025 19:21

pfulton force-pushed the spectrum-two branch from ff3adf1 to f5b76b3 Compare February 6, 2025 21:29

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from eb8c57f to 2454e32 Compare February 7, 2025 00:44

castastrophe force-pushed the spectrum-two branch 2 times, most recently from db2a5dd to f34473b Compare February 7, 2025 17:35

cdransf force-pushed the cdransf/s2-colorwheel-migration branch 3 times, most recently from 1bfefa5 to ee52db2 Compare February 7, 2025 17:42

castastrophe force-pushed the spectrum-two branch from f34473b to cf46c2b Compare February 7, 2025 20:01

cdransf force-pushed the cdransf/s2-colorwheel-migration branch from ee52db2 to 02a3f15 Compare February 7, 2025 21:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(colorwheel): S2 migration #3390

feat(colorwheel): S2 migration #3390

cdransf commented Nov 12, 2024

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

marissahuysentruyt left a comment

cdransf commented Nov 14, 2024 •

edited

Loading

marissahuysentruyt left a comment

marissahuysentruyt left a comment •

edited

Loading

cdransf commented Jan 30, 2025

marissahuysentruyt left a comment •

edited

Loading

marissahuysentruyt Feb 3, 2025

cdransf Feb 4, 2025

marissahuysentruyt Feb 5, 2025 •

edited

Loading

cdransf Feb 5, 2025

		--highcontrast-colorwheel-border-color-disabled: GrayText;
		--highcontrast-colorwheel-fill-color-disabled: Canvas;

feat(colorwheel): S2 migration #3390

Are you sure you want to change the base?

feat(colorwheel): S2 migration #3390

Conversation

cdransf commented Nov 12, 2024

Description

How and where has this been tested?

Validation steps

Regression testing

To-do list

changeset-bot bot commented Nov 12, 2024 • edited Loading

🦋 Changeset detected

github-actions bot commented Nov 12, 2024 • edited Loading

github-actions bot commented Nov 12, 2024 • edited Loading

File metrics

Summary

colorwheel

marissahuysentruyt left a comment

Choose a reason for hiding this comment

cdransf commented Nov 14, 2024 • edited Loading

marissahuysentruyt left a comment

Choose a reason for hiding this comment

marissahuysentruyt left a comment • edited Loading

Choose a reason for hiding this comment

cdransf commented Jan 30, 2025

marissahuysentruyt left a comment • edited Loading

Choose a reason for hiding this comment

marissahuysentruyt Feb 3, 2025

Choose a reason for hiding this comment

cdransf Feb 4, 2025

Choose a reason for hiding this comment

marissahuysentruyt Feb 5, 2025 • edited Loading

Choose a reason for hiding this comment

cdransf Feb 5, 2025

Choose a reason for hiding this comment

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

marissahuysentruyt left a comment •

edited

Loading

marissahuysentruyt left a comment •

edited

Loading

marissahuysentruyt Feb 5, 2025 •

edited

Loading