feat(alert): add component tokens #10218
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -2,8 +2,8 @@ import { E2EElement, E2EPage, newE2EPage } from "@stencil/core/testing"; | |
| import { html } from "../../../support/formatting"; | ||
| import { accessible, defaults, hidden, HYDRATED_ATTR, reflects, renders, t9n } from "../../tests/commonTests"; | ||
| import { getElementXY, skipAnimations } from "../../tests/utils"; | ||
| import { openClose, themed } from "../../tests/commonTests"; | ||
| import { CSS, DURATIONS, SLOTS } from "./resources"; | ||
| import { alertQueueTimeoutMs } from "./AlertManager"; | ||
|
|
||
| describe("defaults", () => { | ||
|
|
@@ -351,8 +351,8 @@ describe("calcite-alert", () => { | |
| await page.setContent(alertSnippet); | ||
| progressBarStyles = await page.evaluate(() => { | ||
| const alert = document.querySelector("calcite-alert"); | ||
| alert.style.setProperty("--calcite-internal-alert-dismiss-progress-background", "white"); | ||
| return window.getComputedStyle(alert).getPropertyValue("--calcite-internal-alert-dismiss-progress-background"); | ||
| }); | ||
| expect(progressBarStyles).toEqual("white"); | ||
| }); | ||
|
|
@@ -594,4 +594,37 @@ describe("calcite-alert", () => { | |
| describe("translation support", () => { | ||
| t9n("calcite-alert"); | ||
| }); | ||
|
|
||
| describe("theme", () => { | ||
| themed( | ||
| html` | ||
| <calcite-alert label="this is a default alert" scale="s"> | ||
| <div slot="${SLOTS.title}">Test title</div> | ||
| <div slot="${SLOTS.message}">Test message</div> | ||
| </calcite-alert> | ||
| `, | ||
| { | ||
|
There was a problem hiding this comment. Found out why the commented-out tokens were failing: diff --git i/packages/calcite-components/src/components/alert/alert.e2e.ts w/packages/calcite-components/src/components/alert/alert.e2e.ts
index b2ea33cbb..674b7ad02 100644
--- i/packages/calcite-components/src/components/alert/alert.e2e.ts
+++ w/packages/calcite-components/src/components/alert/alert.e2e.ts
@@ -605,39 +605,39 @@ describe("calcite-alert", () => {
`,
{
/*"--calcite-alert-width": {
- shadowSelector: `.${CSS.container}`,
- targetProp: "inlineSize",
- },*/
+ shadowSelector: `.${CSS.container}`, // 🕵 sizing styles depend on alert being open
+ targetProp: "inlineSize",
+ },*/
"--calcite-alert-background-color": {
shadowSelector: `.${CSS.container}`,
targetProp: "backgroundColor",
},
/*"--calcite-alert-title-text-color": {
- shadowSelector: `.${CSS.textContainer}`,
+ shadowSelector: `.${CSS.textContainer}`, // 🕵️ text color is applied to the slotted content, this targets the slot parent
targetProp: "color",
},*/
/*"--calcite-alert-message-text-color": {
- shadowSelector: `.${CSS.textContainer}`,
- targetProp: "color",
- },*/
+ shadowSelector: `.${CSS.textContainer}`, // 🕵️ text color is applied to the slotted content, this targets the slot parent
+ targetProp: "color",
+ },*/
"--calcite-alert-corner-radius": {
shadowSelector: `.${CSS.container}`,
targetProp: "borderRadius",
},
/*"--calcite-alert-close-background-color-hover": {
- shadowSelector: `.${CSS.close}`,
- targetProp: "backgroundColor",
- state: "hover",
- },*/
+ shadowSelector: `.${CSS.close}`,
+ targetProp: "backgroundColor",
+ state: "hover", // 🕵 stateful interactions depend on alert being open
+ },*/
/*"--calcite-alert-close-background-color-pressed": {
- shadowSelector: `.${CSS.close}`,
- targetProp: "backgroundColor",
- state: { press: { attribute: "class", value: CSS.close } },
- },*/
+ shadowSelector: `.${CSS.close}`,
+ targetProp: "backgroundColor",
+ state: { press: { attribute: "class", value: CSS.close } }, // 🕵 stateful interactions depend on alert being open
+ },*/
/*"--calcite-alert-dismiss-progress-background-color": {
- shadowSelector: `.${CSS.dismissProgress}`,
- targetProp: "backgroundColor",
- },*/
+ shadowSelector: `.${CSS.dismissProgress}`, // 🕵 the dismiss progress background color needs a different configuration (i.e., auto-close)
+ targetProp: "backgroundColor",
+ },*/
},
);
});Some changes will require separate, different test HTML (see example). |
||
| /*"--calcite-alert-width": { | ||
| shadowSelector: `.${CSS.container}`, | ||
|
There was a problem hiding this comment. if you search for |
||
| targetProp: "inlineSize", | ||
| },*/ | ||
| "--calcite-alert-background-color": { | ||
| shadowSelector: `.${CSS.container}`, | ||
| targetProp: "backgroundColor", | ||
| }, | ||
| /*"--calcite-alert-title-text-color": { | ||
| shadowSelector: `.${CSS.textContainer}`, | ||
|
There was a problem hiding this comment. your selector should target the slot="title" There was a problem hiding this comment. I updated this test but it's still throwing an error.
|
||
| targetProp: "color", | ||
| },*/ | ||
| /*"--calcite-alert-message-text-color": { | ||
| shadowSelector: `.${CSS.textContainer}`, | ||
|
There was a problem hiding this comment. same as title this should target |
||
| targetProp: "color", | ||
| },*/ | ||
| "--calcite-alert-corner-radius": { | ||
| shadowSelector: `.${CSS.container}`, | ||
| targetProp: "borderRadius", | ||
| }, | ||
| }, | ||
| ); | ||
| }); | ||
| }); | ||
This file contains 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 |
|---|---|---|
|
|
@@ -4,19 +4,21 @@ | |
| * These properties can be overridden using the component's tag as selector. | ||
| * | ||
| * @prop --calcite-alert-width: Specifies the width of the component. | ||
| * @prop --calcite-alert-background-color: Specifies the component's background color. | ||
|
There was a problem hiding this comment. Where are these tokens applied? There was a problem hiding this comment.
and in
|
||
| * @prop --calcite-alert-title-text-color: Specifies the component's title text color. | ||
| * @prop --calcite-alert-message-text-color: Specifies the component's message text color. | ||
| * @prop --calcite-alert-corner-radius: Specifies the component's border radius. | ||
|
There was a problem hiding this comment. As a user I might want to override the icon color rendered via prop, or the component's shadow. There was a problem hiding this comment. @alisonailea @jcfranco Should we add tokens for these use cases? There was a problem hiding this comment. Let's discuss customizing the icon and progress color separately. The design spec has both sharing the color defined by |
||
| */ | ||
|
|
||
| $border-style: 1px solid var(--calcite-color-border-3); | ||
|
|
||
| :host { | ||
| --calcite-internal-alert-edge-distance: theme("spacing.8"); | ||
|
There was a problem hiding this comment. This should be alert-size not edge-distance There was a problem hiding this comment.
There was a problem hiding this comment. I updated this to |
||
| @apply block; | ||
| } | ||
|
|
||
| .container { | ||
| @apply box-border | ||
| fixed | ||
| flex | ||
| items-center | ||
|
|
@@ -31,12 +33,13 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| w-full | ||
| z-toast; | ||
|
|
||
| background-color: var(--calcite-alert-background-color, var(--calcite-color-foreground-1)); | ||
| border-radius: var(--calcite-alert-corner-radius, var(--calcite-border-radius)); | ||
| border-block-start: 0 solid transparent; | ||
| border-inline: $border-style; | ||
| border-block-end: $border-style; | ||
| inline-size: var(--calcite-alert-width, auto); | ||
| max-inline-size: calc(100% - (var(--calcite-internal-alert-edge-distance) * 2)); | ||
| transition: | ||
| opacity var(--calcite-internal-animation-timing-slow) $easing-function, | ||
| all var(--calcite-animation-timing) ease-in-out; | ||
|
|
@@ -47,19 +50,19 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| inset-inline-start: 0; | ||
| } | ||
| &[class*="bottom"] { | ||
| transform: translate3d(0, var(--calcite-internal-alert-edge-distance), 0); | ||
| inset-block-end: var(--calcite-internal-alert-edge-distance); | ||
| } | ||
| &[class*="top"] { | ||
| transform: translate3d(0, calc(-1 * var(--calcite-internal-alert-edge-distance)), 0); | ||
| inset-block-start: var(--calcite-internal-alert-edge-distance); | ||
| } | ||
| &[class*="start"] { | ||
| inset-inline-start: var(--calcite-internal-alert-edge-distance); | ||
| inset-inline-end: auto; | ||
| } | ||
| &[class*="end"] { | ||
| inset-inline-end: var(--calcite-internal-alert-edge-distance); | ||
| inset-inline-start: auto; | ||
| } | ||
| } | ||
|
|
@@ -68,13 +71,11 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| @apply flex flex-col items-center justify-center p-0; | ||
| margin-block: auto; | ||
| margin-inline-end: auto; | ||
| } | ||
|
|
||
| .close { | ||
| @apply bg-transparent border-none cursor-pointer flex items-center justify-end outline-none self-stretch text-color-3; | ||
| -webkit-appearance: none; | ||
|
|
||
| @apply focus-base; | ||
| &:focus { | ||
|
|
@@ -83,11 +84,12 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
|
|
||
| &:hover, | ||
| &:focus { | ||
| @apply text-color-1; | ||
| background-color: var(--calcite-color-foreground-2); | ||
| } | ||
|
|
||
| &:active { | ||
| background-color: var(--calcite-color-foreground-3); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -129,7 +131,7 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| block; | ||
| block-size: 2px; | ||
| content: ""; | ||
| background-color: var(--calcite-color-transparent-tint); | ||
| inset-inline-end: 0; | ||
| } | ||
| } | ||
|
|
@@ -140,8 +142,6 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
|
|
||
| .text-container { | ||
| @apply box-border flex flex-auto min-w-0 flex-col break-words; | ||
| } | ||
|
|
||
| .footer { | ||
|
|
@@ -151,11 +151,7 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
|
|
||
| // scale variables | ||
| :host([scale="s"]) { | ||
| inline-size: var(--calcite-alert-width, 40rem); | ||
|
|
||
| @include slotted("title", "*") { | ||
| @apply text-n1-wrap; | ||
|
|
@@ -170,16 +166,22 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| @apply mx-2; | ||
| } | ||
| .container { | ||
| --calcite-internal-alert-min-height: 3.5rem; | ||
| } | ||
| .close { | ||
| padding: theme("spacing.3"); | ||
| } | ||
| .icon { | ||
| padding-inline-start: theme("spacing.3"); | ||
| } | ||
| .text-container { | ||
| padding-block: theme("spacing.2"); | ||
| padding-inline: theme("spacing.3") theme("spacing.2"); | ||
| } | ||
| } | ||
|
|
||
| :host([scale="m"]) { | ||
| inline-size: var(--calcite-alert-width, 50rem); | ||
|
|
||
| @include slotted("title", "*") { | ||
| @apply text-0-wrap; | ||
|
|
@@ -194,16 +196,22 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| @apply mx-3; | ||
| } | ||
| .container { | ||
| --calcite-internal-alert-min-height: 4.1875rem; | ||
| } | ||
| .close { | ||
| padding: theme("spacing.4"); | ||
| } | ||
| .icon { | ||
| padding-inline-start: theme("spacing.4"); | ||
| } | ||
| .text-container { | ||
| padding-block: theme("spacing.3"); | ||
| padding-inline: theme("spacing.4") theme("spacing.3"); | ||
| } | ||
| } | ||
|
|
||
| :host([scale="l"]) { | ||
| inline-size: var(--calcite-alert-width, 60rem); | ||
|
|
||
| @include slotted("title", "*") { | ||
| @apply text-1-wrap mb-1; | ||
|
|
@@ -218,7 +226,17 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| @apply mx-4; | ||
| } | ||
| .container { | ||
| --calcite-internal-alert-min-height: 5.625rem; | ||
| } | ||
| .close { | ||
| padding: theme("spacing.5"); | ||
| } | ||
| .icon { | ||
| padding-inline-start: theme("spacing.5"); | ||
| } | ||
| .text-container { | ||
| padding-block: theme("spacing.4"); | ||
| padding-inline: theme("spacing.5") theme("spacing.4"); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -227,10 +245,10 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
| @apply border-t-2 opacity-100; | ||
| pointer-events: initial; | ||
| &[class*="bottom"] { | ||
| transform: translate3d(0, calc(-1 * var(--calcite-internal-alert-edge-distance)), inherit); | ||
| } | ||
| &[class*="top"] { | ||
| transform: translate3d(0, var(--calcite-internal-alert-edge-distance), inherit); | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -241,17 +259,18 @@ $border-style: 1px solid var(--calcite-color-border-3); | |
|
|
||
| @include slotted("title", "*") { | ||
| @apply text-0-wrap | ||
| font-medium; | ||
|
|
||
| color: var(--calcite-alert-title-text-color, var(--calcite-color-text-1)); | ||
| } | ||
|
|
||
| @include slotted("message", "*") { | ||
| @apply text-n1-wrap | ||
| m-0 | ||
| inline | ||
| font-normal; | ||
| margin-inline-end: theme("margin.2"); | ||
| color: var(--calcite-alert-message-text-color, var(--calcite-color-text-2)); | ||
| } | ||
|
|
||
| @include slotted("link", "*") { | ||
|
|
||
This file contains 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 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,12 @@ | ||
| import { html } from "../../support/formatting"; | ||
| import { SLOTS } from "../components/alert/resources"; | ||
|
|
||
| export const alertTokens = { | ||
| calciteAlertBackgroundColor: "", | ||
| calciteAlertCornerRadius: "", | ||
| }; | ||
|
|
||
| export const alert = html`<calcite-alert label="this is a default alert" scale="s" open> | ||
| <div slot="${SLOTS.title}">Test title</div> | ||
| <div slot="${SLOTS.message}">Test message</div> | ||
| </calcite-alert>`; |
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.
break this into a "default" alert test followed by additional tests to cover tokens only effected by certain props. I.E. Slotted content styles