Alert
Installation
yarn add @chewy/kib-messaging-stylesImport
@use '~@chewy/kib-messaging-styles/src/kib-alert/styles' as kib-alert;Mixins
root-container
@mixin root-container() { ... }@mixin root-container() { @include typography.style-as('paragraph-1'); @include severity-info; display: flex; padding: settings.$spacing; border-radius: settings.$border-radius; @media (forced-colors: active) { outline: unit.rem(1px) solid; outline-offset: unit.rem(-1px); } }
Description
Base block container styles
Parameters
None.
Requires
- [mixin]
severity-info - [function]
rem - [variable]
spacing - [variable]
border-radius
root-container-large
@mixin root-container-large() { ... }@mixin root-container-large() { padding: settings.$spacing-large; }
icon
@mixin icon() { ... }@mixin icon() { flex-shrink: 0; margin-right: settings.$spacing; width: settings.$icon-size; height: settings.$icon-size; fill: currentColor; // ensure the icon is vertically centered // with the first line of text for all themes margin-top: calc((settings.$icon-size - settings.$computed-message-line-height) / -2); }
Description
Alert message icon
Parameters
None.
Requires
- [variable]
spacing - [variable]
icon-size - [variable]
computed-message-line-height
Used by
- [mixin]
action-wrapper
icon-with-title
@mixin icon-with-title() { ... }@mixin icon-with-title() { margin-top: calc((settings.$icon-size - settings.$computed-title-line-height) / -2); }
Description
Alert message icon with title
Parameters
None.
Requires
- [variable]
icon-size - [variable]
computed-title-line-height
content
@mixin content() { ... }@mixin content() { display: flex; flex-direction: column; justify-content: space-between; position: relative; flex-grow: 1; min-width: 0; overflow-wrap: break-word; }
Description
Alert content container icon
Parameters
None.
content-dismissible
@mixin content-dismissible() { ... }@mixin content-dismissible() { padding-right: calc(#{settings.$dismiss-button-size} + #{settings.$spacing}); }
Description
Title modifier for dismissible alert
Parameters
None.
Requires
- [variable]
dismiss-button-size - [variable]
spacing
title
@mixin title() { ... }@mixin title() { @include typography.style-as(settings.$title-token-size); margin-bottom: spacing.get('s2'); }
message
@mixin message() { ... }@mixin message() { @include typography.style-as(settings.$messaging-token-size); margin-top: 0; margin-bottom: 0; }
actions
@mixin actions() { ... }@mixin actions() { @include typography.style-as('paragraph-2'); padding-top: spacing.get('s4'); display: flex; justify-content: flex-end; }
actions-dismissible
@mixin actions-dismissible() { ... }@mixin actions-dismissible() { margin-right: calc((#{settings.$dismiss-button-size} + #{spacing.get('s2')}) * -1); }
Description
Actions container for dismissible alert
Parameters
None.
Requires
- [function]
get - [variable]
dismiss-button-size
action-trigger
@mixin action-trigger() { ... }@mixin action-trigger() { @include link.link(false); color: currentColor; &:not(:first-child) { margin-left: spacing.get('s2'); } }
Description
Action trigger styles, could apply to buttons or anchors
Parameters
None.
Requires
- [function]
get
dismiss-button
@mixin dismiss-button() { ... }@mixin dismiss-button() { padding: 0; position: absolute; top: 0; right: 0; display: flex; align-items: center; justify-content: center; width: settings.$dismiss-button-size; height: settings.$dismiss-button-size; background: none; border: 0; color: inherit; cursor: pointer; &::before { $offset: kib-core.dimensions-get('tiny') * -1; position: absolute; top: $offset; left: $offset; right: $offset; bottom: $offset; border: unit.rem(1px) solid currentColor; border-radius: 100%; content: ''; opacity: 0; transition: opacity 0.2s; } &:hover, &:focus { outline: 0; &::before { opacity: 1; } } }
dismiss-icon
@mixin dismiss-icon() { ... }@mixin dismiss-icon() { width: settings.$dismiss-icon-size; height: settings.$dismiss-icon-size; fill: currentColor; }
severity-info
@mixin severity-info() { ... }@mixin severity-info() { background-color: settings.$info-background-color; color: settings.$info-text-color; }
Description
Informative alert variant styles
Parameters
None.
Requires
- [variable]
info-background-color - [variable]
info-text-color
Used by
- [mixin]
root-container
severity-success
@mixin severity-success() { ... }@mixin severity-success() { background-color: settings.$success-background-color; color: settings.$success-text-color; }
Description
Success alert variant styles
Parameters
None.
Requires
- [variable]
success-background-color - [variable]
success-text-color
severity-caution
Deprecated!
use severity-warning for alignment purposes
@mixin severity-caution() { ... }@mixin severity-caution() { @include severity-warning; }
severity-danger
Deprecated!
use severity-error for alignment purposes
@mixin severity-danger() { ... }@mixin severity-danger() { @include severity-error; }
severity-warning
@mixin severity-warning() { ... }@mixin severity-warning() { background-color: settings.$warning-background-color; color: settings.$warning-text-color; }
Description
Caution alert variant styles
Parameters
None.
Requires
- [variable]
warning-background-color - [variable]
warning-text-color
Used by
- [mixin]
severity-caution
severity-error
@mixin severity-error() { ... }@mixin severity-error() { background-color: settings.$error-background-color; color: settings.$error-text-color; }
Description
Danger alert variant styles
Parameters
None.
Requires
- [variable]
error-background-color - [variable]
error-text-color
Used by
- [mixin]
severity-danger
Variables
spacing
$spacing: spacing.get('s2') !default;Description
Default padding spacing around alert contents
Type
Number
Used by
- [mixin]
root-container - [mixin]
icon - [mixin]
content-dismissible - [function]
get-spacing - [mixin]
spacing - [mixin]
generate-spacing - [mixin]
list - [mixin]
choices-portrait-spacing - [mixin]
content-landscape - [mixin]
content-condensed - [mixin]
actions-condensed - [mixin]
actions-landscape - [mixin]
flag - [mixin]
container - [mixin]
content-item
spacing-large
$spacing-large: spacing.get('s4') !default;border-radius
$border-radius: kib-core.dimensions-get('small') !default;Description
Container border radius
Type
Number
Used by
- [mixin]
root-container - [mixin]
base - [mixin]
card - [mixin]
controls - [mixin]
action - [mixin]
default - [mixin]
container - [mixin]
canvas-flat - [mixin]
canvas-landscape-flat - [mixin]
canvas-only-flat - [mixin]
flag - [mixin]
sponsor - [mixin]
indicator - [mixin]
root-container - [mixin]
text-skeleton - [mixin]
swatch-shared-styles - [mixin]
tooltip
icon-size
$icon-size: kib-core.dimensions-get('large') !default;Description
Message icon size
Type
Number
Used by
- [mixin]
icon - [mixin]
icon-with-title - [mixin]
button-with-icon - [mixin]
rating-icon - [mixin]
icon - [mixin]
clear-control-with-icon - [mixin]
icon - [mixin]
icon-with-action - [mixin]
loading-spinner - [mixin]
action - [mixin]
field-icon - [mixin]
icon-circle - [mixin]
icon-wrapper - [mixin]
icon-wrapper-with-subtitle - [mixin]
icon - [mixin]
icon - [mixin]
icon - [mixin]
autoship-icon - [mixin]
icon
title-token-size
$title-token-size: 'section-2' !default;messaging-token-size
$messaging-token-size: 'paragraph-1' !default;computed-title-line-height
$computed-title-line-height: calc(
typography.get($title-token-size, 'line-height') * typography.get($title-token-size, 'font-size')
) !default;computed-message-line-height
$computed-message-line-height: calc(
typography.get($messaging-token-size, 'line-height') *
typography.get($messaging-token-size, 'font-size')
) !default;dismiss-button-size
$dismiss-button-size: kib-core.dimensions-get('large') !default;Description
Dismiss button size
Type
Number
Used by
- [mixin]
content-dismissible - [mixin]
actions-dismissible - [mixin]
dismiss-button - [mixin]
dismiss-button
dismiss-icon-size
$dismiss-icon-size: kib-core.dimensions-get('large') !default;info-background-color
$info-background-color: color.get('message', 'info', '03') !default;info-text-color
$info-text-color: color.get('message', 'info', '04') !default;success-background-color
$success-background-color: color.get('message', 'success', '03') !default;success-text-color
$success-text-color: color.get('message', 'success', '04') !default;warning-background-color
$warning-background-color: color.get-color-property('message', 'warning', '03') !default;warning-text-color
$warning-text-color: color.get-color-property('message', 'warning', '04') !default;error-background-color
$error-background-color: color.get-color-property('message', 'error', '03') !default;error-text-color
$error-text-color: color.get-color-property('message', 'error', '04') !default;caution-background-color
Deprecated!
$caution-background-color: $warning-background-color !default;caution-text-color
Deprecated!
$caution-text-color: $warning-text-color !default;danger-background-color
Deprecated!
$danger-background-color: $error-background-color !default;danger-text-color
Deprecated!
$danger-text-color: $error-text-color !default;