Skip to content

chore: Alternative style api for badge #5120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pan-kot wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore: Alternative style api for badge #5120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pages/badge/style-api-v2.page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export default function () {
<SpaceBetween size="m" direction="horizontal">
<Badge {...{ styleClassNames: { root: clsx(styles.badge, styles['badge-info-pill']) } }}>Info pill</Badge>
<Badge {...{ styleClassNames: { root: clsx(styles.badge, styles['badge-error-square']) } }}>Error square</Badge>
<Badge {...{ styleClassNames: { root: clsx(styles.badge, styles['badge-label']) } }}>Label</Badge>
</SpaceBetween>
</SimplePage>
);
Expand Down
43 changes: 32 additions & 11 deletions pages/badge/style-api-v2.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,45 @@
SPDX-License-Identifier: Apache-2.0
*/

@use '@cloudscape-design/component-toolkit/styling' as styling;
@use '../style-api/palette' as palette;

.badge {
--awsui-style-border-color: transparent;
--awsui-style-border-radius: 4px;
--awsui-style-border-width: 3px;
--awsui-style-padding-block: 6px;
--awsui-style-padding-inline: 12px;
@include styling.override {
border-color: transparent;
border-start-start-radius: 4px;
border-start-end-radius: 4px;
border-end-start-radius: 4px;
border-end-end-radius: 4px;
border-width: 3px;
padding-block: 6px;
padding-inline: 12px;
}
}

.badge-info-pill {
--awsui-style-background-color: #{palette.$accent};
--awsui-style-color: #{palette.$text-on-accent};
--awsui-style-border-radius: 77px;
@include styling.override {
background-color: palette.$accent;
color: palette.$text-on-accent;
border-start-start-radius: 77px;
border-start-end-radius: 77px;
border-end-start-radius: 77px;
border-end-end-radius: 77px;
}
}

.badge-error-square {
--awsui-style-background-color: #{palette.$error-surface};
--awsui-style-color: #{palette.$error};
--awsui-style-border-color: #{palette.$error};
@include styling.override {
background-color: palette.$error-surface;
color: palette.$error;
border-color: palette.$error;
}
}

.badge-label {
@include styling.override {
font-family: monospace;
font-size: 14px;
font-weight: 400;
}
}
17 changes: 9 additions & 8 deletions src/__tests__/snapshot-tests/__snapshots__/style-docs.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,19 @@ exports[`Style API docs definition for badge matches the snapshot: badge 1`] = `
"slots": [
{
"name": "root",
"properties": [],
"propertyDescriptions": {},
"tokenDescriptions": {},
"tokens": [
"properties": [
"color",
"background-color",
"border-color",
"border-width",
"border",
"border-radius",
"padding-block",
"padding-inline",
"padding",
"font-family",
"font-size",
"font-weight",
],
"propertyDescriptions": {},
"tokenDescriptions": {},
"tokens": [],
},
],
}
Expand Down
81 changes: 39 additions & 42 deletions src/badge/styles.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,82 +7,79 @@
@use '../internal/styles/tokens' as awsui;
@use '../internal/styles/style-api' as style-api;

$tokens: style-api.resolve(style-api.combine(style-api.$surface, (padding-block, padding-inline)), public);
@include style-api.register($tokens);
@include style-api.docs('root', $tokens);
@include style-api.docs(
'root',
$properties: (color, background-color, border, border-radius, padding, font-family, font-size, font-weight)
);

.badge {
@include styles.styles-reset;

@include styles.font-body-s;
line-height: awsui.$line-height-body-m;
display: inline-block;
border-start-start-radius: style-api.value($tokens, border-radius, awsui.$border-radius-badge);
border-start-end-radius: style-api.value($tokens, border-radius, awsui.$border-radius-badge);
border-end-start-radius: style-api.value($tokens, border-radius, awsui.$border-radius-badge);
border-end-end-radius: style-api.value($tokens, border-radius, awsui.$border-radius-badge);
border-start-start-radius: awsui.$border-radius-badge;
border-start-end-radius: awsui.$border-radius-badge;
border-end-start-radius: awsui.$border-radius-badge;
border-end-end-radius: awsui.$border-radius-badge;
border-block-style: solid;
border-inline-style: solid;
border-width: style-api.value($tokens, border-width, awsui.$border-width-badge);
padding-block: style-api.value($tokens, padding-block, 0);
padding-inline: style-api.value($tokens, padding-inline, awsui.$space-xs);
color: style-api.value($tokens, color, awsui.$color-text-notification-default);
border-width: awsui.$border-width-badge;
padding-block: 0;
padding-inline: awsui.$space-xs;
color: awsui.$color-text-notification-default;

&.badge-color-grey {
background-color: style-api.value($tokens, background-color, awsui.$color-background-badge-grey);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-grey);
color: style-api.value($tokens, color, awsui.$color-text-badge-grey);
background-color: awsui.$color-background-badge-grey;
border-color: awsui.$color-border-badge-grey;
color: awsui.$color-text-badge-grey;
}

&.badge-color-green {
background-color: style-api.value($tokens, background-color, awsui.$color-background-badge-green);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-green);
color: style-api.value($tokens, color, awsui.$color-text-badge-green);
background-color: awsui.$color-background-badge-green;
border-color: awsui.$color-border-badge-green;
color: awsui.$color-text-badge-green;
}

&.badge-color-blue {
background-color: style-api.value($tokens, background-color, awsui.$color-background-badge-blue);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-blue);
color: style-api.value($tokens, color, awsui.$color-text-badge-blue);
background-color: awsui.$color-background-badge-blue;
border-color: awsui.$color-border-badge-blue;
color: awsui.$color-text-badge-blue;
}

&.badge-color-red {
background-color: style-api.value($tokens, background-color, awsui.$color-background-badge-red);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-red);
color: style-api.value($tokens, color, awsui.$color-text-badge-red);
background-color: awsui.$color-background-badge-red;
border-color: awsui.$color-border-badge-red;
color: awsui.$color-text-badge-red;
}

&.badge-color-severity-critical {
background-color: style-api.value(
$tokens,
background-color,
awsui.$color-background-notification-severity-critical
);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-severity-critical);
color: style-api.value($tokens, color, awsui.$color-text-badge-severity-critical);
background-color: awsui.$color-background-notification-severity-critical;
border-color: awsui.$color-border-badge-severity-critical;
color: awsui.$color-text-badge-severity-critical;
}

&.badge-color-severity-high {
background-color: style-api.value($tokens, background-color, awsui.$color-background-notification-severity-high);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-severity-high);
color: style-api.value($tokens, color, awsui.$color-text-badge-severity-high);
background-color: awsui.$color-background-notification-severity-high;
border-color: awsui.$color-border-badge-severity-high;
color: awsui.$color-text-badge-severity-high;
}

&.badge-color-severity-medium {
background-color: style-api.value($tokens, background-color, awsui.$color-background-notification-severity-medium);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-severity-medium);
color: style-api.value($tokens, color, awsui.$color-text-badge-severity-medium);
background-color: awsui.$color-background-notification-severity-medium;
border-color: awsui.$color-border-badge-severity-medium;
color: awsui.$color-text-badge-severity-medium;
}

&.badge-color-severity-low {
background-color: style-api.value($tokens, background-color, awsui.$color-background-notification-severity-low);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-severity-low);
color: style-api.value($tokens, color, awsui.$color-text-badge-severity-low);
background-color: awsui.$color-background-notification-severity-low;
border-color: awsui.$color-border-badge-severity-low;
color: awsui.$color-text-badge-severity-low;
}

&.badge-color-severity-neutral {
background-color: style-api.value($tokens, background-color, awsui.$color-background-notification-severity-neutral);
border-color: style-api.value($tokens, border-color, awsui.$color-border-badge-severity-neutral);
color: style-api.value($tokens, color, awsui.$color-text-badge-severity-neutral);
background-color: awsui.$color-background-notification-severity-neutral;
border-color: awsui.$color-border-badge-severity-neutral;
color: awsui.$color-text-badge-severity-neutral;
}
}
4 changes: 2 additions & 2 deletions src/internal/styles/style-api.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ $_focus-ring-carriers: toolkit.resolve($focus-ring, carrier);
}
}

@mixin docs($name, $map) {
@mixin docs($name, $tokens: null, $properties: null, $descriptions: null) {
@if enabled() {
@include toolkit.docs($name, $map);
@include toolkit.docs($name, $tokens, $properties, $descriptions);
}
}

Expand Down
Loading