feat(divider): migrate to second-gen styles and architecture #5798
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| /** | ||
| * Copyright 2025 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import type { ElementSize } from '@swc/core/shared/base'; | ||
|
|
||
| export const DIVIDER_VALID_SIZES: ElementSize[] = ['s', 'm', 'l'] as const; | ||
|
|
||
| export const DIVIDER_STATIC_COLORS = ['white', 'black'] as const; | ||
|
Comment on lines
+15
to
+16
Contributor
There was a problem hiding this comment. How do you feel separating the types and the runtime values in
Contributor
There was a problem hiding this comment. @Rajdeepc @rise-erpelding While I'm definitely open to evolving in this direction as we work our way through more components and refine our approach to defining structured Spectrum data types, I'd prefer to keep it simple for now by maintaining just one file. My reasoning here is that I could see us evolving in various directions from this initial starting point, so doing this refactor now seems premature. |
||
|
|
||
| export type DividerStaticColor = (typeof DIVIDER_STATIC_COLORS)[number]; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Collaborator
Author
There was a problem hiding this comment. Keeping this separate so it can be rolled back easily if we don't want to add it at this time. I noticed that the static color controls on progress circle didn't apply a background making the static white invisible, so this would address that as well.
Contributor
There was a problem hiding this comment. This is great! I think we should definitely keep it for now. It is one of those things we can always revisit once we dive deeper into our Storybook setup. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /** | ||
| * Copyright 2025 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import { html } from 'lit'; | ||
| import { makeDecorator } from '@storybook/preview-api'; | ||
| import type { DecoratorFunction } from '@storybook/types'; | ||
|
|
||
| /** | ||
| * Static color background settings - matching spectrum-css gradients | ||
| */ | ||
| const staticColorSettings = { | ||
|
Contributor
There was a problem hiding this comment. Thanks so much for adding this! After this merges, I could go back into progress circle and update it to use this. 👯 |
||
| black: 'linear-gradient(45deg, rgb(255 241 246), rgb(238 245 255))', | ||
| white: 'linear-gradient(45deg, rgb(64 0 22), rgb(14 24 67))', | ||
| } as const; | ||
|
|
||
| /** | ||
| * Decorator that applies background colors based on static-color arg. | ||
| * Wraps the story in a div with the appropriate background when static-color is set. | ||
| */ | ||
| export const withStaticColorBackground: DecoratorFunction = makeDecorator({ | ||
| name: 'withStaticColorBackground', | ||
| parameterName: 'staticColorBackground', | ||
| wrapper: (StoryFn, context) => { | ||
| const { args } = context; | ||
| const staticColor = args?.[ | ||
| 'static-color' | ||
| ] as keyof typeof staticColorSettings; | ||
|
|
||
| const background = | ||
| staticColor && staticColorSettings[staticColor] | ||
| ? staticColorSettings[staticColor] | ||
| : ''; | ||
|
|
||
| // If no static color is set, just return the story as-is | ||
| if (!background) { | ||
| return StoryFn(context); | ||
| } | ||
|
|
||
| // Wrap the story with the background | ||
| return html` | ||
| <div style="background: ${background}; padding: 24px;"> | ||
| ${StoryFn(context)} | ||
| </div> | ||
| `; | ||
| }, | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <style> | ||
| /* Fix for Storybook's zoom wrapper interfering with forced-colors mode */ | ||
| @media (forced-colors: active) { | ||
| .innerZoomElementWrapper.innerZoomElementWrapper.innerZoomElementWrapper | ||
| > * { | ||
| border: none !important; | ||
| } | ||
| } | ||
| </style> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,111 +12,77 @@ | |
|
|
||
| :host { | ||
| display: block; | ||
| } | ||
|
|
||
| .spectrum-Divider { | ||
| --spectrum-divider-background-color: var(--spectrum-gray-200); | ||
| --spectrum-divider-thickness: var(--spectrum-divider-thickness-medium); | ||
| --spectrum-divider-inline-minimum-size: var( | ||
| --spectrum-divider-horizontal-minimum-width | ||
| ); | ||
| --spectrum-divider-block-minimum-size: var( | ||
| --spectrum-divider-vertical-minimum-height | ||
| ); | ||
| } | ||
|
|
||
| .spectrum-Divider--sizeS { | ||
| --spectrum-divider-thickness: var(--spectrum-divider-thickness-small); | ||
| } | ||
|
|
||
| .spectrum-Divider--sizeL { | ||
| --spectrum-divider-thickness: var(--spectrum-divider-thickness-large); | ||
| --spectrum-divider-background-color: var(--spectrum-gray-800); | ||
| } | ||
|
|
||
| /* static white variant colors */ | ||
| .spectrum-Divider--staticWhite { | ||
| --spectrum-divider-background-color: var(--spectrum-transparent-white-200); | ||
| } | ||
|
|
||
| .spectrum-Divider--staticWhite.spectrum-Divider--sizeL { | ||
| --spectrum-divider-background-color: var(--spectrum-transparent-white-800); | ||
| } | ||
|
|
||
| /* static black variant colors */ | ||
| .spectrum-Divider--staticBlack { | ||
| --spectrum-divider-background-color: var(--spectrum-transparent-black-200); | ||
| } | ||
|
|
||
| .spectrum-Divider--staticBlack.spectrum-Divider--sizeL { | ||
| --spectrum-divider-background-color: var(--spectrum-transparent-black-800); | ||
| } | ||
|
|
||
| .spectrum-Divider { | ||
| block-size: var(--spectrum-divider-thickness); | ||
| inline-size: 100%; | ||
|
|
||
| /* Show the overflow for hr in Edge and IE. */ | ||
| overflow: visible; | ||
| border: none; | ||
| border-width: var(--spectrum-divider-thickness); | ||
| border-radius: var(--spectrum-divider-thickness); | ||
| background-color: var( | ||
| --highcontrast-divider-background-color, | ||
| var(--spectrum-divider-background-color) | ||
| ); | ||
| } | ||
|
|
||
| .spectrum-Divider:not(.spectrum-Divider--vertical) { | ||
| min-inline-size: var(--spectrum-divider-inline-minimum-size); | ||
| } | ||
|
|
||
| /* vertical dividers */ | ||
| .spectrum-Divider--vertical { | ||
| inline-size: var(--spectrum-divider-thickness); | ||
| min-block-size: var(--spectrum-divider-block-minimum-size); | ||
| margin-block: 0; | ||
| block-size: 100%; | ||
| align-self: flex-start; | ||
| } | ||
|
|
||
| /* windows high contrast mode */ | ||
| @media (forced-colors: active) { | ||
|
Collaborator
Author
There was a problem hiding this comment. If you test WHCM or forced-colors (even adjusting the Rendering in Chrome will reveal this), you'll see the divider on the docs page looks something like this: I did investigate this, and it looks like it's coming from Storybook styling that's adding an 8px transparent border that shows up in forced colors. We might want to remove that eventually, but that feels a little out of scope for now. And the border isn't visible when you view the default story.
Contributor
There was a problem hiding this comment. Hmm, is this something we can override with forced specificity in the Storybook styles?
Collaborator
Author
There was a problem hiding this comment. Was this what you meant? I added some styles to a new preview-head.html file in f0d7607 but the class selector needs to be tripled in order to increase the specificity enough to override. |
||
| .spectrum-Divider { | ||
| --highcontrast-divider-background-color: CanvasText; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We’re still missing the contributing documentation that will clarify these nuances (SWC-1234). However, in this specific case, we don’t need to add this static variable. It is only needed to handle cases where these values differ from S1/S2 and we want to throw dev warnings (e.g., deprecation, invalid value) at runtime. By making these values class properties, we can access them through the constructor and retrieve the correct value being loaded, whether it’s from the first or second generation. Hopefully, we can make this information clear enough in the aforementioned documentation! 😛
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rise-erpelding: I discussed this briefly offline with @rubencarvalho, and we agreed that for now we'd like to consistently apply the pattern where we hang structured Spectrum data-type arrays off of the component's constructor.
Let's do this even in cases where the data type doesn't vary from S1 to S2, and even in cases where we don't have a specific need for the structured types at runtime.
At minimum, doing this consistently means we should essentially never have to separately import the structured type arrays into a component's stories—we can always just import the constructor and access the type arrays from there.
The fundamental reasoning behind this is to minimize cognitive load for component authors and maximize consistency.
In the case of Divider, this would mean defining static readonly properties on the base component for both VALID_SIZES and STATIC_COLORS.In the case of Divider, this would mean defining a static readonly property on the base component for
STATIC_COLORS. (It's not necessary to define one forVALID_SIZES, sinceSizedMixindoes that for you.)Let me know if any of this isn't clear!