/** * @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 */ import {coerceBooleanProperty} from '@angular/cdk/coercion'; import {Directive, ElementRef, EventEmitter, Inject, Input, OnChanges, Output} from '@angular/core'; import {hasModifierKey, TAB} from '@angular/cdk/keycodes'; import {MAT_CHIPS_DEFAULT_OPTIONS, MatChipsDefaultOptions} from './chip-default-options'; import {MatChipList} from './chip-list'; import {MatChipTextControl} from './chip-text-control'; /** Represents an input event on a `matChipInput`. */ export interface MatChipInputEvent { /** The native `` element that the event is being fired for. */ input: HTMLInputElement; /** The value of the input. */ value: string; } // Increasing integer for generating unique ids. let nextUniqueId = 0; /** * Directive that adds chip-specific behaviors to an input element inside ``. * May be placed inside or outside of an ``. */ @Directive({ selector: 'input[matChipInputFor]', exportAs: 'matChipInput, matChipInputFor', host: { 'class': 'mat-chip-input mat-input-element', '(keydown)': '_keydown($event)', '(blur)': '_blur()', '(focus)': '_focus()', '(input)': '_onInput()', '[id]': 'id', '[attr.disabled]': 'disabled || null', '[attr.placeholder]': 'placeholder || null', '[attr.aria-invalid]': '_chipList && _chipList.ngControl ? _chipList.ngControl.invalid : null', } }) export class MatChipInput implements MatChipTextControl, OnChanges { /** Whether the control is focused. */ focused: boolean = false; _chipList: MatChipList; /** Register input for chip list */ @Input('matChipInputFor') set chipList(value: MatChipList) { if (value) { this._chipList = value; this._chipList.registerInput(this); } } /** * Whether or not the chipEnd event will be emitted when the input is blurred. */ @Input('matChipInputAddOnBlur') get addOnBlur(): boolean { return this._addOnBlur; } set addOnBlur(value: boolean) { this._addOnBlur = coerceBooleanProperty(value); } _addOnBlur: boolean = false; /** * The list of key codes that will trigger a chipEnd event. * * Defaults to `[ENTER]`. */ @Input('matChipInputSeparatorKeyCodes') separatorKeyCodes: number[] | Set = this._defaultOptions.separatorKeyCodes; /** Emitted when a chip is to be added. */ @Output('matChipInputTokenEnd') chipEnd: EventEmitter = new EventEmitter(); /** The input's placeholder text. */ @Input() placeholder: string = ''; /** Unique id for the input. */ @Input() id: string = `mat-chip-list-input-${nextUniqueId++}`; /** Whether the input is disabled. */ @Input() get disabled(): boolean { return this._disabled || (this._chipList && this._chipList.disabled); } set disabled(value: boolean) { this._disabled = coerceBooleanProperty(value); } private _disabled: boolean = false; /** Whether the input is empty. */ get empty(): boolean { return !this._inputElement.value; } /** The native input element to which this directive is attached. */ protected _inputElement: HTMLInputElement; constructor( protected _elementRef: ElementRef, @Inject(MAT_CHIPS_DEFAULT_OPTIONS) private _defaultOptions: MatChipsDefaultOptions) { this._inputElement = this._elementRef.nativeElement as HTMLInputElement; } ngOnChanges() { this._chipList.stateChanges.next(); } /** Utility method to make host definition/tests more clear. */ _keydown(event?: KeyboardEvent) { // Allow the user's focus to escape when they're tabbing forward. Note that we don't // want to do this when going backwards, because focus should go back to the first chip. if (event && event.keyCode === TAB && !hasModifierKey(event, 'shiftKey')) { this._chipList._allowFocusEscape(); } this._emitChipEnd(event); } /** Checks to see if the blur should emit the (chipEnd) event. */ _blur() { if (this.addOnBlur) { this._emitChipEnd(); } this.focused = false; // Blur the chip list if it is not focused if (!this._chipList.focused) { this._chipList._blur(); } this._chipList.stateChanges.next(); } _focus() { this.focused = true; this._chipList.stateChanges.next(); } /** Checks to see if the (chipEnd) event needs to be emitted. */ _emitChipEnd(event?: KeyboardEvent) { if (!this._inputElement.value && !!event) { this._chipList._keydown(event); } if (!event || this._isSeparatorKey(event)) { this.chipEnd.emit({ input: this._inputElement, value: this._inputElement.value }); if (event) { event.preventDefault(); } } } _onInput() { // Let chip list know whenever the value changes. this._chipList.stateChanges.next(); } /** Focuses the input. */ focus(options?: FocusOptions): void { this._inputElement.focus(options); } /** Checks whether a keycode is one of the configured separators. */ private _isSeparatorKey(event: KeyboardEvent) { if (hasModifierKey(event)) { return false; } const separators = this.separatorKeyCodes; const keyCode = event.keyCode; return Array.isArray(separators) ? separators.indexOf(keyCode) > -1 : separators.has(keyCode); } }