User Guide

Sass Library

Our style packages are built using dart-sass >=1.23.0. This version is required in order to support the use of SASS modules.

yarn add sass

Sass Modules

When using modules, the @use rule replaces the @import rule, which places all the file's variables, mixins, and functions inside a namespace.

Usage

By default, the namespace is created from the end of URL path:

@use '~@chewy/kib-layout-styles/src/kib-container/styles/kib-container';

.my-layout-container {
  @include kib-container.base;
}

The namespace can also be set explicitly using an as keyword:

@use '~@chewy/kib-layout-styles/src/kib-container/styles/kib-container' as content-container;

.my-layout-container {
  @include content-container.base;
}

Overriding Module Variables

You can override variable values by specifying the changes within the @use statement using the with keyword:

@use '~@chewy/kib-cards-styles/src/kib-ingress-card/styles/kib-ingress-card' with (
  $background-color: $your-custom-color,
  $radius: 0,
  $icon-size: 3.8rem
);

Migrating to Modules

For more details on migration support and the motivations for using Sass modules: https://sass-lang.com/blog/the-module-system-is-launched

accordion

mixins

root-container

@mixin root-container() { ... }

Description

Root accordion container

Parameters

None.

Requires

item-disabled

@mixin item-disabled() { ... }

Description

Accordion item in disabled state

Parameters

None.

item-trigger-wrapper

@mixin item-trigger-wrapper() { ... }

Description

Accordion item trigger wrapper

Parameters

None.

Requires

item-trigger

@mixin item-trigger() { ... }

Description

Accordion item trigger element

Parameters

None.

Requires

item-trigger-open

@mixin item-trigger-open() { ... }

Description

Accordion item trigger element when opened

Parameters

None.

Requires

item-trigger-icon-wrapper

@mixin item-trigger-icon-wrapper() { ... }

Description

Accordion item trigger icon wrapper

Parameters

None.

Requires

item-content-wrapper

@mixin item-content-wrapper() { ... }

Description

Accordion item content wrapper

Parameters

None.

Requires

item-content-wrapper-open

@mixin item-content-wrapper-open() { ... }

Description

Accordion item content wrapper in open state

Parameters

None.

Requires

fade-transition

@mixin fade-transition() { ... }

Description

Accordion item open/close transition

Parameters

None.

TODO's

  • This style is just a placeholder until we have react transition component ready

variables

spacing-bottom

$spacing-bottom: kib-core-dimensions-get(default) !default;

Description

Default bottom spacing after accordion

Type

Number

Used by

item-background

$item-background: kib-core-theme-get('fair') !default;

Description

Default background color of accordion items

Type

Color

Used by

item-background-open

$item-background-open: kib-core-theme-get('background', 'header') !default;

Description

Background color of opened accordion items

Type

Color

Used by

item-border-color

$item-border-color: kib-core-theme-get('outline') !default;

Description

Default border color of accordion items

Type

Color

Used by

item-border-width

$item-border-width: kib-core-px-to-relative(1px) !default;

Description

Border width of accordion items

Type

Number

Used by

item-icon-size

$item-icon-size: (kib-core-dimensions-get(default) * 1.25) !default;

Description

Dimension of accordion item toggle

Type

Number

Used by

item-icon-topposition

$item-icon-topposition: (kib-core-dimensions-get(small) * 1.7) !default;

Description

Height of accordion icon psuedo element

Type

Number

item-trigger-text-color

$item-trigger-text-color: kib-core-theme-get('text') !default;

Description

Default text color of accordion item headers

Type

Color

Used by

item-trigger-font-size

$item-trigger-font-size: kib-core-get-type-property(base, size) !default;

Description

Text font size of accordion item headers

Type

Number

Used by

item-trigger-font-weight

$item-trigger-font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Text font weight of accordion item headers

Type

Number

Used by

item-trigger-line-height

$item-trigger-line-height: kib-core-get-type-property(micro, height) !default;

Description

Default line height of accordion item headers

Type

Number

Used by

item-trigger-spacing-vertical

$item-trigger-spacing-vertical: (
  kib-core-dimensions-get(small) * 1.875
) !default;

Description

Vertical spacing of accordion item trigger

Type

Number

Used by

item-trigger-spacing-horizontal

$item-trigger-spacing-horizontal: kib-core-dimensions-get(default) !default;

Description

Horizontal spacing of accordion item trigger

Type

Number

Used by

animations

mixins

bg-loop

@mixin bg-loop($duration: 1.5s, $iteration: infinite, $timing: ease-in-out) { ... }

Description

Add a background animation to an element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$duration noneString1.5s
$iteration noneStringinfinite
$timing noneStringease-in-out

Example

.element {
  @include kib-animation.bg-loop;
}

params - scss

.element {
  @include kib-animation.bg-loop(5s, 2, ease);
}

fade-in

@mixin fade-in($duration: 0.5s, $iteration: 1, $timing: ease-out) { ... }

Description

Add a Fade In animation to an element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$duration noneString0.5s
$iteration noneString1
$timing noneStringease-out

Example

.element {
  @include kib-animation.fade-in;
}

params - scss

.element {
  @include kib-animation.fade-in(5s, 2, ease);
}

fade-out

@mixin fade-out($duration: 0.5s, $iteration: 1, $timing: ease-out) { ... }

Description

Add a Fade Out animation to an element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$duration noneString0.5s
$iteration noneString1
$timing noneStringease-out

Example

.element {
  @include kib-animation.fade-out;
}

params - scss

.element {
  @include kib-animation.fade-out(5s, 2, ease);
}

rotate

@mixin rotate($duration: 0.5s, $iteration: infinite, $timing: linear) { ... }

Description

Add a 360 rotation animation to an element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$duration noneString0.5s
$iteration noneStringinfinite
$timing noneStringlinear

Example

.element {
  @include kib-animation.rotate;
}

params - scss

.element {
  @include kib-animation.rotate(5s, 2, ease-out);
}

breadcrumb

button

mixins

generate-arrow

@mixin generate-arrow($direction) { ... }

Description

Generate arrow styles for buttons.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$direction

The direction of the arrow, such as prev or next.

String none

Requires

Used by

base-styles

@mixin base-styles() { ... }

Description

Common button styles

Parameters

None.

Requires

base-disabled-styles

@mixin base-disabled-styles() { ... }

Description

Common button disabled styles

Parameters

None.

Requires

Used by

default-styles

@mixin default-styles() { ... }

Description

Default button styles

Parameters

None.

Requires

action-styles

@mixin action-styles() { ... }

Description

Action orange button styles

Parameters

None.

Requires

soft-styles

@mixin soft-styles() { ... }

Description

Soft button styles

Parameters

None.

Requires

white-styles

@mixin white-styles() { ... }

Description

White button styles

Parameters

None.

Requires

flat-styles

@mixin flat-styles() { ... }

Description

Flat button styles

Parameters

None.

Requires

bold-styles

@mixin bold-styles() { ... }

Description

Bold button styles

Parameters

None.

Requires

blue-styles

@mixin blue-styles() { ... }

Description

Blue button styles

Parameters

None.

Requires

dashed-styles

@mixin dashed-styles() { ... }

Description

Dashed button styles

Parameters

None.

Requires

cancel-styles

@mixin cancel-styles() { ... }

Description

Cancel button styles

Parameters

None.

Requires

close-styles

@mixin close-styles() { ... }

Description

Close button styles

Parameters

None.

Requires

follow-styles

@mixin follow-styles() { ... }

Description

Follow button styles

Parameters

None.

Requires

arrow-styles

@mixin arrow-styles($direction) { ... }

Description

Next and previous arrow button styles

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$direction

The direction of the arrow, such as prev or next.

String none

Requires

group-styles

@mixin group-styles() { ... }

Description

Group button styles

Parameters

None.

Requires

large-size-styles

@mixin large-size-styles() { ... }

Description

Large size button styles

Parameters

None.

Requires

small-size-styles

@mixin small-size-styles() { ... }

Description

Small size button styles

Parameters

None.

Requires

xsmall-size-styles

@mixin xsmall-size-styles() { ... }

Description

Xsmall size button styles

Parameters

None.

Requires

narrow-styles

@mixin narrow-styles() { ... }

Description

Narrow button styles

Parameters

None.

Requires

half-styles

@mixin half-styles() { ... }

Description

Half button styles

Parameters

None.

full-styles

@mixin full-styles() { ... }

Description

Full button styles

Parameters

None.

variables

font-family

$font-family: kib-core-theme-get('font', 'base', 'family') !default;

Description

Default Button font family

Type

String

Used by

radius

$radius: kib-core-dimensions-get(tiny) !default;

Description

Default Button border radius

Type

Number

Used by

border-size

$border-size: kib-core-px-to-relative(1px) !default;

Description

Default Button border size

Type

Number

Used by

font-size

$font-size: kib-core-px-to-relative(18px) !default;

Description

Default Button font size

Type

Number

Used by

font-weight

$font-weight: map.get($kib-core-type-weights, regular) !default;

Description

Default Button font weight

Type

Number

Used by

padding-vertical

$padding-vertical: kib-core-px-to-relative(14px) !default;

Description

Default Button vertical padding

Type

Number

Used by

padding-horizontal

$padding-horizontal: kib-core-px-to-relative(35px) !default;

Description

Default Button horizontal padding

Type

Number

Used by

margin-bottom

$margin-bottom: kib-core-px-to-relative(15px) !default;

Description

Default Button bottom margin

Type

Number

Used by

action-font-weight

$action-font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Action Button font weight

Type

Number

Used by

close-dimensions

$close-dimensions: kib-core-px-to-relative(40px) !default;

Description

Close Button dimension

Type

Number

Used by

close-pseudo-width

$close-pseudo-width: kib-core-px-to-relative(20px) !default;

Description

Close Button pseudo element width

Type

Number

Used by

close-pseudo-height

$close-pseudo-height: kib-core-px-to-relative(3px) !default;

Description

Close Button pseudo element height

Type

Number

Used by

follow-pseudo-right-pos

$follow-pseudo-right-pos: kib-core-px-to-relative(20px) !default;

Description

Follow Button pseudo element position right value

Type

Number

Used by

follow-pseudo-width

$follow-pseudo-width: kib-core-px-to-relative(9px) !default;

Description

Follow Button pseudo element width

Type

Number

Used by

follow-pseudo-height

$follow-pseudo-height: kib-core-dimensions-get(default) !default;

Description

Follow Button pseudo element height

Type

Number

Used by

follow-pseudo-background

$follow-pseudo-background: url(#{kib-core-svg-encode("<svg xmlns='http://www.w3.org/2000/svg' viewBox='-2 -6 20.5 35'><style>.st0{fill:#{kib-core-theme-get('ash', 'surface'
)};}</style><path class='st0' d='M17.7 9.5l-.1-.1L3.1-5.1C2.5-5.7 1.8-6 1-6s-1.5.3-2.1.9C-1.7-4.5-2-3.8-2-3s.3 1.5.9 2.1l12.4 12.4-12.4 12.4c-.6.6-.9 1.3-.9 2.1s.3 1.5.9 2.1c.6.6 1.3.9 2.1.9s1.5-.3 2.1-.9l14.5-14.5c.6-.6.9-1.3.9-2.1 0-.9-.5-1.5-.8-2z'/></svg>")}) !default;

Description

Follow Button pseudo element background svg url

Type

String

Used by

next-pseudo-background

$next-pseudo-background: url(#{kib-core-svg-base64-encode(
    $kib-asset-icon-arrow-right-disabled
  )}) !default;

Description

Next Button pseudo element background svg url

Type

String

prev-pseudo-background

$prev-pseudo-background: url(#{kib-core-svg-base64-encode(
    $kib-asset-icon-arrow-left-disabled
  )}) !default;

Description

Previous Button pseudo element background svg url

Type

String

large-font

$large-font: kib-core-px-to-relative(24px) !default;

Description

Large button font size

Type

Number

Used by

large-spacing-vertical

$large-spacing-vertical: kib-core-px-to-relative(15px) !default;

Description

Large button vertical spacing

Type

Number

Used by

large-spacing-horizontal

$large-spacing-horizontal: 2 * kib-core-dimensions-get(default) !default;

Description

Large button horizontal spacing

Type

Number

Used by

small-font

$small-font: kib-core-dimensions-get(default) !default;

Description

Small button font size

Type

Number

Used by

small-padding-vertical

$small-padding-vertical: kib-core-px-to-relative(11px) !default;

Description

Small button vertical padding

Type

Number

Used by

small-padding-horizontal

$small-padding-horizontal: kib-core-dimensions-get(default) !default;

Description

Small button horizontal padding

Type

Number

Used by

small-margin-bottom

$small-margin-bottom: kib-core-px-to-relative(5px) !default;

Description

Small button bottom margin

Type

Number

Used by

extrasmall-font

$extrasmall-font: kib-core-px-to-relative(13px) !default;

Description

Extrasmall button font size

Type

Number

Used by

extrasmall-padding

$extrasmall-padding: kib-core-dimensions-get(small) !default;

Description

Extrasmall button padding

Type

Number

Used by

extrasmall-margin-bottom

$extrasmall-margin-bottom: kib-core-px-to-relative(5px) !default;

Description

Extrasmall button bottom margin

Type

Number

Used by

narrow-padding

$narrow-padding: kib-core-px-to-relative(15px) !default;

Description

Narrow button padding

Type

Number

Used by

blue-font-weight

$blue-font-weight: map.get($kib-core-type-weights, medium) !default;

Description

Blue button font weight

Type

Number

Used by

white

$white: kib-core-theme-get('fair') !default;

Description

White button color

Type

Color

Used by

light-gray

$light-gray: kib-core-theme-get('outline') !default;

Description

Light Gray button color

Type

Color

Used by

gray

$gray: kib-core-theme-get('outline', 'form') !default;

Description

Gray button color

Type

Color

dark-gray

$dark-gray: kib-core-theme-get('ash', 'surface') !default;

Description

Dark Gray button color

Type

Color

Used by

darkest-gray

$darkest-gray: kib-core-theme-get('text') !default;

Description

Darkest Gray button color

Type

Color

Used by

close-pseudo-background

$close-pseudo-background: kib-core-theme-get('text') !default;

Description

Close button pseudo element background color

Type

Color

Used by

close-tap-color

$close-tap-color: kib-core-theme-get('slate') !default;

Description

Close button tap highlight color

Type

Color

Used by

default-blue

$default-blue: kib-core-theme-get('link', 'deepest') !default;

Description

Default button blue color

Type

Color

Used by

hover-blue

$hover-blue: #e9edf2 !default;

Description

Blue button hover color

Type

Color

Used by

orange

$orange: kib-core-theme-get('warning') !default;

Description

Orange button color

Type

Color

Used by

orange-hover

$orange-hover: #c15000 !default;

Description

Orange button hover color

Type

Color

Used by

soft-orange

$soft-orange: kib-core-theme-get('warning', 'highlight') !default;

Description

Soft orange button color

Type

Color

Used by

yellow

$yellow: #f5a623 !default;

Description

Yellow button color

Type

Color

Used by

blue

$blue: kib-core-theme-get('link', 'deep') !default;

Description

Blue button color

Type

Color

Used by

blue-hover

$blue-hover: #0b528b !default;

Description

Blue button hover color

Type

Color

Used by

soft-blue

$soft-blue: #f3f9fe !default;

Description

Soft Blue button color

Type

Color

Used by

dark-blue

$dark-blue: kib-core-theme-get('link', 'deep') !default;

Description

Dark Blue button color

Type

Color

Used by

arrow-sizes

$arrow-sizes: (
  prev: (
    icon: kib-core-px-to-relative(10px),
    direction: left,
    image: kib-core-svg-base64-encode($kib-asset-icon-arrow-left-blue)
  ),
  next: (
    icon: kib-core-px-to-relative(10px),
    direction: right,
    image: kib-core-svg-base64-encode($kib-asset-icon-arrow-right-blue)
  )
) !default;

Description

Definitions of size variants for buttons.

Type

Map

Used by

group-margin

$group-margin: kib-core-px-to-relative(15px) !default;

Description

Margin for group button

Type

Number

Used by

card

mixins

container

@mixin container() { ... }

Description

Card container

Parameters

None.

Requires

Used by

container-large

@mixin container-large() { ... }

Description

Large card container

Parameters

None.

Used by

action

@mixin action() { ... }

Description

Action card variant

Parameters

None.

Requires

Used by

action-emphasis

@mixin action-emphasis() { ... }

Description

Action card emphasis styles

Parameters

None.

Requires

group

@mixin group() { ... }

Description

Card group wrapper

Parameters

None.

Requires

row

@mixin row() { ... }

Description

Card group row

Parameters

None.

Requires

row-emphasis

@mixin row-emphasis() { ... }

Description

Interactive card group row emphasis

Parameters

None.

Requires

row-large

@mixin row-large() { ... }

Description

Large card row

Parameters

None.

Requires

variables

icons

$icons: (
  arrow: kib-core.svg-base64-encode(kib-core.$kib-asset-icon-arrow-right-light)
) !default;

Description

Definitions of svg uri icons for card icons

Type

Map

Used by

action-padding-right

$action-padding-right: kib-core.dimensions-get(huge) + kib-core.dimensions-get(small) !default;

Description

Card action right padding

Type

Number

Used by

action-pseudo-right-position

$action-pseudo-right-position: kib-core.dimensions-get(default) !default;

Description

Card action pseudo element right position

Type

Number

Used by

action-pseudo-right-position-minmedium

$action-pseudo-right-position-minmedium: kib-core.dimensions-get(large) !default;

Description

Card action pseudo element right position for min-medium media query

Type

Number

Used by

action-pseudo-top-margin

$action-pseudo-top-margin: -1 * kib-core.dimensions-get(small) !default;

Description

Card action pseudo element top margin

Type

Number

Used by

action-pseudo-dimensions

$action-pseudo-dimensions: kib-core.dimensions-get(default) !default;

Description

Card action pseudo element dimensions

Type

Number

Used by

group-horizontal-margin

$group-horizontal-margin: -1 * kib-core.dimensions-get(default) !default;

Description

Card group horizontal margin

Type

Number

Used by

group-horizontal-margin-minmedium

$group-horizontal-margin-minmedium: -1 * kib-core.dimensions-get(large) !default;

Description

Card group horizontal margin for min-medium media query

Type

Number

Used by

group-pseudo-margin

$group-pseudo-margin: -1 * kib-core.dimensions-get(default) !default;

Description

Card group margin for pseudo elements

Type

Number

Used by

row-active-background-color

$row-active-background-color: kib-core.theme-get('background', 'container') !default;

Description

Card row active background color

Type

Color

Used by

row-border-width

$row-border-width: kib-core.$container-border-width !default;

Description

Card row border width

Type

Number

Used by

row-border-color

$row-border-color: kib-core.$kib-container-border-color !default;

Description

Card row border color

Type

Color

Used by

interaction-focus-border-color

$interaction-focus-border-color: kib-core.theme-get('outline', 'form') !default;

Description

Card interaction focus border color

Type

Color

Used by

interaction-focus-text-color

$interaction-focus-text-color: kib-core.theme-get('text') !default;

Description

Card interaction focus text color

Type

Color

Used by

interaction-row-focus-background-color

$interaction-row-focus-background-color: kib-core.theme-get('background', 'container') !default;

Description

Card interaction row focus background color

Type

Color

Used by

interaction-focus-blur-width

$interaction-focus-blur-width: kib-core.px-to-relative(1px) !default;

Description

Card interaction focus blur width

Type

Number

Used by

interaction-focus-shadow-color

$interaction-focus-shadow-color: kib-core.theme-get('outline', 'form') !default;

Description

Card interaction focus blur width

Type

Color

Used by

card-number

mixins

name

@mixin name() { ... }

Description

Card number name styles

Parameters

None.

Requires

label

@mixin label() { ... }

Description

Card number label styles

Parameters

None.

variables

font-weight

$font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Default card number font weight

Type

Number

core

functions

register

@function register($name) { ... }

Description

Register a bootstrapable component.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the component to register.

String none

Returns

Map

An updated map of resitered components.

Example

Register a component named "component".

$registry: bootstrap.register(component);

Requires

map-deep-get

@function map-deep-get($selectors) { ... }

Description

Get a specific theme data.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$selectors

Provide a single argument to grab a single section of the theme. Provide multiple selectors to navigate down the tree and get a definition deep within the theme.

String none

Returns

Any type —

Return the value of the $selector references.

Requires

Used by

get

@function get($selectors) { ... }

Description

Get a specific theme data.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$selectors

Provide a single argument to grab a single section of the theme. Provide multiple selectors to navigate down the tree and get a definition deep within the theme.

String none

Returns

Any type —

Return the value of the $selector references.

Requires

Used by

set

@function set($theme) { ... }

Description

Set a new theme data.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$theme

Provide a new theme map data that need to be set on $themes

Map none

Returns

Map

Return the value of the $selector references.

Requires

Used by

map-deep-set

@function map-deep-set($keys, $value) { ... }

Description

Override a theme variable already set.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$keys

Key chain

List none
$value

Value to assign

Any none

Returns

Map

Return the value of the $selector references.

Throws

  • Key #{$current-key} doesn

Requires

mixins

set

@mixin set($_registry: settings.$registry) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$_registry

A list of components to process bootstrap functions for.

Listsettings.$registry

variables

[private] registry

$registry: ();

Description

Define the components to bootstrap.

This should not be accessed directly and should instead be added to with the bootstrap-register() function.

Type

List

Used by

breakpoints

$breakpoints: (
  "small": $kib-core-breakpoints-small,
  "medium": $kib-core-breakpoints-medium,
  "large": $kib-core-breakpoints-large,
  "huge": $kib-core-breakpoints-huge,
  "giant": $kib-core-breakpoints-giant
) !default;

Description

Define supported screen sizes.

These values will be converted to rem units and fed to the Include Media library. They are in pixels since it is a tad easier to think in pixels.

Type

Map

Map structure

map key Namemap key Descriptionmap key Typemap key Value
small noneNumber(px)320px
medium noneNumber(px)640px
large noneNumber(px)980px
huge noneNumber(px)1200px
giant noneNumber(px)1400px

Used by

Links

themes

$themes: (
  core: (
    link: (
      base: $kib-blue,
      deep: $kib-blue-dark,
      deepest: $kib-blue-darkest,
      primary: $kib-dark-theme-dark-blue,
      secondary: $kib-dark-theme-secondary-blue,
      mid: $kib-dark-theme-mid-blue,
      soft: $kib-dark-theme-soft-blue,
      messageBackground: $kib-core-message-background-color
    ),
    success: (
      base: $kib-green,
      messageBackground: $kib-core-message-success-background-color
    ),
    error: (
      base: $kib-red,
      deep: $kib-red-dark,
      messageBackground: $kib-core-message-error-background-color
    ),
    warning: (
      base: $kib-orange,
      surface: $kib-orange-light,
      highlight: $kib-orange-highlight,
      messageBackground: $kib-core-message-warning-background-color
    ),
    notice: (
      base: $kib-yellow,
      surface: $kib-yellow-bright
    ),
    dignify: (
      base: $kib-teal
    ),
    royal: (
      base: $kib-purple
    ),
    slate: (
      base: $kib-black
    ),
    fair: (
      base: $kib-white
    ),
    ash: (
      surface: $kib-gray-light
    ),
    text: (
      base: $kib-text-body,
      secondary: $kib-text-secondary,
      surface: $kib-text-light
    ),
    background: (
      base: $kib-background-page,
      container: $kib-background-container,
      header: $kib-background-header
    ),
    outline: (
      base: $kib-outline-container,
      form: $kib-outline-form
    ),
    font: (
      base: (
        family: $kib-core-font-base,
        size: $kib-core-root-font-size
      ),
      monospace: (
        family: $kib-core-font-monospace
      )
    ),
    next: (
      font: (
        family: (
          base: $kib-core-font-next-sans-body,
          monospace: $kib-core-font-next-monospace,
          sans: $kib-core-font-next-sans,
          sans-body: $kib-core-font-next-sans-body,
          serif: $kib-core-font-next-serif
        ),
        size: $kib-core-root-font-size,
        /// @deprecated Kept to avoid breaking change
        base:
          (
            family: $kib-core-font-next-sans,
            size: $kib-core-root-font-size
          )
      ),
      brand: (
        base: $kib-blue-1-next-500,
        low: $kib-blue-1-next-50,
        high: $kib-blue-1-next-800,
        50: $kib-blue-1-next-50,
        100: $kib-blue-1-next-100,
        200: $kib-blue-1-next-200,
        300: $kib-blue-1-next-300,
        400: $kib-blue-1-next-400,
        500: $kib-blue-1-next-500,
        600: $kib-blue-1-next-600,
        700: $kib-blue-1-next-700,
        800: $kib-blue-1-next-800,
        900: $kib-blue-1-next-900
      ),
      alternate: (
        base: $kib-blue-2-next-500,
        low: $kib-blue-2-next-50,
        high: $kib-blue-2-next-900,
        50: $kib-blue-2-next-50,
        100: $kib-blue-2-next-100,
        200: $kib-blue-2-next-200,
        300: $kib-blue-2-next-300,
        400: $kib-blue-2-next-400,
        500: $kib-blue-2-next-500,
        600: $kib-blue-2-next-600,
        700: $kib-blue-2-next-700,
        800: $kib-blue-2-next-800,
        900: $kib-blue-2-next-900
      ),
      neutral: (
        base: $kib-neutral-next-500,
        minimal: $kib-neutral-next-100,
        low: $kib-neutral-next-200,
        high: $kib-neutral-next-600,
        highest: $kib-neutral-next-800,
        50: $kib-neutral-next-50,
        100: $kib-neutral-next-100,
        200: $kib-neutral-next-200,
        300: $kib-neutral-next-300,
        400: $kib-neutral-next-400,
        500: $kib-neutral-next-500,
        600: $kib-neutral-next-600,
        700: $kib-neutral-next-700,
        800: $kib-neutral-next-800,
        900: $kib-neutral-next-900
      ),
      accent: (
        base: $kib-green-1-next-100,
        low: $kib-green-1-next-50,
        high: $kib-green-1-next-700,
        50: $kib-green-1-next-50,
        100: $kib-green-1-next-100,
        200: $kib-green-1-next-200,
        300: $kib-green-1-next-300,
        400: $kib-green-1-next-400,
        500: $kib-green-1-next-500,
        600: $kib-green-1-next-600,
        700: $kib-green-1-next-700,
        800: $kib-green-1-next-800,
        900: $kib-green-1-next-900
      ),
      caution: (
        base: $kib-yellow-next-400,
        low: $kib-yellow-next-50,
        high: $kib-yellow-next-800,
        50: $kib-yellow-next-50,
        100: $kib-yellow-next-100,
        200: $kib-yellow-next-200,
        300: $kib-yellow-next-300,
        400: $kib-yellow-next-400,
        500: $kib-yellow-next-500,
        600: $kib-yellow-next-600,
        700: $kib-yellow-next-700,
        800: $kib-yellow-next-800,
        900: $kib-yellow-next-900
      ),
      danger: (
        base: $kib-red-2-next-700,
        low: $kib-red-2-next-50,
        high: $kib-red-2-next-900,
        50: $kib-red-2-next-50,
        100: $kib-red-2-next-100,
        200: $kib-red-2-next-200,
        300: $kib-red-2-next-300,
        400: $kib-red-2-next-400,
        500: $kib-red-2-next-500,
        600: $kib-red-2-next-600,
        700: $kib-red-2-next-700,
        800: $kib-red-2-next-800,
        900: $kib-red-2-next-900
      ),
      success: (
        base: $kib-green-2-next-800,
        low: $kib-green-2-next-50,
        high: $kib-green-2-next-900,
        50: $kib-green-2-next-50,
        100: $kib-green-2-next-100,
        200: $kib-green-2-next-200,
        300: $kib-green-2-next-300,
        400: $kib-green-2-next-400,
        500: $kib-green-2-next-500,
        600: $kib-green-2-next-600,
        700: $kib-green-2-next-700,
        800: $kib-green-2-next-800,
        900: $kib-green-2-next-900
      ),
      rating: (
        base: $kib-orange-1-next-500,
        low: $kib-orange-1-next-50,
        high: $kib-orange-1-next-900,
        50: $kib-orange-1-next-50,
        100: $kib-orange-1-next-100,
        200: $kib-orange-1-next-200,
        300: $kib-orange-1-next-300,
        400: $kib-orange-1-next-400,
        500: $kib-orange-1-next-500,
        600: $kib-orange-1-next-600,
        700: $kib-orange-1-next-700,
        800: $kib-orange-1-next-800,
        900: $kib-orange-1-next-900
      ),
      transactional: (
        base: $kib-orange-2-next-400,
        low: $kib-orange-2-next-50,
        high: $kib-orange-2-next-800,
        50: $kib-orange-2-next-50,
        100: $kib-orange-2-next-100,
        200: $kib-orange-2-next-200,
        300: $kib-orange-2-next-300,
        400: $kib-orange-2-next-400,
        500: $kib-orange-2-next-500,
        600: $kib-orange-2-next-600,
        700: $kib-orange-2-next-700,
        800: $kib-orange-2-next-800,
        900: $kib-orange-2-next-900
      )
    )
  )
) !default;

Description

Multiple theme definitions.

Type

Map

Used by

theme

$theme: core !default;

Description

Default theme definition.

Type

String

Used by

datepicker

Installation

  yarn add @chewy/kib-datepicker-styles

Import

  @use '~@chewy/kib-datepicker-styles/src/styles' as kib-datepicker;

mixins

input-readonly

@mixin input-readonly() { ... }

Description

Override input used to render the datepicker and remove readonly styling if rendered on mobile.

Parameters

None.

input-field-icon

@mixin input-field-icon() { ... }

Description

Override input icon wrapper to allow clicks

Parameters

None.

TODO's

  • Find a different way of doing this.

input-adornment-new

@mixin input-adornment-new() { ... }

Description

MUI adornment added to input

Parameters

None.

button-new

@mixin button-new() { ... }

Description

Default button styles

Parameters

None.

input-adornment

@mixin input-adornment() { ... }

Description

MUI adornment added to input deprecrate when field new is supported

Parameters

None.

Requires

button

@mixin button() { ... }

Description

Default button styles deprecate when field new is supported

Parameters

None.

button-action-expanded

@mixin button-action-expanded() { ... }

Description

KibField action button expanded styles

Parameters

None.

Requires

button-action-disabled

@mixin button-action-disabled() { ... }

Description

KibField action button disabled styles

Parameters

None.

input-adornment-icon

@mixin input-adornment-icon() { ... }

Description

MUI adornment icon

Parameters

None.

Requires

input-adornment-icon-expanded

@mixin input-adornment-icon-expanded() { ... }

Description

MUI adornment icon expanded

Parameters

None.

Requires

input-adornment-icon-disabled

@mixin input-adornment-icon-disabled() { ... }

Description

MUI adornment icon when disabled

Parameters

None.

Requires

input-hidden-text

@mixin input-hidden-text() { ... }

Description

Hidden a11y text on input label

Parameters

None.

icon

@mixin icon() { ... }

Description

Icons in calendar component

Parameters

None.

Requires

Used by

icon-disabled

@mixin icon-disabled() { ... }

Description

Disabled icon

Parameters

None.

Requires

button-focus

@mixin button-focus() { ... }

Description

Focus styles for any MUI button inside component

Parameters

None.

Requires

button-action-focus

@mixin button-action-focus() { ... }

Description

Focus styles for any MUI button inside of component with action enabled

Parameters

None.

Requires

wrapper

@mixin wrapper() { ... }

Description

Wrapper around calendar (MuiPaper)

Parameters

None.

Requires

picker-calendar-container

@mixin picker-calendar-container() { ... }

Description

Calendar container

Parameters

None.

Requires

picker-controls-bar

@mixin picker-controls-bar() { ... }

Description

Controls section above calendar

Parameters

None.

Requires

picker-month-name

@mixin picker-month-name() { ... }

Description

Styles for month names at the top of calendar

Parameters

None.

Requires

picker-selected-month-year

@mixin picker-selected-month-year() { ... }

Description

Current month/year text

Parameters

None.

picker-choice

@mixin picker-choice() { ... }

Description

Base styles for all picker choices (day, month or year)

Parameters

None.

picker-choice-default

@mixin picker-choice-default() { ... }

Description

Styles for default state of all picker choices

Parameters

None.

Requires

picker-choice-hover

@mixin picker-choice-hover() { ... }

Description

Hovered choice

Parameters

None.

Requires

picker-choice-focus

@mixin picker-choice-focus() { ... }

Description

Focused choice

Parameters

None.

Requires

picker-choice-selected

@mixin picker-choice-selected() { ... }

Description

Selected choice

Parameters

None.

Requires

picker-choice-disabled

@mixin picker-choice-disabled() { ... }

Description

Disabled choice

Parameters

None.

Requires

picker-choice-today

@mixin picker-choice-today() { ... }

Description

Today choice

Parameters

None.

Requires

picker-toolbar

@mixin picker-toolbar() { ... }

Description

Toolbar

Parameters

None.

Requires

picker-toolbar-title

@mixin picker-toolbar-title() { ... }

Description

Toolbar title

Parameters

None.

Requires

picker-toolbar-selected-date

@mixin picker-toolbar-selected-date() { ... }

Description

Current selected date

Parameters

None.

Requires

picker-toolbar-switch-button

@mixin picker-toolbar-switch-button() { ... }

Description

Toolbar switch view button

Parameters

None.

Requires

picker-dialog-content

@mixin picker-dialog-content() { ... }

Description

Mobile dialog content container

Parameters

None.

Requires

picker-dialog-content-input

@mixin picker-dialog-content-input() { ... }

Description

Styles for input when inside mobile dialog

Parameters

None.

Requires

picker-dialog-action-button

@mixin picker-dialog-action-button() { ... }

Description

Mobile dialog action button

Parameters

None.

css

// deprecate when fields new is suppored @mixin button-action

// deprecate when fields new is suppored
@mixin button-action { ... }

Description

KibField action button styles

variables

icon-size

$icon-size: kib-core.dimensions-get('large') !default;

Description

Size for icons inside calendar widget

Type

Number

Used by

icon-color

$icon-color: color.get('link', 'active', 'primary') !default;

Description

Color for icons inside calendar widget

Type

Color

Used by

icon-disabled-opacity

$icon-disabled-opacity: kib-button-new.$disabled-opacity !default;

Description

Disabled opacity for icons inside calendar widget

Type

Color

Used by

adornment-icon-color

$adornment-icon-color: color.get('text', 'primary') !default;

Description

Color for adornment icon placed on text input

Type

Color

Used by

adornment-icon-disabled-opacity

$adornment-icon-disabled-opacity: $icon-disabled-opacity !default;

Description

Disabled opacity for adornment icon placed on text input

Type

Number

Used by

button-focus-bg-color

$button-focus-bg-color: color.get('action', 'utility', 'alternate', '03') !default;

Description

Focus background color for all MUI buttons in the component

Type

Color

Used by

wrapper-radius

$wrapper-radius: border.get('br02') !default;

Description

Border radius for Popper/Dialog wrapper around picker

Type

Number

Used by

picker-month-name-color

$picker-month-name-color: color.get('text', 'primary') !default;

Description

Color for month names at the top row of calendar

Type

Color

Used by

picker-choice-text-color

$picker-choice-text-color: color.get('link', 'active', 'primary') !default;

Description

Choice default text color

Type

Color

Used by

picker-choice-hover-bg-color

$picker-choice-hover-bg-color: color.get('action', 'cta', 'alternate', '03') !default;

Description

Choice hover background color

Type

Color

Used by

picker-choice-focus-outline-width

$picker-choice-focus-outline-width: unit.rem(2px) !default;

Description

Choice focus outline width

Type

Number

Used by

picker-choice-focus-outline-color

$picker-choice-focus-outline-color: color.get('action', 'cta', 'primary', 'primary') !default;

Description

Choice focus outline color

Type

Color

Used by

picker-choice-selected-bg-color

$picker-choice-selected-bg-color: color.get('action', 'cta', 'alternate', '02') !default;

Description

Selected choice background color

Type

Color

Used by

picker-choice-disabled-color

$picker-choice-disabled-color: color.get('link', 'active', 'secondary') !default;

Description

Disabled choice text color

Type

Color

Used by

picker-choice-disabled-line-color

$picker-choice-disabled-line-color: color.get('ui-bg', '05') !default;

Description

Disabled line color across choice

Type

Color

Used by

picker-choice-today-dot-color

$picker-choice-today-dot-color: color.get('link', 'active', 'primary') !default;

Description

Color for dot on choice representing current day

Type

Color

Used by

picker-choice-today-dot-size

$picker-choice-today-dot-size: kib-core.dimensions-get('tiny') !default;

Description

Size of dot on choice representing current day

Type

Number

Used by

picker-toolbar-border-color

$picker-toolbar-border-color: color.get('ui-bg', '04') !default;

Description

Border color below toolbar on mobile dialog

Type

Color

picker-toolbar-border-width

$picker-toolbar-border-width: unit.rem(1px) !default;

Description

Border width below toolbar on mobile dialog

Type

Color

picker-open-action-icon-focus-color

$picker-open-action-icon-focus-color: color.get('field', '04') !default;

Description

Color for action icon when picker is open or focus

Type

Color

Used by

picker-open-action-icon-bg-color

$picker-open-action-icon-bg-color: color.get('field', '03') !default;

Description

Color for icon background when picker is open

Type

Color

Used by

dialog

variables

[private] _dialog-registry

$_dialog-registry: bootstrap.register(dialog);

Description

Add storage elements before use.

Type

String

[private] _dialog-zindex-registry

$_dialog-zindex-registry: dialog-zindex-set-bootstrap();

Description

Register dialog z-index

Type

Boolean

backdrop-background

$backdrop-background: rgba(kib-core-theme-get('slate'), 0.6) !default;

Description

Dialog backdrop background color (overlay)

Type

Color

Used by

z-index

$z-index: kib-core-zindex-get(dialog) !default;

Description

Dialog stacking z-index

Type

Color

Used by

inner-max-width

$inner-max-width: calc(80ch + #{kib-core-dimensions-get(default)}) !default;

Description

Dialog inner max-width

Type

Color

Used by

container-background

$container-background: map.get(kib-scroll.theme-get('neutral'), background) !default;

Description

Dialog container background color

Type

Color

Used by

container-background-chirp

$container-background-chirp: kib-core-theme-get('fair') !default;

Description

Dialog container background color chirp

Type

Color

Used by

container-border-color

$container-border-color: kib-core-theme-get('outline') !default;

Description

Dialog container border color

Type

Color

Used by

container-border-radius

$container-border-radius: kib-core-dimensions-get(tiny) !default;

Description

Dialog container border radius

Type

Number

Used by

container-border-radius-chirp

$container-border-radius-chirp: kib-core-dimensions-get(small) !default;

Description

Dialog container border radius chirp

Type

Number

Used by

container-min-width

$container-min-width: kib-core-px-to-relative(320px) - kib-core-dimensions-get(small) * 2 !default;

Description

Dialog container min width

Type

Number

Used by

container-border-width

$container-border-width: kib-core-px-to-relative(1px) !default;

Description

Dialog container border width

Type

Number

Used by

title-border-width

$title-border-width: kib-core-px-to-relative(2px) !default;

Description

Dialog title border width

Type

Number

Used by

title-padding-right

$title-padding-right: (kib-core-dimensions-get(huge) + kib-core-dimensions-get(large)) !default;

Description

Dialog title padding right

Type

Number

Used by

title-border-color

$title-border-color: $container-border-color !default;

Description

Dialog title border color

Type

Color

Used by

title-color

$title-color: kib-core-theme-get('text') !default;

Description

Dialog title text color

Type

Color

Used by

title-font-size

$title-font-size: kib-core-get-type-property(large, size) !default;

Description

Dialog title font size

Type

Number

Used by

title-font-weight

$title-font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Dialog title font weight

Type

Number

Used by

title-line-height

$title-line-height: kib-core-type-line-height(large) !default;

Description

Dialog title line-height

Type

Number

Used by

summary-color

$summary-color: kib-core-theme-get('ash', 'surface') !default;

Description

Dialog summary text color

Type

Color

Used by

summary-font-size

$summary-font-size: kib-core-get-type-property(tiny, size) !default;

Description

Dialog summary font size.

Type

String

Used by

summary-line-height

$summary-line-height: kib-core-type-line-height(tiny) !default;

Description

Dialog summary line height

Type

String

Used by

content-color

$content-color: kib-core-theme-get('text') !default;

Description

Dialog content text color

Type

Color

Used by

content-font-size

$content-font-size: kib-core-get-type-property(base, size) !default;

Description

Dialog content font size

Type

Number

Used by

content-line-height

$content-line-height: kib-core-type-line-height(base) !default;

Description

Dialog content line-height

Type

Number

Used by

close-text-color

$close-text-color: kib-core-theme-get('text') !default;

Description

Set the color of the close button.

Type

Color

Used by

close-text-color-chirp

$close-text-color-chirp: kib-core-theme-get('next', 'neutral', 900) !default;

Description

Set the color of the close button chirp styles.

Type

Color

Used by

close-background

$close-background: kib-core-theme-get('fair') !default;

Description

Set the background color of the close button.

Type

Color

Used by

close-border-width

$close-border-width: kib-core-px-to-relative(1px) !default;

Description

Set the size of the close button border on focus.

Type

Color

Used by

close-border-color

$close-border-color: transparent !default;

Description

Set the size of the close button border on focus.

Type

Color

Used by

close-emphasis-color

$close-emphasis-color: kib-core-theme-get('link', 'deep') !default;

Description

Set the color of the close button on hover/focus.

Type

Color

Used by

close-background-focus-chirp

$close-background-focus-chirp: kib-core-theme-get('next', 'brand', 600) !default;

Description

Default variant background color on close button focus

Type

Color

Used by

close-size

$close-size: kib-core-dimensions-get(large) + kib-core-dimensions-get(small) !default;

Description

Calculated minimum size for the close button.

Type

Number

Used by

backdrop-filter

$backdrop-filter: blur(kib-core-px-to-relative(2px)) !default;

Description

Dialog backdrop filter value

Type

Color

Used by

backdrop-z-index

$backdrop-z-index: kib-core-zindex-get(dialog-backdrop) !default;

Description

Dialog backdrop stacking z-index value

Type

Color

Used by

controls-divider-border-width

$controls-divider-border-width: kib-core-px-to-relative(1px) !default;

Description

Dialog controls divider border width

Type

Number

Used by

controls-divider-border-color

$controls-divider-border-color: $container-border-color !default;

Description

Dialog controls divider border color

Type

Number

Used by

fullscreen-close-color

$fullscreen-close-color: kib-core-theme-get('link', 'deep') !default;

Description

Set the color of the close button on mobile variant.

Type

Color

Used by

functions

[private] dialog-zindex-set-bootstrap

@function dialog-zindex-set-bootstrap() { ... }

Description

Store the z-index values for dialog

Parameters

None.

Returns

Boolean

Requires

mixins

wrapper

@mixin wrapper() { ... }

Description

Dialog wrapper

Parameters

None.

Requires

inner

@mixin inner() { ... }

Description

Dialog inner focusable wrapper

Parameters

None.

Requires

container

@mixin container() { ... }

Description

Dialog container element

Parameters

None.

Requires

container-chirp

@mixin container-chirp() { ... }

Description

Dialog container element with Chirp styles

Parameters

None.

Requires

scroll

@mixin scroll() { ... }

Description

Dialog scrolling container for overflow content

Parameters

None.

title

@mixin title() { ... }

Description

Dialog title heading element

Parameters

None.

Requires

title-chirp

@mixin title-chirp() { ... }

Description

Dialog title with chirp styling

Parameters

None.

Requires

content

@mixin content() { ... }

Description

Dialog content wrapper element

Parameters

None.

Requires

body

@mixin body() { ... }

Description

Dialog content body container

Parameters

None.

body-chirp

@mixin body-chirp() { ... }

Description

Dialog content body with chirp styles

Parameters

None.

summary

@mixin summary() { ... }

Description

Dialog summary wrapper

Parameters

None.

Requires

controls

@mixin controls() { ... }

Description

Dialog controls wrapper

Parameters

None.

Requires

controls-chirp

@mixin controls-chirp() { ... }

Description

Dialog controls with chirp styles

Parameters

None.

close-button

@mixin close-button() { ... }

Description

Dialog default close button

Parameters

None.

Requires

close-button-classic

@mixin close-button-classic() { ... }

Description

Dialog default close button classic theme

Parameters

None.

Requires

close-button-chirp

@mixin close-button-chirp() { ... }

Description

Dialog default close button chirp theme

Parameters

None.

Requires

close-icon

@mixin close-icon() { ... }

Description

Dialog close icon svg

Parameters

None.

close-label

@mixin close-label() { ... }

Description

Dialog close text label.

Parameters

None.

backdrop

@mixin backdrop() { ... }

Description

Dialog backdrop.

Parameters

None.

Requires

backdrop-transition

@mixin backdrop-transition() { ... }

Description

Dialog backdrop fade transition

Parameters

None.

TODO's

  • Remove once there is a React transition component

dialog-transition

@mixin dialog-transition() { ... }

Description

Dialog scale transition on open/close

Parameters

None.

TODO's

  • Remove once there is a React transition component

dialog-slide-transition

@mixin dialog-slide-transition() { ... }

Description

Fullscreen dialog slide transition on open/close

Parameters

None.

TODO's

  • Remove once there is a React transition component

inner--full

@mixin inner--full() { ... }

Description

Full size dialog inner wrapper

Parameters

None.

wrapper--fullscreen

@mixin wrapper--fullscreen() { ... }

Description

Fullscreen dialog wrapper

Parameters

None.

inner--fullscreen

@mixin inner--fullscreen() { ... }

Description

Fullscreen dialog inner focusable wrapper

Parameters

None.

container--fullscreen

@mixin container--fullscreen() { ... }

Description

Fullscreen dialog container element

Parameters

None.

title--fullscreen

@mixin title--fullscreen() { ... }

Description

Fullscreen dialog title heading element

Parameters

None.

content--fullscreen

@mixin content--fullscreen() { ... }

Description

Fullscreen dialog content wrapper element

Parameters

None.

body--fullscreen

@mixin body--fullscreen() { ... }

Description

Fullscreen dialog content body container

Parameters

None.

triggers--fullscreen

@mixin triggers--fullscreen() { ... }

Description

Fullscreen dialog triggers wrapper

Parameters

None.

Requires

close-button--fullscreen

@mixin close-button--fullscreen() { ... }

Description

Fullscreen dialog close button

Parameters

None.

Requires

close-icon--fullscreen

@mixin close-icon--fullscreen() { ... }

Description

Fullscreen dialog close icon svg

Parameters

None.

drawer

variables

[private] _drawer-registry

$_drawer-registry: bootstrap.register(drawer);

Description

Add storage elements before use.

Type

String

[private] _drawer-zindex-registry

$_drawer-zindex-registry: drawer-zindex-set-bootstrap();

Description

Register drawer z-index

Type

Boolean

background-color

$background-color: kib-core-theme-get('fair') !default;

Description

Drawer background color

Type

Color

Used by

text-color

$text-color: kib-core-theme-get('text') !default;

Description

Drawer text color

Type

Color

Used by

common-background-focus-chirp

$common-background-focus-chirp: kib-core-theme-get('next', 'brand', 600) !default;

Description

Default variant background color on close button focus

Type

Color

control-icon-color

$control-icon-color: inherit !default;

Description

Drawer control button icon color

Type

Color

control-icon-color-emphasis

$control-icon-color-emphasis: kib-core-theme-get('link', 'deep') !default;

Description

Drawer control button icon color on hover/focus

Type

Color

control-icon-back-size

$control-icon-back-size: kib-core-px-to-relative(36px) !default;

Description

Drawer control back button icon size

Type

Number

Used by

control-icon-close-size

$control-icon-close-size: kib-core-dimensions-get(default) !default;

Description

Drawer control close button icon size

Type

Number

Used by

default-max-width

$default-max-width: kib-core-px-to-relative(400px) !default;

Description

Drawer default maximum size

Type

Number

Used by

z-index

$z-index: kib-core-zindex-get(drawer) !default;

Description

Drawer stacking z-index

Type

Number

header-border-width

$header-border-width: kib-core-px-to-relative(1px) !default;

Description

Drawer header divider border width

Type

Number

Used by

header-border-color

$header-border-color: kib-core-theme-get('outline') !default;

Description

Drawer header divider border color

Type

Color

Used by

backdrop-background-color

$backdrop-background-color: rgba(kib-core-theme-get('slate'), 0.5) !default;

Description

Drawer backdrop background color

Type

Color

Used by

backdrop-z-index

$backdrop-z-index: kib-core-zindex-get(drawer-backdrop) !default;

Description

Drawer backdrop stacking z-index value

Type

Number

sizes

$sizes: (
  small: kib-core-px-to-relative(280px),
  large: kib-core-px-to-relative(600px),
  largest: kib-core-px-to-relative(1200px)
) !default;

Description

Drawer width size modifiers

Type

List

Used by

functions

[private] drawer-zindex-set-bootstrap

@function drawer-zindex-set-bootstrap() { ... }

Description

Store the z-index values for drawer

Parameters

None.

Returns

Boolean

Requires

mixins

panel

@mixin panel() { ... }

Description

Drawer panel base styles

Parameters

None.

Requires

panel-size

@mixin panel-size($max-width) { ... }

Description

Drawer panel size variant styles

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$max-width

panel's maximum allowed width

Number none

panel-from-right

@mixin panel-from-right() { ... }

Description

Panel variant when positioned on the right

Parameters

None.

panel-from-left

@mixin panel-from-left() { ... }

Description

Panel variant when positioned on the left

Parameters

None.

content-wrapper

@mixin content-wrapper() { ... }

Description

Drawer content wrapper styles

Parameters

None.

header

@mixin header() { ... }

Description

Drawer header container styles

Parameters

None.

Requires

title

@mixin title() { ... }

Description

Drawer's title heading styles

Parameters

None.

Requires

body

@mixin body() { ... }

Description

Drawer content body container

Parameters

None.

steps-wrapper

@mixin steps-wrapper() { ... }

Description

Drawer steps wrapper styles

Parameters

None.

control-common

@mixin control-common() { ... }

Description

Drawer control buttons common styles

Parameters

None.

control-back

@mixin control-back() { ... }

Description

Drawer back button styles

Parameters

None.

control-close

@mixin control-close() { ... }

Description

Drawer close button styles

Parameters

None.

control-icon-common

@mixin control-icon-common() { ... }

Description

Drawer control icon common styles

Parameters

None.

control-icon-back

@mixin control-icon-back() { ... }

Description

Drawer back button icon styles

Parameters

None.

Requires

control-icon-close

@mixin control-icon-close() { ... }

Description

Drawer close control icon

Parameters

None.

Requires

backdrop

@mixin backdrop() { ... }

Description

Drawer backdrop overlay

Parameters

None.

Requires

step

@mixin step() { ... }

Description

Drawer step container

Parameters

None.

step-vue-transition-common

@mixin step-vue-transition-common() { ... }

Description

Styles for custom Vueclasses for forward/back step animation

Parameters

None.

step-vue-transition-forward

@mixin step-vue-transition-forward() { ... }

Description

Vue transition styles for forward step animation

Parameters

None.

step-vue-transition-backward

@mixin step-vue-transition-backward() { ... }

Description

Vue transition styles for backward step animation

Parameters

None.

step-react-transitions

@mixin step-react-transitions() { ... }

Description

Custom classes for React component open/close animation

Parameters

None.

TODO's

  • Remove once there is a React transition component

field-group

variables

field-group-legend-typography

$field-group-legend-typography: 'form-grouping' !default;

Description

Field Group Legend typography token name

Type

String

Used by

field-group-legend-padding

$field-group-legend-padding: spacing.get('s3') !default;

Description

Field Group Legend padding

Type

Number

field-group-legend-transition-duration

$field-group-legend-transition-duration: 0.2s !default;

Description

Field Group transitions duration

Type

Number

icon-size

$icon-size: $field-group-line-height;

Description

Field Group icon size

Type

Number

help-text-color

$help-text-color: color.get('text', 'secondary') !default;

Description

Field Group Help text color

Type

Color

Used by

error-text-color

$error-text-color: color.get('text', 'error') !default;

Description

Text color in error state

Type

Color

Used by

error-message-token-size

$error-message-token-size: 'form-error' !default;

Description

Field Group error typography token size

Type

String

Used by

field-new

mixins

root-container

@mixin root-container() { ... }

Description

Root container

Parameters

None.

Requires

root-container-disabled

@mixin root-container-disabled() { ... }

Description

Root container when control is disabled

Parameters

None.

label

@mixin label() { ... }

Description

Field label

Parameters

None.

Requires

label-disabled

@mixin label-disabled() { ... }

Description

Disabled field label

Parameters

None.

label-hidden

@mixin label-hidden() { ... }

Description

Hidden label

Parameters

None.

field

@mixin field() { ... }

Description

Wrapper around control and icon

Parameters

None.

Requires

control

@mixin control() { ... }

Description

Field control

Parameters

None.

Requires

control-on-hover

@mixin control-on-hover() { ... }

Description

Control when hovered

Parameters

None.

Requires

control-on-focus

@mixin control-on-focus() { ... }

Description

Control when focused

Parameters

None.

Requires

control-on-invalid

@mixin control-on-invalid() { ... }

Description

Invalid control

Parameters

None.

Requires

control-disabled

@mixin control-disabled() { ... }

Description

Disabled control

Parameters

None.

control-read-only

@mixin control-read-only() { ... }

Description

Read only control

Parameters

None.

Requires

control-placeholder

@mixin control-placeholder() { ... }

Description

Control's placeholder text

Parameters

None.

Requires

control-autofill

@mixin control-autofill() { ... }

Description

Control's autofill state

Parameters

None.

Requires

clear-control-with-icon

@mixin clear-control-with-icon() { ... }

Description

Control styles when it contains an icon

Parameters

None.

Requires

help

@mixin help() { ... }

Description

Helper text

Parameters

None.

Requires

help-bottom

@mixin help-bottom() { ... }

Description

Helper text when on bottom position

Parameters

None.

clear-icon

@mixin clear-icon() { ... }

Description

Clear icon

Parameters

None.

Requires

clear-control-hidden

@mixin clear-control-hidden() { ... }

Description

Hidden clear control

Parameters

None.

icon

@mixin icon() { ... }

Description

Field icon

Parameters

None.

Requires

icon-on-focus

@mixin icon-on-focus() { ... }

Description

Field icon when control is focused

Parameters

None.

Requires

icon-with-action

@mixin icon-with-action() { ... }

Description

Field icon with action behavior

Parameters

None.

Requires

Used by

icon-with-action-on-focus

@mixin icon-with-action-on-focus() { ... }

Description

Field icon with action behavior is focused

Parameters

None.

Requires

loading-spinner

@mixin loading-spinner() { ... }

Description

Generates the styles for the loading spinner

Parameters

None.

Requires

action-wrapper

@mixin action-wrapper() { ... }

Description

styles applied to action wrapper

Parameters

None.

Requires

action

@mixin action() { ... }

Description

styles for the content within action

Parameters

None.

Requires

error

@mixin error() { ... }

Description

Error wrapper

Parameters

None.

error-message

@mixin error-message() { ... }

Description

Error message

Parameters

None.

Requires

error-icon

@mixin error-icon() { ... }

Description

Error icon

Parameters

None.

Requires

variables

control-background-color

$control-background-color: color.get('field', 'primary') !default;

Description

Control background color

Type

Color

Used by

control-background-color-read-only

$control-background-color-read-only: color.get('field', '02') !default;

Description

Control background readonly color

Type

Color

Used by

control-background-color-autofill

$control-background-color-autofill: color.get('field', '03');

Description

Control field autofill text color

Type

Color

Used by

control-text-color

$control-text-color: color.get('text', 'primary') !default;

Description

Control text color

Type

Color

Used by

control-border-color

$control-border-color: color.get('field', '07') !default;

Description

Control border color

Type

Color

Used by

control-border-color-focus

$control-border-color-focus: color.get('field', '04') !default;

Description

Control border color on focus

Type

Color

Used by

control-border-color-error

$control-border-color-error: color.get('field', '06') !default;

Description

Control border color when invalid

Type

Color

Used by

control-border-radius

$control-border-radius: border.get('br02') !default;

Description

Control border radius

Type

Number

Used by

control-border-width

$control-border-width: unit.rem(1px) !default;

Description

Control border default width

Type

Number

Used by

control-border-width-large

$control-border-width-large: unit.rem(2px) !default;

Description

Control border large width

Type

Number

Used by

control-outline-color

$control-outline-color: color.get('field', '08') !default;

Description

Control outline color

Type

Color

Used by

control-outline-width

$control-outline-width: unit.rem(6px) !default;

Description

Control outline width

Type

Number

Used by

control-transition-duration

$control-transition-duration: 0.2s !default;

Description

Control transitions duration

Type

Number

Used by

control-padding

$control-padding: spacing.get('s3') !default;

Description

Control padding

Type

Number

Used by

field-control-typography

$field-control-typography: 'form-text' !default;

Description

Form text typography token name

Type

String

Used by

label-text-color

$label-text-color: color.get('text', 'fields') !default;

Description

Label text color

Type

Color

Used by

help-text-color

$help-text-color: color.get('text', 'secondary') !default;

Description

Label text color

Type

Color

clear-control-size

$clear-control-size: unit.rem(14px) !default;

Description

Cleara control size

Type

Number

clear-control-background-color

$clear-control-background-color: color.get('text', 'tertiary') !default;

Description

Clear control background color

Type

Color

clear-control-hover-color

$clear-control-hover-color: color.get('action', 'utility', 'primary', '03') !default;

Description

Clear control hover color

Type

Color

clear-icon-size

$clear-icon-size: unit.rem(12px) !default;

Description

Clear icon size

Type

Number

Used by

icon-size

$icon-size: $input-field-line-height;

Description

icon size

Type

Number

action-height

$action-height: calc($input-field-line-height + spacing.get('s3') * 2) !default;

Description

Action size

Type

Number

Used by

clear-icon-offset

$clear-icon-offset: calc(#{$control-padding} + #{spacing.get('s2')}) !default;

Description

Clear icon position offset

Type

Number

Used by

clear-icon-color

$clear-icon-color: color.get('field', 'primary') !default;

Description

Clear icon color

Type

Color

Used by

icon-with-action-color

$icon-with-action-color: color.get('text', 'primary') !default;

Description

Icon with action color

Type

Color

Used by

icon-with-action-focus-color

$icon-with-action-focus-color: color.get('field', '04') !default;

Description

Icon with action focus color

Type

Color

Used by

placeholder-text-color

$placeholder-text-color: color.get('text', 'tertiary') !default;

Description

Placeholder text color

Type

Color

Used by

control-with-icon-padding

$control-with-icon-padding: calc(
  #{$icon-size} + #{$clear-icon-offset} + #{spacing.get('s2')}
) !default;

Description

Control with icon padding

Type

Number

control-error-text-color

$control-error-text-color: color.get('text', 'error') !default;

Description

Control text color in error state

Type

Color

Used by

control-read-only-text-color

$control-read-only-text-color: color.get('text', 'secondary') !default;

Description

Control text color in readonly

Type

Color

Used by

error-message-token-size

$error-message-token-size: 'form-error' !default;

Description

Form error token size

Type

String

action-right-spacing

$action-right-spacing: unit.rem(10px) !default;

Description

position the action button to the right length

Type

Number

icon-size

$icon-size: $input-field-line-height;

Description

icon size

Type

Number

fields-group

Installation

  yarn add @chewy/kib-fields-new-styles

Import

  @use '~@chewy/kib-fields-new-styles/src/kib-field-group/styles' as kib-field-group;

mixins

root-container

@mixin root-container() { ... }

Description

Root container

Parameters

None.

Requires

label

@mixin label() { ... }

Description

Styles for the label of a container of a collection of related fields.

Parameters

None.

Requires

label-with-message

@mixin label-with-message() { ... }

Description

Styles for the label of a container of a collection of related fields.

Parameters

None.

Requires

help

@mixin help() { ... }

Description

Helper text

Parameters

None.

Requires

help-bottom

@mixin help-bottom() { ... }

Description

Helper text when on bottom position

Parameters

None.

Requires

content

@mixin content() { ... }

Description

Content spacing positioning

Parameters

None.

Requires

alert

@mixin alert() { ... }

Description

Custom alert message

Parameters

None.

Requires

icon

@mixin icon() { ... }

Description

Field icon

Parameters

None.

Requires

error

@mixin error() { ... }

Description

Error wrapper

Parameters

None.

error-message

@mixin error-message() { ... }

Description

Error message

Parameters

None.

Requires

error-icon

@mixin error-icon() { ... }

Description

Error icon

Parameters

None.

Requires

form

variables

error-color

$error-color: kib-core-theme-get('error') !default;

Description

Form error color.

Type

Color

Used by

warning-color

$warning-color: kib-core-theme-get('warning') !default;

Description

Form warning color.

Type

Color

Used by

control-vertical-padding

$control-vertical-padding: kib-core-px-to-relative(24px * 0.5) !default;

Description

Form control vertical padding.

Type

Number

Used by

control-horizontal-padding

$control-horizontal-padding: kib-core-dimensions-get(small) !default;

Description

Form control horizontal padding.

Type

Number

Used by

input-height

$input-height: (
  kib-core-dimensions-get(large) +
    (kib-core-type-line-height(base) * kib-core-get-type-property(base, size))
);

Description

Form input height size.

Type

Number

Used by

control-font-style

$control-font-style: map.get(kib-type.style-get(body-desktop), size) !default;

Description

Form control font styles.

Type

Map

Used by

control-line-height

$control-line-height: kib-core-type-line-height(base) !default;

Description

Form control line height.

Type

Number

input-background-default

$input-background-default: kib-core-theme-get('fair') !default;

Description

Form control default background color.

Type

Color

Used by

input-border-size

$input-border-size: kib-core-px-to-relative(1px) !default;

Description

Form control border size.

Type

Number

Used by

input-border-gray

$input-border-gray: kib-core-theme-get('outline', 'form') !default;

Description

Form control border color.

Type

Color

Used by

input-border-radius

$input-border-radius: kib-core-px-to-relative(2px) !default;

Description

Form control border radius.

Type

Number

Used by

input-color

$input-color: kib-core-theme-get('text') !default;

Description

Form control default text color.

Type

Color

Used by

input-color-active

$input-color-active: kib-core-theme-get('warning', 'surface') !default;

Description

Form input interactive color.

Type

Color

Used by

control-autofill-padding-top

$control-autofill-padding-top: kib-core-px-to-relative(20px) !default;

Description

Form control webkit autofill top padding.

Type

Number

Used by

control-autofill-padding-bottom

$control-autofill-padding-bottom: kib-core-px-to-relative(4px) !default;

Description

Form control webkit autofill bottom padding.

Type

Number

Used by

control-label-top-position

$control-label-top-position: kib-core-dimensions-get(small) - ($input-border-size * 2) !default;

Description

Form control label top position.

Type

Number

Used by

input-border-error

$input-border-error: $error-color !default;

Description

Form control border error color.

Type

Color

Used by

control-error-padding-right

$control-error-padding-right: kib-core-px-to-relative(38px) !default;

Description

Form control error padding right.

Type

Number

Used by

label-font-style

$label-font-style: map.get(kib-type.style-get(body-desktop), size) !default;

Description

Form label font styles.

Type

Map

Used by

label-color

$label-color: darken(kib-core-theme-get('fair'), 40%) !default;

Description

Form label color.

Type

Color

Used by

inactive-placeholder-top-position

$inactive-placeholder-top-position: kib-core-dimensions-get(small) - ($input-border-size * 2) !default;

Description

Form label inactive placeholder top position.

Type

Number

Used by

inactive-placeholder-font-size

$inactive-placeholder-font-size: kib-core-get-type-property(
  map.get(kib-type.style-get(modifier), size),
  size
) !default;

Description

Form label inactive placeholder font size.

Type

Number

Used by

input-placeholder-color

$input-placeholder-color: kib-core-theme-get('ash', 'surface') !default;

Description

Form control placeholder color.

Type

Color

Used by

help-color

$help-color: kib-core-theme-get('ash', 'surface') !default;

Description

Form help text color

Type

Color

Used by

active-placeholder-top-position

$active-placeholder-top-position: kib-core-px-to-relative(26px * 0.5) + ($input-border-size * 2) !default;

Description

Form label active placeholder top position.

Type

Number

Used by

label-placeholder-padding-top

$label-placeholder-padding-top: kib-core-px-to-relative(20px) !default;

Description

Form label placeholder top position.

Type

Number

Used by

label-placeholder-padding-bottom

$label-placeholder-padding-bottom: kib-core-px-to-relative(4px) !default;

Description

Form label placeholder bottom position.

Type

Number

Used by

password-toggle-index

$password-toggle-index: 2;

Description

z-index of password toggle.

Type

Number

Used by

password-toggle-color

$password-toggle-color: kib-core-theme-get('link', 'deep');

Description

Password toggle color.

Type

Color

Used by

select-arrows

$select-arrows: kib-core-svg-encode(
  "<svg  width='23.88' height='43.81' viewBox='0 0 23.88 43.81' preserveAspectRatio='xMinYMid' xmlns='http://www.w3.org/2000/svg'><polyline fill='none' points='23.91 0.03 23.91 43.86 -0.03 43.86 -0.03 0.03'/><path fill='#{$help-color}' d='M16.88,23.41H8.63l4.12,4.7,4.12-4.71Zm0-2.86H8.63l4.12-4.71,4.12,4.71Z'/></svg>"
) !default;

Description

Form select arrows icon.

Type

String

Used by

select-background-position-width

$select-background-position-width: kib-core-px-to-relative(2px) !default;

Description

Form select background position width.

Type

Number

Used by

select-padding-right

$select-padding-right: kib-core-dimensions-get(large) !default;

Description

Form select padding right.

Type

Number

Used by

select-error-background-position-width

$select-error-background-position-width: kib-core-px-to-relative(2px) !default;

Description

Form select error background position width.

Type

Number

Used by

label-overlayed-background

$label-overlayed-background: rgba(kib-core-theme-get('fair'), 0.8) !default;

Description

Form label background color when overlayed over scrolling controls.

Type

Color

Used by

check-size

$check-size: kib-core-dimensions-get(large) !default;

Description

Form checkbox control check size.

Type

Number

Used by

check-size-default

$check-size-default: $check-size;

Description

Form checkbox control check default size.

Type

Number

check-size-small

$check-size-small: kib-core-dimensions-get(default) !default;

Description

Form checkbox control check small size.

Type

Number

binary-size

$binary-size: kib-core-px-to-relative(30px) !default;

Description

Form binary input size.

Type

Number

Used by

check-offset

$check-offset: ($binary-size - $check-size) *0.5;

Description

Form checkbox check offset size.

Type

Number

Used by

icon-checkbox

$icon-checkbox: kib-core-svg-encode(
  "<svg width='24' height='24' viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'><path fill='#{$input-color-active}' d='M4.452 11.28a2.028 2.028 0 0 0-2.88.052 2.059 2.059 0 0 0 .05 2.898l6.23 6.052c.864.84 2.259.748 3.007-.197L22.556 5.328a2.058 2.058 0 0 0-.323-2.88 2.029 2.029 0 0 0-2.863.324L9.07 15.768 4.452 11.28z'/></svg>"
) !default;

Description

Form checkbox icon.

Type

String

Used by

radio-check-radius-default

$radio-check-radius-default: kib-core-px-to-relative(7px) !default;

Description

Form radio check size.

Type

Number

Used by

binary-size-default

$binary-size-default: $binary-size;

Description

Form binary input size.

Type

Number

binary-size-small

$binary-size-small: kib-core-px-to-relative(22px) !default;

Description

Form binary input size.

Type

Number

radio-check-radius-small

$radio-check-radius-small: kib-core-px-to-relative(5px) !default;

Description

Form radio check small size.

Type

Number

binary-sizes

$binary-sizes: (
  default: (
    size: $binary-size-default,
    spacing: small,
    padding: kib-core-dimensions-get(tiny) 0 0 0,
    padding-min-medium: 0,
    check-size: $check-size-default,
    radio-size: $radio-check-radius-default
  ),
  small: (
    size: $binary-size-small,
    spacing: small,
    padding: 0 0 kib-core-px-to-relative(1px) kib-core-dimensions-get(tiny),
    padding-min-medium: kib-core-dimensions-get(tiny),
    check-size: $check-size-small,
    radio-size: $radio-check-radius-small
  )
) !default;

Description

Map of binary input sizes.

Type

Map

Used by

label-padding-right

$label-padding-right: kib-core-dimensions-get(tiny) !default;

Description

Form label padding right.

Type

Number

Used by

label-boolean-color

$label-boolean-color: kib-core-theme-get('text') !default;

Description

Form label boolean color.

Type

Color

Used by

label-pseudo-left-position

$label-pseudo-left-position: -1 * ($binary-size + kib-core-dimensions-get(small)) !default;

Description

Form label pseudo left position.

Type

Number

Used by

switch-size

$switch-size: kib-core-px-to-relative(44px) !default;

Description

Form switch input size.

Type

Number

switch-height

$switch-height: kib-core-px-to-relative(19px) !default;

Description

Form switch input height.

Type

Number

switch-height-small

$switch-height-small: kib-core-px-to-relative(18px) !default;

Description

Form switch input height.

Type

Number

switch-height-default

$switch-height-default: $switch-height;

Description

Form switch input height.

Type

Number

switch-size-default

$switch-size-default: $switch-size;

Description

Form switch input size.

Type

Number

switch-color-base

$switch-color-base: kib-core-theme-get('text', 'surface') !default;

Description

Form switch input base color

Type

Color

Used by

switch-color-active

$switch-color-active: $input-color-active !default;

Description

Form switch input active color

Type

Color - color theme on switch only

Used by

switch-color-active-opacity

$switch-color-active-opacity: 0.4 !default;

Description

Form switch input active color opacity

Type

Number

Used by

switch-size-small

$switch-size-small: kib-core-px-to-relative(35px) !default;

Description

Form switch input size.

Type

Number

switch-border-radius

$switch-border-radius: $switch-size * 0.5 !default;

Description

Form switch input border-radius.

Type

Number

switch-border-radius-default

$switch-border-radius-default: $switch-border-radius;

Description

Form switch input border-radius.

Type

Number

switch-border-radius-small

$switch-border-radius-small: $switch-size-small * 0.5 !default;

Description

Form switch input border-radius.

Type

Number

switch-position-top-offset

$switch-position-top-offset: kib-core-px-to-relative(4px) !default;

Description

Form switch input top offset position.

Type

Number

switch-position-top-offset-default

$switch-position-top-offset-default: $switch-position-top-offset;

Description

Form switch input top offset osition.

Type

Number

switch-position-top-offset-small

$switch-position-top-offset-small: kib-core-px-to-relative(3px) !default;

Description

Form switch input top offset position.

Type

Number

switch-knob-size

$switch-knob-size: $switch-height + kib-core-px-to-relative(9px) !default;

Description

Form switch input knob size.

Type

Number

switch-knob-size-default

$switch-knob-size-default: $switch-knob-size;

Description

Form switch input knob size.

Type

Number

switch-knob-size-small

$switch-knob-size-small: $switch-height-small + kib-core-px-to-relative(5px) !default;

Description

Form switch input knob size.

Type

Number

switch-knob-top-offset

$switch-knob-top-offset: kib-core-px-to-relative(1px) * -1 !default;

Description

Form switch knob top offset position.

Type

Number

switch-knob-top-offset-default

$switch-knob-top-offset-default: $switch-knob-top-offset;

Description

Form switch input top offset osition.

Type

Number

switch-knob-top-offset-small

$switch-knob-top-offset-small: 0 !default;

Description

Form switch input top offset position.

Type

Number

switch-knob-left-offset

$switch-knob-left-offset: ($switch-size + $switch-knob-size*0.2) * -1 !default;

Description

Form switch knob left offset position.

Type

Number

switch-knob-left-offset-default

$switch-knob-left-offset-default: $switch-knob-left-offset;

Description

Form switch input left offset position.

Type

Number

switch-knob-left-offset-small

$switch-knob-left-offset-small: ($switch-size-small + $switch-knob-size-small*0.2) * -1 !default;

Description

Form switch input lef offset position.

Type

Number

switch-knob-checked-position

$switch-knob-checked-position: $switch-knob-size*0.2 * -4 !default;

Description

Form switch input knob checked position.

Type

Number

switch-knob-checked-position-default

$switch-knob-checked-position-default: $switch-knob-checked-position;

Description

Form switch input knob checked position.

Type

Number

switch-knob-checked-position-small

$switch-knob-checked-position-small: $switch-knob-size-small*0.2 * -4 !default;

Description

Form switch input knob checked position.

Type

Number

switch-sizes

$switch-sizes: (
  default: (
    size: $switch-size-default,
    height: $switch-height-default,
    border-radius: $switch-border-radius-default,
    top-position: $switch-position-top-offset-default,
    knob-top-offset: $switch-knob-top-offset-default,
    knob-left-offset: $switch-knob-left-offset-default,
    knob-size: $switch-knob-size-default,
    knob-checked-position: $switch-knob-checked-position-default,
    label-vertical-align: bottom,
    space-between-label-and-switch: kib-core-dimensions-get(default)
  ),
  small: (
    size: $switch-size-small,
    height: $switch-height-small,
    border-radius: $switch-border-radius-small,
    top-position: $switch-position-top-offset-small,
    knob-top-offset: $switch-knob-top-offset-small,
    knob-left-offset: $switch-knob-left-offset-small,
    knob-size: $switch-knob-size-small,
    knob-checked-position: $switch-knob-checked-position-small,
    label-vertical-align: baseline,
    space-between-label-and-switch: kib-core-dimensions-get(default)
  )
);

Description

Switch: Map of switch input sizes.

Type

Map

Used by

switch-hovered-and-focused-states

$switch-hovered-and-focused-states: (
  default: (
    hovered: 0 0 2px 12px rgba($switch-color-base, 0.1),
    focused: 0 0 2px 10px rgba($switch-color-base, 0.3),
    active: 0 0 2px 14px rgba($switch-color-base, 0.4),
    checked-and-hovered: 0 0 2px 12px rgba($switch-color-active, 0.1),
    checked-and-active: 0 0 2px 14px rgba($switch-color-active, 0.3),
    checked-and-focused: 0 0 2px 10px rgba($switch-color-active, 0.3)
  ),
  small: (
    hovered: 0 0 2px 8px rgba($switch-color-base, 0.1),
    focused: 0 0 2px 7px rgba($switch-color-base, 0.2),
    active: 0 0 2px 9px rgba($switch-color-base, 0.3),
    checked-and-hovered: 0 0 2px 8px rgba($switch-color-active, 0.1),
    checked-and-active: 0 0 2px 9px rgba($switch-color-active, 0.3),
    checked-and-focused: 0 0 2px 7px rgba($switch-color-active, 0.2)
  )
);

Description

Switch - Map of switch input hovered and focused states.

Type

Map

Used by

mixins

label-boolean-sized

@mixin label-boolean-sized($size) { ... }

Description

Generate styles for a boolean input label by size.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

indicator-boolean-size

@mixin indicator-boolean-size($size) { ... }

Description

Generate styles for a boolean input by size.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

label-mixin

@mixin label-mixin($type) { ... }

Description

Generate styles for a form label radio/checkbox.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type noneString none

Requires

control-mixin

@mixin control-mixin($type) { ... }

Description

Generate styles for a form control radio/checkbox.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type noneString none

Requires

field-boolean

@mixin field-boolean($size) { ... }

Description

Generates the form boolean styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

label-switch-base

@mixin label-switch-base($size) { ... }

Description

Generate switch base styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Used by

label-switch-track-base

@mixin label-switch-track-base($size) { ... }

Description

Generate switch - track base styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

Used by

label-switch-knob-base

@mixin label-switch-knob-base($size) { ... }

Description

Generate switch - knob base styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

Used by

label-switch

@mixin label-switch($size: 'default', $label-placement: 'end') { ... }

Description

Generate switch styles

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

default size

String'default'
$label-placement

label placement of the switch

String'end'

Requires

label-switch-is-checked

@mixin label-switch-is-checked($size) { ... }

Description

Label styles for switch controls that are checked.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

label-switch-hovered-and-focused-states

@mixin label-switch-hovered-and-focused-states($size: default, $state: hovered) { ... }

Description

Label styles for switch controls that are hovered or focus.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

Default or small size of switch

Stringdefault
$state

Hovered, focused, active, checked-and-hovered, check-and-active and or checked-and-focused state

Stringhovered

Requires

label-switch-disabled

@mixin label-switch-disabled() { ... }

Description

Label styles for switch controls that are disabled.

Parameters

None.

Requires

label-boolean-is-hovered

@mixin label-boolean-is-hovered() { ... }

Description

Label styles for when its boolean input is hovered over.

Parameters

None.

label-boolean-is-focused

@mixin label-boolean-is-focused() { ... }

Description

Label styles for a boolean control when it is focused.

Parameters

None.

indicator-checkbox-is-checked

@mixin indicator-checkbox-is-checked() { ... }

Description

Checkbox indicator styles when it is checkedß.

Parameters

None.

Requires

Used by

label-radio-is-checked

@mixin label-radio-is-checked() { ... }

Description

Label styles for radio controls when the control is checked.

Parameters

None.

Requires

label-checkbox-is-checked

@mixin label-checkbox-is-checked() { ... }

Description

Label styles for checkbox controls that are checked.

Parameters

None.

Requires

label-radio-is-checked-and-focused

@mixin label-radio-is-checked-and-focused() { ... }

Description

Label styles for radio controls that are checked and focused.

Parameters

None.

Requires

indicator-boolean

@mixin indicator-boolean() { ... }

Description

Generate default styles for a boolean input.

Parameters

None.

Requires

Used by

control-boolean

@mixin control-boolean() { ... }

Description

Generate styles for a boolean control.

Parameters

None.

Used by

label-boolean

@mixin label-boolean() { ... }

Description

Generate styles for a boolean input label.

Parameters

None.

Requires

Used by

field-container

@mixin field-container() { ... }

Description

General styles for a form field container.

Parameters

None.

field-container-nested

@mixin field-container-nested() { ... }

Description

General style for a nested form field container.

Parameters

None.

field-help

@mixin field-help() { ... }

Description

General styles for form help text.

Parameters

None.

Requires

field-inner-wrapper

@mixin field-inner-wrapper() { ... }

Description

General styles for form inner wrapper.

Parameters

None.

field-is-hovered

@mixin field-is-hovered() { ... }

Description

General styles for form hover state.

Parameters

None.

Requires

field-is-focused

@mixin field-is-focused() { ... }

Description

General styles for form focused state.

Parameters

None.

Requires

field-is-disabled

@mixin field-is-disabled() { ... }

Description

General styles for form disabled state.

Parameters

None.

field-is-inline

@mixin field-is-inline() { ... }

Description

Variant styles for inline form components.

Parameters

None.

transition

@mixin transition() { ... }

Description

General styles for the form transitions.

Parameters

None.

field-control

@mixin field-control() { ... }

Description

General styles for all form controls.

Parameters

None.

Requires

field-control-is-hovered

@mixin field-control-is-hovered() { ... }

Description

Control styles for radio controls when the control is hovered.

Parameters

None.

Requires

field-control-is-focused

@mixin field-control-is-focused() { ... }

Description

Control styles for radio controls when the control is focused.

Parameters

None.

Requires

field-control-has-label-placholder

@mixin field-control-has-label-placholder() { ... }

Description

Control styles for labels being used as placeholders.

Parameters

None.

Requires

field-control-input

@mixin field-control-input() { ... }

Description

Control styles for input controls.

Parameters

None.

field-control-textarea

@mixin field-control-textarea() { ... }

Description

Control styles for textarea controls.

Parameters

None.

field-control-select

@mixin field-control-select() { ... }

Description

Control styles for select controls.

Parameters

None.

Requires

field-control-has-error-base

@mixin field-control-has-error-base() { ... }

Description

General styles for control error states.

Parameters

None.

Requires

Used by

field-control-has-error-is-hovered

@mixin field-control-has-error-is-hovered() { ... }

Description

General styles for control error hover states.

Parameters

None.

Requires

Used by

field-control-has-error-is-focused

@mixin field-control-has-error-is-focused() { ... }

Description

General styles for control error focus states.

Parameters

None.

Requires

Used by

field-control-has-error

@mixin field-control-has-error() { ... }

Description

Control styles for error states.

Parameters

None.

Requires

field-control-select-has-error

@mixin field-control-select-has-error() { ... }

Description

Control styles for select error states.

Parameters

None.

Requires

field-label

@mixin field-label() { ... }

Description

General styles for all form labels.

Parameters

None.

Requires

field-label-is-placeholder

@mixin field-label-is-placeholder() { ... }

Description

Label styles for when they are being used as placeholders.

Parameters

None.

Requires

field-label-is-placeholder-is-active

@mixin field-label-is-placeholder-is-active() { ... }

Description

Label styles for when the placeholder is active.

Parameters

None.

Requires

field-label-is-placeholder-is-inactive

@mixin field-label-is-placeholder-is-inactive() { ... }

Description

Label styles for when the placeholder is inactive.

Parameters

None.

Requires

field-label-is-overlayed

@mixin field-label-is-overlayed() { ... }

Description

Label styles for when it must be positioned over scolling controls.

Parameters

None.

Requires

field-label-is-hovered

@mixin field-label-is-hovered() { ... }

Description

Label styles for when its boolean input is hovered over.

Parameters

None.

field-label-is-focused

@mixin field-label-is-focused() { ... }

Description

Label styles for a boolean control when it is focused.

Parameters

None.

form-autocomplete

mixins

states-property-generate

@mixin states-property-generate($type) { ... }

Description

Generate styles for autocomplete states

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type noneString none

Requires

Used by

loader-property-generate

@mixin loader-property-generate($type) { ... }

Description

Generate styles for autocomplete loader

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type noneString none

Requires

Used by

menu

@mixin menu() { ... }

Description

Generate styles for autocomplete menu

Parameters

None.

Requires

listbox

@mixin listbox() { ... }

Description

Generate styles for autocomplete listbox

Parameters

None.

Requires

listbox-is-hovered

@mixin listbox-is-hovered() { ... }

Description

Generate styles for autocomplete listbox hover state

Parameters

None.

Requires

listbox-is-focused

@mixin listbox-is-focused() { ... }

Description

Generate styles for autocomplete listbox focus state

Parameters

None.

Requires

listbox-has-error

@mixin listbox-has-error() { ... }

Description

Generate styles for autocomplete listbox error state

Parameters

None.

Requires

listbox-is-hidden

@mixin listbox-is-hidden() { ... }

Description

Generate styles for autocomplete listbox error state

Parameters

None.

option

@mixin option() { ... }

Description

Generate styles for autocomplete option

Parameters

None.

Requires

option-is-active

@mixin option-is-active() { ... }

Description

Generate styles for autocomplete option active state

Parameters

None.

Requires

option-hidden

@mixin option-hidden() { ... }

Description

Generate styles for visually hidden option for SRs

Parameters

None.

highlight

@mixin highlight() { ... }

Description

Generate styles for autocomplete highlight

Parameters

None.

Requires

appended-control

@mixin appended-control() { ... }

Description

Generate styles for autocomplete appended controls

Parameters

None.

icon-base

@mixin icon-base() { ... }

Description

Generate styles for autocomplete base icon styles

Parameters

None.

Requires

loader-base

@mixin loader-base() { ... }

Description

Generate styles for autocomplete base loader styles

Parameters

None.

Requires

clear-button

@mixin clear-button() { ... }

Description

Generate styles for autocomplete clear button

Parameters

None.

Requires

clear-button-no-icon

@mixin clear-button-no-icon() { ... }

Description

Generate styles for autocomplete clear button variant with no icon

Parameters

None.

Requires

icon

@mixin icon() { ... }

Description

Generate styles for autocomplete icon

Parameters

None.

Requires

loader

@mixin loader() { ... }

Description

Generate styles for autocomplete loader

Parameters

None.

Requires

loader-no-icon

@mixin loader-no-icon() { ... }

Description

Generate styles for autocomplete loader variant with no icon

Parameters

None.

control-has-suggestions

@mixin control-has-suggestions() { ... }

Description

Generate styles for autocomplete control variant with suggestions

Parameters

None.

transition

@mixin transition() { ... }

Description

Generate styles for the autocomplete transitions

Parameters

None.

TODO's

  • This style is just a placeholder until we have react transition component ready

variables

option-emphasis-background

$option-emphasis-background: kib-core-theme-get(
  'background',
  'header'
) !default;

Description

Autocomplete option with emphasis background color

Type

Color

Used by

clear-color

$clear-color: kib-core-theme-get('text', 'surface') !default;

Description

Autocomplete clear button icon color

Type

Color

Used by

clear-emphasis-color

$clear-emphasis-color: kib-core-theme-get('text', 'secondary') !default;

Description

Autocomplete clear button icon color when on hover/focus

Type

Color

Used by

icon-color

$icon-color: kib-core-theme-get('link') !default;

Description

Autocomplete search and loading icons color

Type

Color

listbox-maxheight

$listbox-maxheight: kib-core-px-to-relative(240px) !default;

Description

Autocomplete listbox max-height

Type

Number

Used by

option-font-size

$option-font-size: kib-core-get-type-property(tiny, size) !default;

Description

Autocomplete option font size

Type

Number

Used by

option-font-weight

$option-font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Autocomplete option font weight

Type

Number

Used by

highlight-font-weight

$highlight-font-weight: map.get($kib-core-type-weights, regular) !default;

Description

Autocomplete highlight font weight

Type

Number

Used by

icon-dimensions

$icon-dimensions: kib-core-dimensions-get(default) !default;

Description

Autocomplete highlight font weight

Type

Number

Used by

loader-right-position

$loader-right-position: kib-core-dimensions-get(default) !default;

Description

Autocomplete loader right position

Type

Number

Used by

loader-margin-top

$loader-margin-top: -1 * kib-core-dimensions-get(small) !default;

Description

Autocomplete loader margin top

Type

Number

clear-right-position

$clear-right-position: kib-core-dimensions-get(huge) +
  kib-core-dimensions-get(small) !default;

Description

Autocomplete clear right position

Type

Number

Used by

clear-noicon-right-position

$clear-noicon-right-position: kib-core-dimensions-get(default) !default;

Description

Autocomplete clear no icon right position

Type

Number

Used by

states-map

$states-map: (
  active: (
    color: settings.$input-color-active
  ),
  error: (
    color: settings.$input-border-error
  )
);

Description

Autocomplete map for different states

Type

Map

Used by

loader-map

$loader-map: (
  loader: (
    top: settings.$input-height * 0.5,
    margin-top: (
      kib-core-dimensions-get(small) - settings.$input-border-size
    ) * -1
  ),
  clear: (
    top: settings.$input-height * 0.5 + settings.$input-border-size,
    margin-top: $loader-margin-top
  )
);

Description

Autocomplete map for loader properties

Type

Map

Used by

form-button-toggle

mixins

container

@mixin container() { ... }

Description

Generates container styles for the button toggle

Parameters

None.

control

@mixin control() { ... }

Description

Generates control styles for the button toggle

Parameters

None.

label

@mixin label() { ... }

Description

Generates label styles for the button toggle

Parameters

None.

Requires

label-is-disabled

@mixin label-is-disabled() { ... }

Description

Generates label styles for the button toggle disabled state

Parameters

None.

Requires

label-is-disabled-is-hovered

@mixin label-is-disabled-is-hovered() { ... }

Description

Generates label styles for the button toggle disabled hover state

Parameters

None.

Requires

label-is-invalid

@mixin label-is-invalid() { ... }

Description

Generates label styles for the button toggle invalid state

Parameters

None.

label-is-invalid-is-hovered

@mixin label-is-invalid-is-hovered() { ... }

Description

Generates label styles for the button toggle invalid hover state

Parameters

None.

label-text

@mixin label-text() { ... }

Description

Generates label text styles for the button toggle

Parameters

None.

label-text-is-disabled

@mixin label-text-is-disabled() { ... }

Description

Generates label text styles for the button toggle disabled state

Parameters

None.

label-text-is-invalid

@mixin label-text-is-invalid() { ... }

Description

Generates label text styles for the button toggle invalid state

Parameters

None.

label-text-is-invalid-is-hovered

@mixin label-text-is-invalid-is-hovered() { ... }

Description

Generates label text styles for the button toggle invalid hover state

Parameters

None.

label-is-selected

@mixin label-is-selected() { ... }

Description

Generates label styles for the button toggle selected state

Parameters

None.

Requires

label-is-focused

@mixin label-is-focused() { ... }

Description

Generates label styles for the button toggle focus state

Parameters

None.

Requires

label-with-input

@mixin label-with-input() { ... }

Description

Generates label with input styles for the button toggle

Parameters

None.

label-input-indicator

@mixin label-input-indicator() { ... }

Description

Generates label input indicator styles for the button toggle

Parameters

None.

label-with-input-is-left-is-inline

@mixin label-with-input-is-left-is-inline() { ... }

Description

Generates label input styles for the button toggle when left aligned

Parameters

None.

Requires

label-with-input-is-right-is-inline

@mixin label-with-input-is-right-is-inline() { ... }

Description

Generates label input styles for the button toggle when right aligned

Parameters

None.

Requires

label-with-input-is-hovered

@mixin label-with-input-is-hovered() { ... }

Description

Generates label input styles for the button toggle when hovered

Parameters

None.

label-with-input-is-focused

@mixin label-with-input-is-focused() { ... }

Description

Generates label input styles for the button toggle when focused

Parameters

None.

input-outer

@mixin input-outer() { ... }

Description

Generates input outer styles for the button toggle

Parameters

None.

input-outer-is-left

@mixin input-outer-is-left() { ... }

Description

Generates input outer styles for the button toggle when left aligned

Parameters

None.

input-outer-is-right

@mixin input-outer-is-right() { ... }

Description

Generates input outer styles for the button toggle when right aligned

Parameters

None.

input-inner

@mixin input-inner() { ... }

Description

Generates input inner styles for the button toggle

Parameters

None.

input-checkbox-inner-is-left

@mixin input-checkbox-inner-is-left() { ... }

Description

Generates checkbox inner styles for the button toggle when left aligned

Parameters

None.

Requires

input-checkbox-inner-is-right

@mixin input-checkbox-inner-is-right() { ... }

Description

Generates checkbox inner styles for the button toggle when right aligned

Parameters

None.

Requires

input-checkbox-outer

@mixin input-checkbox-outer() { ... }

Description

Generates checkbox outer styles for the button toggle

Parameters

None.

Requires

input-checkbox-is-checked

@mixin input-checkbox-is-checked() { ... }

Description

Generates checkbox styles for the button toggle when checked

Parameters

None.

input-checkbox-outer-is-checked

@mixin input-checkbox-outer-is-checked() { ... }

Description

Generates checkbox outer styles for the button toggle when checked

Parameters

None.

Requires

input-radio-outer

@mixin input-radio-outer() { ... }

Description

Generates radio outer styles for the button toggle

Parameters

None.

Requires

input-radio-is-checked

@mixin input-radio-is-checked() { ... }

Description

Generates radio outer styles for the button toggle when checked

Parameters

None.

variables

yellow

$yellow: #f5a623 !default;

Description

Colors -- Orange

Type

Color

disabled-background-color

$disabled-background-color: $kib-gray-100 !default;

Description

Button toggle disabled background color

Type

Color

Used by

disabled-border-color

$disabled-border-color: kib-core-theme-get('outline') !default;

Description

Button toggle disabled border color

Type

Color

Used by

label-boxshadow-color

$label-boxshadow-color: kib-core-theme-get('link') !default;

Description

Button toggle label boxshadow color

Type

Color

Used by

label-border-radius

$label-border-radius: kib-core-dimensions-get(tiny) !default;

Description

Button toggle label border radius

Type

Number

Used by

control-label-boxshadow-color

$control-label-boxshadow-color: kib-core-theme-get('outline') !default;

Description

Button toggle control label boxshadow color

Type

Color

Used by

control-label-background-color

$control-label-background-color: kib-core-theme-get('fair') !default;

Description

Button toggle control label background color

Type

Color

Used by

control-label-text-color

$control-label-text-color: kib-core-theme-get('text') !default;

Description

Button toggle control label text color

Type

Color

Used by

active-background-color

$active-background-color: kib-core-theme-get('warning', 'highlight') !default;

Description

Button toggle active background color

Type

Color

Used by

form-calendar

variables

bezier

$bezier: cubic-bezier(0.23, 1, 0.32, 1) !default;

Description

Calendar cubic bezier value

Type

Animation

slide-time

$slide-time: 400ms !default;

Description

Calendar slide time

Type

Number

day-size

$day-size: (kib-core-dimensions-get(large) * 1.35) !default;

Description

Calendar day size

Type

Number

padding

$padding: kib-core-dimensions-get(default) !default;

Description

Calendar padding

Type

Number

Used by

day-margin

$day-margin: kib-core-px-to-relative(2px) !default;

Description

Calendar day margin

Type

Number

days-width

$days-width: (($day-size * 7) + ($day-margin * 14)) !default;

Description

Calendar day width

Type

Number

calendar-width

$calendar-width: $days-width + ($padding * 2) !default;

Description

Calendar width

Type

Number

month-nav-height

$month-nav-height: kib-core-dimensions-get(large) !default;

Description

Calendar month nav height

Type

Number

weekdays-height

$weekdays-height: kib-core-dimensions-get(huge) !default;

Description

Calendar weekdays height

Type

Number

time-height

$time-height: kib-core-dimensions-get(huge) !default;

Description

Calendar time height

Type

Number

no-calendar-border

$no-calendar-border: false !default;

Description

Calendar picker border

Type

Boolean

calendar-background

$calendar-background: kib-core-theme-get('fair') !default;

Description

Calendar background color

Type

Color

calendar-border-color

$calendar-border-color: kib-core-theme-get('outline') !default;

Description

Calendar border color

Type

Color

month-foreground

$month-foreground: rgba(kib-core-theme-get('slate'), 0.9) !default;

Description

Calendar month foreground color

Type

Color

arrow-hover-color

$arrow-hover-color: darken(kib-core-theme-get('link'), 20) !default;

Description

Calendar arrow hover color

Type

Color

month-background

$month-background: kib-core-theme-get('fair') !default;

Description

Calendar month background color

Type

Color

weekdays-background

$weekdays-background: transparent !default;

Description

Calendar weekdays background color

Type

Color

weekdays-foreground

$weekdays-foreground: rgba(kib-core-theme-get('slate'), 0.54) !default;

Description

Calendar weekdays foreground color

Type

Color

day-foreground

$day-foreground: kib-core-theme-get('text') !default;

Description

Calendar day foreground color

Type

Color

day-hover-background

$day-hover-background: kib-core-theme-get('outline') !default;

Description

Calendar day hover background color

Type

Color

today-fg-color

$today-fg-color: kib-core-theme-get('fair') !default;

Description

Calendar today foreground color

Type

Color

today-color

$today-color: kib-core-theme-get('outline') !default;

Description

Calendar today text color

Type

Color

selected-day-foreground

$selected-day-foreground: null !default;

Description

Calendar selected day foreground color

Type

Color

selected-day-background

$selected-day-background: kib-core-theme-get('success') !default;

Description

Calendar selected day background color

Type

Color

inverted-bg

$inverted-bg: color.invert($calendar-background) !default;

Description

Calendar inverted color

Type

Color

disabled-border-color

$disabled-border-color: transparent !default;

Description

Calendar disabled border color

Type

Color

arrow-color

$arrow-color: kib-core-theme-get('link') !default;

Description

Calendar arrow color

Type

Color

arrow-disabled

$arrow-disabled: rgba($day-foreground, 0.1) !default;

Description

Calendar arrow disabled color

Type

Color

transform

$transform: translate3d(0, 0, 0);

Description

Calendar transform

Type

Transform

transform-negative-100

$transform-negative-100: translate3d(-100%, 0, 0);

Description

Calendar transform negative 100

Type

Transform

transform-100

$transform-100: translate3d(100%, 0, 0);

Description

Calendar transform 100

Type

Transform

inline-top-position

$inline-top-position: kib-core-px-to-relative(2px) !default;

Description

Calendar inline top position

Type

Number

input-time-border

$input-time-border: kib-core-px-to-relative(1px) solid $calendar-border-color !default;

Description

Calendar input time border

Type

Border

arrow-border

$arrow-border: kib-core-dimensions-get(tiny) solid transparent !default;

Description

Calendar arrow border

Type

Border

calendar-pseudo-position

$calendar-pseudo-position: kib-core-px-to-relative(22px) !default;

Description

Calendar calendar pseudo position

Type

Number

form-checkbox

mixins

label-checkbox-is-checked

@mixin label-checkbox-is-checked($size) { ... }

Description

Label styles for checkbox controls that are checked.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

label-checkbox

@mixin label-checkbox($size) { ... }

Description

Generate checkbox styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

indicator-checkbox-is-checked

@mixin indicator-checkbox-is-checked($size) { ... }

Description

Generate checkbox checked styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

label-base

@mixin label-base() { ... }

Description

Generate checkbox base label styles.

Parameters

None.

form-dropdown

mixins

popup

@mixin popup() { ... }

Description

Generates popup styles for the dropdown

Parameters

None.

list

@mixin list() { ... }

Description

Generates list styles for the dropdown

Parameters

None.

Requires

option

@mixin option() { ... }

Description

Generates option styles for the dropdown

Parameters

None.

radio-wrapper

@mixin radio-wrapper() { ... }

Description

Generates radio wrapper styles for the dropdown

Parameters

None.

radio-label

@mixin radio-label() { ... }

Description

Generates radio label styles for the dropdown

Parameters

None.

Requires

radio-label-is-hovered

@mixin radio-label-is-hovered() { ... }

Description

Generates radio label state styles for the dropdown when hovered

Parameters

None.

radio-label-is-selected

@mixin radio-label-is-selected() { ... }

Description

Generates radio label state styles for the dropdown when selected

Parameters

None.

variables

list-maxheight

$list-maxheight: kib-core-px-to-relative(224px) !default;

Description

Dropdown list max-height

Type

Number

Used by

label-font-size

$label-font-size: kib-core-get-type-property(base, size) !default;

Description

Dropdown label font size

Type

Number

Used by

label-line-height

$label-line-height: kib-core-get-type-property(base, height) !default;

Description

Dropdown label line height

Type

Number

Used by

form-group

mixins

kib-form-group-label

@mixin kib-form-group-label() { ... }

Description

Styles for the label of a container of a collection of related fields.

Parameters

None.

Requires

legend-is-hidden

@mixin legend-is-hidden() { ... }

Description

Styles when the legend is hidden

Parameters

None.

messages-above

@mixin messages-above() { ... }

Description

Styles when messages are displayed above

Parameters

None.

variables

label-font-weight

$label-font-weight: map.get($kib-core-type-weights, regular) !default;

Description

Form group label font weight.

Type

Color

Used by

form-messaging

mixins

container

@mixin container() { ... }

Description

styles for the form message container.

Parameters

None.

list

@mixin list() { ... }

Description

Styles for the form message list.

Parameters

None.

item

@mixin item() { ... }

Description

General/default styles for form messages.

Parameters

None.

Requires

item-is-error

@mixin item-is-error() { ... }

Description

Style for form related error messages

Parameters

None.

Requires

item-is-warning

@mixin item-is-warning() { ... }

Description

Style for form related error messages

Parameters

None.

Requires

variables

font-size

$font-size: kib-core-get-type-property(micro, size) !default;

Description

Form messages font size

Type

Number

font-weight

$font-weight: map.get($kib-core-type-weights, normal) !default;

Description

Form messages font weight

Type

Number

color

$color: kib-core-theme-get('ash', 'surface') !default;

Description

Form messages default text color

Type

Color

Used by

error-color

$error-color: settings.$error-color !default;

Description

Form messages error text color

Type

Color

warning-color

$warning-color: settings.$warning-color !default;

Description

Form messages warning text color

Type

Color

form-multiselect

mixins

multiselect-option-pseudo-properties

@mixin multiselect-option-pseudo-properties($type) { ... }

Description

Generate styles for multiselect option pseudo elements.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type noneString none

Requires

Used by

multiselect-spinner-pseudo-properties

@mixin multiselect-spinner-pseudo-properties($type) { ... }

Description

Generate styles for multiselect spinner pseudo elements.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type noneString none

Requires

Used by

multiselect-select-properties

@mixin multiselect-select-properties($type) { ... }

Description

Generate styles for multiselect select element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type noneString none

Requires

multiselect-option

@mixin multiselect-option() { ... }

Description

Common styles for multiselect option.

Parameters

None.

Requires

multiselect-caret

@mixin multiselect-caret() { ... }

Description

Common styles for multiselect caret.

Parameters

None.

Requires

multiselect-spinner

@mixin multiselect-spinner() { ... }

Description

Common styles for multiselect spinner.

Parameters

None.

Requires

multiselect-input-border

@mixin multiselect-input-border() { ... }

Description

Common styles for multiselect input border.

Parameters

None.

Used by

multiselect-select-pseudo

@mixin multiselect-select-pseudo() { ... }

Description

Common styles for multiselect select pseudo element.

Parameters

None.

Requires

multiselect-placeholder

@mixin multiselect-placeholder() { ... }

Description

Common styles for multiselect placeholder element.

Parameters

None.

Requires

multiselect-content-wrapper

@mixin multiselect-content-wrapper() { ... }

Description

Common styles for multiselect content wrapper.

Parameters

None.

Requires

multiselect-above-content-wrapper

@mixin multiselect-above-content-wrapper() { ... }

Description

Common styles for multiselect above content wrapper.

Parameters

None.

Requires

multiselect-content

@mixin multiselect-content() { ... }

Description

Common styles for multiselect content.

Parameters

None.

control

@mixin control() { ... }

Description

Common styles for the control.

Parameters

None.

noresult

@mixin noresult() { ... }

Description

Common styles for no results.

Parameters

None.

loader

@mixin loader() { ... }

Description

Common styles for the loader.

Parameters

None.

after-list-message

@mixin after-list-message() { ... }

Description

Common styles for the after list message.

Parameters

None.

label-is-active

@mixin label-is-active() { ... }

Description

Common styles for the label active state.

Parameters

None.

container-is-active

@mixin container-is-active() { ... }

Description

Common styles for the container active state.

Parameters

None.

caret-is-active

@mixin caret-is-active() { ... }

Description

Common styles for the caret active state.

Parameters

None.

content-wrapper-has-error

@mixin content-wrapper-has-error() { ... }

Description

Common styles for content wrapper error state.

Parameters

None.

Requires

fieldset-is-disabled

@mixin fieldset-is-disabled() { ... }

Description

Common styles for fieldset disabled state.

Parameters

None.

multiselect-loading-is-in

@mixin multiselect-loading-is-in() { ... }

Description

Common styles for multiselect loader in view state.

Parameters

None.

multiselect-loading-is-out

@mixin multiselect-loading-is-out() { ... }

Description

Common styles for multiselect loading out of view state.

Parameters

None.

multiselect-fonts

@mixin multiselect-fonts() { ... }

Description

Common styles for multiselect base fonts.

Parameters

None.

multiselect-is-disabled

@mixin multiselect-is-disabled() { ... }

Description

Common styles for multiselect disabled state.

Parameters

None.

multiselect-is-active

@mixin multiselect-is-active() { ... }

Description

Common styles for multiselect active state.

Parameters

None.

multiselect-select-is-active

@mixin multiselect-select-is-active() { ... }

Description

Common styles for multiselect select active state.

Parameters

None.

multiselect-input-is-above-is-active

@mixin multiselect-input-is-above-is-active() { ... }

Description

Common styles for multiselect input state when above and active.

Parameters

None.

multiselect-input-base

@mixin multiselect-input-base() { ... }

Description

Common styles for base multiselect input.

Parameters

None.

multiselect-input

@mixin multiselect-input() { ... }

Description

Common styles for multiselect input.

Parameters

None.

multiselect-input-placeholder

@mixin multiselect-input-placeholder() { ... }

Description

Common styles for multiselect input placeholder.

Parameters

None.

Requires

multiselect-tags-container

@mixin multiselect-tags-container() { ... }

Description

Common styles for multiselect tags container.

Parameters

None.

multiselect-strong

@mixin multiselect-strong() { ... }

Description

Common styles for multiselect strong.

Parameters

None.

multiselect-element

@mixin multiselect-element() { ... }

Description

Common styles for multiselect element.

Parameters

None.

multiselect-is-in

@mixin multiselect-is-in() { ... }

Description

Common styles for multiselect in view state.

Parameters

None.

multiselect-is-out

@mixin multiselect-is-out() { ... }

Description

Common styles for multiselect out of view state.

Parameters

None.

variables

option-padding-left

$option-padding-left: kib-core-dimensions-get(small) * 2 + kib-core-dimensions-get(default) !default;

Description

Multiselect option padding left

Type

Number

Used by

option-before-top-position

$option-before-top-position: (
  math.div(kib-core-dimensions-get(default), 6) + kib-core-dimensions-get(small)
) !default;

Description

Multiselect option before pseudo element top position

Type

Number

option-before-left-position

$option-before-left-position: kib-core-dimensions-get(small) !default;

Description

Multiselect option before pseudo element left position

Type

Number

option-before-dimensions

$option-before-dimensions: kib-core-dimensions-get(default) !default;

Description

Multiselect option before pseudo element dimensions

Type

Number

option-before-border-width

$option-before-border-width: kib-core-px-to-relative(1px) !default;

Description

Multiselect option before pseudo element border width

Type

Number

Used by

option-before-border-color

$option-before-border-color: rgba(kib-core-theme-get('slate'), 0.3) !default;

Description

Multiselect option before pseudo element border color

Type

Number

Used by

option-before-border-radius

$option-before-border-radius: kib-core-px-to-relative(2px) !default;

Description

Multiselect option before pseudo element border radius

Type

Number

Used by

option-after-top-position

$option-after-top-position: (
  math.div(kib-core-dimensions-get(default), 6) + kib-core-dimensions-get(small) +
    (kib-core-dimensions-get(default) - kib-core-dimensions-get(default) * 0.9)
) !default;

Description

Multiselect option after pseudo element top position

Type

Number

option-after-left-position

$option-after-left-position: kib-core-dimensions-get(small) +
  (kib-core-dimensions-get(default) - kib-core-dimensions-get(default) * 0.9) * 0.5 !default;

Description

Multiselect option after pseudo element left position

Type

Number

option-after-dimensions

$option-after-dimensions: kib-core-dimensions-get(default) !default;

Description

Multiselect option after pseudo element dimensions

Type

Number

option-highlight-background-color

$option-highlight-background-color: kib-core-theme-get('background', 'container') !default;

Description

Multiselect option highlight background color

Type

Color

Used by

option-highlight-selected-background-image

$option-highlight-selected-background-image: url(kib-core-svg-base64-encode(
  $kib-asset-icon-multi-option-selected
)) !default;

Description

Multiselect option highlight selected background image

Type

Color

Used by

caret-right-position

$caret-right-position: kib-core-dimensions-get(small) !default;

Description

Multiselect caret right position

Type

Number

Used by

spinner-position

$spinner-position: kib-core-px-to-relative(1px) !default;

Description

Multiselect spinner position

Type

Number

Used by

spinner-width

$spinner-width: kib-core-px-to-relative(48px) !default;

Description

Multiselect spinner width

Type

Number

Used by

spinner-height

$spinner-height: kib-core-px-to-relative(35px) !default;

Description

Multiselect spinner height

Type

Number

Used by

spinner-background-color

$spinner-background-color: kib-core-theme-get('fair') !default;

Description

Multiselect spinner background color

Type

Color

Used by

spinner-pseudo-margin

$spinner-pseudo-margin: -1 * kib-core-dimensions-get(small) !default;

Description

Multiselect spinner pseudo margin

Type

Number

Used by

spinner-pseudo-dimensions

$spinner-pseudo-dimensions: kib-core-dimensions-get(default) !default;

Description

Multiselect spinner pseudo dimensions

Type

Number

Used by

spinner-pseudo-border-width

$spinner-pseudo-border-width: kib-core-px-to-relative(2px) !default;

Description

Multiselect spinner pseudo border width

Type

Number

Used by

spinner-pseudo-border-color

$spinner-pseudo-border-color: kib-core-px-to-relative(2px) !default;

Description

Multiselect spinner pseudo border color

Type

Color

Used by

spinner-pseudo-shadow-offset

$spinner-pseudo-shadow-offset: #41b883 !default;

Description

Multiselect spinner pseudo box shadow offset

Type

Color

Used by

current-line-height

$current-line-height: kib-core-dimensions-get(default) !default;

Description

Multiselect current line height

Type

Number

current-min-height

$current-min-height: kib-core-px-to-relative(40px) !default;

Description

Multiselect current min height

Type

Number

Used by

current-border-radius

$current-border-radius: kib-core-dimensions-get(tiny) !default;

Description

Multiselect current border radius

Type

Number

Used by

current-border-width

$current-border-width: kib-core-px-to-relative(1px) !default;

Description

Multiselect current border width

Type

Number

Used by

current-border-color

$current-border-color: #e8e8e8 !default;

Description

Multiselect current border color

Type

Color

Used by

current-padding-right

$current-padding-right: kib-core-px-to-relative(30px) !default;

Description

Multiselect current padding right

Type

Number

Used by

select-line-height

$select-line-height: kib-core-dimensions-get(default) !default;

Description

Multiselect select padding right

Type

Number

select-width

$select-width: kib-core-px-to-relative(40px) !default;

Description

Multiselect select width

Type

Number

Used by

select-height

$select-height: kib-core-px-to-relative(38px) !default;

Description

Multiselect select height

Type

Number

Used by

select-position

$select-position: kib-core-px-to-relative(1px) !default;

Description

Multiselect select position

Type

Number

Used by

select-pseudo-text-color

$select-pseudo-text-color: kib-core-theme-get('text', 'surface') !default;

Description

Multiselect select pseudo text color

Type

Color

Used by

select-pseudo-border-width

$select-pseudo-border-width: kib-core-px-to-relative(5px) !default;

Description

Multiselect select pseudo border width

Type

Number

Used by

placeholder-text-color

$placeholder-text-color: #adadad !default;

Description

Multiselect placeholder text color

Type

Color

placeholder-margin-bottom

$placeholder-margin-bottom: kib-core-px-to-relative(10px) !default;

Description

Multiselect placeholder margin bottom

Type

Number

Used by

placeholder-padding-top

$placeholder-padding-top: kib-core-px-to-relative(2px) !default;

Description

Multiselect placeholder padding top

Type

Number

Used by

wrapper-left-position

$wrapper-left-position: -1 * kib-core-px-to-relative(2px) !default;

Description

Multiselect wrapper left position

Type

Number

Used by

wrapper-width

$wrapper-width: kib-core-dimensions-get(tiny) !default;

Description

Multiselect wrapper width

Type

Number

Used by

wrapper-min-height

$wrapper-min-height: (kib-core-dimensions-get(small) * 2 + kib-core-type-line-height(base) * 1rem) *
  2 !default;

Description

Multiselect wrapper min height

Type

Number

Used by

wrapper-max-height

$wrapper-max-height: kib-core-px-to-relative(240px) !default;

Description

Multiselect wrapper max height

Type

Number

Used by

wrapper-border-width

$wrapper-border-width: kib-core-px-to-relative(2px) !default;

Description

Multiselect wrapper border width

Type

Number

Used by

wrapper-border-radius

$wrapper-border-radius: kib-core-dimensions-get(tiny) !default;

Description

Multiselect wrapper border radius

Type

Number

Used by

option-pseudo-map

$option-pseudo-map: (
  before: (
    z-index: 1,
    top: $option-before-top-position,
    left: $option-before-left-position,
    width: $option-before-dimensions,
    height: $option-before-dimensions
  ),
  after: (
    z-index: 2,
    top: $option-after-top-position,
    left: $option-after-left-position,
    width: $option-after-dimensions,
    height: $option-after-dimensions
  )
);

Description

Multiselect option pseudo properties map

Type

Map

Used by

spinner-pseudo-map

$spinner-pseudo-map: (
  before: (
    animation-function: cubic-bezier(0.41, 0.26, 0.2, 0.62)
  ),
  after: (
    animation-function: cubic-bezier(0.51, 0.09, 0.21, 0.8)
  )
);

Description

Multiselect spinner pseudo properties map

Type

Map

Used by

select-properties-map

$select-properties-map: (
  current: (
    line-height: $current-line-height
  ),
  select: (
    line-height: $select-line-height
  )
);

Description

Multiselect select properties map

Type

Map

Used by

form-password

mixins

toggle

@mixin toggle() { ... }

Description

Generates styles for the password toggle

Parameters

None.

Requires

form-radio

mixins

label-radio

@mixin label-radio($size) { ... }

Description

Generate radio styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

label-radio-is-checked

@mixin label-radio-is-checked($size) { ... }

Description

Generate radio checked styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

container-is-small

@mixin container-is-small() { ... }

Description

Generate small container styles.

Parameters

None.

label-base

@mixin label-base() { ... }

Description

Generate base label styles.

Parameters

None.

label

@mixin label() { ... }

Description

Generate label styles.

Parameters

None.

radio-outer-is-focused

@mixin radio-outer-is-focused($size) { ... }

Description

Generate radio outer focused state styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

form-range

functions

kib-form-range-get-fill

@function kib-form-range-get-fill($lowerFill, $upperFill) { ... }

Description

Calculate the fill color of the range

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$lowerFill

The color of the lower fill

Color none
$upperFill

The color of the upper fill

Color none

Requires

Used by

mixins

range-track

@mixin range-track($fill) { ... }

Description

Generate styles for range's track

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$fill noneNumber none

Requires

range-fill

@mixin range-fill() { ... }

Description

Generate styles for range's fill

Parameters

None.

Requires

range-fill-disabled

@mixin range-fill-disabled($fill) { ... }

Description

Generate styles for range's fill when disabled

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$fill noneNumber none

Requires

range-thumb

@mixin range-thumb() { ... }

Description

Generate styles for range's thumb

Parameters

None.

Requires

Used by

range-thumb-focused

@mixin range-thumb-focused() { ... }

Description

Generate styles for range's thumb when focused

Parameters

None.

Requires

Used by

range-thumb-disabled

@mixin range-thumb-disabled() { ... }

Description

Generate styles for range's thumb when disabled

Parameters

None.

Requires

variables

height

$height: kib-core-px-to-relative(8px);

Description

Range's track height.

Type

Number

Used by

thumb-size

$thumb-size: kib-core-px-to-relative(24px);

Description

Range's thumb size.

Type

Number

Used by

color

$color: kib-core-theme-get('link', 'base');

Description

Range's primary color

Type

Color

grey-color

$grey-color: kib-core-theme-get('text', 'surface');

Description

Range's secondary color.

Type

Color

Used by

fill-color

$fill-color: kib-core-theme-get('link', 'base');

Description

Range's primary fill color

Type

Color

Used by

fill-grey-color

$fill-grey-color: kib-core-theme-get('outline', 'base');

Description

Range's secondary fill color

Type

Color

Used by

form-select

mixins

control-ms-value

@mixin control-ms-value() { ... }

Description

Generate control ms-value styles for the select

Parameters

None.

control-moz-focusring

@mixin control-moz-focusring() { ... }

Description

Generate control moz-focusring styles for the select

Parameters

None.

form-switch

variables

sizes

$sizes: default, small;

Description

Generate styles depending on the specified size: default, small

@param {String} $size

mixins

container

@mixin container() { ... }

Description

Container styles

Parameters

None.

container-size

@mixin container-size() { ... }

Description

Container styles for variant sizes

Parameters

None.

Requires

container-is-start

@mixin container-is-start() { ... }

Description

Container styles for variant sizes when label is first

Parameters

None.

container-is-end

@mixin container-is-end() { ... }

Description

Container styles for variant sizes when label is at the end

Parameters

None.

Requires

label

@mixin label() { ... }

Description

Label styles for variant sizes

Parameters

None.

label-is-disabled

@mixin label-is-disabled() { ... }

Description

Label styles for switch disabled state

Parameters

None.

label-is-start

@mixin label-is-start() { ... }

Description

Switch variant styles when label is first

Parameters

None.

label-is-spaced-apart

@mixin label-is-spaced-apart() { ... }

Description

Switch label is space apart from the switch (only when switch starts with label first)

Parameters

None.

switch-is-start

@mixin switch-is-start() { ... }

Description

Switch itself when the label placement is at 'start'

Parameters

None.

control

@mixin control() { ... }

Description

Control styles for variant sizes

Parameters

None.

control-size

@mixin control-size() { ... }

Description

Control styles for variant sizes

Parameters

None.

Requires

label-has-error

@mixin label-has-error() { ... }

Description

Label styles for switch disabled variant

Parameters

None.

Requires

global

mixins

base-styles

@mixin base-styles() { ... }

Description

Base styles

Parameters

None.

Requires

variables

root-font

$root-font: map.get($kib-core-type-weights, regular)
  list.slash(
    math.div(kib-core-theme-get('font', 'base', 'size'), 16px) * 100%,
    kib-core-type-line-height(base)
  )
  #{kib-core-theme-get('font', 'base', 'family')} !default;

Description

Root font

Type

List</code> or <code>Number

Used by

root-minmedium-line-height

$root-minmedium-line-height: kib-core-type-line-height(small) !default;

Description

Root line height for min-medium media query

Type

Number

Used by

body-font-size

$body-font-size: kib-core-get-type-property(base, size) !default;

Description

Body font size

Type

Number

Used by

list-padding-right

$list-padding-right: kib-core-dimensions-get(default, em) !default;

Description

List padding right

Type

Number

Used by

list-padding-left

$list-padding-left: kib-core-dimensions-get(large, em) !default;

Description

List padding left

Type

Number

Used by

listitem-margin-bottom

$listitem-margin-bottom: kib-core-dimensions-get(small, em) !default;

Description

List item margin bottom

Type

Number

Used by

description-list-padding-horizontal

$description-list-padding-horizontal: kib-core-dimensions-get(default, em) !default;

Description

Description list padding horizontal

Type

Number

Used by

description-term-font-weight

$description-term-font-weight: map.get($kib-core-type-weights, medium) !default;

Description

Description term font weight

Type

Number

Used by

nested-list-margin-top

$nested-list-margin-top: kib-core-dimensions-get(small, em) !default;

Description

Nested List margin top

Type

Number

Used by

nested-list-padding-left

$nested-list-padding-left: kib-core-dimensions-get(default, em) !default;

Description

Nested List padding left

Type

Number

Used by

small-font-size

$small-font-size: kib-core-get-type-property(
  micro,
  size,
  (
    base: 16px,
    inline: true
  )
) !default;

Description

Small tag font size

Type

Number

Used by

italic-font-style

$italic-font-style: italic !default;

Description

Italic font style

Type

Number

Used by

bold-font-weight

$bold-font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Bold font weight

Type

Number

Used by

table-border-width

$table-border-width: kib-core-px-to-relative(1px) !default;

Description

Table border width

Type

Number

Used by

table-border-color

$table-border-color: kib-core-theme-get('outline', 'form') !default;

Description

Table border color

Type

Color

Used by

table-border-width

$table-border-width: kib-core-px-to-relative(1px) !default;

Description

Table border width

Type

Number

caption-padding-vertical

$caption-padding-vertical: kib-core-dimensions-get(small, em) !default;

Description

Caption vertical padding

Type

Number

Used by

caption-padding-horizontal

$caption-padding-horizontal: kib-core-dimensions-get(small) !default;

Description

Caption horizontal padding

Type

Number

Used by

table-header-font-weight

$table-header-font-weight: map.get($kib-core-type-weights, medium) !default;

Description

Table header font weight

Type

Number

Used by

table-header-background-color

$table-header-background-color: kib-core-theme-get('background', 'header') !default;

Description

Table header background color

Type

Color

Used by

code-padding-horizontal

$code-padding-horizontal: kib-core-dimensions-get(tiny, em) !default;

Description

Code tag horizontal padding

Type

Number

Used by

code-padding

$code-padding: kib-core-dimensions-get(small, em) !default;

Description

Pre tag padding

Type

Number

Used by

code-font-family

$code-font-family: kib-core-theme-get('font', 'monospace', 'family') !default;

Description

Code font family

Type

String

Used by

code-background-color

$code-background-color: kib-core-theme-get('outline') !default;

Description

Code background color

Type

Color

Used by

blockquote-font-size

$blockquote-font-size: map.get(kib-core-get-type-size(giant), size) * 2 !default;

Description

Blockquote font size

Type

Number

Used by

blockquote-font-size-minmedium

$blockquote-font-size-minmedium: map.get(kib-core-get-type-size(epic), size) * 2 !default;

Description

Blockquote font size for min-medium media query

Type

Number

Used by

blockquote-padding-horizontal

$blockquote-padding-horizontal: kib-core-dimensions-get(large) + kib-core-dimensions-get(tiny) !default;

Description

Blockquote horizontal padding

Type

Number

Used by

blockquote-before-text-color

$blockquote-before-text-color: kib-core-theme-get('outline') !default;

Description

Blockquote before text color

Type

Color

Used by

blockquote-padding-horizontal-minmedium

$blockquote-padding-horizontal-minmedium: kib-core-dimensions-get(huge) +
  kib-core-dimensions-get(tiny) !default;

Description

Blockquote horizontal padding for min-medium media query

Type

Number

Used by

helpers

mixins

box-sizing

@mixin box-sizing() { ... }

Description

Set box sizing to include padding and borders in the dimensions of an element.

Parameters

None.

box-sizing-reset

@mixin box-sizing-reset() { ... }

Description

Reset element box sising to default.

Parameters

None.

clearfix

@mixin clearfix() { ... }

Description

Ensure an element's bottom edge clears all of its content.

Parameters

None.

Example

.container {
  @include kib-helpers-clearfix;
}

clearfix-reset

@mixin clearfix-reset() { ... }

Description

Disable a previously added clearfix.

Parameters

None.

Example

.container {
  @include kib-helpers-clearfix-reset;
}

container

@mixin container($padding: null, $padding: all) { ... }

Description

Add common styles between card containers and rows

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$padding

Spacing alias name

Stringnull
$padding

Spacing direction alias

Stringall

Requires

dropshadow

@mixin dropshadow($preset, $inset: false) { ... }

Description

Apply a dropshadow preset to an element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset

The name of a preset from $kib-helpers-dropshadow-presets to use.

String none
$inset

If true, the shadow will be inset on the element.

Booleanfalse

Example

Use small for elements laying directlyon the page.

.element {
  @include kib-helpers-dropshadow(small);
}

Use medium for elements that are overlayed, but not blocking. Examples like tooltips and popovers.

.element-overlayed {
  @include kib-helpers-dropshadow(medium);
}

Use large for blocking elements like modals.

.element-blocking {
  @include kib-helpers-dropshadow(large);
}

Set the $inset argument to true on any preset to givethe appearance of a sunken element.

.element-sunk {
  @include kib-helpers-dropshadow(medium, true);
}

Requires

fontface

@mixin fontface($family, $name, $weight: 400, $style: normal, $path: "/static/fonts/") { ... }

Description

Define a new webfont

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$family

Sets the name to be used for the font-family property.

String none
$name

The name of the file sans suffix to be referenced.

String none
$weight

The weight to be represented by this declaration.

Number400
$style

The style type to be used.

Stringnormal
$path

Where your webfont files will be located.

String"/static/fonts/"

media-query

@mixin media-query($preset, $extend: null) { ... }

Description

Wrap styles in a media query using a preset definition.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset

The id of the query preset to use.

String none
$extend

Optionally extend the preset with extra definitions.

Null or List or Stringnull

Requires

overflow

@mixin overflow($type: visible, $direction: all) { ... }

Description

Apply overflow properties to an element.

This mixin will apply overflow properties to elements. It is recommended to use this mixin instead of adding the property directly to your styles. Eventually this mixin will be used to apply extra visual affordances to styles and allow for easy resettign of existing styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type

Select the type of overflow value. This matches the values for the overflow properties (visible, auto, hidden, scroll).

Stringvisible
$direction

Select the direction in which overflow should be applied.. Available options are "all", "horizontal", or "vertical".

Stringall

Example

Apply overflow to an element.

.element {
  // Set overflow to `visible`.
  @include overflow;
  @include overflow(visible);
  @include overflow(visible, all);
  @include overflow(visible, horizontal);
  @include overflow(visible, vertical);
  // Set overflow to `auto`.
  @include overflow(auto);
  @include overflow(auto, all);
  @include overflow(auto, horizontal);
  @include overflow(auto, vertical);
  // Set overflow to `hidden`.
  @include overflow(hidden);
  @include overflow(hidden, all);
  @include overflow(hidden, horizontal);
  @include overflow(hidden, vertical);
  // Set overflow to `scroll`.
  @include overflow(scroll);
  @include overflow(scroll, all);
  @include overflow(scroll, horizontal);
  @include overflow(scroll, vertical);
}

Used by

overflow-reset

@mixin overflow-reset() { ... }

Description

Reset a scroll lock on an element to default behavior.

Parameters

None.

Example

Prevent a body element from scrolling in all directions.

body {
  @include overflow-reset;
}

Requires

scroll-shadow

@mixin scroll-shadow($background: theme.get('fair')) { ... }

Description

Add scroll shadows to an element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$background

Set the background element of the element that he scrolling shadow is being applied to.

Colortheme.get('fair')

Requires

spacing

@mixin spacing($type, $size: default, $direction: all) { ... }

Description

Set padding or margin on an element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type

Identifies the type of spacing. This is either margin or padding.

String (padding or Margin) none
$size

A string identifier for a value in $dimensions or "auto". When not auto, the mixin will try to pull from dimension storage.

Stringdefault
$direction

Sets the position of the spacing. all will add the spacing on all four sides. top and bottom will add spacing on the top and bottom, respectively. start and end will add spacing on the left and right, respectively. vertical will add spacing for both the top and bottom sides. horizontal will add spacing for both left and right sides.

String (all or Top or End or Bottom or Start or Vertical or Horizontal)all

Requires

supports-flex

@mixin supports-flex() { ... }

Description

Declare styles for modern browsers that support flexbox.

Parameters

None.

Example

Create flex styles and fallback styles.

.sidebar {
  @include kib-helpers-supports-flex-legacy {
    float: left;
  }
  @include kib-helpers-supports-flex {
    @include kib-helpers-supports-reset {
      float: none;
    }
    flex: 1 1 30%;
  }
}

When $kib-helpers-supports-legacy is true...

.sidebar {
  float: left;
  @supports (display: flex) {
    float: none;
    flex: 1 1 30%;
  }
}

When $kib-helpers-supports-legacy is false...

.sidebar {
  flex: 1 1 30%;
}

When $kib-helpers-supports-legacy-debug is true...

.sidebar {
  float: left;
}

Requires

supports-flex-legacy

@mixin supports-flex-legacy() { ... }

Description

Declare fallback styles for legacy browsers that do not support flexbox.

This is to be used in conjuction with the supports-flex mixin and should be used before it in source order. When $kib-helpers-supports-flex-legacy is set to false, the styles this mixin wraps will not be output.

Parameters

None.

See

supports-reset

@mixin supports-reset() { ... }

Description

Declare styles to reset legacy defaults for flexbox supporting browsers.

This is to be used within the context of the kib-helpers-supports-flex mixin and should only be used when reseting styles set with the kib-helpers-supports-flex-legacy mixin.

When $kib-helpers-supports-flex-legacy is set to false, the contents of the mixin will not be output.

Parameters

None.

See

visually-hidden

@mixin visually-hidden() { ... }

Description

Hide text an element visually, but still allow screen readers to read it.

Parameters

None.

visually-hidden-reset

@mixin visually-hidden-reset() { ... }

Description

Reset visibly hidden text.

Parameters

None.

variables

border-width

$border-width: conversions.px-to-relative(
  $kib-container-border-dimension
) !default;

Description

Size of the container border.

Type

Number

Used by

border-radius

$border-radius: dimensions.get(tiny) !default;

Description

Radius of the container border.

Type

Number

Used by

text-color

$text-color: theme.get('text') !default;

Description

Text color of container content.

Type

Color

presets

$presets: (
  small: (
    x-offset: 0,
    y-offset: conversions.px-to-relative(1px),
    blur: 0,
    spread: 0,
    color: rgba(theme.get('slate'), $kib-helpers-dropshadow-opacity)
  ),
  medium: (
    x-offset: 0,
    y-offset: conversions.px-to-relative(3px),
    blur: conversions.px-to-relative(5px),
    spread: 0,
    color: rgba(theme.get('slate'), $kib-helpers-dropshadow-opacity)
  ),
  large: (
    x-offset: 0,
    y-offset: conversions.px-to-relative(5px),
    blur: conversions.px-to-relative(10px),
    spread: 0,
    color: rgba(theme.get('slate'), $kib-helpers-dropshadow-opacity)
  )
) !default;

Description

Drop shadow preset definitions.

Type

Map

Map structure

Map key NameMap key DescriptionMap key TypeMap key Value
small

Used for general elements that do not overlap other elements

Map none
small.x-offset noneNumber0
small.y-offset noneNumberkib-core-px-to-relative(1px)
small.blur noneNumberkib-core-px-to-relative(1px)
small.spread noneNumber0
small.color noneColorrgba(kib-core-theme-get('slate'), $kib-helpers-dropshadow-opacity)
medium

Used for elements that overlay parts of the page, but are non-blocking.

Map none
medium.x-offset noneNumber0
medium.y-offset noneNumberkib-core-px-to-relative(3px)
medium.blur noneNumberkib-core-px-to-relative(5px)
medium.spread noneNumber0
medium.color noneColorrgba(kib-core-theme-get('slate'), $kib-helpers-dropshadow-opacity)
large

Used on overlaying page-blocking elements such as modals

Map none
large.x-offset noneNumber0
large.y-offset noneNumberkib-core-px-to-relative(5px)
large.blur noneNumberkib-core-px-to-relative(10px)
large.spread noneNumber0
large.color noneColorrgba(kib-core-theme-get('slate'), $kib-helpers-dropshadow-opacity)

Used by

light-background-color

$light-background-color: kib-core.theme-get('fair') !default;

Description

Light Background Color

Type

Color

white-text-color

$white-text-color: kib-core.theme-get('fair') !default;

Description

White text Color

Type

Color

body-text-color

$body-text-color: kib-core.theme-get('text') !default;

Description

Body text Color

Type

Color

secondary-text-color

$secondary-text-color: kib-core.theme-get('text', 'secondary') !default;

Description

Secondary text Color

Type

Color

light-text-color

$light-text-color: kib-core.theme-get('text', 'surface') !default;

Description

Secondary text Color

Type

Color

dark-background-color

$dark-background-color: kib-core.theme-get('text') !default;

Description

Dark Background Color

Type

Color

black-text-color

$black-text-color: kib-core.theme-get('slate') !default;

Description

Black text Color

Type

Color

dark-text-color

$dark-text-color: kib-core.theme-get('fair') !default;

Description

Dark text Color

Type

Color

warning-background-color

$warning-background-color: kib-core.theme-get('notice') !default;

Description

Warning Background Color

Type

Color

Used by

warning-text-color

$warning-text-color: kib-core.theme-get('notice') !default;

Description

Warning Text Color

Type

Color

Used by

success-background-color

$success-background-color: kib-core.theme-get('success') !default;

Description

Success Background Color

Type

Color

Used by

success-text-color

$success-text-color: kib-core.theme-get('success') !default;

Description

Success Text Color

Type

Color

Used by

error-background-color

$error-background-color: kib-core.theme-get('error') !default;

Description

Error Background Color

Type

Color

Used by

error-text-color

$error-text-color: kib-core.theme-get('error') !default;

Description

Error text Color

Type

Color

blue-background-color

$blue-background-color: kib-core.theme-get('link') !default;

Description

Blue Background Color

Type

Color

blue-text-color

$blue-text-color: kib-core.theme-get('link') !default;

Description

Blue Text Color

Type

Color

dark-blue-background-color

$dark-blue-background-color: kib-core.theme-get('link', 'deep') !default;

Description

Dark Blue Background Color

Type

Color

dark-blue-text-color

$dark-blue-text-color: kib-core.theme-get('fair') !default;

Description

Dark Blue text Color

Type

Color

teal-background-color

$teal-background-color: kib-core.theme-get('dignify') !default;

Description

Teal Background Color

Type

Color

container-background-color

$container-background-color: kib-core.theme-get('background', 'container') !default;

Description

Default Container Background Color

Type

Color

page-background-color

$page-background-color: kib-core.theme-get('background') !default;

Description

Default Page Background Color

Type

Color

hero-slider

mixins

root

@mixin root() { ... }

Description

Hero slider root element styles

Parameters

None.

root-container

@mixin root-container() { ... }

Description

Hero slider root container styles

Parameters

None.

ratio-element

@mixin ratio-element() { ... }

Description

Hero slider aspect ratio element

Parameters

None.

slides-container

@mixin slides-container() { ... }

Description

Hero slider aspect ratio element

Parameters

None.

slide

@mixin slide() { ... }

Description

Hero slide element

Parameters

None.

tablist

@mixin tablist() { ... }

Description

Hero slider tablist container

Parameters

None.

Requires

tablist-noncollapsible

@mixin tablist-noncollapsible() { ... }

Description

Hero slider tablist container for noncollapsible tabs

Parameters

None.

Requires

tablist-active

@mixin tablist-active() { ... }

Description

Hero slider tablist container when active

Parameters

None.

Requires

tab

@mixin tab() { ... }

Description

Hero slider tab dot

Parameters

None.

Requires

tab-active

@mixin tab-active() { ... }

Description

Hero slider tab dot when active

Parameters

None.

Requires

control

@mixin control() { ... }

Description

Hero arrow control

Parameters

None.

Requires

control-prev

@mixin control-prev() { ... }

Description

Hero previous arrow control

Parameters

None.

Requires

control-next

@mixin control-next() { ... }

Description

Hero next arrow control

Parameters

None.

Requires

control-icon

@mixin control-icon($control-selector) { ... }

Description

Hero control arrow icon

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$control-selector

Selector class for hero control element

String none

Requires

control-icon-prev

@mixin control-icon-prev() { ... }

Description

Hero control prev arrow icon

Parameters

None.

Requires

control-icon-next

@mixin control-icon-next() { ... }

Description

Hero control next arrow icon

Parameters

None.

Requires

slide-react-transition

@mixin slide-react-transition() { ... }

Description

Custom slide React transition

Parameters

None.

Requires

TODO's

  • Remove once there is a React transition component

slide-vue-transition

@mixin slide-vue-transition() { ... }

Description

Custom slide Vue transition for <transition /> component

Parameters

None.

Requires

variables

control-background

$control-background: transparent !default;

Description

Hero control default background color

Type

List

Used by

control-color

$control-color: kib-core-theme-get('fair') !default;

Description

Hero control default color

Type

Color

Used by

control-emphasis-color

$control-emphasis-color: $control-color !default;

Description

Hero control color on hover/focus

Type

Color

Used by

control-emphasis-border-width

$control-emphasis-border-width: kib-core-px-to-relative(2px) !default;

Description

Hero control border width on hover/focus

Type

Number

Used by

control-emphasis-border-color

$control-emphasis-border-color: kib-core-theme-get('link') !default;

Description

Hero control border color on hover/focus

Type

Color

Used by

control-emphasis-prev-background

$control-emphasis-prev-background: linear-gradient(
  to left,
  rgba(#000, 0) 0%,
  rgba(#000, 0.15) 100%
) !default;

Description

Hero 'previous' control background on hover/focus

Type

List

Used by

control-emphasis-next-background

$control-emphasis-next-background: linear-gradient(
  to right,
  rgba(#000, 0) 0%,
  rgba(#000, 0.15) 100%
) !default;

Description

Hero 'next' control background on hover/focus

Type

List

Used by

control-width

$control-width: kib-core-dimensions-get('huge') !default;

Description

Hero control default width

Type

Number

Used by

control-width-medium

$control-width-medium: kib-core-dimensions-get('huge') * 1.5 !default;

Description

Hero control width on medium screens

Type

Number

Used by

control-width-large

$control-width-large: kib-core-dimensions-get('huge') * 3 !default;

Description

Hero control width on large screens

Type

Number

Used by

control-icon-size

$control-icon-size: kib-core-dimensions-get('huge') !default;

Description

Hero control icon default size

Type

Number

Used by

control-icon-size-large

$control-icon-size-large: kib-core-dimensions-get('large') * 3 !default;

Description

Hero control icon size on larger screens

Type

Number

Used by

control-icon-offset

$control-icon-offset: kib-core-dimensions-get('default') !default;

Description

Hero control icon offset away from the hero edges on huge screens

Type

Number

Used by

control-icon-offset-giant

$control-icon-offset-giant: kib-core-dimensions-get('large') !default;

Description

Hero control icon offset away from the hero edges on giant screens

Type

Number

Used by

tablist-background-color

$tablist-background-color: kib-core-theme-get('fair') !default;

Description

Hero tablist background color

Type

Color

Used by

tablist-border-radius

$tablist-border-radius: kib-core-dimensions-get('tiny') !default;

Description

Hero tablist border-radius

Type

Number

Used by

tablist-active-outline-color

$tablist-active-outline-color: kib-core-theme-get('link') !default;

Description

Hero tablist outline color when active

Type

Color

Used by

tablist-active-outline-width

$tablist-active-outline-width: kib-core-dimensions-get('tiny') !default;

Description

Hero tablist outline width when active

Type

Number

Used by

tablist-noncollapsible-spacing

$tablist-noncollapsible-spacing: kib-core-px-to-relative(6px) !default;

Description

Hero noncollapsible tablist spacing

Type

Number

Used by

tab-background-color

$tab-background-color: transparent !default;

Description

Hero tab background color

Type

Color

Used by

tab-border-width

$tab-border-width: kib-core-px-to-relative(1px) !default;

Description

Hero tab border width

Type

Number

Used by

tab-border-color

$tab-border-color: kib-core-theme-get('link', 'deep') !default;

Description

Hero tab default border color

Type

Color

Used by

tab-hover-border-color

$tab-hover-border-color: kib-core-theme-get('warning') !default;

Description

Hero tab border color on hover

Type

Color

Used by

tab-active-background-color

$tab-active-background-color: kib-core-theme-get('link', 'deep') !default;

Description

Hero tab background color when active

Type

Color

Used by

tab-spacing

$tab-spacing: kib-core-dimensions-get('tiny') !default;

Description

Spacing between each hero slider tab dot

Type

Number

Used by

tab-size

$tab-size: kib-core-px-to-relative(10px) !default;

Description

Hero tab dot size

Type

Number

Used by

slide-transition-duration

$slide-transition-duration: 600ms !default;

Description

Hero slide transition duration

Type

Number

Used by

slide-transition-timing

$slide-transition-timing: ease-in-out !default;

Description

Hero slide transition timing function

Type

String

Used by

listbox

mixins

root-container

@mixin root-container() { ... }

Description

Root container

Parameters

None.

Requires

hidden

@mixin hidden() { ... }

Description

Closed listbox

Parameters

None.

options

@mixin options() { ... }

Description

Option container

Parameters

None.

status

@mixin status() { ... }

Description

Status bar at the top of listbox

Parameters

None.

Requires

no-results

@mixin no-results() { ... }

Description

No results message

Parameters

None.

Requires

item

@mixin item() { ... }

Description

Listbox item container

Parameters

None.

Requires

item-active

@mixin item-active() { ... }

Description

Highlighted/selected item

Parameters

None.

Requires

Used by

item-hover

@mixin item-hover() { ... }

Description

Hovered item

Parameters

None.

Requires

checkbox

@mixin checkbox() { ... }

Description

Checkbox

Parameters

None.

Requires

checkbox-fill

@mixin checkbox-fill() { ... }

Description

Checkbox fill

Parameters

None.

selected-checkbox

@mixin selected-checkbox() { ... }

Description

Selected checkbox

Parameters

None.

selected-checkbox-fill

@mixin selected-checkbox-fill() { ... }

Description

Selected checkbox fill

Parameters

None.

variables

background-color

$background-color: color.get('field', 'primary') !default;

Description

background-color

loader

mixins

common

@mixin common() { ... }

Description

Default styles for a loader.

Parameters

None.

Requires

background-style

@mixin background-style($name) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the type style to generate the style for.

String none

Requires

Used by

background-margins

@mixin background-margins($name) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the type style to generate the style for.

String none

Requires

Used by

small-style

@mixin small-style() { ... }

Description

Styles for small loader

Parameters

None.

Requires

screen

@mixin screen() { ... }

Description

Styles for loader screen

Parameters

None.

Requires

section

@mixin section() { ... }

Description

Styles for loader section

Parameters

None.

Requires

background

@mixin background() { ... }

Description

Styles for loader background

Parameters

None.

Requires

holder

@mixin holder() { ... }

Description

Styles for content holder

Parameters

None.

Requires

message

@mixin message() { ... }

Description

Styles for loader message

Parameters

None.

hidden

@mixin hidden() { ... }

Description

Styles for hidden loader

Parameters

None.

variables

indexes

$indexes: kib-core-zindex-set(kib-loader, 10000);

Description

Set z-index of fullscreen loader

zindex

$zindex: kib-core-zindex-get(kib-loader) !default;

Description

z-index of fullscreen loader

Type

Number

Used by

background

$background: rgba(0, 0, 0, 0.2) !default;

Description

Loader spinner background color

Type

Color

Used by

foreground

$foreground: kib-core-theme-get('link', 'deep') !default;

Description

Loader spinner foreground color

Type

Color

Used by

width

$width: kib-core-px-to-relative(2px) !default;

Description

Loader spinner stroke width

Type

Color

Used by

spacing-vertical

$spacing-vertical: kib-core-px-to-relative(60px) !default;

Description

Loader vertical spacing

Type

Number

Used by

button-background

$button-background: $background !default;

Description

Button loader background color

Type

Color

button-foreground

$button-foreground: kib-core-theme-get('fair') !default;

Description

Button loader foreground color

Type

Color

Used by

section-background

$section-background: rgba(kib-core-theme-get('fair'), 0.6) !default;

Description

Section loader background color

Type

Color

Used by

screen-background

$screen-background: rgba(kib-core-theme-get('fair'), 0.6) !default;

Description

Fullscreen loader background color

Type

Color

Used by

screen-holder-background

$screen-holder-background: kib-core-theme-get('fair') !default;

Description

Fullscreen loader holder background color

Type

Color

Used by

screen-holder-radius

$screen-holder-radius: kib-core-dimensions-get(tiny) !default;

Description

Fullscreen loader holder corner radius

Type

Number

Used by

placeholder-background

$placeholder-background: rgba(kib-core-theme-get('text', 'surface'), 0.5) !default;

Description

Placeholder loader background color

Type

Color

Used by

placeholder-radius

$placeholder-radius: kib-core-px-to-relative(3px) !default;

Description

Placeholder loader corner radius

Type

Number

Used by

dark-screen-background

$dark-screen-background: rgba(kib-core-theme-get('slate'), 0.6) !default;

Description

Fullscreen dark loader background color

Type

Color

dark-screen-holder-border-color

$dark-screen-holder-border-color: kib-core-theme-get('outline') !default;

Description

Fullscreen dark loader holder border color

Type

Color

dark-screen-holder-border-width

$dark-screen-holder-border-width: kib-core-px-to-relative(1px) !default;

Description

Fullscreen dark loader holder border-width

Type

Number

dark-screen-holder-shadow

$dark-screen-holder-shadow: kib-core-px-to-relative(0 5px 10px)
  rgba(kib-core-theme-get('slate'), 0.5) !default;

Description

Fullscreen dark loader holder box shadow

Type

Shadow

size-large

$size-large: kib-core-px-to-relative(40px) !default;

Description

Size when the loader is large.

Type

Number

Used by

size-small

$size-small: kib-core-px-to-relative(20px) !default;

Description

Size when the loader is small.

Type

Number

Used by

screen-holder-offset

$screen-holder-offset: -1 * ($size-small + kib-core-dimensions-get(default) * 2) * 0.5 !default;

Description

Fullscreen loader holder offset

Type

Number

message-max-dimensions

$message-max-dimensions: 2 * kib-core-dimensions-get(default) !default;

Description

Message max dimensions.

Type

Number

Used by

message-width

$message-width: kib-core-px-to-relative(326px) !default;

Description

Message max width.

Type

Number

Used by

media-figure

mixins

base-styles

@mixin base-styles() { ... }

Description

Media figure base element styles

Parameters

None.

caption-styles

@mixin caption-styles() { ... }

Description

Media figure caption element styles

Parameters

None.

Requires

caption-hide

@mixin caption-hide() { ... }

Description

Media figure caption hide styles

Parameters

None.

variables

caption-color

$caption-color: kib-core-theme-get('ash', 'surface') !default;

Description

Figure caption color

Type

Color

Used by

media-icon

mixins

common

@mixin common() { ... }

Description

Common styles for any icon root container.

Parameters

None.

svg-common

@mixin svg-common() { ... }

Description

Common styles for all icon svg elements.

Parameters

None.

generate-size

@mixin generate-size($size, $block) { ... }

Description

Generate styles for an icon size variant.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

icon size

String none
$block

root class of parent block element

String none

generate-position

@mixin generate-position($direction, $justify, $align) { ... }

Description

Generate styles for an icon position variant.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$direction

The main axis of the icon and label. Can be row, row-reverse, column, or column-reverse.

String none
$justify

The alignment along the main axis for icon and label.

String none
$align

The alignment along the cross axis for icon and label.

String none

Used by

generate-label-size

@mixin generate-label-size($label-size) { ... }

Description

Generate styles for an icon label size variant.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$label-size

The general size of the label font. This will be a key in the $kib-type-sizes map.

String none

Requires

Used by

icon-image

@mixin icon-image() { ... }

Description

Icon image styles

Parameters

None.

media-styles

@mixin media-styles() { ... }

Description

Actual media element styles

Parameters

None.

label-styles

@mixin label-styles() { ... }

Description

Icon label styles

Parameters

None.

Requires

vertical-center-styles

@mixin vertical-center-styles($label-selector) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$label-selector

selector class of label element

String none

Requires

vertical-styles

@mixin vertical-styles($label-selector) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$label-selector

selector class of label element

String none

Requires

vertical-center-reverse-styles

@mixin vertical-center-reverse-styles($label-selector) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$label-selector

selector class of label element

String none

Requires

vertical-reverse-styles

@mixin vertical-reverse-styles($label-selector) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$label-selector

selector class of label element

String none

Requires

reverse-styles

@mixin reverse-styles($label-selector) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$label-selector

selector class of label element

String none

Requires

center-reverse-styles

@mixin center-reverse-styles($label-selector) { ... }

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$label-selector

selector class of label element

String none

Requires

variables

sizes

$sizes: small, large, huge, huger, giant;

Description

Definitions of size variants for icons.

Type

List

label-sizes

$label-sizes: micro, medium, large, giant, huge, epic;

Description

Definitions of size variants for icon labels.

Type

List

media-image

mixins

base-styles

@mixin base-styles() { ... }

Description

Media image base element styles

Parameters

None.

hide-image

@mixin hide-image() { ... }

Description

Media image hide styles

Parameters

None.

loader-wrapper

@mixin loader-wrapper() { ... }

Description

Media image loader wrapper styles

Parameters

None.

loader-styles

@mixin loader-styles() { ... }

Description

Media image loader styles

Parameters

None.

caption-hidden

@mixin caption-hidden() { ... }

Description

Media image caption styles

Parameters

None.

figure-styles

@mixin figure-styles() { ... }

Description

Figure element styles

Parameters

None.

resize

@mixin resize() { ... }

Description

Image resize styles

Parameters

None.

object-fit

@mixin object-fit() { ... }

Description

Image object fit styles

Parameters

None.

fade-react-transitions

@mixin fade-react-transitions() { ... }

Description

Custom classes for React component animation

Parameters

None.

TODO's

  • Remove once there is a React transition component

message

mixins

root

@mixin root() { ... }

Description

Root container styles

Parameters

None.

container

@mixin container() { ... }

Description

Styles for message container

Parameters

None.

Requires

state-success

@mixin state-success() { ... }

Description

Styles for success message variant

Parameters

None.

Requires

state-error

@mixin state-error() { ... }

Description

Styles for error message variant

Parameters

None.

Requires

state-warning

@mixin state-warning() { ... }

Description

Styles for warning message variant

Parameters

None.

Requires

content

@mixin content() { ... }

Description

Styles for message content

Parameters

None.

Requires

title

@mixin title() { ... }

Description

Styles for message title

Parameters

None.

Requires

description

@mixin description() { ... }

Description

Styles for message title

Parameters

None.

icon

@mixin icon() { ... }

Description

Styles for message icon

Parameters

None.

compact

@mixin compact() { ... }

Description

Styles for compact variant

Parameters

None.

compact-title

@mixin compact-title() { ... }

Description

Styles for compact message title

Parameters

None.

Requires

compact-description

@mixin compact-description() { ... }

Description

Styles for compact message description

Parameters

None.

variables

background-color

$background-color: kib-core-theme-get('link', 'messageBackground') !default;

Description

Default background color

Type

Color

border-color

$border-color: kib-core-theme-get('link', 'deep') !default;

Description

Default border color

Type

Color

Used by

border-width

$border-width: kib-core-px-to-relative(1px) !default;

Description

Default border width

Type

Number

border-radius

$border-radius: kib-core-dimensions-get(tiny) !default;

Description

Default border radius

Type

Number

text-color

$text-color: kib-core-theme-get('text') !default;

Description

Default text color

Type

Color

success-background-color

$success-background-color: kib-core-theme-get('success', 'messageBackground') !default;

Description

Success background color

success-text-color

$success-text-color: kib-core-theme-get('success') !default;

Description

color for the success message

Type

Color

error-background-color

$error-background-color: kib-core-theme-get('error', 'messageBackground') !default;

Description

background color for the error message

Type

Color

error-text-color

$error-text-color: kib-core-theme-get('error') !default;

Description

color for the error message

Type

Color

warning-background-color

$warning-background-color: kib-core-theme-get('warning', 'messageBackground') !default;

Description

background color for the warning message

Type

Color

warning-text-color

$warning-text-color: kib-core-theme-get('warning', 'surface') !default;

Description

color for the warning message

Type

Color

title-icon-dimensions

$title-icon-dimensions: kib-core-dimensions-get(large) !default;

Description

Title message icon dimensions

Type

Number

title-font-weight

$title-font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Title message font weight

Type

Number

content-font-weight

$content-font-weight: map.get($kib-core-type-weights, regular) !default;

Description

Message content font weight

Type

Number

Used by

compact-title-right-spacing

$compact-title-right-spacing: kib-core-px-to-relative(2px) !default;

Description

compact title right spacing

Type

Number

Used by

notification

variables

padding-left

$padding-left: kib-core-dimensions-get(large) + kib-core-dimensions-get(small);

Description

Left padding for notification title

Type

Number

icon-top-position

$icon-top-position: -1 * kib-core-px-to-relative(1px);

Description

Icon top position

Type

Number

pagination

mixins

list-wrapper

@mixin list-wrapper() { ... }

Description

Pagination list styles.

Parameters

None.

list-item

@mixin list-item($block) { ... }

Description

Pagination list item styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

nav-item

@mixin nav-item($block) { ... }

Description

Pagination control item styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

nav-item-chirp

@mixin nav-item-chirp($block) { ... }

Description

Pagination control item styles in Chirp theme

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

nav-item-with-arrow

@mixin nav-item-with-arrow($block) { ... }

Description

Pagination control item with arrow (next/previous).

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

nav-item-with-arrow-chirp

@mixin nav-item-with-arrow-chirp($block) { ... }

Description

Pagination control item with arrow (next/previous) in Chirp theme.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

arrow-svg-icon

@mixin arrow-svg-icon() { ... }

Description

Pagination control arrow icon styles.

Parameters

None.

Requires

ellipsis-item

@mixin ellipsis-item($block) { ... }

Description

Pagination ellipsis item styles.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

ellipsis-item-chirp

@mixin ellipsis-item-chirp($block) { ... }

Description

Pagination ellipsis item styles in Chirp.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

sr-status

@mixin sr-status() { ... }

Description

Pagination status text for screen readers.

Parameters

None.

nav-item-disabled

@mixin nav-item-disabled() { ... }

Description

Pagination item disabled state styles.

Parameters

None.

Requires

nav-item-disabled-chirp

@mixin nav-item-disabled-chirp() { ... }

Description

Pagination item disabled state styles in Chirp.

Parameters

None.

Requires

nav-item-active

@mixin nav-item-active() { ... }

Description

Pagination item active state styles.

Parameters

None.

Requires

nav-item-active-chirp

@mixin nav-item-active-chirp() { ... }

Description

Pagination item active state styles in Chirp.

Parameters

None.

compact-content

@mixin compact-content($block) { ... }

Description

Helper mixin to add overrides for compact modifier and small breakpoint

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Used by

variables

item-font-size

$item-font-size: kib-core-get-type-property(base, size) !default;

Description

Text font size of pagination controls

Type

Number

item-font-weight

$item-font-weight: map.get($kib-core-type-weights, regular) !default;

Description

Font weight of pagination controls

Type

String

item-text-color

$item-text-color: kib-core-theme-get('link', 'deep') !default;

Description

Default text color of pagination controls

Type

Color

Used by

item-background-color

$item-background-color: kib-core-theme-get('fair') !default;

Description

Default background color of pagination controls

Type

Color

Used by

item-border-color

$item-border-color: kib-core-theme-get('outline') !default;

Description

Default border color of pagination controls

Type

Color

item-border-color-chirp

$item-border-color-chirp: kib-core-theme-get('next', 'neutral', 'minimal') !default;

Description

Default border color of pagination controls for Chirp

Type

Color

Used by

item-border-radius

$item-border-radius: kib-core-px-to-relative(4px) !default;

Description

Border radius of pagination controls

Type

Number

Used by

item-border-width

$item-border-width: kib-core-px-to-relative(1px) !default;

Description

Border width of pagination controls

Type

Number

item-background-color-hover

$item-background-color-hover: $item-background-color !default;

Description

Background color of pagination controls on hover/focus

Type

Color

item-border-color-hover

$item-border-color-hover: kib-core-theme-get('link', 'deep') !default;

Description

Default border color of pagination controls

Type

Color

Used by

item-text-color-hover

$item-text-color-hover: kib-core-theme-get('link', 'deep') !default;

Description

Default text color of pagination controls

Type

Color

Used by

item-background-color-disabled

$item-background-color-disabled: $item-background-color !default;

Description

Default background color of disabled controls in pagination

Type

Color

Used by

item-border-color-disabled

$item-border-color-disabled: $item-border-color !default;

Description

Default border color of disabled controls in pagination

Type

Color

Used by

item-border-color-disabled-chirp

$item-border-color-disabled-chirp: $item-border-color-chirp !default;

Description

Default border color of disabled controls in pagination for Chirp

Type

Color

Used by

item-text-color-disabled

$item-text-color-disabled: kib-core-theme-get('outline') !default;

Description

Default color of disabled controls text in pagination

Type

Color

Used by

item-text-color-disabled-chirp

$item-text-color-disabled-chirp: kib-core-theme-get('next', 'neutral', 'low') !default;

Description

Default color of disabled controls text in pagination for Chirp

Type

Color

Used by

item-background-color-active

$item-background-color-active: kib-core-theme-get('link', 'deep') !default;

Description

Background color of active control in pagination

Type

Color

Used by

item-border-color-active

$item-border-color-active: kib-core-theme-get('link', 'deep') !default;

Description

Border color of active control in pagination

Type

Color

Used by

item-text-color-active

$item-text-color-active: kib-core-theme-get('fair') !default;

Description

Text color of active control in pagination

Type

Color

Used by

ellipsis-text-color

$ellipsis-text-color: kib-core-theme-get('ash', 'surface') !default;

Description

Text color of in-between pages indicator in pagination

Type

Color

Used by

ellipsis-font-size

$ellipsis-font-size: kib-core-get-type-property(tiny, size) !default;

Description

Text size of in-between pages indicator in pagination

Type

Color

Used by

arrow-size

$arrow-size: kib-core-dimensions-get('default') !default;

Description

The size of the arrow element in pagination

Type

Number

Used by

pill

mixins

default

@mixin default() { ... }

Description

Base styles for a default pill and color variants Variant names taken from settings.$colors map

Parameters

None.

Requires

large

@mixin large() { ... }

Description

Large pill variant styles

Parameters

None.

Requires

filled

@mixin filled($block) { ... }

Description

Filled pill variant styles with color variants

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

filter

@mixin filter($control-selector) { ... }

Description

Filter pill variant styles

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$control-selector

custom selector for inner pill control

String none

Requires

disabled

@mixin disabled() { ... }

Description

Disabled pill styles

Parameters

None.

Requires

has-control

@mixin has-control() { ... }

Description

Pill with control variant styles

Parameters

None.

Requires

control

@mixin control() { ... }

Description

Pill control base styles

Parameters

None.

Requires

control-large

@mixin control-large() { ... }

Description

Large pill control styles

Parameters

None.

control-item

@mixin control-item($block) { ... }

Description

Pill control item styles with color variants

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

control-item-large

@mixin control-item-large() { ... }

Description

Large pill control item

Parameters

None.

Requires

control-item-filter

@mixin control-item-filter() { ... }

Description

Filter pill control item

Parameters

None.

Requires

variables

font-family

$font-family: kib-core-theme-get('font', 'base', 'family') !default;

Description

Pill font family.

Type

String

font-size

$font-size: kib-core-px-to-relative(13px) !default;

Description

Pill font size.

Type

Number

font-weight

$font-weight: map.get($kib-core-type-weights, regular) !default;

Description

Pill font weight.

Type

Number

line-height

$line-height: kib-core-type-line-height(small) !default;

Description

Pill line height

Type

Number

Used by

background-color

$background-color: kib-core-theme-get('fair') !default;

Description

Pill background color

Type

Color

border

$border: kib-core-theme-get('ash', 'surface') !default;

Description

Pill border color

Type

Color

Used by

border-width

$border-width: kib-core-px-to-relative(2px) !default;

Description

Pill border width

Type

Number

margin-vertical

$margin-vertical: kib-core-px-to-relative(2px) !default;

Description

Pill vertical margin

Type

Number

Used by

padding-vertical

$padding-vertical: kib-core-px-to-relative(2px) !default;

Description

Pill vertical padding

Type

Number

padding-horizontal

$padding-horizontal: kib-core-dimensions-get(tiny) !default;

Description

Pill horizontal padding

Type

Number

text-color

$text-color: kib-core-theme-get('ash', 'surface') !default;

Description

Pill text color

Type

Color

border-radius

$border-radius: kib-core-dimensions-get(tiny) !default;

Description

Pill border radius

Type

Number

control-font-size

$control-font-size: 1em !default;

Description

Pill control font size

Type

Number

Used by

control-margin-start

$control-margin-start: kib-core-px-to-relative(5px) !default;

Description

Pill control left margin

Type

Number

Used by

control-margin-vertical

$control-margin-vertical: -1 * kib-core-px-to-relative(9px) !default;

Description

Pill control vertical margin

Type

Number

Used by

control-min-height

$control-min-height: kib-core-px-to-relative(5px, $inline: true) +
  kib-core-type-line-height(micro) !default;

Description

Pill control min height

Type

Number

Used by

control-item-margin-top

$control-item-margin-top: -1 * kib-core-px-to-relative(1px) !default;

Description

Pill control item top margin

Type

Number

Used by

control-item-padding-vertical

$control-item-padding-vertical: kib-core-dimensions-get(tiny) !default;

Description

Pill control item vertical padding

Type

Number

Used by

control-item-padding-horizontal

$control-item-padding-horizontal: kib-core-dimensions-get(small) !default;

Description

Pill control item horizontal padding

Type

Number

Used by

control-item-border-width

$control-item-border-width: kib-core-px-to-relative(1px) !default;

Description

Pill control item border width

Type

Number

Used by

control-item-large-line-height

$control-item-large-line-height: kib-core-get-type-property(
  large,
  height
) !default;

Description

Large Pill control item line height

Type

Number

Used by

control-item-filter-background-color

$control-item-filter-background-color: kib-core-theme-get(
  'link',
  'deepest'
) !default;

Description

Filter Pill control item background color

Type

Color

Used by

large-font-size

$large-font-size: kib-core-get-type-property(base, size) !default;

Description

Large pill font size

Type

Number

Used by

large-line-height

$large-line-height: kib-core-get-type-property(large, height) !default;

Description

Large pill line height

Type

Number

Used by

filled-text

$filled-text: kib-core-theme-get('fair') !default;

Description

Filled pill text color

Type

Color

Used by

filter-background-color

$filter-background-color: kib-core-theme-get('link', 'deep') !default;

Description

Filter pill background color

Type

Color

Used by

filter-text-color

$filter-text-color: kib-core-theme-get('text') !default;

Description

Filter pill text color

Type

Color

Used by

filter-control-text-color

$filter-control-text-color: kib-core-theme-get('fair') !default;

Description

Filter pill control color

Type

Color

Used by

disabled-background-color

$disabled-background-color: kib-core-theme-get('background', 'header') !default;

Description

Disabled pill background color

Type

Color

disabled-margin-horizontal

$disabled-margin-horizontal: kib-core-px-to-relative(6px) !default;

Description

Disabled pill horizontal margin

Type

Color

Used by

colors

$colors: (
  default: kib-core-theme-get('ash', 'surface'),
  primary: kib-core-theme-get('link', 'deep'),
  success: kib-core-theme-get('success'),
  error: kib-core-theme-get('error'),
  disabled: kib-core-theme-get('ash', 'surface'),
  tag: kib-core-theme-get('link', 'deep'),
  filter: kib-core-theme-get('link', 'deep')
) !default;

Description

Define border color, font color and hover state color for pills.

Type

Map

Map structure

Map key NameMap key DescriptionMap key TypeMap key Value
default noneString none
primary

deprecrated

String none
success noneString none
error noneString none
disabled noneString none
tag

deprecrated

String none
filter noneString none

Used by

popper

mixins

root-container

@mixin root-container() { ... }

Description

Styles for the component root container

Parameters

None.

content-container

@mixin content-container() { ... }

Description

Popper content container (popup) with modifiers

Parameters

None.

Requires

content-arrow

@mixin content-arrow() { ... }

Description

Popper arrow attached to content wrapper

Parameters

None.

Requires

close-button

@mixin close-button() { ... }

Description

Close icon wrapper element

Parameters

None.

Requires

close-icon

@mixin close-icon() { ... }

Description

Close icon SVG styles

Parameters

None.

Requires

content-transition

@mixin content-transition() { ... }

Description

Popper content open/close transition

Parameters

None.

TODO's

  • This style is just a placeholder until we have react transition component ready

variables

background-color

$background-color: $kib-container-background-default !default;

Description

Popper background color

Type

Color

border-color

$border-color: $kib-container-border-color !default;

Description

Popper border color

Type

Color

border-radius

$border-radius: $kib-core-container-border-radius !default;

Description

Popper border radius

Type

Number

border-width

$border-width: kib-core-px-to-relative(
  $kib-container-border-dimension
) !default;

Description

Popper border width

Type

Number

text-color

$text-color: $kib-core-container-text-color !default;

Description

Popper text color

Type

Color

width-default

$width-default: kib-core-px-to-relative(224px) !default;

Description

Popper default maximum width

Type

Number

Used by

width-large

$width-large: kib-core-px-to-relative(328px) !default;

Description

Large modifier maximum width

Type

Number

Used by

width-huge

$width-huge: kib-core-px-to-relative(480px) !default;

Description

Huge modifier maximum width

Type

Number

Used by

width-giant

$width-giant: kib-core-px-to-relative(960px) !default;

Description

Giant modifier maximum width

Type

Number

Used by

arrow-size

$arrow-size: kib-core-dimensions-get(large) !default;

Description

Popper arrow size. Equal height/width only.

Type

Number

z-index

$z-index: kib-core-zindex-get(kib-popper) !default;

Description

Popper stacking z-index

Type

Number

close-icon-color

$close-icon-color: currentColor !default;

Description

Popper close svg fill color

Type

Color

Used by

close-icon-size

$close-icon-size: kib-core-dimensions-get(default) !default;

Description

Popper close icon svg size

Type

Number

Used by

close-position

$close-position: kib-core-dimensions-get(small) !default;

Description

Popper close trigger position

Type

Number

Used by

progress

mixins

container

@mixin container() { ... }

Description

Root container of all progress bars.

Parameters

None.

Author

  • CDS

label

@mixin label() { ... }

Description

Progress bar label

Parameters

None.

Requires

Author

  • CDS

variables

color-default

$color-default: kib-core-theme-get('slate') !default;

Description

Color used for the default state

Type

Color

Used by

color-success

$color-success: kib-core-theme-get('success') !default;

Description

Color used for the success state

Type

Color

Used by

color-warn

$color-warn: kib-core-theme-get('warning') !default;

Description

Color used for the warn state

Type

Color

Used by

color-error

$color-error: kib-core-theme-get('error') !default;

Description

Color used for the error state

Type

Color

Used by

color-review

$color-review: kib-core-theme-get('warning', 'surface') !default;

Description

Color used for the review state

Type

Color

Used by

color-primary

$color-primary: kib-core-theme-get('link', 'base') !default;

Description

Color used for the primary state

Type

Color

Used by

color-accent

$color-accent: kib-core-theme-get('next', 'brand', 500) !default;

Description

Color used for the chirp component

Type

Color

Used by

progress-bar

functions

stop-size

@function stop-size($icon-size) { ... }

Description

Calculate the size of a stop based on its icon size

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$icon-size noneNumber (rem) none

Requires

Used by

mixins

display-wrapper

@mixin display-wrapper() { ... }

Description

Styles for the progressbar display wrapper.

Parameters

None.

progress

@mixin progress() { ... }

Description

Styles for the kib-progress-bar indicator container.

Parameters

None.

Requires

progress-small

@mixin progress-small() { ... }

Description

Styles for the kib-progress-bar small size.

Parameters

None.

Requires

progress-medium

@mixin progress-medium() { ... }

Description

Styles for the kib-progress-bar medium size.

Parameters

None.

Requires

Used by

progress-large

@mixin progress-large() { ... }

Description

Styles for the kib-progress-bar large size.

Parameters

None.

Requires

progress-has-stops

@mixin progress-has-stops() { ... }

Description

Styles for the kib-progress-bar with visible stops.

Parameters

None.

Requires

progress-accent

@mixin progress-accent() { ... }

Description

Styles for the accent kib-progress bar.

Parameters

None.

Requires

segment

@mixin segment() { ... }

Description

Styles for the kib-progress-bar segment.

Parameters

None.

indicator

@mixin indicator() { ... }

Description

Base styles for the kib-progress-bar indicator.

Parameters

None.

Requires

indicator-success

@mixin indicator-success() { ... }

Description

Styles for the kib-progress-bar success type.

Parameters

None.

Requires

indicator-warn

@mixin indicator-warn() { ... }

Description

Styles for the kib-progress-bar warn type.

Parameters

None.

Requires

indicator-error

@mixin indicator-error() { ... }

Description

Styles for the kib-progress-bar error type.

Parameters

None.

Requires

indicator-review

@mixin indicator-review() { ... }

Description

Styles for the kib-progress-bar error type.

Parameters

None.

Requires

indicator-primary

@mixin indicator-primary() { ... }

Description

Styles for the kib-progress-bar primary type.

Parameters

None.

Requires

indicator-accent

@mixin indicator-accent() { ... }

Description

Styles for the kib-progress-bar accent type.

Parameters

None.

Requires

indicator-accent-small

@mixin indicator-accent-small() { ... }

Description

Styles for the small kib-progress-bar accent type.

Parameters

None.

Requires

indicator-accent-medium

@mixin indicator-accent-medium() { ... }

Description

Styles for the medium kib-progress-bar accent type.

Parameters

None.

Requires

Used by

indicator-accent-large

@mixin indicator-accent-large() { ... }

Description

Styles for the large kib-progress-bar accent type.

Parameters

None.

Requires

stop-container

@mixin stop-container() { ... }

Description

Styles for the progressbar stops container.

Parameters

None.

stop

@mixin stop() { ... }

Description

Styles for the progressbar stop container.

Parameters

None.

stop-label

@mixin stop-label() { ... }

Description

Styles for the progressbar stop label.

Parameters

None.

Requires

stop-label-is-current

@mixin stop-label-is-current() { ... }

Description

Style for current stop.

Parameters

None.

Requires

stop-label-success

@mixin stop-label-success() { ... }

Description

Styles for a stop that is successful

Parameters

None.

Requires

stop-label-warn

@mixin stop-label-warn() { ... }

Description

Styles for a stop that is successful

Parameters

None.

Requires

stop-label-error

@mixin stop-label-error() { ... }

Description

Styles for a stop that is successful

Parameters

None.

Requires

stop-label-primary

@mixin stop-label-primary() { ... }

Description

Styles for a stop that is a primary

Parameters

None.

Requires

stop-fill

@mixin stop-fill() { ... }

Description

Styles for the progressbar stop fill.

Parameters

None.

Requires

stop-fill-success

@mixin stop-fill-success() { ... }

Description

Styles for the progressbar stop fill when the stop has success type.

Parameters

None.

Requires

stop-fill-success-without-icon

@mixin stop-fill-success-without-icon() { ... }

Description

Styles for the progressbar stop fill when the stop has success type, but no status icon.

Parameters

None.

Requires

stop-fill-warn

@mixin stop-fill-warn() { ... }

Description

Styles for the progressbar stop fill when the stop has warn type.

Parameters

None.

Requires

stop-fill-error

@mixin stop-fill-error() { ... }

Description

Styles for the progressbar stop fill when the stop has error type.

Parameters

None.

Requires

stop-fill-inactive

@mixin stop-fill-inactive() { ... }

Description

Styles for the progressbar stop fill when the stop is inactive.

Parameters

None.

Requires

stop-fill-primary

@mixin stop-fill-primary() { ... }

Description

Styles for the progressbar stop fill when the stop has warn type.

Parameters

None.

Requires

stop-icon

@mixin stop-icon() { ... }

Description

Styles for the progressbar stop icon.

Parameters

None.

stop-icon-small

@mixin stop-icon-small() { ... }

Description

Styles for small progressbar stop icon.

Parameters

None.

stop-icon-large

@mixin stop-icon-large() { ... }

Description

Styles for large progressbar stop icon.

Parameters

None.

value

@mixin value() { ... }

Description

Styles for the kib-progress-bar valuenow or valuetext.

Parameters

None.

size-has-stops

@mixin size-has-stops($size) { ... }

Description

Generate styles for a size variant when stops are displayed

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

stop-size

@mixin stop-size($size) { ... }

Description

Generate styles for a progressbar stop size variant

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

Requires

Used by

variables

size-small

$size-small: kib-core-dimensions-get(small) !default;

Description

Size for a small progress bar.

Type

Number (rem)

size-medium

$size-medium: kib-core-dimensions-get(default) !default;

Description

Size for a medium progress bar.

Type

Number (rem)

Used by

size-large

$size-large: kib-core-dimensions-get(large) !default;

Description

Size for a large progress bar.

Type

Number (rem)

border-width

$border-width: kib-core-dimensions-get(tiny) * 0.5 !default;

Description

Size for a progress bar border.

Type

Number (rem)

stop-padding

$stop-padding: kib-core-dimensions-get(tiny) !default;

Description

Space to reserve around a stop icon.

Type

Number (rem)

Used by

background-color

$background-color: kib-core-theme-get('outline') !default;

Description

Background color of progress bar

Type

Color

border-radius

$border-radius: kib-core-px-to-relative(3px) !default;

Description

Border radius of progress bar

Type

Number (rem)

accent-background-color

$accent-background-color: kib-core-theme-get('next', 'brand', 50) !default;

Description

Background color of accent progress bar

Type

Color

Used by

accent-small-border-radius

$accent-small-border-radius: $size-small !default;

Description

Border radius of small accent progress bar

Type

Number (rem)

Used by

accent-medium-border-radius

$accent-medium-border-radius: $size-medium !default;

Description

Border radius of medium accent progress bar

Type

Number (rem)

Used by

accent-large-border-radius

$accent-large-border-radius: $size-large !default;

Description

Border radius of accent progress bar

Type

Number (rem)

Used by

stop-label-font-size

$stop-label-font-size: kib-core-get-type-property(tiny, size) !default;

Description

Font size of progress bar stop label

Type

Number (rem)

Used by

stop-label-line-height

$stop-label-line-height: kib-core-type-line-height(tiny) !default;

Description

Line height of progress bar stop label

Type

Number (rem)

Used by

stop-label-text-color

$stop-label-text-color: kib-core-theme-get('text', 'surface') !default;

Description

Text color of progress bar stop label

Type

Color (rem)

Used by

stop-fill-background-color

$stop-fill-background-color: kib-core-theme-get('fair') !default;

Description

Background color of progress bar stop fill

Type

Color (rem)

Used by

current-stop-label-font-weight

$current-stop-label-font-weight: map.get($kib-core-type-weights, bold) !default;

Description

Font weight of current progress bar stop label

Type

Number

Used by

current-stop-label-text-color

$current-stop-label-text-color: kib-core-theme-get('text') !default;

Description

Text color of current progress bar stop label

Type

Color

Used by

stop-fill-success-text-color

$stop-fill-success-text-color: kib-core-theme-get('fair') !default;

Description

Text color of success stop fill

Type

Color

Used by

stop-fill-error-text-color

$stop-fill-error-text-color: kib-core-theme-get('fair') !default;

Description

Text color of error stop fill

Type

Color

Used by

stop-fill-inactive-text-color

$stop-fill-inactive-text-color: kib-core-theme-get('outline') !default;

Description

Text color of inactive stop fill

Type

Color

Used by

stop-fill-inactive-background-color

$stop-fill-inactive-background-color: kib-core-theme-get('fair') !default;

Description

Background color of inactive stop fill

Type

Color

Used by

background-gradient

$background-gradient: to right, transparent,
  transparent kib-core-dimensions-get(tiny),
  kib-core-theme-get('outline') kib-core-dimensions-get(tiny),
  kib-core-theme-get('outline')
    (kib-core-dimensions-get(small) + kib-core-dimensions-get(tiny)),
  transparent (kib-core-dimensions-get(small) + kib-core-dimensions-get(tiny)) !default;

Description

Background gradient of progress bar

Type

Color

Used by

sizes

$sizes: small, medium, large;

Description

Definitions of size variants for progress bar

Type

Map

progress-linear

Installation

  yarn add @chewy/kib-progress-styles

Import

  @use '~@chewy/kib-progress-styles/src/kib-progress-linear/styles' as kib-progress-linear;

mixins

container

@mixin container() { ... }

Description

Root container of all progress linear

Parameters

None.

label

@mixin label() { ... }

Description

Progress linear label

Parameters

None.

Requires

indicator

@mixin indicator() { ... }

Description

Base styles for the kib-progress-linear indicator.

Parameters

None.

Requires

value

@mixin value() { ... }

Description

Style for kib-progress-linear value

Parameters

None.

Requires

variables

height

$height: kib-core.dimensions-get(small) !default;

Description

Height of progress-linear

Type

Number (rem)

background-color

$background-color: color.get('action', 'switch', 'background', 'on', '03') !default;

Description

Background color for progress-linear indicator container

Type

Color

default-color

$default-color: color.get('action', 'switch', 'background', 'on', 'primary') !default;

Description

Default color for progress-linear indicator

Type

Color

Used by

border-radius

$border-radius: kib-core.dimensions-get(small) !default;

Description

Border radius of progress-linear

Type

Number (rem)

value-color

$value-color: color.get('text', 'secondary') !default;

Description

Text Color for progress-linear value

Type

Color

Used by

label-spacing

$label-spacing: spacing.get('s2') !default;

Description

Label Spacing of progress-linear

Type

Number (rem)

Used by

wrapper-spacing

$wrapper-spacing: spacing.get('s1') !default;

Description

Wrapper Spacing of progress-linear

Type

Number (rem)

indicator-spacing

$indicator-spacing: spacing.get('s2') !default;

Description

Indicator Spacing of progress-linear

Type

Number (rem)

progress-path

mixins

path

@mixin path() { ... }

Description

root progress path styles

Parameters

None.

step

@mixin step() { ... }

Description

root progress path step styles

Parameters

None.

Requires

step-completed

@mixin step-completed() { ... }

Description

completed step styles

Parameters

None.

Requires

step-active

@mixin step-active() { ... }

Description

active step styles

Parameters

None.

Requires

visibility-hidden

@mixin visibility-hidden() { ... }

Description

hide step text styles

Parameters

None.

visually-hidden

@mixin visually-hidden() { ... }

Description

visually hidden styles

Parameters

None.

variables

step-height

$step-height: spacing.get('s1') !default;

Description

Line height

Type

Number

Used by

incomplete-color

$incomplete-color: color.get('action', 'switch', 'background', 'on', '03') !default;

Description

Incomplete step color

Type

Color

Used by

complete-color

$complete-color: color.get('action', 'switch', 'background', 'on', 'primary') !default;

Description

Completed step color

Type

Color

Used by

dot-height

$dot-height: unit.rem(12px) !default;

Description

Step dot height

Type

Number

Used by

active-dot-height

$active-dot-height: spacing.get('s1') !default;

Description

Active step dot height

Type

Number

Used by

bar-margin

$bar-margin: unit.rem(-12px) !default;

Description

Spacing between label and the bar

Type

Number

Used by

progress-radial

mixins

generate-size

@mixin generate-size($size) { ... }

Description

Generate sizes for radial progress bars.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size

The name of the variant to generate styles for. This will be a key in the $kib-progress-radial-circle-sizes map.

String none

Requires

variables

size-medium

$size-medium: kib-core-dimensions-get(small) * 12 !default;

Description

Size of the medium variant radial

Type

Number (rem)

size-large

$size-large: kib-core-dimensions-get(small) * 16 !default;

Description

Size of the large variant radial

Type

Number (rem)

background-color

$background-color: kib-core-theme-get('background', 'header') !default;

Description

Color of the radial progress track

Type

Color

transition-duration

$transition-duration: 1s !default;

Description

Length of the radial change animation

Type

String

Used by

circle-sizes

$circle-sizes: (
  medium: (
    size: $size-medium
  ),
  large: (
    size: $size-large
  )
) !default;

Description

Definitions of size variants for radial progress bars.

Type

Map

Used by

quantity

mixins

root-container

@mixin root-container() { ... }

Description

Root container styles

Parameters

None.

Requires

count-wrapper

@mixin count-wrapper() { ... }

Description

Wrapper for the quantity value

Parameters

None.

Requires

action

@mixin action() { ... }

Description

Increment, decrement, and remove buttons

Parameters

None.

Requires

action-icon

@mixin action-icon() { ... }

Description

Icons within buttons

Parameters

None.

variables

min-width

$min-width: unit.rem(140px) !default;

Description

Min component width

Type

Number

Used by

base-padding

$base-padding: unit.rem(2px) !default;

Description

Base padding

Type

Number

Used by

base-border

$base-border: unit.rem(2px) !default;

Description

Base border

Type

Number

Used by

row

functions

item-selector-generate

@function item-selector-generate($type, $value, $selectors) { ... }

Description

Generate class selector extensions for row items.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$type

Thew type of class to be generated. This is normally one of "span", "pull", "push", "suffix", or "prefix".

String none
$value

The name of the specific selector being generated. This is normally related to a grid unit measurment.

String none
$selectors

(both | class | attribute) [both] Select the types of selectors default styles will have.

String none

Returns

String

Returns & prefixed selectors that are meant to be appended to a parent class designation.

Requires

mixins

container

@mixin container($id: default, $justify-content: flex-start, $align-content: flex-start, $inline: false, $query, $gutter: settings.$gutter) { ... }

Description

Generate styles for a row container.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$id noneStringdefault
$justify-content noneStringflex-start
$align-content noneStringflex-start
$inline noneBooleanfalse
$query

$query is a named query that can be used with the kib-core.media-query mixin

String none
$gutter noneNumbersettings.$gutter

Requires

item-span

@mixin item-span($preset, $query) { ... }

Description

Generate styles for a alternate width for a row item.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset noneString none
$query

$query is a named breakpoint found in $storage-queries

String none

Requires

Used by

item

@mixin item($preset: "1-1", $gutter: settings.$gutter, $query) { ... }

Description

Generate styles for a row item.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset noneString"1-1"
$gutter noneNumbersettings.$gutter
$query

$query is a named breakpoint found in $storage-queries

String none

Requires

item-pull

@mixin item-pull($preset, $query) { ... }

Description

Generate styles for shifting a row item toward the start of a line.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset noneString none
$query

$query is a named breakpoint found in $storage-queries

String none

Requires

item-push

@mixin item-push($preset, $query) { ... }

Description

Generate styles for shifting a row item toward the end of a line.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset noneString none
$query

$query is a named breakpoint found in $storage-queries

String none

Requires

item-prefix

@mixin item-prefix($preset, $query) { ... }

Description

Generate styles for prefixing a row item with a margin.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset noneString none
$query

$query is a named breakpoint found in $storage-queries

String none

Requires

item-suffix

@mixin item-suffix($preset, $query) { ... }

Description

Generate styles for suffixing a row item with a margin.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$preset noneString none
$query

$query is a named breakpoint found in $storage-queries

String none

Requires

variables

selectors

$selectors: both !default;

Description

Select the types of selectors default styles will have.

Type

String(both</code> or <code>Class</code> or <code>Attribute) [both]

Used by

debug

$debug: false !default;

Description

Turn on or off a visual debug background.

Type

Boolean [false]

Used by

gutter

$gutter: kib-core.dimensions-get(default) !default;

Description

Set the default space between row items.

Type

Number [kib-storage-dimensions-get(large)]

Used by

widths

$widths: (
  '1-12': math.div(100%, 12),
  '1-8': (
    100% * 0.125
  ),
  '2-12': (
    math.div(100%, 12) * 2
  ),
  '1-4': (
    100% * 0.25
  ),
  '1-3': math.div(100%, 3),
  '3-8': (
    100% * 0.125 * 3
  ),
  '5-12': (
    math.div(100%, 12) * 5
  ),
  '1-2': (
    100% * 0.5
  ),
  '7-12': (
    math.div(100%, 12) * 7
  ),
  '5-8': (
    100% * 0.125 * 5
  ),
  '2-3': (
    math.div(100%, 3) * 2
  ),
  '3-4': (
    100% * 0.25 * 3
  ),
  '10-12': (
    math.div(100%, 12) * 10
  ),
  '7-8': (
    100% * 0.125 * 7
  ),
  '11-12': (
    math.div(100%, 12) * 11
  ),
  '1-1': 100%
) !default;

Description

Defined width options for row items.

Type

Map

Used by

align-items

$align-items: (
  center: center,
  end: flex-end,
  start: flex-start,
  stretch: stretch,
  vertical: center
) !default;

Description

Defined align options for row items.

Type

Map

align-content

$align-content: (
  center: center,
  end: flex-end,
  start: flex-start,
  normal: normal,
  stretch: stretch,
  space-around: space-around,
  space-between: space-between,
  space-evenly: space-evenly
) !default;

Description

Defined justified content options for row items.

Type

Map

Used by

scroll

functions

theme-get

@function theme-get($name, $options: null) { ... }

Description

Get a theme definition

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

Theme defined in $scroll-theme

String none
$options

Theme overrides or new definition

Null or Mapnull

Returns

Map

Map of theme definitions

Requires

Used by

mixins

container

@mixin container($name, $options: null) { ... }

Description

Scroll container styles for all variants

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

Theme name defined in settings.$themes

String none
$options

Theme overrides or new definition

Null or Mapnull

Requires

covers

@mixin covers($name, $options: null) { ... }

Description

Scroll content styles for all variants

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

Theme name defined in settings.$themes

String none
$options

Theme overrides or new definition

Null or Mapnull

Requires

content

@mixin content() { ... }

Description

General styles for the scrolling content to make sure all is cleared

Parameters

None.

variables

themes

$themes: (
  light: (
    background: kib-core-theme-get('fair'),
    opacity: 0.2,
    shadow: kib-core-theme-get('slate'),
    size: 0.8rem
  ),
  neutral: (
    background: kib-core-theme-get('background', 'container'),
    opacity: 0.2,
    shadow: kib-core-theme-get('slate'),
    size: 0.8rem
  )
) !default;

Description

Define alternate themes

Type

Map

Map structure

Map key NameMap key DescriptionMap key TypeMap key Value
name

Theme definitions

Map none
name.background

Scrollable area background color

Color none
name.opacity

Shadow opacity level

Number none
name.shadow

Shadow color

Color none
name.size

Shadow size

Number none

theme-default

$theme-default: light !default;

Description

Set the default scroll theme

Type

String

Used by

skeleton-shape

mixins

shape

@mixin shape() { ... }

Description

Square shape skeleton with customizable aspect ratio through custom properties

Parameters

None.

Requires

shape-circle

@mixin shape-circle() { ... }

Description

Circle shape skeleton

Parameters

None.

skeleton-text

mixins

wrapper

@mixin wrapper() { ... }

Description

Text wrapper

Parameters

None.

line

@mixin line($size) { ... }

Description

Generate text skeleton line

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$size noneString none

length

@mixin length() { ... }

Description

Modifies text skeleton length

Parameters

None.

slider-carousel

star-rating

mixins

root-container

@mixin root-container() { ... }

Description

Styles for the component root container

Parameters

None.

hidden-label

@mixin hidden-label() { ... }

Description

Hidden text label container for accessibility

Parameters

None.

stars-wrapper

@mixin stars-wrapper() { ... }

Description

Wrapper for both empty and full stars groups

Parameters

None.

Requires

stars-common

@mixin stars-common() { ... }

Description

Common styles for empty and full stars groups

Parameters

None.

stars-full

@mixin stars-full() { ... }

Description

Styles for the full stars group only

Parameters

None.

star-svg-icon

@mixin star-svg-icon($block) { ... }

Description

Base svg star icon styles and various size modifiers

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none

Requires

count-wrapper

@mixin count-wrapper() { ... }

Description

Wrapper for count content

Parameters

None.

Requires

variables

brand

$brand: kib-core-theme-get('warning', 'surface') !default;

Description

Star rating icon color

Type

Color

Used by

size-default

$size-default: kib-core-dimensions-get('default') !default;

Description

Default star icon size

Type

Number

Used by

size-large

$size-large: kib-core-dimensions-get('large') !default;

Description

Large star icon size

Type

Number

count-text-color

$count-text-color: kib-core-theme-get('ash', 'surface') !default;

Description

Count text color

Type

Color

Used by

sticky

mixins

sticky

@mixin sticky() { ... }

Description

Sticky element styles

Parameters

None.

storage

functions

get

@function get($name, $raw: false) { ... }

Description

Retrieve a dimension value from the store.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the dimension to retrieve.

String none
$raw

Determine the unit type to return. false (default) will return a value using rem units, true will return px units.

Booleanfalse

Returns

Number(px) or Number(rem) or Null

Requires

set

@function set($name, $value) { ... }

Description

Add a value to the dimensions store.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name noneString none
$value noneNumber(px) none

Returns

Map

Requires

set

@function set($name) { ... }

Description

Add an entry for an existing placeholder.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the placeholder without the beginning %.

String none

Returns

Map

Returns the updated placeholder references.

Requires

exists

@function exists($name) { ... }

Description

Check if a placeholder exists.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the placeholder without the % to check for.

String none

Returns

Boolean

If there is a reference for the placeholder, true will be returned, otherwise false.

Requires

breakpoints-convert

@function breakpoints-convert() { ... }

Description

Make sure all registered breakpoints are formatted to rem units.

Parameters

None.

Returns

Map

Returns the modified $breakpoints values.

Requires

breakpoints-set

@function breakpoints-set($values) { ... }

Description

Make sure all registered breakpoints are formatted to rem units.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$values

A map of new breakpoint values to add.

Map none

Returns

Map

Returns the modified $breakpoints values.

Requires

set

@function set($name, $query) { ... }

Description

Set a query string.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The id to give to the new query preset.

String none
$query

The value of the new prest definition.

String none

Requires

get

@function get($name) { ... }

Description

Get a query string.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the preset to get from storage.

String none

Requires

extend

@function extend($name, $preset, $query) { ... }

Description

Extend an existing query definition.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The id of the new preset to be created.

String none
$preset

The id of the existing preset to merge into the new preset.

String none
$query

The new query to merge into the existing preset.

String or List none

Requires

set

@function set($name, $value) { ... }

Description

Add a value to the global z-index storage.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name/identifier for the z-index value to be added of overriden.

String none
$value

The z-index value to be stored for the $value.

Number none

Returns

Map

Returns the new map with additions and changes.

Example

Store z-index values.

// Set the z-index of the root component.
$index: zindex.set(component-name, 4);
// (base: 0, component-name: 4)

// Set the z-index of a component child.
$index: zindex.set(component-name__child, 5);
// (base: 0, component-name: 4, component-name__child: 5)

Requires

get

@function get($name) { ... }

Description

Get a value from the global z-index storage.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name/identifier of the z-index value to retrieve.

String none

Returns

Number or Boolean

Return the z-index value for $name if there is an entry. If there is no entry, false will be returned.

Example

Get z-index values.

// Get the z-index of the root component.
$index: zindex.get(component-name);
// 4

// Get the z-index of a component child.
$index: zindex.get(component-name__child);
// 5

Requires

increment-set

@function increment-set($name, $preset: base, $increment: 1) { ... }

Description

Set a z-index incremented from an existing values.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the z-index entry to be added.

String none
$preset

The name of the base z-index entry to be incremented.

Stringbase
$increment

The numerical increment step to increase $preset value.

Number1

Returns

Map or Boolean

If a value was able to be incremented, the new map of z-index values will be returned. If not, false will be returned.

Example

Set a z-index value based on another.

$index: zindex.increment-set(component);
// (base: 0, component: 1)

$index: zindex.increment-set(component__child, component);
// (base: 0, component: 1, component__child: 2)

$index: zindex.increment-set(component__overlay, component, 10);
// (base: 0, component: 1, component__child: 2, component__overlay: 11)

$index: zindex.increment-set(component__new, component__null);
// false

Requires

Used by

variables

[private] dimensions

$dimensions: (
  default: ($kib-storage-dimensions-base * 2),
  none: 0,
  tiny: ($kib-storage-dimensions-base * 0.5),
  small: $kib-storage-dimensions-base,
  large: ($kib-storage-dimensions-base * 3),
  huge: ($kib-storage-dimensions-base * 5),
  huger: ($kib-storage-dimensions-base * 6),
  giant: ($kib-storage-dimensions-base * 14),
);

Description

Define storage for all dimension entries along with defaults.

Type

Map

Map structure

Map key NameMap key DescriptionMap key TypeMap key Value
default noneNumber(px)$kib-storage-dimensions-base * 2
small noneNumber(px)$kib-storage-dimensions-base
large noneNumber(px)$kib-storage-dimensions-base * 3
huge noneNumber(px)$kib-storage-dimensions-base * 5
huger noneNumber(px)$kib-storage-dimensions-base * 6
giant noneNumber(px)$kib-storage-dimensions-base * 14

Used by

[private] placeholders

$placeholders: () !default;

Description

Storage for placeholders that exist.

This variable should not be accessed directly. See the placeholders-set() function for adding to the variable. To check if a value exists, see the placeholders-exists() function.

Type

List

Used by

queries

$queries: (
  'small': '<medium',
  'portrait-small': (
    '<medium',
    'portrait'
  ),
  'min-small': '>=small',
  'max-small': '<small',
  'medium': (
    '>=medium',
    '<large'
  ),
  'portrait-medium': (
    '>=medium',
    '<large',
    'portrait'
  ),
  'min-medium': (
    '>=medium'
  ),
  'portrait-min-medium': (
    '>=medium',
    'portrait'
  ),
  'max-large': (
    '<large'
  ),
  'portrait-max-large': (
    '<large',
    'portrait'
  ),
  'large': (
    '>=large',
    '<huge'
  ),
  'portrait-large': (
    '>=large',
    '<huge',
    'portrait'
  ),
  'min-large': '>=large',
  'portrait-min-large': (
    '>=large',
    'portrait'
  ),
  'max-huge': (
    '<huge'
  ),
  'portrait-max-huge': (
    '<huge',
    'portrait'
  ),
  'huge': (
    '>=huge',
    '<giant'
  ),
  'portrait-huge': (
    '>=huge',
    '<giant',
    'portrait'
  ),
  'min-huge': (
    '>=huge'
  ),
  'portrait-min-huge': (
    '>=huge',
    'portrait'
  ),
  'giant': '>=giant',
  'portrait-giant': (
    '>=giant',
    'portrait'
  )
);

Description

Global store for queries

This is a private global variable that should not be accessed diretly. Use the kib-storage-queries-set(), kib-storage-queries-get(), or kib-storage-queries-extend().

Map structure

key Namekey Descriptionkey Typekey Value
small noneString none
medium noneString none
large noneString none
huge noneString none
giant noneString none

Used by

[private] zindex

$zindex: (
  base: $kib-storage-zindex-base
);

Description

Initialize storage for z-index values.

This is a storage map. This variable should not be accessed directly, but instead be altered via updating zindex-base, and using the zindex-set() and kib-storage-zindex-get() functions.

Type

Map

table

mixins

cell-padding

@mixin cell-padding() { ... }

Description

Default table cell padding

Parameters

None.

Requires

cell-padding-large

@mixin cell-padding-large() { ... }

Description

Large table cell padding

Parameters

None.

Requires

cell-padding-compact

@mixin cell-padding-compact() { ... }

Description

Compact table cell padding

Parameters

None.

Requires

bordered-cell

@mixin bordered-cell() { ... }

Description

Bordered table cell

Parameters

None.

Requires

hovered-row

@mixin hovered-row() { ... }

Description

Hovered table row styles

Parameters

None.

Requires

full-width

@mixin full-width() { ... }

Description

Full width table

Parameters

None.

vertical

@mixin vertical() { ... }

Description

Vertical table

Parameters

None.

cell-highlight

@mixin cell-highlight() { ... }

Description

Table cell highlight

Parameters

None.

Requires

header-sort

@mixin header-sort() { ... }

Description

Sorted table header

Parameters

None.

header-sort-icon-wrapper

@mixin header-sort-icon-wrapper() { ... }

Description

Sorted table header icon

Parameters

None.

header-sort-button

@mixin header-sort-button() { ... }

Description

Sorted table header sort button

Parameters

None.

Requires

header-sort-icon

@mixin header-sort-icon() { ... }

Description

Sorted table header sort icon

Parameters

None.

Requires

header-sort-icon-active

@mixin header-sort-icon-active() { ... }

Description

Sorted table header sort icon while active

Parameters

None.

Requires

stripe-pattern

@mixin stripe-pattern($row: even, $highlight: odd, $selector: .kib-table) { ... }

Description

Generate stripe patterns for table.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$row noneStringeven
$highlight noneStringodd
$selector noneString.kib-table

Requires

variables

cell-highlight-background-color

$cell-highlight-background-color: #fff7ec !default;

Description

Table cell highlight background color

Type

Color

Used by

hovered-row-background-color

$hovered-row-background-color: kib-core-theme-get(
  'background',
  'header'
) !default;

Description

Hovered table row background color on hover

Type

Color

Used by

header-sort-icon-color

$header-sort-icon-color: kib-core-theme-get('text', 'surface') !default;

Description

Table header sort icon color

Type

Color

Used by

header-sort-icon-size

$header-sort-icon-size: kib-core-dimensions-get('small') !default;

Description

Table header sort icon size

Type

Number

Used by

header-sort-icon-active-color

$header-sort-icon-active-color: kib-core-theme-get('link') !default;

Description

Table header sort icon color when active

Type

Color

Used by

header-sort-padding-vertical

$header-sort-padding-vertical: kib-core-dimensions-get(small, em) !default;

Description

Table header sort padding vertical

Type

Number

Used by

header-sort-padding-horizontal

$header-sort-padding-horizontal: kib-core-dimensions-get(small) !default;

Description

Table header sort padding horizontal

Type

Number

Used by

header-sort-focus-outline-color

$header-sort-focus-outline-color: kib-core-theme-get('link') !default;

Description

Table header button color of focus outline

Type

Color

Used by

header-sort-focus-outline-width

$header-sort-focus-outline-width: kib-core-px-to-relative(2px) !default;

Description

Table header sort padding horizontal

Type

Number

Used by

header-sort-focus-outline-offset

$header-sort-focus-outline-offset: kib-core-px-to-relative(1px) !default;

Description

Table header sort padding horizontal

Type

Number

Used by

bordered-border-color

$bordered-border-color: kib-core-theme-get('outline', 'form') !default;

Description

Bordered table border color

Type

Color

Used by

bordered-border-width

$bordered-border-width: kib-core-px-to-relative(1px) !default;

Description

Bordered table border width

Type

Number

Used by

striped-row-background

$striped-row-background: kib-core-theme-get('background', 'container');

Description

Striped table row background color

Type

Color

Used by

striped-highlight-background

$striped-highlight-background: #fefcf7 !default;

Description

Striped table row highlight background color

Type

Color

Used by

cell-padding

$cell-padding: kib-core-dimensions-get(small, em) kib-core-dimensions-get(small) !default;

Description

Default table cell padding

Type

Number</code> or <code>List

Used by

cell-padding-large

$cell-padding-large: kib-core-dimensions-get(default, em)
  kib-core-dimensions-get(large) !default;

Description

Large table cell padding

Type

Number</code> or <code>List

Used by

cell-padding-compact

$cell-padding-compact: kib-core-dimensions-get(tiny, em)
  kib-core-dimensions-get(tiny) !default;

Description

Small table cell padding

Type

Number</code> or <code>List

Used by

tabs

mixins

bar-wrapper

@mixin bar-wrapper() { ... }

Description

Wrapper around bar of tab triggers

Parameters

None.

Requires

bar

@mixin bar() { ... }

Description

Horizontal bar of tab triggers

Parameters

None.

bar-item

@mixin bar-item() { ... }

Description

Wrapper around tab triggers

Parameters

None.

trigger

@mixin trigger() { ... }

Description

Tab trigger

Parameters

None.

Requires

trigger-small

@mixin trigger-small() { ... }

Description

Small tab trigger

Parameters

None.

Requires

variables

bar-background-color

$bar-background-color: kib-core-theme-get('background', 'container') !default;

Description

Default background color of tabs bar

Type

Color

Used by

bar-divider-color

$bar-divider-color: kib-core-theme-get('outline') !default;

Description

Color of border divider between tabs and content

Type

Color

Used by

bar-divider-width

$bar-divider-width: kib-core-px-to-relative(1px) !default;

Description

Border divider width between tabs and content

Type

Color

Used by

trigger-text-color

$trigger-text-color: kib-core-theme-get('text') !default;

Description

Text color of the tab label

Type

Color

Used by

trigger-font-family

$trigger-font-family: kib-core-theme-get('font', 'base', 'family') !default;

Description

Tab label font family

Type

String

Used by

trigger-font-size

$trigger-font-size: kib-core-get-type-property(base, size) !default;

Description

Tab label font size

Type

String

Used by

trigger-font-weight

$trigger-font-weight: $kib-type-weights-bold !default;

Description

Tab label font weight

Type

Number

Used by

trigger-line-height

$trigger-line-height: kib-core-get-type-property(base, height) !default;

Description

Tab label line height

Type

Number

Used by

trigger-selected-background-color

$trigger-selected-background-color: kib-core-theme-get('fair') !default;

Description

Background color of selected tab

Type

Color

Used by

trigger-selected-text-color

$trigger-selected-text-color: $trigger-text-color !default;

Description

Text color of the selected tab label

Type

Color

trigger-selected-emphasis-color

$trigger-selected-emphasis-color: kib-core-theme-get(
  'warning',
  'surface'
) !default;

Description

Color of the selected tab highlight

Type

Color

Used by

trigger-selected-emphasis-size

$trigger-selected-emphasis-size: kib-core-px-to-relative(3px) !default;

Description

Height of the selected tab highlight

Type

Number

Used by

trigger-emphasis-background-color

$trigger-emphasis-background-color: $trigger-selected-background-color !default;

Description

Background color of tab on hover/focus

Type

Color

Used by

trigger-emphasis-text-color

$trigger-emphasis-text-color: $trigger-text-color !default;

Description

Text color of tab on hover/focus

Type

Color

Used by

trigger-focus-outline-width

$trigger-focus-outline-width: kib-core-px-to-relative(1px) !default;

Description

Outline width of focused tabs trigger

Type

Number

Used by

trigger-spacing-vertical

$trigger-spacing-vertical: (kib-core-dimensions-get(default) * 1.1875) !default;

Description

Default tab vertical spacing

Type

Number

Used by

trigger-spacing-horizontal

$trigger-spacing-horizontal: (kib-core-dimensions-get(huge) * 1.25) !default;

Description

Default tab horizontal spacing

Type

Number

Used by

trigger-large-spacing-vertical

$trigger-large-spacing-vertical: (
  kib-core-dimensions-get(small) * 1.625
) !default;

Description

Large tab vertical spacing

Type

Number

Used by

trigger-large-spacing-horizontal

$trigger-large-spacing-horizontal: (
  kib-core-dimensions-get(large) * 1.25
) !default;

Description

Large tab horizontal spacing

Type

Number

Used by

trigger-small-spacing-vertical

$trigger-small-spacing-vertical: kib-core-dimensions-get(small) !default;

Description

Small tab vertical spacing

Type

Number

Used by

trigger-small-spacing-horizontal

$trigger-small-spacing-horizontal: kib-core-dimensions-get(large) !default;

Description

Small tab horizontal spacing

Type

Number

Used by

tag

mixins

tag-variant

@mixin tag-variant($variant) { ... }

Description

Variant styles

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$variant noneString none

Requires

secondary

@mixin secondary() { ... }

Description

Default secondary emphasis styles

Parameters

None.

Requires

secondary-variant

@mixin secondary-variant($variant) { ... }

Description

Secondary emphasis variant

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$variant noneString none

Requires

icon

@mixin icon() { ... }

Description

Icon styles

Parameters

None.

Requires

button

@mixin button() { ... }

Description

Button tag styles

Parameters

None.

Requires

button-hover

@mixin button-hover() { ... }

Description

Button tag on hover

Parameters

None.

Requires

button-focus

@mixin button-focus() { ... }

Description

Button tag on focus

Parameters

None.

button-variant

@mixin button-variant() { ... }

Description

Button tag variant

Parameters

None.

Requires

button-variant-hover

@mixin button-variant-hover() { ... }

Description

Button tag variant on hover

Parameters

None.

Requires

variables

text-color

$text-color: color.get('message', 'info', '04') !default;

Description

Default tag text color

Type

String

background-color

$background-color: color.get('message', 'info', '03') !default;

Description

Default tag background color

Type

String

hover-background-color

$hover-background-color: color.get('message', 'info', '06') !default;

Description

Tag background color on hover

Type

String

Used by

border-color

$border-color: color.get('message', 'info', '02') !default;

Description

Default tag border color

Type

String

border-width

$border-width: unit.rem(1px) !default;

Description

Border width

Type

Number

border-radius

$border-radius: unit.rem(3px) !default;

Description

todo: should be updated with tokens in the future NOTE: this is defaulting to enterprise values, should be fixed when using tokenss tag border radius

Type

Number

padding

$padding: spacing.get(0, 's3') !default;

Description

Padding spacing

Type

List

focus-border-radius

$focus-border-radius: unit.rem(4px) !default;

Description

todo: should be updated with tokens in the future NOTE: this is defaulting to enterprise values, should be fixed when using tokenss tag border radius

Type

Number

Used by

icon-size

$icon-size: unit.rem(16px) !default;

Description

icon size

Type

Number

icon-margin

$icon-margin: spacing.get(0, 0, 0, 's1') !default;

Description

icon margin

Type

List

Used by

background-color-secondary

$background-color-secondary: color.get('ui-bg', 'primary') !default;

Description

background color when secondary emphasis

Type

String

Used by

focus-border-distance

$focus-border-distance: unit.rem(-2px) !default;

Description

Focus border distance

Type

Number

Used by

focus-border-radius

$focus-border-radius: unit.rem(4px) !default;

Description

Focus border radius

Type

Number

focus-transition-duration

$focus-transition-duration: 100ms !default;

Description

Ease out timer

Type

Number

Used by

variant-states

$variant-states: (
  'caution': (
    'color': color.get('message', 'warning', '04'),
    'background-color': color.get('message', 'warning', '03'),
    'border-color': color.get('message', 'warning', '02'),
    'hover-background-color': color.get('message', 'warning', '06')
  ),
  'error': (
    'color': color.get('message', 'error', '04'),
    'background-color': color.get('message', 'error', '03'),
    'border-color': color.get('message', 'error', '02'),
    'hover-background-color': color.get('message', 'error', '06')
  ),
  'neutral': (
    'color': color.get('message', 'neutral', '04'),
    'background-color': color.get('message', 'neutral', '03'),
    'border-color': color.get('message', 'neutral', '02'),
    'hover-background-color': color.get('message', 'neutral', '06')
  ),
  'success': (
    'color': color.get('message', 'success', '04'),
    'background-color': color.get('message', 'success', '03'),
    'border-color': color.get('message', 'success', '02'),
    'hover-background-color': color.get('message', 'success', '06')
  )
);

Description

Variant themes map

Type

Map

Used by

tile

mixins

base

@mixin base() { ... }

Description

Base styles for the tile root container

Parameters

None.

Requires

gist

@mixin gist() { ... }

Description

Styles for the tile gist variant

Parameters

None.

no-header

@mixin no-header() { ... }

Description

Styles for the tile without a header displayed

Parameters

None.

disabled

@mixin disabled() { ... }

Description

Styles for when a tile is in a disabled state

Parameters

None.

header

@mixin header() { ... }

Description

Styles for the tile header content container

Parameters

None.

Requires

header-gist

@mixin header-gist() { ... }

Description

Styles for when a tile is in a disabled state

Parameters

None.

header-summary

@mixin header-summary() { ... }

Description

Styles for the tile summary variant.

Parameters

None.

Requires

title

@mixin title() { ... }

Description

Styles for the tile title

Parameters

None.

Requires

actions

@mixin actions() { ... }

Description

Styles for the tile actions container

Parameters

None.

action-item

@mixin action-item() { ... }

Description

Styles for an individual tile action

Parameters

None.

Requires

content-row

@mixin content-row() { ... }

Description

General styles for tile content containers

Parameters

None.

Used by

body

@mixin body() { ... }

Description

Styles for the tile body container

Parameters

None.

Requires

control

@mixin control() { ... }

Description

Styles for the tile control container

Parameters

None.

Requires

notation

@mixin notation() { ... }

Description

Styles for the tile notation

Parameters

None.

Requires

variables

border-color

$border-color: kib-core-theme-get('outline') !default;

Description

Color of the tile border.

Type

Color

border-size

$border-size: $kib-core-container-border-width !default;

Description

Size of the tile border.

Type

Number

action-item-text-color

$action-item-text-color: kib-core-theme-get('link', 'deep') !default;

Description

Color of the tile actions

Type

Color

Used by

notation-color

$notation-color: kib-core-theme-get('text', 'surface') !default;

Description

Text color of the tile notation

Type

Color

Used by

notation-font-size

$notation-font-size: kib-core-get-type-property(tiny, size) !default;

Description

Font size of the tile notation

Type

Number

Used by

notation-line-height

$notation-line-height: kib-core-type-line-height(tiny) !default;

Description

Line height of the tile notation

Type

Number

Used by

transition-duration

$transition-duration: 0.5s !default;

Description

Transition duration for tile.

Type

Number

toast

variables

[private] _toast-registry

$_toast-registry: bootstrap.register(toast);

Description

Add storage elements before use.

Type

String

[private] _toast-zindex-registry

$_toast-zindex-registry: toast-zindex-set-bootstrap();

Description

Register toast z-index

Type

Boolean

container-max-width

$container-max-width: kib-core-px-to-relative(400px) !default;

Description

Max-width of toast container

Type

Number

Used by

container-wide-width

$container-wide-width: kib-core-px-to-relative(600px) !default;

Description

Width of wide container

Type

Number

Used by

container-wide-max-width

$container-wide-max-width: kib-core-dimensions-get(small) * 2 !default;

Description

Max-width of wide toast container

Type

Number

Used by

container-box-shadow

$container-box-shadow: kib-core-px-to-relative(-1px 0 3px 0)
    rgba(kib-core-theme-get('outline', 'form'), 0.3),
  kib-core-px-to-relative(1px 3px 3px 0)
    rgba(kib-core-theme-get('outline', 'form'), 0.3) !default;

Description

Box shadow of toast container

Type

Number

Used by

z-index

$z-index: kib-core-zindex-get(toast) !default;

Description

Stacking z-index value for all toasts

Type

Number

close-top-pos

$close-top-pos: kib-core-px-to-relative(4px) !default;

Description

Close button top position

Type

Number

Used by

close-button-dimensions

$close-button-dimensions: kib-core-px-to-relative(48px) !default;

Description

Close button dimensions

Type

Number

Used by

close-content-padding-right

$close-content-padding-right: kib-core-dimensions-get(large) * 1.5 !default;

Description

Close content padding right

Type

Number

Used by

close-icon-color

$close-icon-color: kib-message.$text-color !default;

Description

Close icon color

Type

Color

close-icon-dimensions

$close-icon-dimensions: kib-core-dimensions-get(default) !default;

Description

Close icon dimensions

Type

Number

Used by

functions

[private] toast-zindex-set-bootstrap

@function toast-zindex-set-bootstrap() { ... }

Description

Store the z-index value for toast

Parameters

None.

Returns

Boolean

Requires

mixins

root

@mixin root() { ... }

Description

Root container styles

Parameters

None.

Requires

vertical

@mixin vertical() { ... }

Description

Vertically positioned toast variant

Parameters

None.

top

@mixin top() { ... }

Description

Top positioned toast variant

Parameters

None.

bottom

@mixin bottom() { ... }

Description

Bottom positioned toast variant

Parameters

None.

top-right

@mixin top-right() { ... }

Description

Top right positioned toast variant

Parameters

None.

top-left

@mixin top-left() { ... }

Description

Top left positioned toast variant

Parameters

None.

bottom-right

@mixin bottom-right() { ... }

Description

Bottom right positioned toast variant

Parameters

None.

bottom-left

@mixin bottom-left() { ... }

Description

Bottom left positioned toast variant

Parameters

None.

container

@mixin container() { ... }

Description

Toast container

Parameters

None.

Requires

container-full-width

@mixin container-full-width() { ... }

Description

Full width toast container

Parameters

None.

container-wide

@mixin container-wide() { ... }

Description

Wide toast container

Parameters

None.

Requires

content-with-close

@mixin content-with-close() { ... }

Description

Styles for message toast content with visible close button

Parameters

None.

Requires

close-button

@mixin close-button() { ... }

Description

Styles for toast close button

Parameters

None.

Requires

close-icon

@mixin close-icon() { ... }

Description

Styles for toast close button icon

Parameters

None.

Requires

react-transition

@mixin react-transition() { ... }

Description

Custom transition for open/close

Parameters

None.

TODO's

  • Remove once there is a React transition component

transition

Installation

  yarn add @chewy/kib-transition-styles

Import

  @use '~@chewy/kib-transition-styles/src/styles' as kib-transition;

variables

movement

$movement: kib-core-dimensions-get(large) !default;

Description

Default transition movement

Type

Number

Used by

collapse-perspective

$collapse-perspective: kib-core-px-to-relative(1000px) !default;

Description

Transition collapse perspective

Type

Number

Used by

durations

$durations: (
  slow: 0.6s,
  default: 0.4s,
  fast: 0.2s
) !default;

Type

Map

mixins

collapse-transform

@mixin collapse-transform() { ... }

Description

Collapse transform styles

Parameters

None.

collapse-hide

@mixin collapse-hide() { ... }

Description

Collapse hide styles

Parameters

None.

collapse-show

@mixin collapse-show() { ... }

Description

Collapse show styles

Parameters

None.

Requires

collapse-reduced-motion-reset

@mixin collapse-reduced-motion-reset() { ... }

Description

Collapse reduced motion reset styles

Parameters

None.

fade-down-transform

@mixin fade-down-transform() { ... }

Description

Fade down transform styles

Parameters

None.

fade-down-hide

@mixin fade-down-hide() { ... }

Description

Fade down hide styles

Parameters

None.

Requires

fade-down-show

@mixin fade-down-show() { ... }

Description

Fade down show styles

Parameters

None.

fade-left-transform

@mixin fade-left-transform() { ... }

Description

Fade left transform styles

Parameters

None.

fade-left-hide

@mixin fade-left-hide() { ... }

Description

Fade left hide styles

Parameters

None.

Requires

fade-left-show

@mixin fade-left-show() { ... }

Description

Fade left show styles

Parameters

None.

fade-right-transform

@mixin fade-right-transform() { ... }

Description

Fade right transform styles

Parameters

None.

fade-right-hide

@mixin fade-right-hide() { ... }

Description

Fade right hide styles

Parameters

None.

Requires

fade-right-show

@mixin fade-right-show() { ... }

Description

Fade right show styles

Parameters

None.

fade-up-transform

@mixin fade-up-transform() { ... }

Description

Fade up transform styles

Parameters

None.

fade-up-hide

@mixin fade-up-hide() { ... }

Description

Fade up hide styles

Parameters

None.

Requires

fade-up-show

@mixin fade-up-show() { ... }

Description

Fade up show styles

Parameters

None.

fade-transform

@mixin fade-transform() { ... }

Description

Fade transform styles

Parameters

None.

fade-hide

@mixin fade-hide() { ... }

Description

Fade hide styles

Parameters

None.

fade-show

@mixin fade-show() { ... }

Description

Fade show styles

Parameters

None.

slide-left-transform

@mixin slide-left-transform() { ... }

Description

Slide left transform styles

Parameters

None.

slide-left-hide

@mixin slide-left-hide() { ... }

Description

Slide left hide styles

Parameters

None.

slide-left-show

@mixin slide-left-show() { ... }

Description

Slide left show styles

Parameters

None.

slide-right-transform

@mixin slide-right-transform() { ... }

Description

Slide right transform styles

Parameters

None.

slide-right-hide

@mixin slide-right-hide() { ... }

Description

Slide right hide styles

Parameters

None.

slide-right-show

@mixin slide-right-show() { ... }

Description

Slide right show styles

Parameters

None.

slide-up-transform

@mixin slide-up-transform() { ... }

Description

Slide up transform styles

Parameters

None.

slide-up-hide

@mixin slide-up-hide() { ... }

Description

Slide up hide styles

Parameters

None.

slide-up-show

@mixin slide-up-show() { ... }

Description

Slide up show styles

Parameters

None.

zoom-transform

@mixin zoom-transform() { ... }

Description

Zoom transform styles

Parameters

None.

zoom-hide

@mixin zoom-hide() { ... }

Description

Zoom hide styles

Parameters

None.

zoom-show

@mixin zoom-show() { ... }

Description

Zoom show styles

Parameters

None.

truncation

mixins

content

@mixin content() { ... }

Description

base styles for content subcomponent

Parameters

None.

Requires

toggle

@mixin toggle() { ... }

Description

base styles for toggle subcomponent

Parameters

None.

focus-target

@mixin focus-target() { ... }

Description

base styles for focus-target subcomponent

Parameters

None.

visually-hidden

@mixin visually-hidden() { ... }

Description

visually hidden styles

Parameters

None.

type

functions

style-get

@function style-get($name) { ... }

Description

Get a defined type style definition.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the defined type style.

String none

Returns

Map

Return a map containing a style definition.

Requires

Used by

style-is-responsive

@function style-is-responsive($style) { ... }

Description

Determine if a style is defined as responsive.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$style

A type style definition.

Map none

Returns

Boolean

If the style has min and max definitions, return true, else false.

Used by

style-is-generated

@function style-is-generated($name) { ... }

Description

Determine if a style placeholder has been generated.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the style definition to check for.

String none

Returns

Boolean

If placeholders for the style have been generated, return true, else false.

Used by

style-placeholder-register

@function style-placeholder-register($name) { ... }

Description

Register generated placeholders for a style.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the style definition to check for.

String none

Returns

Boolean

A value of true is returned when all placeholder are registered.

Used by

mixins

styles

@mixin styles() { ... }

Description

Generate classes and styles for all type style definitions.

Parameters

None.

Requires

generate-placeholder

@mixin generate-placeholder($name) { ... }

Description

Generate a placeholder for a type style.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$name

The name of the type style to generate a placeholder for.

String none

Requires

Used by

style

@mixin style($style) { ... }

Description

Generate common styles for a type variation.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$style

A type style definition.

Map none

Requires

Used by

style-block

@mixin style-block($style, $is-heading: false) { ... }

Description

Generate styles for a type variation used as a block element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$style

A type style definition.

Map none
$is-heading

If set to true, additional padding will be added to the top of the element.

Booleanfalse

Requires

Used by

style-inline

@mixin style-inline($style) { ... }

Description

Generate styles for a type variation used as a block element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$style

A type style definition

Map none

Requires

Used by

variables

styles

$styles: (
  h1: (
    min: h1-small,
    max: h1-desktop
  ),
  h1-desktop: (
    size: epic,
    weight: light,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h1-small: (
    size: giant,
    weight: light,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h2: (
    min: h2-small,
    max: h2-large
  ),
  h2-small: (
    size: large,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h2-large: (
    size: huge,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h3: (
    min: h3-small,
    max: h3-large
  ),
  h3-small: (
    size: medium,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h3-large: (
    size: giant,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h4: (
    min: h4-small,
    max: h4-large
  ),
  h4-small: (
    size: base,
    weight: bold,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h4-large: (
    size: large,
    weight: bold,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h5: (
    size: tiny,
    weight: bold,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  h6: (
    size: micro,
    weight: bold,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  body: (
    min: body-small,
    max: body-desktop
  ),
  body-desktop: (
    size: base,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  body-small: (
    size: small,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text'),
      border: none
    )
  ),
  data: (
    size: tiny,
    weight: regular
  ),
  modifier: (
    size: micro,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text')
    )
  ),
  meta: (
    size: micro,
    weight: regular,
    properties: (
      color: kib-core.theme-get('text', 'surface')
    )
  ),
  navigation: (
    properties: (
      color: kib-core.theme-get('link', 'deep'),
      text-decoration: none,
      background-color: transparent,
      -webkit-text-decoration-skip: objects
    )
  ),
  navigation-hover: (
    properties: (
      color: kib-core.theme-get('link', 'deep'),
      text-decoration: underline
    )
  )
) !default;

Description

Define alternate text styles.

Type

{map}

Used by

General

css

& .kib-input-text__icon, & .kib-field__icon--action

& .kib-input-text__icon,
  & .kib-field__icon--action { ... }

Description

deprecate when field new is supported

.kib-input-text__icon &__adornment

.kib-input-text__icon &__adornment { ... }

Description

deprecate when field new is supported

.kib-input-text__icon &__adornment-icon

.kib-input-text__icon &__adornment-icon { ... }

Description

deprecate when field new is supported

.kib-field__action &__adornment

.kib-field__action &__adornment { ... }

Description

new datepicker specific styles

.kib-field__action .Mui-disabled &__adornment-icon

.kib-field__action .Mui-disabled &__adornment-icon { ... }

Description

new datepicker specific styles

mixins

custom-properties

@mixin custom-properties($deprecated) { ... }

Description

Mixin to output CSS custom properties for this token set

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$deprecated

include deprecated tokens in the output

Boolean none

custom-properties

@mixin custom-properties($deprecated) { ... }

Description

Mixin to output CSS custom properties for this token set

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$deprecated

include deprecated tokens in the output

Boolean none

custom-properties

@mixin custom-properties($deprecated) { ... }

Description

Mixin to output CSS custom properties for this token set

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$deprecated

include deprecated tokens in the output

Boolean none

custom-properties

@mixin custom-properties($deprecated) { ... }

Description

Mixin to output CSS custom properties for this token set

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$deprecated

include deprecated tokens in the output

Boolean none

variables

chirp-typography-price-small-strikethrough-text-case

$chirp-typography-price-small-strikethrough-text-case: none !default;

Description

Sass variables

chirp-typography

$chirp-typography: (
  'display-typeface': $chirp-typography-display-typeface,
  'text-typeface': $chirp-typography-text-typeface,
  'ls-standard': $chirp-typography-ls-standard,
  'ls-loose': $chirp-typography-ls-loose,
  'ls-wide': $chirp-typography-ls-wide,
  'ls-tight': $chirp-typography-ls-tight,
  'weight-normal': $chirp-typography-weight-normal,
  'weight-bold': $chirp-typography-weight-bold,
  'weight-semibold': $chirp-typography-weight-semibold,
  'weight-medium': $chirp-typography-weight-medium,
  'weight-heavy': $chirp-typography-weight-heavy,
  'display-1': (
    'font-family': $chirp-typography-display-1-font-family,
    'font-weight': $chirp-typography-display-1-font-weight,
    'line-height': $chirp-typography-display-1-line-height,
    'font-size': $chirp-typography-display-1-font-size,
    'letter-spacing': $chirp-typography-display-1-letter-spacing,
    'text-decoration': $chirp-typography-display-1-text-decoration,
    'text-case': $chirp-typography-display-1-text-case
  ),
  'display-2': (
    'font-family': $chirp-typography-display-2-font-family,
    'font-weight': $chirp-typography-display-2-font-weight,
    'line-height': $chirp-typography-display-2-line-height,
    'font-size': $chirp-typography-display-2-font-size,
    'letter-spacing': $chirp-typography-display-2-letter-spacing,
    'text-decoration': $chirp-typography-display-2-text-decoration,
    'text-case': $chirp-typography-display-2-text-case
  ),
  'display-3': (
    'font-family': $chirp-typography-display-3-font-family,
    'font-weight': $chirp-typography-display-3-font-weight,
    'line-height': $chirp-typography-display-3-line-height,
    'font-size': $chirp-typography-display-3-font-size,
    'letter-spacing': $chirp-typography-display-3-letter-spacing,
    'text-decoration': $chirp-typography-display-3-text-decoration,
    'text-case': $chirp-typography-display-3-text-case
  ),
  'display-4': (
    'font-family': $chirp-typography-display-4-font-family,
    'font-weight': $chirp-typography-display-4-font-weight,
    'line-height': $chirp-typography-display-4-line-height,
    'font-size': $chirp-typography-display-4-font-size,
    'letter-spacing': $chirp-typography-display-4-letter-spacing,
    'text-decoration': $chirp-typography-display-4-text-decoration,
    'text-case': $chirp-typography-display-4-text-case
  ),
  'display-5': (
    'font-family': $chirp-typography-display-5-font-family,
    'font-weight': $chirp-typography-display-5-font-weight,
    'line-height': $chirp-typography-display-5-line-height,
    'font-size': $chirp-typography-display-5-font-size,
    'letter-spacing': $chirp-typography-display-5-letter-spacing,
    'text-decoration': $chirp-typography-display-5-text-decoration,
    'text-case': $chirp-typography-display-5-text-case
  ),
  'display-6': (
    'font-family': $chirp-typography-display-6-font-family,
    'font-weight': $chirp-typography-display-6-font-weight,
    'line-height': $chirp-typography-display-6-line-height,
    'font-size': $chirp-typography-display-6-font-size,
    'letter-spacing': $chirp-typography-display-6-letter-spacing,
    'text-decoration': $chirp-typography-display-6-text-decoration,
    'text-case': $chirp-typography-display-6-text-case
  ),
  'section-1': (
    'font-family': $chirp-typography-section-1-font-family,
    'font-weight': $chirp-typography-section-1-font-weight,
    'line-height': $chirp-typography-section-1-line-height,
    'font-size': $chirp-typography-section-1-font-size,
    'letter-spacing': $chirp-typography-section-1-letter-spacing,
    'text-decoration': $chirp-typography-section-1-text-decoration,
    'text-case': $chirp-typography-section-1-text-case
  ),
  'section-2': (
    'font-family': $chirp-typography-section-2-font-family,
    'font-weight': $chirp-typography-section-2-font-weight,
    'line-height': $chirp-typography-section-2-line-height,
    'font-size': $chirp-typography-section-2-font-size,
    'letter-spacing': $chirp-typography-section-2-letter-spacing,
    'text-decoration': $chirp-typography-section-2-text-decoration,
    'text-case': $chirp-typography-section-2-text-case
  ),
  'section-3': (
    'font-family': $chirp-typography-section-3-font-family,
    'font-weight': $chirp-typography-section-3-font-weight,
    'line-height': $chirp-typography-section-3-line-height,
    'font-size': $chirp-typography-section-3-font-size,
    'letter-spacing': $chirp-typography-section-3-letter-spacing,
    'text-decoration': $chirp-typography-section-3-text-decoration,
    'text-case': $chirp-typography-section-3-text-case
  ),
  'paragraph-1': (
    'font-family': $chirp-typography-paragraph-1-font-family,
    'font-weight': $chirp-typography-paragraph-1-font-weight,
    'line-height': $chirp-typography-paragraph-1-line-height,
    'font-size': $chirp-typography-paragraph-1-font-size,
    'letter-spacing': $chirp-typography-paragraph-1-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-1-text-decoration,
    'text-case': $chirp-typography-paragraph-1-text-case
  ),
  'paragraph-2': (
    'font-family': $chirp-typography-paragraph-2-font-family,
    'font-weight': $chirp-typography-paragraph-2-font-weight,
    'line-height': $chirp-typography-paragraph-2-line-height,
    'font-size': $chirp-typography-paragraph-2-font-size,
    'letter-spacing': $chirp-typography-paragraph-2-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-2-text-decoration,
    'text-case': $chirp-typography-paragraph-2-text-case
  ),
  'caption': (
    'font-family': $chirp-typography-caption-font-family,
    'font-weight': $chirp-typography-caption-font-weight,
    'line-height': $chirp-typography-caption-line-height,
    'font-size': $chirp-typography-caption-font-size,
    'letter-spacing': $chirp-typography-caption-letter-spacing,
    'text-decoration': $chirp-typography-caption-text-decoration,
    'text-case': $chirp-typography-caption-text-case
  ),
  'button': (
    'font-family': $chirp-typography-button-font-family,
    'font-weight': $chirp-typography-button-font-weight,
    'line-height': $chirp-typography-button-line-height,
    'font-size': $chirp-typography-button-font-size,
    'letter-spacing': $chirp-typography-button-letter-spacing,
    'text-decoration': $chirp-typography-button-text-decoration,
    'text-case': $chirp-typography-button-text-case
  ),
  'button-medium': (
    'font-family': $chirp-typography-button-medium-font-family,
    'font-weight': $chirp-typography-button-medium-font-weight,
    'line-height': $chirp-typography-button-medium-line-height,
    'font-size': $chirp-typography-button-medium-font-size,
    'letter-spacing': $chirp-typography-button-medium-letter-spacing,
    'text-decoration': $chirp-typography-button-medium-text-decoration,
    'text-case': $chirp-typography-button-medium-text-case
  ),
  'overline': (
    'font-family': $chirp-typography-overline-font-family,
    'font-weight': $chirp-typography-overline-font-weight,
    'line-height': $chirp-typography-overline-line-height,
    'font-size': $chirp-typography-overline-font-size,
    'letter-spacing': $chirp-typography-overline-letter-spacing,
    'text-decoration': $chirp-typography-overline-text-decoration,
    'text-case': $chirp-typography-overline-text-case
  ),
  'form-grouping': (
    'font-family': $chirp-typography-form-grouping-font-family,
    'font-weight': $chirp-typography-form-grouping-font-weight,
    'line-height': $chirp-typography-form-grouping-line-height,
    'font-size': $chirp-typography-form-grouping-font-size,
    'letter-spacing': $chirp-typography-form-grouping-letter-spacing,
    'text-decoration': $chirp-typography-form-grouping-text-decoration,
    'text-case': $chirp-typography-form-grouping-text-case
  ),
  'form-label': (
    'font-family': $chirp-typography-form-label-font-family,
    'font-weight': $chirp-typography-form-label-font-weight,
    'line-height': $chirp-typography-form-label-line-height,
    'font-size': $chirp-typography-form-label-font-size,
    'letter-spacing': $chirp-typography-form-label-letter-spacing,
    'text-decoration': $chirp-typography-form-label-text-decoration,
    'text-case': $chirp-typography-form-label-text-case
  ),
  'form-dropdown-header': (
    'font-family': $chirp-typography-form-dropdown-header-font-family,
    'font-weight': $chirp-typography-form-dropdown-header-font-weight,
    'line-height': $chirp-typography-form-dropdown-header-line-height,
    'font-size': $chirp-typography-form-dropdown-header-font-size,
    'letter-spacing': $chirp-typography-form-dropdown-header-letter-spacing,
    'text-decoration': $chirp-typography-form-dropdown-header-text-decoration,
    'text-case': $chirp-typography-form-dropdown-header-text-case,
    'font-style': $chirp-typography-form-dropdown-header-font-style
  ),
  'form-text': (
    'font-family': $chirp-typography-form-text-font-family,
    'font-weight': $chirp-typography-form-text-font-weight,
    'line-height': $chirp-typography-form-text-line-height,
    'font-size': $chirp-typography-form-text-font-size,
    'letter-spacing': $chirp-typography-form-text-letter-spacing,
    'text-decoration': $chirp-typography-form-text-text-decoration,
    'text-case': $chirp-typography-form-text-text-case
  ),
  'form-helper': (
    'font-family': $chirp-typography-form-helper-font-family,
    'font-weight': $chirp-typography-form-helper-font-weight,
    'line-height': $chirp-typography-form-helper-line-height,
    'font-size': $chirp-typography-form-helper-font-size,
    'letter-spacing': $chirp-typography-form-helper-letter-spacing,
    'text-decoration': $chirp-typography-form-helper-text-decoration,
    'text-case': $chirp-typography-form-helper-text-case
  ),
  'form-error': (
    'font-family': $chirp-typography-form-error-font-family,
    'font-weight': $chirp-typography-form-error-font-weight,
    'line-height': $chirp-typography-form-error-line-height,
    'font-size': $chirp-typography-form-error-font-size,
    'letter-spacing': $chirp-typography-form-error-letter-spacing,
    'text-decoration': $chirp-typography-form-error-text-decoration,
    'text-case': $chirp-typography-form-error-text-case
  ),
  'utility': (
    'font-family': $chirp-typography-utility-font-family,
    'font-weight': $chirp-typography-utility-font-weight,
    'line-height': $chirp-typography-utility-line-height,
    'font-size': $chirp-typography-utility-font-size,
    'letter-spacing': $chirp-typography-utility-letter-spacing,
    'text-decoration': $chirp-typography-utility-text-decoration,
    'text-case': $chirp-typography-utility-text-case
  ),
  'utility-small': (
    'font-family': $chirp-typography-utility-small-font-family,
    'font-weight': $chirp-typography-utility-small-font-weight,
    'line-height': $chirp-typography-utility-small-line-height,
    'font-size': $chirp-typography-utility-small-font-size,
    'letter-spacing': $chirp-typography-utility-small-letter-spacing,
    'text-decoration': $chirp-typography-utility-small-text-decoration,
    'text-case': $chirp-typography-utility-small-text-case
  ),
  'price-x-small': (
    'font-family': $chirp-typography-price-x-small-font-family,
    'font-weight': $chirp-typography-price-x-small-font-weight,
    'line-height': $chirp-typography-price-x-small-line-height,
    'font-size': $chirp-typography-price-x-small-font-size,
    'letter-spacing': $chirp-typography-price-x-small-letter-spacing,
    'text-decoration': $chirp-typography-price-x-small-text-decoration,
    'text-case': $chirp-typography-price-x-small-text-case
  ),
  'price-small': (
    'font-family': $chirp-typography-price-small-font-family,
    'font-weight': $chirp-typography-price-small-font-weight,
    'line-height': $chirp-typography-price-small-line-height,
    'font-size': $chirp-typography-price-small-font-size,
    'letter-spacing': $chirp-typography-price-small-letter-spacing,
    'text-decoration': $chirp-typography-price-small-text-decoration,
    'text-case': $chirp-typography-price-small-text-case
  ),
  'price-medium': (
    'font-family': $chirp-typography-price-medium-font-family,
    'font-weight': $chirp-typography-price-medium-font-weight,
    'line-height': $chirp-typography-price-medium-line-height,
    'font-size': $chirp-typography-price-medium-font-size,
    'letter-spacing': $chirp-typography-price-medium-letter-spacing,
    'text-decoration': $chirp-typography-price-medium-text-decoration,
    'text-case': $chirp-typography-price-medium-text-case
  ),
  'price-large': (
    'font-family': $chirp-typography-price-large-font-family,
    'font-weight': $chirp-typography-price-large-font-weight,
    'line-height': $chirp-typography-price-large-line-height,
    'font-size': $chirp-typography-price-large-font-size,
    'letter-spacing': $chirp-typography-price-large-letter-spacing,
    'text-decoration': $chirp-typography-price-large-text-decoration,
    'text-case': $chirp-typography-price-large-text-case
  ),
  'price-x-large': (
    'font-family': $chirp-typography-price-x-large-font-family,
    'font-weight': $chirp-typography-price-x-large-font-weight,
    'line-height': $chirp-typography-price-x-large-line-height,
    'font-size': $chirp-typography-price-x-large-font-size,
    'letter-spacing': $chirp-typography-price-x-large-letter-spacing,
    'text-decoration': $chirp-typography-price-x-large-text-decoration,
    'text-case': $chirp-typography-price-x-large-text-case
  ),
  'price-x-small-strikethrough': (
    'font-family': $chirp-typography-price-x-small-strikethrough-font-family,
    'font-weight': $chirp-typography-price-x-small-strikethrough-font-weight,
    'line-height': $chirp-typography-price-x-small-strikethrough-line-height,
    'font-size': $chirp-typography-price-x-small-strikethrough-font-size,
    'letter-spacing': $chirp-typography-price-x-small-strikethrough-letter-spacing,
    'text-decoration': $chirp-typography-price-x-small-strikethrough-text-decoration,
    'text-case': $chirp-typography-price-x-small-strikethrough-text-case
  ),
  'price-small-strikethrough': (
    'font-family': $chirp-typography-price-small-strikethrough-font-family,
    'font-weight': $chirp-typography-price-small-strikethrough-font-weight,
    'line-height': $chirp-typography-price-small-strikethrough-line-height,
    'font-size': $chirp-typography-price-small-strikethrough-font-size,
    'letter-spacing': $chirp-typography-price-small-strikethrough-letter-spacing,
    'text-decoration': $chirp-typography-price-small-strikethrough-text-decoration,
    'text-case': $chirp-typography-price-small-strikethrough-text-case
  )
);

Description

Modified 'scss/map-deep' template to output custom properties for properties that have references

chirp-typography-price-small-strikethrough-text-case

$chirp-typography-price-small-strikethrough-text-case: none !default;

Description

Sass variables

chirp-typography

$chirp-typography: (
  'display-typeface': $chirp-typography-display-typeface,
  'ls-wide': $chirp-typography-ls-wide,
  'text-typeface': $chirp-typography-text-typeface,
  'weight-heavy': $chirp-typography-weight-heavy,
  'weight-bold': $chirp-typography-weight-bold,
  'weight-semibold': $chirp-typography-weight-semibold,
  'ls-standard': $chirp-typography-ls-standard,
  'ls-loose': $chirp-typography-ls-loose,
  'ls-tight': $chirp-typography-ls-tight,
  'weight-normal': $chirp-typography-weight-normal,
  'weight-medium': $chirp-typography-weight-medium,
  'display-1': (
    'font-family': $chirp-typography-display-1-font-family,
    'font-weight': $chirp-typography-display-1-font-weight,
    'line-height': $chirp-typography-display-1-line-height,
    'font-size': $chirp-typography-display-1-font-size,
    'letter-spacing': $chirp-typography-display-1-letter-spacing,
    'text-decoration': $chirp-typography-display-1-text-decoration,
    'text-case': $chirp-typography-display-1-text-case
  ),
  'display-2': (
    'font-family': $chirp-typography-display-2-font-family,
    'font-weight': $chirp-typography-display-2-font-weight,
    'line-height': $chirp-typography-display-2-line-height,
    'font-size': $chirp-typography-display-2-font-size,
    'letter-spacing': $chirp-typography-display-2-letter-spacing,
    'text-decoration': $chirp-typography-display-2-text-decoration,
    'text-case': $chirp-typography-display-2-text-case
  ),
  'display-3': (
    'font-family': $chirp-typography-display-3-font-family,
    'font-weight': $chirp-typography-display-3-font-weight,
    'line-height': $chirp-typography-display-3-line-height,
    'font-size': $chirp-typography-display-3-font-size,
    'letter-spacing': $chirp-typography-display-3-letter-spacing,
    'text-decoration': $chirp-typography-display-3-text-decoration,
    'text-case': $chirp-typography-display-3-text-case
  ),
  'display-4': (
    'font-family': $chirp-typography-display-4-font-family,
    'font-weight': $chirp-typography-display-4-font-weight,
    'line-height': $chirp-typography-display-4-line-height,
    'font-size': $chirp-typography-display-4-font-size,
    'letter-spacing': $chirp-typography-display-4-letter-spacing,
    'text-decoration': $chirp-typography-display-4-text-decoration,
    'text-case': $chirp-typography-display-4-text-case
  ),
  'display-5': (
    'font-family': $chirp-typography-display-5-font-family,
    'font-weight': $chirp-typography-display-5-font-weight,
    'line-height': $chirp-typography-display-5-line-height,
    'font-size': $chirp-typography-display-5-font-size,
    'letter-spacing': $chirp-typography-display-5-letter-spacing,
    'text-decoration': $chirp-typography-display-5-text-decoration,
    'text-case': $chirp-typography-display-5-text-case
  ),
  'display-6': (
    'font-family': $chirp-typography-display-6-font-family,
    'font-weight': $chirp-typography-display-6-font-weight,
    'line-height': $chirp-typography-display-6-line-height,
    'font-size': $chirp-typography-display-6-font-size,
    'letter-spacing': $chirp-typography-display-6-letter-spacing,
    'text-decoration': $chirp-typography-display-6-text-decoration,
    'text-case': $chirp-typography-display-6-text-case
  ),
  'section-1': (
    'font-family': $chirp-typography-section-1-font-family,
    'font-weight': $chirp-typography-section-1-font-weight,
    'line-height': $chirp-typography-section-1-line-height,
    'font-size': $chirp-typography-section-1-font-size,
    'letter-spacing': $chirp-typography-section-1-letter-spacing,
    'text-decoration': $chirp-typography-section-1-text-decoration,
    'text-case': $chirp-typography-section-1-text-case
  ),
  'section-2': (
    'font-family': $chirp-typography-section-2-font-family,
    'font-weight': $chirp-typography-section-2-font-weight,
    'line-height': $chirp-typography-section-2-line-height,
    'font-size': $chirp-typography-section-2-font-size,
    'letter-spacing': $chirp-typography-section-2-letter-spacing,
    'text-decoration': $chirp-typography-section-2-text-decoration,
    'text-case': $chirp-typography-section-2-text-case
  ),
  'section-3': (
    'font-family': $chirp-typography-section-3-font-family,
    'font-weight': $chirp-typography-section-3-font-weight,
    'line-height': $chirp-typography-section-3-line-height,
    'font-size': $chirp-typography-section-3-font-size,
    'letter-spacing': $chirp-typography-section-3-letter-spacing,
    'text-decoration': $chirp-typography-section-3-text-decoration,
    'text-case': $chirp-typography-section-3-text-case
  ),
  'editorial-p-1': (
    'font-family': $chirp-typography-editorial-p-1-font-family,
    'font-weight': $chirp-typography-editorial-p-1-font-weight,
    'line-height': $chirp-typography-editorial-p-1-line-height,
    'font-size': $chirp-typography-editorial-p-1-font-size,
    'letter-spacing': $chirp-typography-editorial-p-1-letter-spacing,
    'text-decoration': $chirp-typography-editorial-p-1-text-decoration,
    'text-case': $chirp-typography-editorial-p-1-text-case
  ),
  'editorial-p-2': (
    'font-family': $chirp-typography-editorial-p-2-font-family,
    'font-weight': $chirp-typography-editorial-p-2-font-weight,
    'line-height': $chirp-typography-editorial-p-2-line-height,
    'font-size': $chirp-typography-editorial-p-2-font-size,
    'letter-spacing': $chirp-typography-editorial-p-2-letter-spacing,
    'text-decoration': $chirp-typography-editorial-p-2-text-decoration,
    'text-case': $chirp-typography-editorial-p-2-text-case
  ),
  'paragraph-1': (
    'font-family': $chirp-typography-paragraph-1-font-family,
    'font-weight': $chirp-typography-paragraph-1-font-weight,
    'line-height': $chirp-typography-paragraph-1-line-height,
    'font-size': $chirp-typography-paragraph-1-font-size,
    'letter-spacing': $chirp-typography-paragraph-1-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-1-text-decoration,
    'text-case': $chirp-typography-paragraph-1-text-case
  ),
  'paragraph-2': (
    'font-family': $chirp-typography-paragraph-2-font-family,
    'font-weight': $chirp-typography-paragraph-2-font-weight,
    'line-height': $chirp-typography-paragraph-2-line-height,
    'font-size': $chirp-typography-paragraph-2-font-size,
    'letter-spacing': $chirp-typography-paragraph-2-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-2-text-decoration,
    'text-case': $chirp-typography-paragraph-2-text-case
  ),
  'caption': (
    'font-family': $chirp-typography-caption-font-family,
    'font-weight': $chirp-typography-caption-font-weight,
    'line-height': $chirp-typography-caption-line-height,
    'font-size': $chirp-typography-caption-font-size,
    'letter-spacing': $chirp-typography-caption-letter-spacing,
    'text-decoration': $chirp-typography-caption-text-decoration,
    'text-case': $chirp-typography-caption-text-case
  ),
  'button': (
    'font-family': $chirp-typography-button-font-family,
    'font-weight': $chirp-typography-button-font-weight,
    'line-height': $chirp-typography-button-line-height,
    'font-size': $chirp-typography-button-font-size,
    'letter-spacing': $chirp-typography-button-letter-spacing,
    'text-decoration': $chirp-typography-button-text-decoration,
    'text-case': $chirp-typography-button-text-case
  ),
  'button-medium': (
    'font-family': $chirp-typography-button-medium-font-family,
    'font-weight': $chirp-typography-button-medium-font-weight,
    'line-height': $chirp-typography-button-medium-line-height,
    'font-size': $chirp-typography-button-medium-font-size,
    'letter-spacing': $chirp-typography-button-medium-letter-spacing,
    'text-decoration': $chirp-typography-button-medium-text-decoration,
    'text-case': $chirp-typography-button-medium-text-case
  ),
  'overline': (
    'font-family': $chirp-typography-overline-font-family,
    'font-weight': $chirp-typography-overline-font-weight,
    'line-height': $chirp-typography-overline-line-height,
    'font-size': $chirp-typography-overline-font-size,
    'letter-spacing': $chirp-typography-overline-letter-spacing,
    'text-decoration': $chirp-typography-overline-text-decoration,
    'text-case': $chirp-typography-overline-text-case
  ),
  'form-grouping': (
    'font-family': $chirp-typography-form-grouping-font-family,
    'font-weight': $chirp-typography-form-grouping-font-weight,
    'line-height': $chirp-typography-form-grouping-line-height,
    'font-size': $chirp-typography-form-grouping-font-size,
    'letter-spacing': $chirp-typography-form-grouping-letter-spacing,
    'text-decoration': $chirp-typography-form-grouping-text-decoration,
    'text-case': $chirp-typography-form-grouping-text-case
  ),
  'form-label': (
    'font-family': $chirp-typography-form-label-font-family,
    'font-weight': $chirp-typography-form-label-font-weight,
    'line-height': $chirp-typography-form-label-line-height,
    'font-size': $chirp-typography-form-label-font-size,
    'letter-spacing': $chirp-typography-form-label-letter-spacing,
    'text-decoration': $chirp-typography-form-label-text-decoration,
    'text-case': $chirp-typography-form-label-text-case
  ),
  'form-dropdown-header': (
    'font-family': $chirp-typography-form-dropdown-header-font-family,
    'font-weight': $chirp-typography-form-dropdown-header-font-weight,
    'line-height': $chirp-typography-form-dropdown-header-line-height,
    'font-size': $chirp-typography-form-dropdown-header-font-size,
    'letter-spacing': $chirp-typography-form-dropdown-header-letter-spacing,
    'text-decoration': $chirp-typography-form-dropdown-header-text-decoration,
    'text-case': $chirp-typography-form-dropdown-header-text-case,
    'font-style': $chirp-typography-form-dropdown-header-font-style
  ),
  'form-text': (
    'font-family': $chirp-typography-form-text-font-family,
    'font-weight': $chirp-typography-form-text-font-weight,
    'line-height': $chirp-typography-form-text-line-height,
    'font-size': $chirp-typography-form-text-font-size,
    'letter-spacing': $chirp-typography-form-text-letter-spacing,
    'text-decoration': $chirp-typography-form-text-text-decoration,
    'text-case': $chirp-typography-form-text-text-case
  ),
  'form-helper': (
    'font-family': $chirp-typography-form-helper-font-family,
    'font-weight': $chirp-typography-form-helper-font-weight,
    'line-height': $chirp-typography-form-helper-line-height,
    'font-size': $chirp-typography-form-helper-font-size,
    'letter-spacing': $chirp-typography-form-helper-letter-spacing,
    'text-decoration': $chirp-typography-form-helper-text-decoration,
    'text-case': $chirp-typography-form-helper-text-case
  ),
  'form-error': (
    'font-family': $chirp-typography-form-error-font-family,
    'font-weight': $chirp-typography-form-error-font-weight,
    'line-height': $chirp-typography-form-error-line-height,
    'font-size': $chirp-typography-form-error-font-size,
    'letter-spacing': $chirp-typography-form-error-letter-spacing,
    'text-decoration': $chirp-typography-form-error-text-decoration,
    'text-case': $chirp-typography-form-error-text-case
  ),
  'utility': (
    'font-family': $chirp-typography-utility-font-family,
    'font-weight': $chirp-typography-utility-font-weight,
    'line-height': $chirp-typography-utility-line-height,
    'font-size': $chirp-typography-utility-font-size,
    'letter-spacing': $chirp-typography-utility-letter-spacing,
    'text-decoration': $chirp-typography-utility-text-decoration,
    'text-case': $chirp-typography-utility-text-case
  ),
  'utility-small': (
    'font-family': $chirp-typography-utility-small-font-family,
    'font-weight': $chirp-typography-utility-small-font-weight,
    'line-height': $chirp-typography-utility-small-line-height,
    'font-size': $chirp-typography-utility-small-font-size,
    'letter-spacing': $chirp-typography-utility-small-letter-spacing,
    'text-decoration': $chirp-typography-utility-small-text-decoration,
    'text-case': $chirp-typography-utility-small-text-case
  ),
  'price-small': (
    'font-family': $chirp-typography-price-small-font-family,
    'font-weight': $chirp-typography-price-small-font-weight,
    'line-height': $chirp-typography-price-small-line-height,
    'font-size': $chirp-typography-price-small-font-size,
    'letter-spacing': $chirp-typography-price-small-letter-spacing,
    'text-decoration': $chirp-typography-price-small-text-decoration,
    'text-case': $chirp-typography-price-small-text-case
  ),
  'price-medium': (
    'font-family': $chirp-typography-price-medium-font-family,
    'font-weight': $chirp-typography-price-medium-font-weight,
    'line-height': $chirp-typography-price-medium-line-height,
    'font-size': $chirp-typography-price-medium-font-size,
    'letter-spacing': $chirp-typography-price-medium-letter-spacing,
    'text-decoration': $chirp-typography-price-medium-text-decoration,
    'text-case': $chirp-typography-price-medium-text-case
  ),
  'price-large': (
    'font-family': $chirp-typography-price-large-font-family,
    'font-weight': $chirp-typography-price-large-font-weight,
    'line-height': $chirp-typography-price-large-line-height,
    'font-size': $chirp-typography-price-large-font-size,
    'letter-spacing': $chirp-typography-price-large-letter-spacing,
    'text-decoration': $chirp-typography-price-large-text-decoration,
    'text-case': $chirp-typography-price-large-text-case
  ),
  'price-x-large': (
    'font-family': $chirp-typography-price-x-large-font-family,
    'font-weight': $chirp-typography-price-x-large-font-weight,
    'line-height': $chirp-typography-price-x-large-line-height,
    'font-size': $chirp-typography-price-x-large-font-size,
    'letter-spacing': $chirp-typography-price-x-large-letter-spacing,
    'text-decoration': $chirp-typography-price-x-large-text-decoration,
    'text-case': $chirp-typography-price-x-large-text-case
  ),
  'price-x-small-strikethrough': (
    'font-family': $chirp-typography-price-x-small-strikethrough-font-family,
    'font-weight': $chirp-typography-price-x-small-strikethrough-font-weight,
    'line-height': $chirp-typography-price-x-small-strikethrough-line-height,
    'font-size': $chirp-typography-price-x-small-strikethrough-font-size,
    'letter-spacing': $chirp-typography-price-x-small-strikethrough-letter-spacing,
    'text-decoration': $chirp-typography-price-x-small-strikethrough-text-decoration,
    'text-case': $chirp-typography-price-x-small-strikethrough-text-case
  ),
  'price-small-strikethrough': (
    'font-family': $chirp-typography-price-small-strikethrough-font-family,
    'font-weight': $chirp-typography-price-small-strikethrough-font-weight,
    'line-height': $chirp-typography-price-small-strikethrough-line-height,
    'font-size': $chirp-typography-price-small-strikethrough-font-size,
    'letter-spacing': $chirp-typography-price-small-strikethrough-letter-spacing,
    'text-decoration': $chirp-typography-price-small-strikethrough-text-decoration,
    'text-case': $chirp-typography-price-small-strikethrough-text-case
  )
);

Description

Modified 'scss/map-deep' template to output custom properties for properties that have references

chirp-typography-utility-small-text-case

$chirp-typography-utility-small-text-case: none !default;

Description

Sass variables

chirp-typography

$chirp-typography: (
  'display-typeface': $chirp-typography-display-typeface,
  'text-typeface': $chirp-typography-text-typeface,
  'ls-standard': $chirp-typography-ls-standard,
  'ls-loose': $chirp-typography-ls-loose,
  'ls-wide': $chirp-typography-ls-wide,
  'ls-tight': $chirp-typography-ls-tight,
  'weight-normal': $chirp-typography-weight-normal,
  'weight-bold': $chirp-typography-weight-bold,
  'weight-semibold': $chirp-typography-weight-semibold,
  'weight-medium': $chirp-typography-weight-medium,
  'weight-heavy': $chirp-typography-weight-heavy,
  'display-1': (
    'font-family': $chirp-typography-display-1-font-family,
    'font-weight': $chirp-typography-display-1-font-weight,
    'line-height': $chirp-typography-display-1-line-height,
    'letter-spacing': $chirp-typography-display-1-letter-spacing,
    'text-decoration': $chirp-typography-display-1-text-decoration,
    'text-case': $chirp-typography-display-1-text-case,
    'font-size': $chirp-typography-display-1-font-size
  ),
  'display-2': (
    'font-family': $chirp-typography-display-2-font-family,
    'font-weight': $chirp-typography-display-2-font-weight,
    'line-height': $chirp-typography-display-2-line-height,
    'font-size': $chirp-typography-display-2-font-size,
    'letter-spacing': $chirp-typography-display-2-letter-spacing,
    'text-decoration': $chirp-typography-display-2-text-decoration,
    'text-case': $chirp-typography-display-2-text-case
  ),
  'display-3': (
    'font-family': $chirp-typography-display-3-font-family,
    'font-weight': $chirp-typography-display-3-font-weight,
    'line-height': $chirp-typography-display-3-line-height,
    'font-size': $chirp-typography-display-3-font-size,
    'letter-spacing': $chirp-typography-display-3-letter-spacing,
    'text-decoration': $chirp-typography-display-3-text-decoration,
    'text-case': $chirp-typography-display-3-text-case
  ),
  'display-4': (
    'font-family': $chirp-typography-display-4-font-family,
    'font-weight': $chirp-typography-display-4-font-weight,
    'line-height': $chirp-typography-display-4-line-height,
    'font-size': $chirp-typography-display-4-font-size,
    'letter-spacing': $chirp-typography-display-4-letter-spacing,
    'text-decoration': $chirp-typography-display-4-text-decoration,
    'text-case': $chirp-typography-display-4-text-case
  ),
  'display-5': (
    'font-family': $chirp-typography-display-5-font-family,
    'font-weight': $chirp-typography-display-5-font-weight,
    'line-height': $chirp-typography-display-5-line-height,
    'font-size': $chirp-typography-display-5-font-size,
    'letter-spacing': $chirp-typography-display-5-letter-spacing,
    'text-decoration': $chirp-typography-display-5-text-decoration,
    'text-case': $chirp-typography-display-5-text-case
  ),
  'display-6': (
    'font-family': $chirp-typography-display-6-font-family,
    'font-weight': $chirp-typography-display-6-font-weight,
    'line-height': $chirp-typography-display-6-line-height,
    'font-size': $chirp-typography-display-6-font-size,
    'letter-spacing': $chirp-typography-display-6-letter-spacing,
    'text-decoration': $chirp-typography-display-6-text-decoration,
    'text-case': $chirp-typography-display-6-text-case
  ),
  'section-1': (
    'font-family': $chirp-typography-section-1-font-family,
    'font-weight': $chirp-typography-section-1-font-weight,
    'line-height': $chirp-typography-section-1-line-height,
    'font-size': $chirp-typography-section-1-font-size,
    'letter-spacing': $chirp-typography-section-1-letter-spacing,
    'text-decoration': $chirp-typography-section-1-text-decoration,
    'text-case': $chirp-typography-section-1-text-case
  ),
  'section-2': (
    'font-family': $chirp-typography-section-2-font-family,
    'font-weight': $chirp-typography-section-2-font-weight,
    'line-height': $chirp-typography-section-2-line-height,
    'font-size': $chirp-typography-section-2-font-size,
    'letter-spacing': $chirp-typography-section-2-letter-spacing,
    'text-decoration': $chirp-typography-section-2-text-decoration,
    'text-case': $chirp-typography-section-2-text-case
  ),
  'section-3': (
    'font-family': $chirp-typography-section-3-font-family,
    'font-weight': $chirp-typography-section-3-font-weight,
    'line-height': $chirp-typography-section-3-line-height,
    'font-size': $chirp-typography-section-3-font-size,
    'letter-spacing': $chirp-typography-section-3-letter-spacing,
    'text-decoration': $chirp-typography-section-3-text-decoration,
    'text-case': $chirp-typography-section-3-text-case
  ),
  'editorial-p-1': (
    'font-family': $chirp-typography-editorial-p-1-font-family,
    'font-weight': $chirp-typography-editorial-p-1-font-weight,
    'line-height': $chirp-typography-editorial-p-1-line-height,
    'font-size': $chirp-typography-editorial-p-1-font-size,
    'letter-spacing': $chirp-typography-editorial-p-1-letter-spacing,
    'text-decoration': $chirp-typography-editorial-p-1-text-decoration,
    'text-case': $chirp-typography-editorial-p-1-text-case
  ),
  'editorial-p-2': (
    'font-family': $chirp-typography-editorial-p-2-font-family,
    'font-weight': $chirp-typography-editorial-p-2-font-weight,
    'line-height': $chirp-typography-editorial-p-2-line-height,
    'font-size': $chirp-typography-editorial-p-2-font-size,
    'letter-spacing': $chirp-typography-editorial-p-2-letter-spacing,
    'text-decoration': $chirp-typography-editorial-p-2-text-decoration,
    'text-case': $chirp-typography-editorial-p-2-text-case
  ),
  'paragraph-1': (
    'font-family': $chirp-typography-paragraph-1-font-family,
    'font-weight': $chirp-typography-paragraph-1-font-weight,
    'line-height': $chirp-typography-paragraph-1-line-height,
    'font-size': $chirp-typography-paragraph-1-font-size,
    'letter-spacing': $chirp-typography-paragraph-1-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-1-text-decoration,
    'text-case': $chirp-typography-paragraph-1-text-case
  ),
  'paragraph-2': (
    'font-family': $chirp-typography-paragraph-2-font-family,
    'font-weight': $chirp-typography-paragraph-2-font-weight,
    'line-height': $chirp-typography-paragraph-2-line-height,
    'font-size': $chirp-typography-paragraph-2-font-size,
    'letter-spacing': $chirp-typography-paragraph-2-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-2-text-decoration,
    'text-case': $chirp-typography-paragraph-2-text-case
  ),
  'caption': (
    'font-family': $chirp-typography-caption-font-family,
    'font-weight': $chirp-typography-caption-font-weight,
    'line-height': $chirp-typography-caption-line-height,
    'font-size': $chirp-typography-caption-font-size,
    'letter-spacing': $chirp-typography-caption-letter-spacing,
    'text-decoration': $chirp-typography-caption-text-decoration,
    'text-case': $chirp-typography-caption-text-case
  ),
  'button': (
    'font-family': $chirp-typography-button-font-family,
    'font-weight': $chirp-typography-button-font-weight,
    'line-height': $chirp-typography-button-line-height,
    'font-size': $chirp-typography-button-font-size,
    'letter-spacing': $chirp-typography-button-letter-spacing,
    'text-decoration': $chirp-typography-button-text-decoration,
    'text-case': $chirp-typography-button-text-case
  ),
  'button-medium': (
    'font-family': $chirp-typography-button-medium-font-family,
    'font-weight': $chirp-typography-button-medium-font-weight,
    'line-height': $chirp-typography-button-medium-line-height,
    'font-size': $chirp-typography-button-medium-font-size,
    'letter-spacing': $chirp-typography-button-medium-letter-spacing,
    'text-decoration': $chirp-typography-button-medium-text-decoration,
    'text-case': $chirp-typography-button-medium-text-case
  ),
  'overline': (
    'font-family': $chirp-typography-overline-font-family,
    'font-weight': $chirp-typography-overline-font-weight,
    'line-height': $chirp-typography-overline-line-height,
    'font-size': $chirp-typography-overline-font-size,
    'letter-spacing': $chirp-typography-overline-letter-spacing,
    'text-decoration': $chirp-typography-overline-text-decoration,
    'text-case': $chirp-typography-overline-text-case
  ),
  'form-grouping': (
    'font-family': $chirp-typography-form-grouping-font-family,
    'font-weight': $chirp-typography-form-grouping-font-weight,
    'line-height': $chirp-typography-form-grouping-line-height,
    'font-size': $chirp-typography-form-grouping-font-size,
    'letter-spacing': $chirp-typography-form-grouping-letter-spacing,
    'text-decoration': $chirp-typography-form-grouping-text-decoration,
    'text-case': $chirp-typography-form-grouping-text-case
  ),
  'form-label': (
    'font-family': $chirp-typography-form-label-font-family,
    'font-weight': $chirp-typography-form-label-font-weight,
    'line-height': $chirp-typography-form-label-line-height,
    'font-size': $chirp-typography-form-label-font-size,
    'letter-spacing': $chirp-typography-form-label-letter-spacing,
    'text-decoration': $chirp-typography-form-label-text-decoration,
    'text-case': $chirp-typography-form-label-text-case
  ),
  'form-dropdown-header': (
    'font-family': $chirp-typography-form-dropdown-header-font-family,
    'font-weight': $chirp-typography-form-dropdown-header-font-weight,
    'line-height': $chirp-typography-form-dropdown-header-line-height,
    'font-size': $chirp-typography-form-dropdown-header-font-size,
    'letter-spacing': $chirp-typography-form-dropdown-header-letter-spacing,
    'text-decoration': $chirp-typography-form-dropdown-header-text-decoration,
    'text-case': $chirp-typography-form-dropdown-header-text-case,
    'font-style': $chirp-typography-form-dropdown-header-font-style
  ),
  'form-text': (
    'font-family': $chirp-typography-form-text-font-family,
    'font-weight': $chirp-typography-form-text-font-weight,
    'line-height': $chirp-typography-form-text-line-height,
    'font-size': $chirp-typography-form-text-font-size,
    'letter-spacing': $chirp-typography-form-text-letter-spacing,
    'text-decoration': $chirp-typography-form-text-text-decoration,
    'text-case': $chirp-typography-form-text-text-case
  ),
  'form-helper': (
    'font-family': $chirp-typography-form-helper-font-family,
    'font-weight': $chirp-typography-form-helper-font-weight,
    'line-height': $chirp-typography-form-helper-line-height,
    'font-size': $chirp-typography-form-helper-font-size,
    'letter-spacing': $chirp-typography-form-helper-letter-spacing,
    'text-decoration': $chirp-typography-form-helper-text-decoration,
    'text-case': $chirp-typography-form-helper-text-case
  ),
  'form-error': (
    'font-family': $chirp-typography-form-error-font-family,
    'font-weight': $chirp-typography-form-error-font-weight,
    'line-height': $chirp-typography-form-error-line-height,
    'font-size': $chirp-typography-form-error-font-size,
    'letter-spacing': $chirp-typography-form-error-letter-spacing,
    'text-decoration': $chirp-typography-form-error-text-decoration,
    'text-case': $chirp-typography-form-error-text-case
  ),
  'utility': (
    'font-family': $chirp-typography-utility-font-family,
    'font-weight': $chirp-typography-utility-font-weight,
    'line-height': $chirp-typography-utility-line-height,
    'font-size': $chirp-typography-utility-font-size,
    'letter-spacing': $chirp-typography-utility-letter-spacing,
    'text-decoration': $chirp-typography-utility-text-decoration,
    'text-case': $chirp-typography-utility-text-case
  ),
  'utility-small': (
    'font-family': $chirp-typography-utility-small-font-family,
    'font-weight': $chirp-typography-utility-small-font-weight,
    'line-height': $chirp-typography-utility-small-line-height,
    'font-size': $chirp-typography-utility-small-font-size,
    'letter-spacing': $chirp-typography-utility-small-letter-spacing,
    'text-decoration': $chirp-typography-utility-small-text-decoration,
    'text-case': $chirp-typography-utility-small-text-case
  )
);

Description

Modified 'scss/map-deep' template to output custom properties for properties that have references

chirp-typography-deprecated-hero-4-alternate-text-case

$chirp-typography-deprecated-hero-4-alternate-text-case: none !default;

Description

Sass variables

chirp-typography

$chirp-typography: (
  'display-typeface': $chirp-typography-display-typeface,
  'text-typeface': $chirp-typography-text-typeface,
  'ls-standard': $chirp-typography-ls-standard,
  'ls-loose': $chirp-typography-ls-loose,
  'ls-wide': $chirp-typography-ls-wide,
  'ls-tight': $chirp-typography-ls-tight,
  'weight-normal': $chirp-typography-weight-normal,
  'weight-bold': $chirp-typography-weight-bold,
  'weight-semibold': $chirp-typography-weight-semibold,
  'weight-medium': $chirp-typography-weight-medium,
  'weight-heavy': $chirp-typography-weight-heavy,
  'display-1': (
    'font-family': $chirp-typography-display-1-font-family,
    'font-weight': $chirp-typography-display-1-font-weight,
    'line-height': $chirp-typography-display-1-line-height,
    'font-size': $chirp-typography-display-1-font-size,
    'letter-spacing': $chirp-typography-display-1-letter-spacing,
    'text-decoration': $chirp-typography-display-1-text-decoration,
    'text-case': $chirp-typography-display-1-text-case
  ),
  'display-2': (
    'font-family': $chirp-typography-display-2-font-family,
    'font-weight': $chirp-typography-display-2-font-weight,
    'line-height': $chirp-typography-display-2-line-height,
    'font-size': $chirp-typography-display-2-font-size,
    'letter-spacing': $chirp-typography-display-2-letter-spacing,
    'text-decoration': $chirp-typography-display-2-text-decoration,
    'text-case': $chirp-typography-display-2-text-case
  ),
  'display-3': (
    'font-family': $chirp-typography-display-3-font-family,
    'font-weight': $chirp-typography-display-3-font-weight,
    'line-height': $chirp-typography-display-3-line-height,
    'font-size': $chirp-typography-display-3-font-size,
    'letter-spacing': $chirp-typography-display-3-letter-spacing,
    'text-decoration': $chirp-typography-display-3-text-decoration,
    'text-case': $chirp-typography-display-3-text-case
  ),
  'display-4': (
    'font-family': $chirp-typography-display-4-font-family,
    'font-weight': $chirp-typography-display-4-font-weight,
    'line-height': $chirp-typography-display-4-line-height,
    'font-size': $chirp-typography-display-4-font-size,
    'letter-spacing': $chirp-typography-display-4-letter-spacing,
    'text-decoration': $chirp-typography-display-4-text-decoration,
    'text-case': $chirp-typography-display-4-text-case
  ),
  'display-5': (
    'font-family': $chirp-typography-display-5-font-family,
    'font-weight': $chirp-typography-display-5-font-weight,
    'line-height': $chirp-typography-display-5-line-height,
    'font-size': $chirp-typography-display-5-font-size,
    'letter-spacing': $chirp-typography-display-5-letter-spacing,
    'text-decoration': $chirp-typography-display-5-text-decoration,
    'text-case': $chirp-typography-display-5-text-case
  ),
  'display-6': (
    'font-family': $chirp-typography-display-6-font-family,
    'font-weight': $chirp-typography-display-6-font-weight,
    'line-height': $chirp-typography-display-6-line-height,
    'font-size': $chirp-typography-display-6-font-size,
    'letter-spacing': $chirp-typography-display-6-letter-spacing,
    'text-decoration': $chirp-typography-display-6-text-decoration,
    'text-case': $chirp-typography-display-6-text-case
  ),
  'section-1': (
    'font-family': $chirp-typography-section-1-font-family,
    'font-weight': $chirp-typography-section-1-font-weight,
    'line-height': $chirp-typography-section-1-line-height,
    'font-size': $chirp-typography-section-1-font-size,
    'letter-spacing': $chirp-typography-section-1-letter-spacing,
    'text-decoration': $chirp-typography-section-1-text-decoration,
    'text-case': $chirp-typography-section-1-text-case
  ),
  'section-2': (
    'font-family': $chirp-typography-section-2-font-family,
    'font-weight': $chirp-typography-section-2-font-weight,
    'line-height': $chirp-typography-section-2-line-height,
    'font-size': $chirp-typography-section-2-font-size,
    'letter-spacing': $chirp-typography-section-2-letter-spacing,
    'text-decoration': $chirp-typography-section-2-text-decoration,
    'text-case': $chirp-typography-section-2-text-case
  ),
  'section-3': (
    'font-family': $chirp-typography-section-3-font-family,
    'font-weight': $chirp-typography-section-3-font-weight,
    'line-height': $chirp-typography-section-3-line-height,
    'font-size': $chirp-typography-section-3-font-size,
    'letter-spacing': $chirp-typography-section-3-letter-spacing,
    'text-decoration': $chirp-typography-section-3-text-decoration,
    'text-case': $chirp-typography-section-3-text-case
  ),
  'editorial-p-1': (
    'font-family': $chirp-typography-editorial-p-1-font-family,
    'font-weight': $chirp-typography-editorial-p-1-font-weight,
    'line-height': $chirp-typography-editorial-p-1-line-height,
    'font-size': $chirp-typography-editorial-p-1-font-size,
    'letter-spacing': $chirp-typography-editorial-p-1-letter-spacing,
    'text-decoration': $chirp-typography-editorial-p-1-text-decoration,
    'text-case': $chirp-typography-editorial-p-1-text-case
  ),
  'editorial-p-2': (
    'font-family': $chirp-typography-editorial-p-2-font-family,
    'font-weight': $chirp-typography-editorial-p-2-font-weight,
    'line-height': $chirp-typography-editorial-p-2-line-height,
    'font-size': $chirp-typography-editorial-p-2-font-size,
    'letter-spacing': $chirp-typography-editorial-p-2-letter-spacing,
    'text-decoration': $chirp-typography-editorial-p-2-text-decoration,
    'text-case': $chirp-typography-editorial-p-2-text-case
  ),
  'paragraph-1': (
    'font-family': $chirp-typography-paragraph-1-font-family,
    'font-weight': $chirp-typography-paragraph-1-font-weight,
    'line-height': $chirp-typography-paragraph-1-line-height,
    'font-size': $chirp-typography-paragraph-1-font-size,
    'letter-spacing': $chirp-typography-paragraph-1-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-1-text-decoration,
    'text-case': $chirp-typography-paragraph-1-text-case
  ),
  'paragraph-2': (
    'font-family': $chirp-typography-paragraph-2-font-family,
    'font-weight': $chirp-typography-paragraph-2-font-weight,
    'line-height': $chirp-typography-paragraph-2-line-height,
    'font-size': $chirp-typography-paragraph-2-font-size,
    'letter-spacing': $chirp-typography-paragraph-2-letter-spacing,
    'text-decoration': $chirp-typography-paragraph-2-text-decoration,
    'text-case': $chirp-typography-paragraph-2-text-case
  ),
  'caption': (
    'font-family': $chirp-typography-caption-font-family,
    'font-weight': $chirp-typography-caption-font-weight,
    'line-height': $chirp-typography-caption-line-height,
    'font-size': $chirp-typography-caption-font-size,
    'letter-spacing': $chirp-typography-caption-letter-spacing,
    'text-decoration': $chirp-typography-caption-text-decoration,
    'text-case': $chirp-typography-caption-text-case
  ),
  'button': (
    'font-family': $chirp-typography-button-font-family,
    'font-weight': $chirp-typography-button-font-weight,
    'line-height': $chirp-typography-button-line-height,
    'font-size': $chirp-typography-button-font-size,
    'letter-spacing': $chirp-typography-button-letter-spacing,
    'text-decoration': $chirp-typography-button-text-decoration,
    'text-case': $chirp-typography-button-text-case
  ),
  'button-medium': (
    'font-family': $chirp-typography-button-medium-font-family,
    'font-weight': $chirp-typography-button-medium-font-weight,
    'line-height': $chirp-typography-button-medium-line-height,
    'font-size': $chirp-typography-button-medium-font-size,
    'letter-spacing': $chirp-typography-button-medium-letter-spacing,
    'text-decoration': $chirp-typography-button-medium-text-decoration,
    'text-case': $chirp-typography-button-medium-text-case
  ),
  'overline': (
    'font-family': $chirp-typography-overline-font-family,
    'font-weight': $chirp-typography-overline-font-weight,
    'line-height': $chirp-typography-overline-line-height,
    'font-size': $chirp-typography-overline-font-size,
    'letter-spacing': $chirp-typography-overline-letter-spacing,
    'text-decoration': $chirp-typography-overline-text-decoration,
    'text-case': $chirp-typography-overline-text-case
  ),
  'form-grouping': (
    'font-family': $chirp-typography-form-grouping-font-family,
    'font-weight': $chirp-typography-form-grouping-font-weight,
    'line-height': $chirp-typography-form-grouping-line-height,
    'font-size': $chirp-typography-form-grouping-font-size,
    'letter-spacing': $chirp-typography-form-grouping-letter-spacing,
    'text-decoration': $chirp-typography-form-grouping-text-decoration,
    'text-case': $chirp-typography-form-grouping-text-case
  ),
  'form-label': (
    'font-family': $chirp-typography-form-label-font-family,
    'font-weight': $chirp-typography-form-label-font-weight,
    'line-height': $chirp-typography-form-label-line-height,
    'font-size': $chirp-typography-form-label-font-size,
    'letter-spacing': $chirp-typography-form-label-letter-spacing,
    'text-decoration': $chirp-typography-form-label-text-decoration,
    'text-case': $chirp-typography-form-label-text-case
  ),
  'form-dropdown-header': (
    'font-family': $chirp-typography-form-dropdown-header-font-family,
    'font-weight': $chirp-typography-form-dropdown-header-font-weight,
    'line-height': $chirp-typography-form-dropdown-header-line-height,
    'font-size': $chirp-typography-form-dropdown-header-font-size,
    'letter-spacing': $chirp-typography-form-dropdown-header-letter-spacing,
    'text-decoration': $chirp-typography-form-dropdown-header-text-decoration,
    'text-case': $chirp-typography-form-dropdown-header-text-case,
    'font-style': $chirp-typography-form-dropdown-header-font-style
  ),
  'form-text': (
    'font-family': $chirp-typography-form-text-font-family,
    'font-weight': $chirp-typography-form-text-font-weight,
    'line-height': $chirp-typography-form-text-line-height,
    'font-size': $chirp-typography-form-text-font-size,
    'letter-spacing': $chirp-typography-form-text-letter-spacing,
    'text-decoration': $chirp-typography-form-text-text-decoration,
    'text-case': $chirp-typography-form-text-text-case
  ),
  'form-helper': (
    'font-family': $chirp-typography-form-helper-font-family,
    'font-weight': $chirp-typography-form-helper-font-weight,
    'line-height': $chirp-typography-form-helper-line-height,
    'font-size': $chirp-typography-form-helper-font-size,
    'letter-spacing': $chirp-typography-form-helper-letter-spacing,
    'text-decoration': $chirp-typography-form-helper-text-decoration,
    'text-case': $chirp-typography-form-helper-text-case
  ),
  'form-error': (
    'font-family': $chirp-typography-form-error-font-family,
    'font-weight': $chirp-typography-form-error-font-weight,
    'line-height': $chirp-typography-form-error-line-height,
    'font-size': $chirp-typography-form-error-font-size,
    'letter-spacing': $chirp-typography-form-error-letter-spacing,
    'text-decoration': $chirp-typography-form-error-text-decoration,
    'text-case': $chirp-typography-form-error-text-case
  ),
  'menu-heading': (
    'font-family': $chirp-typography-menu-heading-font-family,
    'font-weight': $chirp-typography-menu-heading-font-weight,
    'line-height': $chirp-typography-menu-heading-line-height,
    'font-size': $chirp-typography-menu-heading-font-size,
    'letter-spacing': $chirp-typography-menu-heading-letter-spacing,
    'text-decoration': $chirp-typography-menu-heading-text-decoration,
    'text-case': $chirp-typography-menu-heading-text-case
  ),
  'menu-sub-heading': (
    'font-family': $chirp-typography-menu-sub-heading-font-family,
    'font-weight': $chirp-typography-menu-sub-heading-font-weight,
    'font-size': $chirp-typography-menu-sub-heading-font-size,
    'letter-spacing': $chirp-typography-menu-sub-heading-letter-spacing,
    'text-decoration': $chirp-typography-menu-sub-heading-text-decoration,
    'text-case': $chirp-typography-menu-sub-heading-text-case,
    'line-height': $chirp-typography-menu-sub-heading-line-height
  ),
  'menu-text': (
    'font-family': $chirp-typography-menu-text-font-family,
    'font-weight': $chirp-typography-menu-text-font-weight,
    'font-size': $chirp-typography-menu-text-font-size,
    'letter-spacing': $chirp-typography-menu-text-letter-spacing,
    'text-decoration': $chirp-typography-menu-text-text-decoration,
    'text-case': $chirp-typography-menu-text-text-case,
    'line-height': $chirp-typography-menu-text-line-height
  ),
  'utility': (
    'font-family': $chirp-typography-utility-font-family,
    'font-weight': $chirp-typography-utility-font-weight,
    'line-height': $chirp-typography-utility-line-height,
    'font-size': $chirp-typography-utility-font-size,
    'letter-spacing': $chirp-typography-utility-letter-spacing,
    'text-decoration': $chirp-typography-utility-text-decoration,
    'text-case': $chirp-typography-utility-text-case
  ),
  'utility-small': (
    'font-family': $chirp-typography-utility-small-font-family,
    'font-weight': $chirp-typography-utility-small-font-weight,
    'line-height': $chirp-typography-utility-small-line-height,
    'font-size': $chirp-typography-utility-small-font-size,
    'letter-spacing': $chirp-typography-utility-small-letter-spacing,
    'text-decoration': $chirp-typography-utility-small-text-decoration,
    'text-case': $chirp-typography-utility-small-text-case
  ),
  'price-small': (
    'font-family': $chirp-typography-price-small-font-family,
    'font-weight': $chirp-typography-price-small-font-weight,
    'line-height': $chirp-typography-price-small-line-height,
    'font-size': $chirp-typography-price-small-font-size,
    'letter-spacing': $chirp-typography-price-small-letter-spacing,
    'text-decoration': $chirp-typography-price-small-text-decoration,
    'text-case': $chirp-typography-price-small-text-case
  ),
  'price-medium': (
    'font-family': $chirp-typography-price-medium-font-family,
    'font-weight': $chirp-typography-price-medium-font-weight,
    'line-height': $chirp-typography-price-medium-line-height,
    'font-size': $chirp-typography-price-medium-font-size,
    'letter-spacing': $chirp-typography-price-medium-letter-spacing,
    'text-decoration': $chirp-typography-price-medium-text-decoration,
    'text-case': $chirp-typography-price-medium-text-case
  ),
  'price-large': (
    'font-family': $chirp-typography-price-large-font-family,
    'font-weight': $chirp-typography-price-large-font-weight,
    'line-height': $chirp-typography-price-large-line-height,
    'font-size': $chirp-typography-price-large-font-size,
    'letter-spacing': $chirp-typography-price-large-letter-spacing,
    'text-decoration': $chirp-typography-price-large-text-decoration,
    'text-case': $chirp-typography-price-large-text-case
  ),
  'price-x-large': (
    'font-family': $chirp-typography-price-x-large-font-family,
    'font-weight': $chirp-typography-price-x-large-font-weight,
    'line-height': $chirp-typography-price-x-large-line-height,
    'font-size': $chirp-typography-price-x-large-font-size,
    'letter-spacing': $chirp-typography-price-x-large-letter-spacing,
    'text-decoration': $chirp-typography-price-x-large-text-decoration,
    'text-case': $chirp-typography-price-x-large-text-case
  ),
  'price-x-small-strikethrough': (
    'font-family': $chirp-typography-price-x-small-strikethrough-font-family,
    'font-weight': $chirp-typography-price-x-small-strikethrough-font-weight,
    'line-height': $chirp-typography-price-x-small-strikethrough-line-height,
    'font-size': $chirp-typography-price-x-small-strikethrough-font-size,
    'letter-spacing': $chirp-typography-price-x-small-strikethrough-letter-spacing,
    'text-decoration': $chirp-typography-price-x-small-strikethrough-text-decoration,
    'text-case': $chirp-typography-price-x-small-strikethrough-text-case
  ),
  'price-xx-small-strikethrough': (
    'font-family': $chirp-typography-price-xx-small-strikethrough-font-family,
    'font-weight': $chirp-typography-price-xx-small-strikethrough-font-weight,
    'line-height': $chirp-typography-price-xx-small-strikethrough-line-height,
    'font-size': $chirp-typography-price-xx-small-strikethrough-font-size,
    'letter-spacing': $chirp-typography-price-xx-small-strikethrough-letter-spacing,
    'text-decoration': $chirp-typography-price-xx-small-strikethrough-text-decoration,
    'text-case': $chirp-typography-price-xx-small-strikethrough-text-case
  ),
  'price-small-strikethrough': (
    'font-family': $chirp-typography-price-small-strikethrough-font-family,
    'font-weight': $chirp-typography-price-small-strikethrough-font-weight,
    'line-height': $chirp-typography-price-small-strikethrough-line-height,
    'font-size': $chirp-typography-price-small-strikethrough-font-size,
    'letter-spacing': $chirp-typography-price-small-strikethrough-letter-spacing,
    'text-decoration': $chirp-typography-price-small-strikethrough-text-decoration,
    'text-case': $chirp-typography-price-small-strikethrough-text-case
  ),
  'deprecated': (
    'display-1': (
      'font-family': $chirp-typography-deprecated-display-1-font-family,
      'font-weight': $chirp-typography-deprecated-display-1-font-weight,
      'line-height': $chirp-typography-deprecated-display-1-line-height,
      'font-size': $chirp-typography-deprecated-display-1-font-size,
      'letter-spacing': $chirp-typography-deprecated-display-1-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-display-1-text-decoration,
      'text-case': $chirp-typography-deprecated-display-1-text-case
    ),
    'display-2': (
      'font-family': $chirp-typography-deprecated-display-2-font-family,
      'font-weight': $chirp-typography-deprecated-display-2-font-weight,
      'line-height': $chirp-typography-deprecated-display-2-line-height,
      'font-size': $chirp-typography-deprecated-display-2-font-size,
      'letter-spacing': $chirp-typography-deprecated-display-2-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-display-2-text-decoration,
      'text-case': $chirp-typography-deprecated-display-2-text-case
    ),
    'display-3': (
      'font-family': $chirp-typography-deprecated-display-3-font-family,
      'font-weight': $chirp-typography-deprecated-display-3-font-weight,
      'line-height': $chirp-typography-deprecated-display-3-line-height,
      'font-size': $chirp-typography-deprecated-display-3-font-size,
      'letter-spacing': $chirp-typography-deprecated-display-3-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-display-3-text-decoration,
      'text-case': $chirp-typography-deprecated-display-3-text-case
    ),
    'display-4': (
      'font-family': $chirp-typography-deprecated-display-4-font-family,
      'font-weight': $chirp-typography-deprecated-display-4-font-weight,
      'line-height': $chirp-typography-deprecated-display-4-line-height,
      'font-size': $chirp-typography-deprecated-display-4-font-size,
      'letter-spacing': $chirp-typography-deprecated-display-4-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-display-4-text-decoration,
      'text-case': $chirp-typography-deprecated-display-4-text-case
    ),
    'display-5': (
      'font-family': $chirp-typography-deprecated-display-5-font-family,
      'font-weight': $chirp-typography-deprecated-display-5-font-weight,
      'line-height': $chirp-typography-deprecated-display-5-line-height,
      'font-size': $chirp-typography-deprecated-display-5-font-size,
      'letter-spacing': $chirp-typography-deprecated-display-5-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-display-5-text-decoration,
      'text-case': $chirp-typography-deprecated-display-5-text-case
    ),
    'display-6': (
      'font-family': $chirp-typography-deprecated-display-6-font-family,
      'font-weight': $chirp-typography-deprecated-display-6-font-weight,
      'line-height': $chirp-typography-deprecated-display-6-line-height,
      'font-size': $chirp-typography-deprecated-display-6-font-size,
      'letter-spacing': $chirp-typography-deprecated-display-6-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-display-6-text-decoration,
      'text-case': $chirp-typography-deprecated-display-6-text-case
    ),
    'section-1': (
      'font-family': $chirp-typography-deprecated-section-1-font-family,
      'font-weight': $chirp-typography-deprecated-section-1-font-weight,
      'line-height': $chirp-typography-deprecated-section-1-line-height,
      'font-size': $chirp-typography-deprecated-section-1-font-size,
      'letter-spacing': $chirp-typography-deprecated-section-1-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-section-1-text-decoration,
      'text-case': $chirp-typography-deprecated-section-1-text-case
    ),
    'section-2': (
      'font-family': $chirp-typography-deprecated-section-2-font-family,
      'font-weight': $chirp-typography-deprecated-section-2-font-weight,
      'line-height': $chirp-typography-deprecated-section-2-line-height,
      'font-size': $chirp-typography-deprecated-section-2-font-size,
      'letter-spacing': $chirp-typography-deprecated-section-2-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-section-2-text-decoration,
      'text-case': $chirp-typography-deprecated-section-2-text-case
    ),
    'paragraph-1': (
      'font-family': $chirp-typography-deprecated-paragraph-1-font-family,
      'font-weight': $chirp-typography-deprecated-paragraph-1-font-weight,
      'line-height': $chirp-typography-deprecated-paragraph-1-line-height,
      'font-size': $chirp-typography-deprecated-paragraph-1-font-size,
      'letter-spacing': $chirp-typography-deprecated-paragraph-1-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-paragraph-1-text-decoration,
      'text-case': $chirp-typography-deprecated-paragraph-1-text-case
    ),
    'paragraph-2': (
      'font-family': $chirp-typography-deprecated-paragraph-2-font-family,
      'font-weight': $chirp-typography-deprecated-paragraph-2-font-weight,
      'line-height': $chirp-typography-deprecated-paragraph-2-line-height,
      'font-size': $chirp-typography-deprecated-paragraph-2-font-size,
      'letter-spacing': $chirp-typography-deprecated-paragraph-2-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-paragraph-2-text-decoration,
      'text-case': $chirp-typography-deprecated-paragraph-2-text-case
    ),
    'caption': (
      'font-family': $chirp-typography-deprecated-caption-font-family,
      'font-weight': $chirp-typography-deprecated-caption-font-weight,
      'line-height': $chirp-typography-deprecated-caption-line-height,
      'font-size': $chirp-typography-deprecated-caption-font-size,
      'letter-spacing': $chirp-typography-deprecated-caption-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-caption-text-decoration,
      'text-case': $chirp-typography-deprecated-caption-text-case
    ),
    'button': (
      'font-family': $chirp-typography-deprecated-button-font-family,
      'font-weight': $chirp-typography-deprecated-button-font-weight,
      'line-height': $chirp-typography-deprecated-button-line-height,
      'font-size': $chirp-typography-deprecated-button-font-size,
      'letter-spacing': $chirp-typography-deprecated-button-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-button-text-decoration,
      'text-case': $chirp-typography-deprecated-button-text-case
    ),
    'overline': (
      'font-family': $chirp-typography-deprecated-overline-font-family,
      'font-weight': $chirp-typography-deprecated-overline-font-weight,
      'line-height': $chirp-typography-deprecated-overline-line-height,
      'font-size': $chirp-typography-deprecated-overline-font-size,
      'letter-spacing': $chirp-typography-deprecated-overline-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-overline-text-decoration,
      'text-case': $chirp-typography-deprecated-overline-text-case
    ),
    'hero-1': (
      'font-family': $chirp-typography-deprecated-hero-1-font-family,
      'font-weight': $chirp-typography-deprecated-hero-1-font-weight,
      'line-height': $chirp-typography-deprecated-hero-1-line-height,
      'font-size': $chirp-typography-deprecated-hero-1-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-1-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-1-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-1-text-case
    ),
    'hero-2': (
      'font-family': $chirp-typography-deprecated-hero-2-font-family,
      'font-weight': $chirp-typography-deprecated-hero-2-font-weight,
      'line-height': $chirp-typography-deprecated-hero-2-line-height,
      'font-size': $chirp-typography-deprecated-hero-2-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-2-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-2-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-2-text-case
    ),
    'hero-3': (
      'font-family': $chirp-typography-deprecated-hero-3-font-family,
      'font-weight': $chirp-typography-deprecated-hero-3-font-weight,
      'line-height': $chirp-typography-deprecated-hero-3-line-height,
      'font-size': $chirp-typography-deprecated-hero-3-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-3-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-3-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-3-text-case
    ),
    'hero-4': (
      'font-family': $chirp-typography-deprecated-hero-4-font-family,
      'font-weight': $chirp-typography-deprecated-hero-4-font-weight,
      'line-height': $chirp-typography-deprecated-hero-4-line-height,
      'font-size': $chirp-typography-deprecated-hero-4-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-4-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-4-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-4-text-case
    ),
    'hero-1-alternate': (
      'font-family': $chirp-typography-deprecated-hero-1-alternate-font-family,
      'font-weight': $chirp-typography-deprecated-hero-1-alternate-font-weight,
      'line-height': $chirp-typography-deprecated-hero-1-alternate-line-height,
      'font-size': $chirp-typography-deprecated-hero-1-alternate-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-1-alternate-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-1-alternate-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-1-alternate-text-case
    ),
    'hero-2-alternate': (
      'font-family': $chirp-typography-deprecated-hero-2-alternate-font-family,
      'font-weight': $chirp-typography-deprecated-hero-2-alternate-font-weight,
      'line-height': $chirp-typography-deprecated-hero-2-alternate-line-height,
      'font-size': $chirp-typography-deprecated-hero-2-alternate-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-2-alternate-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-2-alternate-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-2-alternate-text-case
    ),
    'hero-3-alternate': (
      'font-family': $chirp-typography-deprecated-hero-3-alternate-font-family,
      'font-weight': $chirp-typography-deprecated-hero-3-alternate-font-weight,
      'line-height': $chirp-typography-deprecated-hero-3-alternate-line-height,
      'font-size': $chirp-typography-deprecated-hero-3-alternate-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-3-alternate-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-3-alternate-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-3-alternate-text-case
    ),
    'hero-4-alternate': (
      'font-family': $chirp-typography-deprecated-hero-4-alternate-font-family,
      'font-weight': $chirp-typography-deprecated-hero-4-alternate-font-weight,
      'line-height': $chirp-typography-deprecated-hero-4-alternate-line-height,
      'font-size': $chirp-typography-deprecated-hero-4-alternate-font-size,
      'letter-spacing': $chirp-typography-deprecated-hero-4-alternate-letter-spacing,
      'text-decoration': $chirp-typography-deprecated-hero-4-alternate-text-decoration,
      'text-case': $chirp-typography-deprecated-hero-4-alternate-text-case
    )
  )
);

Description

Modified 'scss/map-deep' template to output custom properties for properties that have references

utilities

functions

whole-pixel

@function whole-pixel($factor, $base) { ... }

Description

Calculate a factor that results in whole pixel units when compared a base pixel value.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$factor

The factor to compare for whole pixel-iness.

Number(unitless) none
$base

A base value to check $factor against.

$base(px) none

Returns

Number(unitless)

Requires

strip-unit

@function strip-unit($number) { ... }

Description

Remove the unit of a length

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$number

Number to remove unit from

Number none

Returns

Number

Unitless number

Used by

px-to-relative

@function px-to-relative($px, $base: $kib-core-root-font-size, $inline: false) { ... }

Description

Convert a number using pixel units to a comparable relative unit value.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$px noneNumber(px) none
$base noneNumber(px)$kib-core-root-font-size
$inline noneBooleanfalse

Returns

Number(rem or Em)

Used by

encode-color

@function encode-color($color) { ... }

Description

Replace the # in a color with its encoding, %23.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$color noneColor(hex) none

Returns

Color

Requires

str-replace

@function str-replace($string, $search, $replace) { ... }

Description

Replace instances of a substring

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$string

The source string to search within

String none
$search

The substring to search for in $string

String none
$replace

Replace instances of $search in $string with this value

String none

Returns

String

Returns a modified version of $string that has instances of $search replaced with $replace

Used by

Links

svg-encode

@function svg-encode($svg) { ... }

Description

Encode an inline SVG element so that it works with legacy browsers.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$svg

An inline SVG string

String none

Returns

String

An encoded version of $svg

Requires

svg-base64-encode

@function svg-base64-encode($svg) { ... }

Description

Encode an inline base64 SVG element so that it works with legacy browsers.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$svg

An inline SVG string

String none

Returns

String

An encoded version of $svg

map-deep-get

@function map-deep-get($map, $keys...) { ... }

Description

Map deep get

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$map

Map

Map none
$keys

Key chain

Arglist none

Returns

Any type —

Desired value

Requires

Links

Author

  • Hugo Giraudel

map-deep-set

@function map-deep-set($map, $keys, $value) { ... }

Description

Deep set function to set a value in nested maps

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$map

Map

Map none
$keys

Key chaine

List none
$value

Value to assign

Any none

Returns

Map

Throws

  • Key #{$current-key} doesn

Requires

Links

Author

  • Hugo Giraudel

get-type-size

@function get-type-size($definition) { ... }

Description

Get a type size definition from $kib-type-sizes.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition

The name of the definition to get.

String none

Returns

Map or Null

If the definition is defined, the a definition map will be returned. If the definition does not exist, a warning will be emitted along with a null value.

Requires

Used by

get-type-property

@function get-type-property($definition, $property, $options: ()) { ... }

Description

Get the property from a type size definition.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition

Name of a type size definition.

String none
$property

Name of a property within the type size definition.

String none
$options

Options to pass to the function. A map (default) will add options to the kib-core-px-to-relative function. Allowed keys are base, which takes a pixel value, and inline, which takes a boolean value.

Map or String()

Returns

Number(px) or Number(rem) or Null

Example

$map: (
  base: 16px,
  inline: true
);

Passing a string value of `px` will return px units.

Requires

Used by

type-line-height

@function type-line-height($definition) { ... }

Description

Calculate line height of a type size definition.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition

Name of a type size definition.

String none

Requires

Used by

type-baseline-distance

@function type-baseline-distance($definition) { ... }

Description

Calculte the distance to the baseline of a text definition.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition

The name of the text size definition to process.

String none

Requires

Used by

type-block-space-bottom

@function type-block-space-bottom($definition) { ... }

Description

Calculate spacing below a block element of a text size.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition

The name of the text size definition to process.

String none

Returns

Number(px)

Requires

Used by

type-block-adjust-top

@function type-block-adjust-top($definition) { ... }

Description

Calculate spacing above a block element of a text size.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition

The name of the text size definition to process.

String none

Returns

Number(px)

Requires

Used by

type-whole-pixel-factor

@function type-whole-pixel-factor($factor, $base) { ... }

Description

Calculate a factor that results in whole pixel units when compared a base pixel value.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$factor

The factor to compare for whole pixel-iness.

Number(unitless) none
$base

A base value to check the $factor against.

$base(px) none

Returns

Number(unitless)

Requires

Used by

type-strip-unit

@function type-strip-unit($number) { ... }

Description

Remove the unit of a length

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$number

Number to remove unit from

Number none

Returns

Number

Unitless number

Used by

mixins

add-block-margins

@mixin add-block-margins($definition) { ... }

Description

Add margins to a block style element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition

The name of the definition to create margins for.

String none

Requires

size-inline-element

@mixin size-inline-element($definition) { ... }

Description

Generate styles for an inline element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition noneString none

Requires

size-block-element

@mixin size-block-element($definition) { ... }

Description

Generate styles for a block element.

Parameters

parameter Nameparameter Descriptionparameter Typeparameter Default value
$definition noneString none

Requires

variables

sizes

$sizes: (
  epic: (
    size: $kib-type-sizes-epic-size,
    height: $kib-type-sizes-epic-height,
    lead: $kib-type-sizes-epic-lead
  ),
  huge: (
    size: $kib-type-sizes-huge-size,
    height: $kib-type-sizes-huge-height,
    lead: $kib-type-sizes-huge-lead
  ),
  giant: (
    size: $kib-type-sizes-giant-size,
    height: $kib-type-sizes-giant-height,
    lead: $kib-type-sizes-giant-lead
  ),
  large: (
    size: $kib-type-sizes-large-size,
    height: $kib-type-sizes-large-height,
    lead: $kib-type-sizes-large-lead
  ),
  medium: (
    size: $kib-type-sizes-medium-size,
    height: $kib-type-sizes-medium-height,
    lead: $kib-type-sizes-medium-lead
  ),
  base: (
    size: $kib-type-sizes-base-size,
    height: $kib-type-sizes-base-height,
    lead: $kib-type-sizes-base-lead
  ),
  small: (
    size: $kib-type-sizes-small-size,
    height: $kib-type-sizes-small-height,
    lead: $kib-type-sizes-small-lead
  ),
  tiny: (
    size: $kib-type-sizes-tiny-size,
    height: $kib-type-sizes-tiny-height,
    lead: $kib-type-sizes-tiny-lead
  ),
  micro: (
    size: $kib-type-sizes-micro-size,
    height: $kib-type-sizes-micro-height,
    lead: $kib-type-sizes-micro-lead
  )
) !default;

Description

Font size and spacing definitions.

Map structure

key Namekey Descriptionkey Typekey Value
base

Base size definition for the document.

Map none
base.size noneNumber(px) none
base.height noneNumber(px) none
base.lead noneNumber(px) none

weights

$weights: (
  light: $kib-type-weights-light,
  regular: $kib-type-weights-regular,
  medium: $kib-type-weights-medium,
  bold: $kib-type-weights-bold
) !default;

Description

Define available font-weight values.

Type

{map}

Map structure

{Map} key Name{Map} key Description{Map} key Type{Map} key Value
light noneNumber none
regular noneNumber none
medium noneNumber none
bold noneNumber none

zoom-image

mixins

base-styles

@mixin base-styles() { ... }

Description

Generate base styles for zoom image

Parameters

None.

lens

@mixin lens() { ... }

Description

Styles for zoom image lens

Parameters

None.

Requires

normal-image

@mixin normal-image() { ... }

Description

Styles for zoom image normal

Parameters

None.

loader

@mixin loader() { ... }

Description

Styles for zoom image loader

Parameters

None.

Requires

container

@mixin container() { ... }

Description

Styles for zoom image container

Parameters

None.

Requires

wrapper

@mixin wrapper() { ... }

Description

Styles for zoom image wrapper

Parameters

None.

window

@mixin window() { ... }

Description

Styles for zoom image window

Parameters

None.

Requires

image

@mixin image() { ... }

Description

Styles for zoom image's image

Parameters

None.

transition-lens

@mixin transition-lens() { ... }

Description

Transition styles for zoom image lens

Parameters

None.

transition-image

@mixin transition-image() { ... }

Description

Transition styles for zoom image

Parameters

None.

variables

zoom-image-lens-border

$zoom-image-lens-border: #aaa !default;

Description

border color of zoom image lens

Type

Color

Used by

zoom-image-lens-blur

$zoom-image-lens-blur: kib-core-px-to-relative(5px) !default;

Description

Blur dimension of zoom image lens

Type

Number

Used by

zoom-image-lens-bgcolor

$zoom-image-lens-bgcolor: kib-core-theme-get('fair') !default;

Description

background color of zoom image lens

Type

Color

Used by

zoom-image-lens-border-size

$zoom-image-lens-border-size: kib-core-px-to-relative(1px) !default;

Description

border width of zoom image lens

Type

Number

Used by

zoom-image-container-width

$zoom-image-container-width: kib-core-px-to-relative(704px) !default;

Description

width of zoom image container

Type

Number

Used by

zoom-image-container-height

$zoom-image-container-height: kib-core-px-to-relative(500px) !default;

Description

height of zoom image container

Type

Number

Used by

zoom-image-container-spacing

$zoom-image-container-spacing: kib-core-px-to-relative(20px) !default;

Description

spacing of the zoom image container

Type

Number

Used by

zoom-image-loader-border-color

$zoom-image-loader-border-color: kib-core-theme-get('fair') !default;

Description

border loader color of zoom image

Type

Color

Used by

zoom-image-window-background-color

$zoom-image-window-background-color: kib-core-theme-get('fair') !default;

Description

background color of zoom image window

Type

Color

Used by

zoom-pinch

mixins

base-styles

@mixin base-styles() { ... }

Description

Generate base styles for zoom pinch.

Parameters

None.

Requires

wrapper-styles

@mixin wrapper-styles() { ... }

Description

Styles for zoom pinch wrapper

Parameters

None.

variables

padding

$padding: 0 !default;

Description

Default padding

Type

Number

margin

$margin: 0 !default;

Description

Default margin

Type

Number

Used by