@terminus/ui-select

v3.0.0

Published

3 years ago

<h1>Select :rotating_light: DEPRECATED :rotating_light:</h1>

Downloads

0High
0Medium
0Low

bmalinconico-terminus

atlwendy

terminus_devops

:rotating_light: NOTE: This component is deprecated. Please use the Selection List Component.

A custom select dropdown.

Installation

Packages that need to be installed

@angular/cdk
@angular/common
@angular/core
@angular/flex-layout
@angular/forms
@angular/material
@angular/platform-browser
@terminus/design-tokens
@terminus/fe-utilities
@terminus/ui-checkbox
@terminus/ui-form-field
@terminus/ui-icon
@terminus/ui-input
@terminus/ui-option
@terminus/ui-pipes
@terminus/ui-validators
@terminus/ui-spacing
@terminus/ui-styles
@terminus/ui-validation-messages
@terminus/ui-utilities
@terminus/ui-select
date-fns
text-mask-addons
text-mask-core

Use the ng add command to quickly install all the needed dependencies:

ng add @terminus/ui-select

Modules that need to be in NgModule

BrowserAnimationsModule,
TsOptionModule,
TsSelectModule,
FormsModule,
ReactiveFormsModule

CSS imports

In your top level stylesheet, add these imports:

@import '~@terminus/design-tokens/css/library-design-tokens.css';
@import '~@terminus/ui-styles/terminus-ui.css';

CSS resources

Load the needed font families by adding this link to the <head> of your application:

<link href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">

Usage

The most basic usage is by wrapping one or more ts-options inside an ts-select:

<!-- Define the option value by passing a property to the option's `value` input -->
<ts-select>
  <ts-option
    *ngFor="let item of items"
    [value]="item.value"
  >{{ item.name }}</ts-option>
</ts-select>

Label

Define a label on the select:

<ts-select label="My cool label!">
  ...
</ts-select>

Hint

Define a hint on the select:

<ts-select hint="Please select an option">
  ...
</ts-select>

No validation or hint

A flag to define whether this select field needs validation or hint. If it needs validation or hint, a padding bottom is added for the message, otherwise, no padding at the bottom.

<ts-select
  [formControl]="myCtrl"
  [noValidationOrHint]="true"
></ts-select>

FormControl

To use a FormControl with the select, pass the control in:

<ts-select [formControl]="myCtrl">
  ...
</ts-select>

ngModel

To use ngModel, add the model to the select:

<ts-select [(ngModel)]="myModel">
  ...
</ts-select>

Custom compare function

If more refined control of how options are compared is needed, a custom comparator function can be used:

<ts-select [compareWith]="compareByReference">
  ...
</ts-select>

// Example comparing by reference:
compareByReference(f1: any, f2: any) { return f1 === f2; }

// Example comparing by value:
compareByValue(f1: any, f2: any) { return f1 && f2 && f1.text === f2.text; }

TsOptionCompareWith = (o1: any, o2: any) => boolean;

Optgroups

Optgroups can be used by wrapping one or more options inside an optgroup component:

<ts-select>
  <ts-select-optgroup
    *ngFor="let group of itemsWithGroups"
    [label]="group.myLabel"
  >
    <ts-option
      *ngFor="let child of group.children"
      [value]="child.slug"
    >{{ child.foo }}</ts-option>
  </ts-select-optgroup>
</ts-select>

Disabled

The entire select can be disabled in one of two ways:

Disable via Input

<ts-select [isDisabled]="true">
  ...
</ts-select>

Disable via FormControl

myCtrl = new FormControl({value: null, disabled: true});

<ts-select [formControl]="myCtrl">
  ...
</ts-select>

Disabled Option

Individual options may also be disabled:

<ts-select>
  <ts-option
    *ngFor="let option of options"
    [value]="option.value"
    [isDisabled]="option.disabled" <!-- Disabled when true -->
  >{{ option.name }}</ts-option>
</ts-select>

Disabled Optgroup

Entire optgroups can be disabled just like options. When an optgroup is disabled, all options that are children of that optgroup are also disabled.

<ts-select>
  <ts-select-optgroup
    *ngFor="let group of itemsWithGroups"
    [label]="group.myLabel"
    [isDisabled]="option.disabled" <!-- Disabled when true -->
  >
    <ts-option
      *ngFor="let child of group.children"
      [value]="child.slug"
    >{{ child.foo }}</ts-option>
  </ts-select-optgroup>
</ts-select>

Required

The entire select can be marked required in one of two ways:

Required by Input

<ts-select [isRequired]="true">
  ...
</ts-select>

Required by FormControl

myCtrl = new FormControl(null, Validators.required);

<ts-select [formControl]="myCtrl">
  ...
</ts-select>

Placeholder

The placeholder is used for the trigger value when the control or model value is empty.

<ts-select placeholder="Please make a selection.">
  ...
</ts-select>

Custom trigger value

Custom HTML can be used for the trigger value by using the ts-select-trigger component. This trigger will be shown when the control or model does have value.

<ts-select>
  <!-- Here is my custom trigger! -->
  <ts-select-trigger>
    My custom trigger!
    With <strong>custom</strong> HTML!
  </ts-select-trigger>

  <ts-option
    [value]="option.value"
    *ngFor="let option of options"
  >{{ option.name }}</ts-option>
</ts-select>

Blank option

A blank option can be implemented by adding a ts-option with no value:

<ts-select [formControl]="myForm.get('myChoices1')">
  <ts-option>
    None
  </ts-option>

  <ts-option
    [value]="option.value"
    *ngFor="let option of options"
  >{{ option.name }}</ts-option>
</ts-select>

Option template

A custom template can be used for the option content.

NOTE: The option object must be passed into the option when using a custom template

<ts-select>
  <ts-option
    *ngFor="let option of options"
    [value]="option.value"
    [option]="option"
  >
    <!-- The object you pass to the `option` input will be exposed as `option` in the template -->
    <ng-template let-option>
      <div class="myClass">
        <h4>{{ option.name }}</h4>
        <small>{{ option.value / 100 }}%</small>
      </div>
    </ng-template>
  </ts-option>
</ts-select>

Custom view value

Part of the option view can be defined as the 'view value' which is used to define the title attribute for the option:

<ts-select>
  <ts-option
    *ngFor="let option of options"
    [value]="option.value"
    [option]="option"
  >
    <ng-template let-option>
      <div class="myClass">
        <!-- The content of this h4 will be used for the option title -->
        <h4 tsOptionDisplay>{{ option.name }}</h4>
        <small>{{ option.value / 100 }}%</small>
      </div>
    </ng-template>
  </ts-option>
</ts-select>

Multiple selections

Allow multiple selections via an @Input:

<ts-select [allowMultiple]="true">
  ...
</ts-select>

This will show checkboxes next to each option and include a top-level 'Select All' toggle.

Custom delimiter

The delimiter is used to separate multiple options when shown in the trigger. By default this is a comma (,). A custom delimiter may also be set:

<ts-select
  [allowMultiple]="true"
  delimiter="/"
>
  ...
</ts-select>
<!-- Standard output: `foo, bar, baz` -->
<!-- Output with custom delimiter: `foo/ bar/ baz` -->

Custom sort comparator

By default, the selections will be stored in the order matching the order of items passed in. A custom sort comparator may be passed in to alter the sort order.

<ts-select [sortComparator]="myComparatorFn">
  ...
</ts-select>

The comparator function type is TsSelectSortComparatorFunction and has the following format:

type TsSelectSortComparatorFunction = (
  a: TsOptionComponent,
  b: TsOptionComponent,
  options: TsOptionComponent[],
) => number;

Filterable

A select can include an input at the top of the list to filter options:

<ts-select
  [formControl]="myCtrl"
  [isFilterable]="true"
  (queryChange)="mySearchFunction($event)"
>
  ...
</ts-select>

Any unique, debounced query will be emitted through the queryChange emitter. The consumer is in control of what options are displayed. A blank option can be used to show the user a message when no items are found by the query.

Allow user to request update

There are times where the data may change after it is loaded. The showRefresh option allows the user to manually request updated data.

<ts-select
  [formControl]="myCtrl"
  [showRefresh]="true"
  (optionsRefreshRequested)="userRequestedRefresh()"
>
  ...
</ts-select>

Prompt the user to refine their search

For certain queries it is not always possible to return all options. In those cases, we should prompt the user to refine their search for better results.

<ts-select
  [formControl]="myCtrl"
  [showRefineSearchMessage]="true"
>
  ...
</ts-select>

This will show a message below all existing options:

Narrow your search to reveal hidden results.

If the totalHiddenResults input is defined, the count will be included in the message:

<ts-select
  [formControl]="myCtrl"
  [showRefineSearchMessage]="true"
  [totalHiddenResults]="972"
>
  ...
</ts-select>

This will show a message below all existing options:

Narrow your search to reveal 972 hidden results.

Events

Multiple events are fired during interaction with the select:

| Event | Description | Payload | |:--------------------------|:------------------------------------------------|:---------------------| | closed | Fired when the panel is closed | undefined | | duplicateSelection | Fired when a duplicate selection is made | string | | opened | Fired when the panel is open | undefined | | optionDeselected | Fired when an option is deselected | TsSelectChange | | optionSelected | Fired when an option is selected | TsSelectChange | | optionsRefreshRequested | Fired when the user selects the refresh trigger | undefined | | queryChange | Fired when query changes | string | | selectionChange | Fired when the selection changes | TsSelectChange | | valueChange | Fired when the selection value changes | string \| string[] |

<ts-select (selectionChange)="myFunction($event)">
  ...
</ts-select>

The TsSelectChange structure:

class TsSelectChange {
  constructor(
    // Reference to the select that emitted the change event
    public source: TsSelectComponent,
    // The current value
    public value: any,
  ) {}
}

Test helpers

Some helpers are exposed to assist with testing. These are imported from @terminus/ui-select/testing;

[source]

| Function | |---------------------------| | getSelectInstance | | getSelectElement | | getSelectTriggerElement | | getToggleAllElement | | getPanelElement | | getAllOptionInstances | | getOptionInstance | | getOptionElement | | getAllOptgroups | | getOptgroup | | getOptgroupElement | | getAllChipInstances | | getChipInstance | | getChipElement | | getFilterInputElement |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Table of Contents

Installation

Packages that need to be installed

Modules that need to be in NgModule

CSS imports

CSS resources

Usage

Label

Hint

No validation or hint

FormControl

ngModel

Custom compare function

Optgroups

Disabled

Disable via Input

Disable via FormControl

Disabled Option

Disabled Optgroup

Required

Required by Input

Required by FormControl

Placeholder

Custom trigger value

Blank option

Option template

Custom view value

Multiple selections

Custom delimiter

Custom sort comparator

Filterable

Allow user to request update

Prompt the user to refine their search

Events

Test helpers