@angular/material
Version:
Angular Material
1,100 lines (1,097 loc) • 70.8 kB
JavaScript
import { SPACE, BACKSPACE, DELETE, TAB, hasModifierKey, ENTER } from '@angular/cdk/keycodes';
import * as i0 from '@angular/core';
import { InjectionToken, Directive, EventEmitter, Optional, Inject, Attribute, ContentChild, Input, Output, Component, ViewEncapsulation, ChangeDetectionStrategy, Self, ContentChildren, NgModule } from '@angular/core';
import * as i3 from '@angular/material/core';
import { mixinTabIndex, mixinColor, mixinDisableRipple, RippleRenderer, MAT_RIPPLE_GLOBAL_OPTIONS, mixinErrorState, MatCommonModule, ErrorStateMatcher } from '@angular/material/core';
import { coerceBooleanProperty } from '@angular/cdk/coercion';
import * as i1 from '@angular/cdk/platform';
import { DOCUMENT } from '@angular/common';
import { ANIMATION_MODULE_TYPE } from '@angular/platform-browser/animations';
import { Subject, merge } from 'rxjs';
import { take, takeUntil, startWith } from 'rxjs/operators';
import { FocusKeyManager } from '@angular/cdk/a11y';
import * as i1$1 from '@angular/cdk/bidi';
import { SelectionModel } from '@angular/cdk/collections';
import * as i2 from '@angular/forms';
import { Validators } from '@angular/forms';
import { MatLegacyFormFieldControl } from '@angular/material/legacy-form-field';
/**
* Event object emitted by MatChip when selected or deselected.
* @deprecated Use `MatChipSelectionChange` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
class MatLegacyChipSelectionChange {
constructor(
/** Reference to the chip that emitted the event. */
source,
/** Whether the chip that emitted the event is selected. */
selected,
/** Whether the selection change was a result of a user interaction. */
isUserInput = false) {
this.source = source;
this.selected = selected;
this.isUserInput = isUserInput;
}
}
/**
* Injection token that can be used to reference instances of `MatChipRemove`. It serves as
* alternative token to the actual `MatChipRemove` class which could cause unnecessary
* retention of the class and its directive metadata.
* @deprecated Use `MAT_CHIP_REMOVE` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
const MAT_LEGACY_CHIP_REMOVE = new InjectionToken('MatChipRemove');
/**
* Injection token that can be used to reference instances of `MatChipAvatar`. It serves as
* alternative token to the actual `MatChipAvatar` class which could cause unnecessary
* retention of the class and its directive metadata.
* @deprecated Use `MAT_CHIP_AVATAR` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
const MAT_LEGACY_CHIP_AVATAR = new InjectionToken('MatChipAvatar');
/**
* Injection token that can be used to reference instances of `MatChipTrailingIcon`. It serves as
* alternative token to the actual `MatChipTrailingIcon` class which could cause unnecessary
* retention of the class and its directive metadata.
* @deprecated Use `MAT_CHIP_TRAILING_ICON` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
const MAT_LEGACY_CHIP_TRAILING_ICON = new InjectionToken('MatChipTrailingIcon');
// Boilerplate for applying mixins to MatChip.
/** @docs-private */
class MatChipBase {
constructor(_elementRef) {
this._elementRef = _elementRef;
}
}
const _MatChipMixinBase = mixinTabIndex(mixinColor(mixinDisableRipple(MatChipBase), 'primary'), -1);
/**
* Dummy directive to add CSS class to chip avatar.
* @docs-private
* @deprecated Use `MatChipAvatar` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
class MatLegacyChipAvatar {
}
MatLegacyChipAvatar.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChipAvatar, deps: [], target: i0.ɵɵFactoryTarget.Directive });
MatLegacyChipAvatar.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.0.0-rc.1", type: MatLegacyChipAvatar, selector: "mat-chip-avatar, [matChipAvatar]", host: { classAttribute: "mat-chip-avatar" }, providers: [{ provide: MAT_LEGACY_CHIP_AVATAR, useExisting: MatLegacyChipAvatar }], ngImport: i0 });
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChipAvatar, decorators: [{
type: Directive,
args: [{
selector: 'mat-chip-avatar, [matChipAvatar]',
host: { 'class': 'mat-chip-avatar' },
providers: [{ provide: MAT_LEGACY_CHIP_AVATAR, useExisting: MatLegacyChipAvatar }],
}]
}] });
/**
* Dummy directive to add CSS class to chip trailing icon.
* @docs-private
* @deprecated Use `MatChipTrailingIcon` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
class MatLegacyChipTrailingIcon {
}
MatLegacyChipTrailingIcon.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChipTrailingIcon, deps: [], target: i0.ɵɵFactoryTarget.Directive });
MatLegacyChipTrailingIcon.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.0.0-rc.1", type: MatLegacyChipTrailingIcon, selector: "mat-chip-trailing-icon, [matChipTrailingIcon]", host: { classAttribute: "mat-chip-trailing-icon" }, providers: [{ provide: MAT_LEGACY_CHIP_TRAILING_ICON, useExisting: MatLegacyChipTrailingIcon }], ngImport: i0 });
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChipTrailingIcon, decorators: [{
type: Directive,
args: [{
selector: 'mat-chip-trailing-icon, [matChipTrailingIcon]',
host: { 'class': 'mat-chip-trailing-icon' },
providers: [{ provide: MAT_LEGACY_CHIP_TRAILING_ICON, useExisting: MatLegacyChipTrailingIcon }],
}]
}] });
/**
* Material Design styled chip directive. Used inside the MatChipList component.
* @deprecated Use `MatChip` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
class MatLegacyChip extends _MatChipMixinBase {
constructor(elementRef, _ngZone, platform, globalRippleOptions, _changeDetectorRef, _document, animationMode, tabIndex) {
super(elementRef);
this._ngZone = _ngZone;
this._changeDetectorRef = _changeDetectorRef;
/** Whether the chip has focus. */
this._hasFocus = false;
/** Whether the chip list is selectable */
this.chipListSelectable = true;
/** Whether the chip list is in multi-selection mode. */
this._chipListMultiple = false;
/** Whether the chip list as a whole is disabled. */
this._chipListDisabled = false;
/** ARIA role that should be applied to the chip. */
this.role = 'option';
this._selected = false;
this._selectable = true;
this._disabled = false;
this._removable = true;
/** Emits when the chip is focused. */
this._onFocus = new Subject();
/** Emits when the chip is blurred. */
this._onBlur = new Subject();
/** Emitted when the chip is selected or deselected. */
this.selectionChange = new EventEmitter();
/** Emitted when the chip is destroyed. */
this.destroyed = new EventEmitter();
/** Emitted when a chip is to be removed. */
this.removed = new EventEmitter();
this._addHostClassName();
// Dynamically create the ripple target, append it within the chip, and use it as the
// chip's ripple target. Adding the class '.mat-chip-ripple' ensures that it will have
// the proper styles.
this._chipRippleTarget = _document.createElement('div');
this._chipRippleTarget.classList.add('mat-chip-ripple');
this._elementRef.nativeElement.appendChild(this._chipRippleTarget);
this._chipRipple = new RippleRenderer(this, _ngZone, this._chipRippleTarget, platform);
this._chipRipple.setupTriggerEvents(elementRef);
this.rippleConfig = globalRippleOptions || {};
this._animationsDisabled = animationMode === 'NoopAnimations';
this.tabIndex = tabIndex != null ? parseInt(tabIndex) || -1 : -1;
}
/**
* Whether ripples are disabled on interaction
* @docs-private
*/
get rippleDisabled() {
return (this.disabled ||
this.disableRipple ||
this._animationsDisabled ||
!!this.rippleConfig.disabled);
}
/** Whether the chip is selected. */
get selected() {
return this._selected;
}
set selected(value) {
const coercedValue = coerceBooleanProperty(value);
if (coercedValue !== this._selected) {
this._selected = coercedValue;
this._dispatchSelectionChange();
}
}
/** The value of the chip. Defaults to the content inside `<mat-chip>` tags. */
get value() {
return this._value !== undefined ? this._value : this._elementRef.nativeElement.textContent;
}
set value(value) {
this._value = value;
}
/**
* Whether or not the chip is selectable. When a chip is not selectable,
* changes to its selected state are always ignored. By default a chip is
* selectable, and it becomes non-selectable if its parent chip list is
* not selectable.
*/
get selectable() {
return this._selectable && this.chipListSelectable;
}
set selectable(value) {
this._selectable = coerceBooleanProperty(value);
}
/** Whether the chip is disabled. */
get disabled() {
return this._chipListDisabled || this._disabled;
}
set disabled(value) {
this._disabled = coerceBooleanProperty(value);
}
/**
* Determines whether or not the chip displays the remove styling and emits (removed) events.
*/
get removable() {
return this._removable;
}
set removable(value) {
this._removable = coerceBooleanProperty(value);
}
/** The ARIA selected applied to the chip. */
get ariaSelected() {
// Remove the `aria-selected` when the chip is deselected in single-selection mode, because
// it adds noise to NVDA users where "not selected" will be read out for each chip.
return this.selectable && (this._chipListMultiple || this.selected)
? this.selected.toString()
: null;
}
_addHostClassName() {
const basicChipAttrName = 'mat-basic-chip';
const element = this._elementRef.nativeElement;
if (element.hasAttribute(basicChipAttrName) ||
element.tagName.toLowerCase() === basicChipAttrName) {
element.classList.add(basicChipAttrName);
return;
}
else {
element.classList.add('mat-standard-chip');
}
}
ngOnDestroy() {
this.destroyed.emit({ chip: this });
this._chipRipple._removeTriggerEvents();
}
/** Selects the chip. */
select() {
if (!this._selected) {
this._selected = true;
this._dispatchSelectionChange();
this._changeDetectorRef.markForCheck();
}
}
/** Deselects the chip. */
deselect() {
if (this._selected) {
this._selected = false;
this._dispatchSelectionChange();
this._changeDetectorRef.markForCheck();
}
}
/** Select this chip and emit selected event */
selectViaInteraction() {
if (!this._selected) {
this._selected = true;
this._dispatchSelectionChange(true);
this._changeDetectorRef.markForCheck();
}
}
/** Toggles the current selected state of this chip. */
toggleSelected(isUserInput = false) {
this._selected = !this.selected;
this._dispatchSelectionChange(isUserInput);
this._changeDetectorRef.markForCheck();
return this.selected;
}
/** Allows for programmatic focusing of the chip. */
focus() {
if (!this._hasFocus) {
this._elementRef.nativeElement.focus();
this._onFocus.next({ chip: this });
}
this._hasFocus = true;
}
/**
* Allows for programmatic removal of the chip. Called by the MatChipList when the DELETE or
* BACKSPACE keys are pressed.
*
* Informs any listeners of the removal request. Does not remove the chip from the DOM.
*/
remove() {
if (this.removable) {
this.removed.emit({ chip: this });
}
}
/** Handles click events on the chip. */
_handleClick(event) {
if (this.disabled) {
event.preventDefault();
}
}
/** Handle custom key presses. */
_handleKeydown(event) {
if (this.disabled) {
return;
}
switch (event.keyCode) {
case DELETE:
case BACKSPACE:
// If we are removable, remove the focused chip
this.remove();
// Always prevent so page navigation does not occur
event.preventDefault();
break;
case SPACE:
// If we are selectable, toggle the focused chip
if (this.selectable) {
this.toggleSelected(true);
}
// Always prevent space from scrolling the page since the list has focus
event.preventDefault();
break;
}
}
_blur() {
// When animations are enabled, Angular may end up removing the chip from the DOM a little
// earlier than usual, causing it to be blurred and throwing off the logic in the chip list
// that moves focus not the next item. To work around the issue, we defer marking the chip
// as not focused until the next time the zone stabilizes.
this._ngZone.onStable.pipe(take(1)).subscribe(() => {
this._ngZone.run(() => {
this._hasFocus = false;
this._onBlur.next({ chip: this });
});
});
}
_dispatchSelectionChange(isUserInput = false) {
this.selectionChange.emit({
source: this,
isUserInput,
selected: this._selected,
});
}
}
MatLegacyChip.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChip, deps: [{ token: i0.ElementRef }, { token: i0.NgZone }, { token: i1.Platform }, { token: MAT_RIPPLE_GLOBAL_OPTIONS, optional: true }, { token: i0.ChangeDetectorRef }, { token: DOCUMENT }, { token: ANIMATION_MODULE_TYPE, optional: true }, { token: 'tabindex', attribute: true }], target: i0.ɵɵFactoryTarget.Directive });
MatLegacyChip.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.0.0-rc.1", type: MatLegacyChip, selector: "mat-basic-chip, [mat-basic-chip], mat-chip, [mat-chip]", inputs: { color: "color", disableRipple: "disableRipple", tabIndex: "tabIndex", role: "role", selected: "selected", value: "value", selectable: "selectable", disabled: "disabled", removable: "removable" }, outputs: { selectionChange: "selectionChange", destroyed: "destroyed", removed: "removed" }, host: { listeners: { "click": "_handleClick($event)", "keydown": "_handleKeydown($event)", "focus": "focus()", "blur": "_blur()" }, properties: { "attr.tabindex": "disabled ? null : tabIndex", "attr.role": "role", "class.mat-chip-selected": "selected", "class.mat-chip-with-avatar": "avatar", "class.mat-chip-with-trailing-icon": "trailingIcon || removeIcon", "class.mat-chip-disabled": "disabled", "class._mat-animation-noopable": "_animationsDisabled", "attr.disabled": "disabled || null", "attr.aria-disabled": "disabled.toString()", "attr.aria-selected": "ariaSelected" }, classAttribute: "mat-chip mat-focus-indicator" }, queries: [{ propertyName: "avatar", first: true, predicate: MAT_LEGACY_CHIP_AVATAR, descendants: true }, { propertyName: "trailingIcon", first: true, predicate: MAT_LEGACY_CHIP_TRAILING_ICON, descendants: true }, { propertyName: "removeIcon", first: true, predicate: MAT_LEGACY_CHIP_REMOVE, descendants: true }], exportAs: ["matChip"], usesInheritance: true, ngImport: i0 });
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChip, decorators: [{
type: Directive,
args: [{
selector: `mat-basic-chip, [mat-basic-chip], mat-chip, [mat-chip]`,
inputs: ['color', 'disableRipple', 'tabIndex'],
exportAs: 'matChip',
host: {
'class': 'mat-chip mat-focus-indicator',
'[attr.tabindex]': 'disabled ? null : tabIndex',
'[attr.role]': 'role',
'[class.mat-chip-selected]': 'selected',
'[class.mat-chip-with-avatar]': 'avatar',
'[class.mat-chip-with-trailing-icon]': 'trailingIcon || removeIcon',
'[class.mat-chip-disabled]': 'disabled',
'[class._mat-animation-noopable]': '_animationsDisabled',
'[attr.disabled]': 'disabled || null',
'[attr.aria-disabled]': 'disabled.toString()',
'[attr.aria-selected]': 'ariaSelected',
'(click)': '_handleClick($event)',
'(keydown)': '_handleKeydown($event)',
'(focus)': 'focus()',
'(blur)': '_blur()',
},
}]
}], ctorParameters: function () { return [{ type: i0.ElementRef }, { type: i0.NgZone }, { type: i1.Platform }, { type: undefined, decorators: [{
type: Optional
}, {
type: Inject,
args: [MAT_RIPPLE_GLOBAL_OPTIONS]
}] }, { type: i0.ChangeDetectorRef }, { type: undefined, decorators: [{
type: Inject,
args: [DOCUMENT]
}] }, { type: undefined, decorators: [{
type: Optional
}, {
type: Inject,
args: [ANIMATION_MODULE_TYPE]
}] }, { type: undefined, decorators: [{
type: Attribute,
args: ['tabindex']
}] }]; }, propDecorators: { avatar: [{
type: ContentChild,
args: [MAT_LEGACY_CHIP_AVATAR]
}], trailingIcon: [{
type: ContentChild,
args: [MAT_LEGACY_CHIP_TRAILING_ICON]
}], removeIcon: [{
type: ContentChild,
args: [MAT_LEGACY_CHIP_REMOVE]
}], role: [{
type: Input
}], selected: [{
type: Input
}], value: [{
type: Input
}], selectable: [{
type: Input
}], disabled: [{
type: Input
}], removable: [{
type: Input
}], selectionChange: [{
type: Output
}], destroyed: [{
type: Output
}], removed: [{
type: Output
}] } });
/**
* Applies proper (click) support and adds styling for use with the Material Design "cancel" icon
* available at https://material.io/icons/#ic_cancel.
*
* Example:
*
* `<mat-chip>
* <mat-icon matChipRemove>cancel</mat-icon>
* </mat-chip>`
*
* You *may* use a custom icon, but you may need to override the `mat-chip-remove` positioning
* styles to properly center the icon within the chip.
*
* @deprecated Use `MatChipRemove` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
class MatLegacyChipRemove {
constructor(_parentChip, elementRef) {
this._parentChip = _parentChip;
if (elementRef.nativeElement.nodeName === 'BUTTON') {
elementRef.nativeElement.setAttribute('type', 'button');
}
}
/** Calls the parent chip's public `remove()` method if applicable. */
_handleClick(event) {
const parentChip = this._parentChip;
if (parentChip.removable && !parentChip.disabled) {
parentChip.remove();
}
// We need to stop event propagation because otherwise the event will bubble up to the
// form field and cause the `onContainerClick` method to be invoked. This method would then
// reset the focused chip that has been focused after chip removal. Usually the parent
// the parent click listener of the `MatChip` would prevent propagation, but it can happen
// that the chip is being removed before the event bubbles up.
event.stopPropagation();
event.preventDefault();
}
}
MatLegacyChipRemove.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChipRemove, deps: [{ token: MatLegacyChip }, { token: i0.ElementRef }], target: i0.ɵɵFactoryTarget.Directive });
MatLegacyChipRemove.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "15.0.0-rc.1", type: MatLegacyChipRemove, selector: "[matChipRemove]", host: { listeners: { "click": "_handleClick($event)" }, classAttribute: "mat-chip-remove mat-chip-trailing-icon" }, providers: [{ provide: MAT_LEGACY_CHIP_REMOVE, useExisting: MatLegacyChipRemove }], ngImport: i0 });
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChipRemove, decorators: [{
type: Directive,
args: [{
selector: '[matChipRemove]',
host: {
'class': 'mat-chip-remove mat-chip-trailing-icon',
'(click)': '_handleClick($event)',
},
providers: [{ provide: MAT_LEGACY_CHIP_REMOVE, useExisting: MatLegacyChipRemove }],
}]
}], ctorParameters: function () { return [{ type: MatLegacyChip }, { type: i0.ElementRef }]; } });
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
/**
* Injection token to be used to override the default options for the chips module.
* @deprecated Use `MAT_CHIPS_DEFAULT_OPTIONS` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
const MAT_LEGACY_CHIPS_DEFAULT_OPTIONS = new InjectionToken('mat-chips-default-options');
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
// Boilerplate for applying mixins to MatChipList.
/** @docs-private */
const _MatChipListBase = mixinErrorState(class {
constructor(_defaultErrorStateMatcher, _parentForm, _parentFormGroup,
/**
* Form control bound to the component.
* Implemented as part of `MatFormFieldControl`.
* @docs-private
*/
ngControl) {
this._defaultErrorStateMatcher = _defaultErrorStateMatcher;
this._parentForm = _parentForm;
this._parentFormGroup = _parentFormGroup;
this.ngControl = ngControl;
/**
* Emits whenever the component state changes and should cause the parent
* form-field to update. Implemented as part of `MatFormFieldControl`.
* @docs-private
*/
this.stateChanges = new Subject();
}
});
// Increasing integer for generating unique ids for chip-list components.
let nextUniqueId$1 = 0;
/**
* Change event object that is emitted when the chip list value has changed.
* @deprecated Use `MatChipListChange` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
class MatLegacyChipListChange {
constructor(
/** Chip list that emitted the event. */
source,
/** Value of the chip list when the event was emitted. */
value) {
this.source = source;
this.value = value;
}
}
/**
* A material design chips component (named ChipList for its similarity to the List component).
* @deprecated Use `MatChipList` from `@angular/material/chips` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
* @breaking-change 17.0.0
*/
class MatLegacyChipList extends _MatChipListBase {
constructor(_elementRef, _changeDetectorRef, _dir, _parentForm, _parentFormGroup, _defaultErrorStateMatcher, ngControl) {
super(_defaultErrorStateMatcher, _parentForm, _parentFormGroup, ngControl);
this._elementRef = _elementRef;
this._changeDetectorRef = _changeDetectorRef;
this._dir = _dir;
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
this.controlType = 'mat-chip-list';
/**
* When a chip is destroyed, we store the index of the destroyed chip until the chips
* query list notifies about the update. This is necessary because we cannot determine an
* appropriate chip that should receive focus until the array of chips updated completely.
*/
this._lastDestroyedChipIndex = null;
/** Subject that emits when the component has been destroyed. */
this._destroyed = new Subject();
/** Uid of the chip list */
this._uid = `mat-chip-list-${nextUniqueId$1++}`;
/** Tab index for the chip list. */
this._tabIndex = 0;
/**
* User defined tab index.
* When it is not null, use user defined tab index. Otherwise use _tabIndex
*/
this._userTabIndex = null;
/** Function when touched */
this._onTouched = () => { };
/** Function when changed */
this._onChange = () => { };
this._multiple = false;
this._compareWith = (o1, o2) => o1 === o2;
this._disabled = false;
/** Orientation of the chip list. */
this.ariaOrientation = 'horizontal';
this._selectable = true;
/** Event emitted when the selected chip list value has been changed by the user. */
this.change = new EventEmitter();
/**
* Event that emits whenever the raw value of the chip-list changes. This is here primarily
* to facilitate the two-way binding for the `value` input.
* @docs-private
*/
this.valueChange = new EventEmitter();
if (this.ngControl) {
this.ngControl.valueAccessor = this;
}
}
/** The array of selected chips inside chip list. */
get selected() {
return this.multiple ? this._selectionModel?.selected || [] : this._selectionModel?.selected[0];
}
/** The ARIA role applied to the chip list. */
get role() {
if (this._explicitRole) {
return this._explicitRole;
}
return this.empty ? null : 'listbox';
}
set role(role) {
this._explicitRole = role;
}
/** Whether the user should be allowed to select multiple chips. */
get multiple() {
return this._multiple;
}
set multiple(value) {
this._multiple = coerceBooleanProperty(value);
this._syncChipsState();
}
/**
* A function to compare the option values with the selected values. The first argument
* is a value from an option. The second is a value from the selection. A boolean
* should be returned.
*/
get compareWith() {
return this._compareWith;
}
set compareWith(fn) {
this._compareWith = fn;
if (this._selectionModel) {
// A different comparator means the selection could change.
this._initializeSelection();
}
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
get value() {
return this._value;
}
set value(value) {
this.writeValue(value);
this._value = value;
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
get id() {
return this._chipInput ? this._chipInput.id : this._uid;
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
get required() {
return this._required ?? this.ngControl?.control?.hasValidator(Validators.required) ?? false;
}
set required(value) {
this._required = coerceBooleanProperty(value);
this.stateChanges.next();
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
get placeholder() {
return this._chipInput ? this._chipInput.placeholder : this._placeholder;
}
set placeholder(value) {
this._placeholder = value;
this.stateChanges.next();
}
/** Whether any chips or the matChipInput inside of this chip-list has focus. */
get focused() {
return (this._chipInput && this._chipInput.focused) || this._hasFocusedChip();
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
get empty() {
return (!this._chipInput || this._chipInput.empty) && (!this.chips || this.chips.length === 0);
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
get shouldLabelFloat() {
return !this.empty || this.focused;
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
get disabled() {
return this.ngControl ? !!this.ngControl.disabled : this._disabled;
}
set disabled(value) {
this._disabled = coerceBooleanProperty(value);
this._syncChipsState();
}
/**
* Whether or not this chip list is selectable. When a chip list is not selectable,
* the selected states for all the chips inside the chip list are always ignored.
*/
get selectable() {
return this._selectable;
}
set selectable(value) {
this._selectable = coerceBooleanProperty(value);
this._syncChipsState();
}
set tabIndex(value) {
this._userTabIndex = value;
this._tabIndex = value;
}
/** Combined stream of all of the child chips' selection change events. */
get chipSelectionChanges() {
return merge(...this.chips.map(chip => chip.selectionChange));
}
/** Combined stream of all of the child chips' focus change events. */
get chipFocusChanges() {
return merge(...this.chips.map(chip => chip._onFocus));
}
/** Combined stream of all of the child chips' blur change events. */
get chipBlurChanges() {
return merge(...this.chips.map(chip => chip._onBlur));
}
/** Combined stream of all of the child chips' remove change events. */
get chipRemoveChanges() {
return merge(...this.chips.map(chip => chip.destroyed));
}
ngAfterContentInit() {
this._keyManager = new FocusKeyManager(this.chips)
.withWrap()
.withVerticalOrientation()
.withHomeAndEnd()
.withHorizontalOrientation(this._dir ? this._dir.value : 'ltr');
if (this._dir) {
this._dir.change
.pipe(takeUntil(this._destroyed))
.subscribe(dir => this._keyManager.withHorizontalOrientation(dir));
}
this._keyManager.tabOut.subscribe(() => this._allowFocusEscape());
// When the list changes, re-subscribe
this.chips.changes.pipe(startWith(null), takeUntil(this._destroyed)).subscribe(() => {
if (this.disabled || !this.selectable) {
// Since this happens after the content has been
// checked, we need to defer it to the next tick.
Promise.resolve().then(() => {
this._syncChipsState();
});
}
this._resetChips();
// Reset chips selected/deselected status
this._initializeSelection();
// Check to see if we need to update our tab index
this._updateTabIndex();
// Check to see if we have a destroyed chip and need to refocus
this._updateFocusForDestroyedChips();
this.stateChanges.next();
});
}
ngOnInit() {
this._selectionModel = new SelectionModel(this.multiple, undefined, false);
this.stateChanges.next();
}
ngDoCheck() {
if (this.ngControl) {
// We need to re-evaluate this on every change detection cycle, because there are some
// error triggers that we can't subscribe to (e.g. parent form submissions). This means
// that whatever logic is in here has to be super lean or we risk destroying the performance.
this.updateErrorState();
if (this.ngControl.disabled !== this._disabled) {
this.disabled = !!this.ngControl.disabled;
}
}
}
ngOnDestroy() {
this._keyManager?.destroy();
this._destroyed.next();
this._destroyed.complete();
this.stateChanges.complete();
this._dropSubscriptions();
}
/** Associates an HTML input element with this chip list. */
registerInput(inputElement) {
this._chipInput = inputElement;
// We use this attribute to match the chip list to its input in test harnesses.
// Set the attribute directly here to avoid "changed after checked" errors.
this._elementRef.nativeElement.setAttribute('data-mat-chip-input', inputElement.id);
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
setDescribedByIds(ids) {
if (ids.length) {
this._elementRef.nativeElement.setAttribute('aria-describedby', ids.join(' '));
}
else {
this._elementRef.nativeElement.removeAttribute('aria-describedby');
}
}
// Implemented as part of ControlValueAccessor.
writeValue(value) {
if (this.chips) {
this._setSelectionByValue(value, false);
}
}
// Implemented as part of ControlValueAccessor.
registerOnChange(fn) {
this._onChange = fn;
}
// Implemented as part of ControlValueAccessor.
registerOnTouched(fn) {
this._onTouched = fn;
}
// Implemented as part of ControlValueAccessor.
setDisabledState(isDisabled) {
this.disabled = isDisabled;
this.stateChanges.next();
}
/**
* Implemented as part of MatFormFieldControl.
* @docs-private
*/
onContainerClick(event) {
if (!this._originatesFromChip(event)) {
this.focus();
}
}
/**
* Focuses the first non-disabled chip in this chip list, or the associated input when there
* are no eligible chips.
*/
focus(options) {
if (this.disabled) {
return;
}
// TODO: ARIA says this should focus the first `selected` chip if any are selected.
// Focus on first element if there's no chipInput inside chip-list
if (this._chipInput && this._chipInput.focused) {
// do nothing
}
else if (this.chips.length > 0) {
this._keyManager.setFirstItemActive();
this.stateChanges.next();
}
else {
this._focusInput(options);
this.stateChanges.next();
}
}
/** Attempt to focus an input if we have one. */
_focusInput(options) {
if (this._chipInput) {
this._chipInput.focus(options);
}
}
/**
* Pass events to the keyboard manager. Available here for tests.
*/
_keydown(event) {
const target = event.target;
if (target && target.classList.contains('mat-chip')) {
this._keyManager.onKeydown(event);
this.stateChanges.next();
}
}
/**
* Check the tab index as you should not be allowed to focus an empty list.
*/
_updateTabIndex() {
// If we have 0 chips, we should not allow keyboard focus
this._tabIndex = this._userTabIndex || (this.chips.length === 0 ? -1 : 0);
}
/**
* If the amount of chips changed, we need to update the
* key manager state and focus the next closest chip.
*/
_updateFocusForDestroyedChips() {
// Move focus to the closest chip. If no other chips remain, focus the chip-list itself.
if (this._lastDestroyedChipIndex != null) {
if (this.chips.length) {
const newChipIndex = Math.min(this._lastDestroyedChipIndex, this.chips.length - 1);
this._keyManager.setActiveItem(newChipIndex);
}
else {
this.focus();
}
}
this._lastDestroyedChipIndex = null;
}
/**
* Utility to ensure all indexes are valid.
*
* @param index The index to be checked.
* @returns True if the index is valid for our list of chips.
*/
_isValidIndex(index) {
return index >= 0 && index < this.chips.length;
}
_setSelectionByValue(value, isUserInput = true) {
this._clearSelection();
this.chips.forEach(chip => chip.deselect());
if (Array.isArray(value)) {
value.forEach(currentValue => this._selectValue(currentValue, isUserInput));
this._sortValues();
}
else {
const correspondingChip = this._selectValue(value, isUserInput);
// Shift focus to the active item. Note that we shouldn't do this in multiple
// mode, because we don't know what chip the user interacted with last.
if (correspondingChip) {
if (isUserInput) {
this._keyManager.setActiveItem(correspondingChip);
}
}
}
}
/**
* Finds and selects the chip based on its value.
* @returns Chip that has the corresponding value.
*/
_selectValue(value, isUserInput = true) {
const correspondingChip = this.chips.find(chip => {
return chip.value != null && this._compareWith(chip.value, value);
});
if (correspondingChip) {
isUserInput ? correspondingChip.selectViaInteraction() : correspondingChip.select();
this._selectionModel.select(correspondingChip);
}
return correspondingChip;
}
_initializeSelection() {
// Defer setting the value in order to avoid the "Expression
// has changed after it was checked" errors from Angular.
Promise.resolve().then(() => {
if (this.ngControl || this._value) {
this._setSelectionByValue(this.ngControl ? this.ngControl.value : this._value, false);
this.stateChanges.next();
}
});
}
/**
* Deselects every chip in the list.
* @param skip Chip that should not be deselected.
*/
_clearSelection(skip) {
this._selectionModel.clear();
this.chips.forEach(chip => {
if (chip !== skip) {
chip.deselect();
}
});
this.stateChanges.next();
}
/**
* Sorts the model values, ensuring that they keep the same
* order that they have in the panel.
*/
_sortValues() {
if (this._multiple) {
this._selectionModel.clear();
this.chips.forEach(chip => {
if (chip.selected) {
this._selectionModel.select(chip);
}
});
this.stateChanges.next();
}
}
/** Emits change event to set the model value. */
_propagateChanges(fallbackValue) {
let valueToEmit = null;
if (Array.isArray(this.selected)) {
valueToEmit = this.selected.map(chip => chip.value);
}
else {
valueToEmit = this.selected ? this.selected.value : fallbackValue;
}
this._value = valueToEmit;
this.change.emit(new MatLegacyChipListChange(this, valueToEmit));
this.valueChange.emit(valueToEmit);
this._onChange(valueToEmit);
this._changeDetectorRef.markForCheck();
}
/** When blurred, mark the field as touched when focus moved outside the chip list. */
_blur() {
if (!this._hasFocusedChip()) {
this._keyManager.setActiveItem(-1);
}
if (!this.disabled) {
if (this._chipInput) {
// If there's a chip input, we should check whether the focus moved to chip input.
// If the focus is not moved to chip input, mark the field as touched. If the focus moved
// to chip input, do nothing.
// Timeout is needed to wait for the focus() event trigger on chip input.
setTimeout(() => {
if (!this.focused) {
this._markAsTouched();
}
});
}
else {
// If there's no chip input, then mark the field as touched.
this._markAsTouched();
}
}
}
/** Mark the field as touched */
_markAsTouched() {
this._onTouched();
this._changeDetectorRef.markForCheck();
this.stateChanges.next();
}
/**
* Removes the `tabindex` from the chip list and resets it back afterwards, allowing the
* user to tab out of it. This prevents the list from capturing focus and redirecting
* it back to the first chip, creating a focus trap, if it user tries to tab away.
*/
_allowFocusEscape() {
if (this._tabIndex !== -1) {
this._tabIndex = -1;
setTimeout(() => {
this._tabIndex = this._userTabIndex || 0;
this._changeDetectorRef.markForCheck();
});
}
}
_resetChips() {
this._dropSubscriptions();
this._listenToChipsFocus();
this._listenToChipsSelection();
this._listenToChipsRemoved();
}
_dropSubscriptions() {
if (this._chipFocusSubscription) {
this._chipFocusSubscription.unsubscribe();
this._chipFocusSubscription = null;
}
if (this._chipBlurSubscription) {
this._chipBlurSubscription.unsubscribe();
this._chipBlurSubscription = null;
}
if (this._chipSelectionSubscription) {
this._chipSelectionSubscription.unsubscribe();
this._chipSelectionSubscription = null;
}
if (this._chipRemoveSubscription) {
this._chipRemoveSubscription.unsubscribe();
this._chipRemoveSubscription = null;
}
}
/** Listens to user-generated selection events on each chip. */
_listenToChipsSelection() {
this._chipSelectionSubscription = this.chipSelectionChanges.subscribe(event => {
event.source.selected
? this._selectionModel.select(event.source)
: this._selectionModel.deselect(event.source);
// For single selection chip list, make sure the deselected value is unselected.
if (!this.multiple) {
this.chips.forEach(chip => {
if (!this._selectionModel.isSelected(chip) && chip.selected) {
chip.deselect();
}
});
}
if (event.isUserInput) {
this._propagateChanges();
}
});
}
/** Listens to user-generated selection events on each chip. */
_listenToChipsFocus() {
this._chipFocusSubscription = this.chipFocusChanges.subscribe(event => {
let chipIndex = this.chips.toArray().indexOf(event.chip);
if (this._isValidIndex(chipIndex)) {
this._keyManager.updateActiveItem(chipIndex);
}
this.stateChanges.next();
});
this._chipBlurSubscription = this.chipBlurChanges.subscribe(() => {
this._blur();
this.stateChanges.next();
});
}
_listenToChipsRemoved() {
this._chipRemoveSubscription = this.chipRemoveChanges.subscribe(event => {
const chip = event.chip;
const chipIndex = this.chips.toArray().indexOf(event.chip);
// In case the chip that will be removed is currently focused, we temporarily store
// the index in order to be able to determine an appropriate sibling chip that will
// receive focus.
if (this._isValidIndex(chipIndex) && chip._hasFocus) {
this._lastDestroyedChipIndex = chipIndex;
}
});
}
/** Checks whether an event comes from inside a chip element. */
_originatesFromChip(event) {
let currentElement = event.target;
while (currentElement && currentElement !== this._elementRef.nativeElement) {
if (currentElement.classList.contains('mat-chip')) {
return true;
}
currentElement = currentElement.parentElement;
}
return false;
}
/** Checks whether any of the chips is focused. */
_hasFocusedChip() {
return this.chips && this.chips.some(chip => chip._hasFocus);
}
/** Syncs the list's state with the individual chips. */
_syncChipsState() {
if (this.chips) {
this.chips.forEach(chip => {
chip._chipListDisabled = this._disabled;
chip._chipListMultiple = this.multiple;
chip.chipListSelectable = this._selectable;
});
}
}
}
MatLegacyChipList.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.0.0-rc.1", ngImport: i0, type: MatLegacyChipList, deps: [{ token: i0.ElementRef }, { token: i0.ChangeDetectorRef }, { token: i1$1.Directionality, optional: true }, { token: i2.NgForm, optional: true }, { token: i2.FormGroupDirective, optional: true }, { token: i3.ErrorStateMatcher }, { token: i2.NgControl, optional: true, self: true }], target: i0.ɵɵFactoryTarget.Component });
MatLegacyChipList.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.0.0-rc.1", type: MatLegacyChipList, selector: "mat-chip-list", inputs: { role: "role", userAriaDescribedBy: ["aria-describedby", "userAriaDescribedBy"], errorStateMatcher: "errorStateMatcher", multiple: "multiple", compareWith: "compareWith", value: "value", required: "required", placeholder: "placeholder", disabled: "disabled", ariaOrientation: ["aria-orientation", "ariaOrientation"], selectable: "selectable", tabIndex: "tabIndex" }, outputs: { change: "change", valueChange: "valueChange" }, host: { listeners: { "focus": "focus()", "blur": "_blur()", "keydown": "_keydown($event)" }, properties: { "attr.tabindex": "disabled ? null : _tabIndex", "attr.aria-required": "role ? required : null", "attr.aria-disabled": "disabled.toString()", "attr.aria-invalid": "errorState", "attr.aria-multiselectable": "multiple", "attr.role": "role", "class.mat-chip-list-disabled": "disabled", "class.mat-chip-list-invalid": "errorState", "class.mat-chip-list-required": "required", "attr.aria-orientation": "ariaOrientation", "id": "_uid" }, classAttribute: "mat-chip-list" }, providers: [{ provide: MatLegacyFormFieldControl, useExisting: MatLegacyChipList }], queries: [{ propertyName: "chips", predicate: MatLegacyChip, descendants: true }], exportAs: ["matChipList"], usesInheritance: true, ngImport: i0, template: `<div class="mat-chip-list-wrapper"><ng-content></ng-content></div>`, isInline: true, styles: [".mat-chip{position:relative;box-sizing:border-box;-webkit-tap-highlight-color:rgba(0,0,0,0);border:none;-webkit-appearance:none;-moz-appearance:none}.mat-chip::before{margin:calc(calc(var(--mat-focus-indicator-border-width, 3px) + 2px) * -1)}.mat-standard-chip{transition:box-shadow 280ms cubic-bezier(0.4, 0, 0.2, 1);display:inline-flex;padding:7px 12px;border-radius:16px;align-items:center;cursor:default;min-height:32px;height:1px}.mat-standard-chip._mat-animation-noopable{transition:none !important;animation:none !important}.mat-standard-chip .mat-chip-remove{border:none;-webkit-appearance:none;-moz-appearance:none;padding:0;background:none}.mat-standard-chip .mat-chip-remove.mat-icon,.mat-standard-chip .mat-chip-remove .mat-icon{width:18px;height:18px;font-size:18px}.mat-standard-chip::after{top:0;left:0;right:0;bottom:0;position:absolute;border-radius:inherit;opacity:0;content:\"\";pointer-events:none;transition:opacity 200ms cubic-bezier(0.35, 0, 0.25, 1)}.mat-standard-chip:hover::after{opacity:.12}.mat-standard-chip:focus{outline:none}.mat-standard-chip:focus::after{opacity:.16}.cdk-high-contrast-active .mat-standard-chip{outline:solid 1px}.cdk-high-contrast-active .mat-standard-chip.mat-chip-selected{outline-width:3px}.mat-standard-chip.mat-chip-disabled::after{opacity:0}.mat-standard-chip.mat-chip-disabled .mat-chip-r