Fields Autocomplete

Installation

  yarn add @chewy/kib-fields-styles

Import

  @use '~@chewy/kib-fields-styles/src/kib-input-autocomplete/styles' as kib-input-autocomplete;

Mixins

autocomplete-menu

@mixin autocomplete-menu() { ... }@mixin autocomplete-menu() { 
  position: absolute;
  top: calc(#{common.$height} - #{spacing.get('s2')});
  left: 0;
  z-index: settings.$menu-zindex;
  width: 100%;
 }
Description

Generates styles for the autocomplete menu wrapper

Parameters

None.

Requires
Author
  • CDS

autocomplete-listbox

@mixin autocomplete-listbox($block) { ... }@mixin autocomplete-listbox($block) { 
  margin: 0;
  padding: 0;
  max-height: settings.$menu-height;
  overflow: auto;
  background-color: settings.$menu-background-color;
  border: unit.rem(2px) solid common.$border-color-emphasis;
  border-top: 0;
  border-radius: 0 0 common.$radius common.$radius;
  list-style: none;

  #{$block}--invalid & {
    border-color: common.$border-color-danger;
  }
 }
Description

Generates styles for the autocomplete menu list

Parameters
Parameters
parameter Nameparameter Descriptionparameter Typeparameter Default value
$block

root class of parent block element

String none
Requires
Author
  • CDS

autocomplete-option

@mixin autocomplete-option() { ... }@mixin autocomplete-option() { 
  margin: 0;
  padding: spacing.get('s1', 's4');
  background-color: transparent;
  color: settings.$option-text-color;
  cursor: pointer;
  font-weight: $kib-type-weights-bold;

  &:focus,
  &:hover,
  &.is-active {
    background-color: settings.$option-background-color-emphasis;
  }
 }
Description

Generates styles for the autocomplete menu option (suggestion)

Parameters

None.

Requires
Author
  • CDS

autocomplete-option-hidden

@mixin autocomplete-option-hidden() { ... }@mixin autocomplete-option-hidden() { 
  @include kib-core-visually-hidden;
 }
Description

Visually hidden option for screen readers

Parameters

None.

Author
  • CDS

autocomplete-loader-wrapper

@mixin autocomplete-loader-wrapper() { ... }@mixin autocomplete-loader-wrapper() { 
  @at-root {
    @include kib-spinner.wrapper-animation('kib-spinner-outer');
    @include kib-spinner.path-animation('kib-spinner-path');
  }

  @include kib-spinner.container('kib-spinner-outer');

  margin: 0;
  color: settings.$loader-color;
 }
Description

Generate styles for autocomplete loading spinner wrapper

Parameters

None.

Requires
Author
  • CDS

autocomplete-loader

@mixin autocomplete-loader() { ... }@mixin autocomplete-loader() { 
  @include kib-spinner.path('kib-spinner-path');
 }
Description

Generate styles for autocomplete loading spinner

Parameters

None.

Author
  • CDS

autocomplete-option-highlight

@mixin autocomplete-option-highlight() { ... }@mixin autocomplete-option-highlight() { 
  font-weight: $kib-type-weights-regular;
 }
Description

Generate highlighting styles on suggestion string match

Parameters

None.

Author
  • CDS

Variables

menu-height

$menu-height: unit.rem(160px) !default;
Description

Maximum height of menu when it requires scrolling

Type

Number

Used by
Author
  • CDS

menu-background-color

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

Menu background color

Type

Color

Used by
Author
  • CDS

indexes

$indexes: kib-core-zindex-set(autocomplete-menu, 1000);
Description

Set z-index of menu

Author
  • CDS

menu-zindex

$menu-zindex: kib-core-zindex-get(autocomplete-menu) !default;
Description

Menu z-index

Type

Color

Used by
Author
  • CDS

option-background-color-emphasis

$option-background-color-emphasis: color.get('field', '02') !default;
Description

Menu option background color on hover/focus/active state

Type

Color

Used by
Author
  • CDS

option-text-color

$option-text-color: common.$text-color-emphasis !default;
Description

Menu option text color

Type

Color

Used by
Author
  • CDS

loader-color

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

Loader color

Type

Color

Author
  • CDS