-
Notifications
You must be signed in to change notification settings - Fork 6.7k
/
chip.ts
492 lines (431 loc) · 15.6 KB
/
chip.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
/**
* @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 {FocusableOption} from '@angular/cdk/a11y';
import {BooleanInput, coerceBooleanProperty, NumberInput} from '@angular/cdk/coercion';
import {BACKSPACE, DELETE, SPACE} from '@angular/cdk/keycodes';
import {Platform} from '@angular/cdk/platform';
import {DOCUMENT} from '@angular/common';
import {
Attribute,
ChangeDetectorRef,
ContentChild,
Directive,
ElementRef,
EventEmitter,
Inject,
InjectionToken,
Input,
NgZone,
OnDestroy,
Optional,
Output,
} from '@angular/core';
import {
CanColor,
CanColorCtor,
CanDisableRipple,
CanDisableRippleCtor,
HasTabIndex,
HasTabIndexCtor,
MAT_RIPPLE_GLOBAL_OPTIONS,
mixinColor,
mixinDisableRipple,
mixinTabIndex,
RippleConfig,
RippleGlobalOptions,
RippleRenderer,
RippleTarget,
} from '@angular/material/core';
import {ANIMATION_MODULE_TYPE} from '@angular/platform-browser/animations';
import {Subject} from 'rxjs';
import {take} from 'rxjs/operators';
/** Represents an event fired on an individual `mat-chip`. */
export interface MatChipEvent {
/** The chip the event was fired on. */
chip: MatChip;
}
/** Event object emitted by MatChip when selected or deselected. */
export class MatChipSelectionChange {
constructor(
/** Reference to the chip that emitted the event. */
public source: MatChip,
/** Whether the chip that emitted the event is selected. */
public selected: boolean,
/** Whether the selection change was a result of a user interaction. */
public isUserInput = false) { }
}
/**
* 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.
*/
export const MAT_CHIP_REMOVE = new InjectionToken<MatChipRemove>('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.
*/
export const MAT_CHIP_AVATAR = new InjectionToken<MatChipAvatar>('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.
*/
export const MAT_CHIP_TRAILING_ICON =
new InjectionToken<MatChipTrailingIcon>('MatChipTrailingIcon');
// Boilerplate for applying mixins to MatChip.
/** @docs-private */
abstract class MatChipBase {
abstract disabled: boolean;
constructor(public _elementRef: ElementRef) {}
}
const _MatChipMixinBase: CanColorCtor & CanDisableRippleCtor &
HasTabIndexCtor & typeof MatChipBase =
mixinTabIndex(mixinColor(mixinDisableRipple(MatChipBase), 'primary'), -1);
/**
* Dummy directive to add CSS class to chip avatar.
* @docs-private
*/
@Directive({
selector: 'mat-chip-avatar, [matChipAvatar]',
host: {'class': 'mat-chip-avatar'},
providers: [{provide: MAT_CHIP_AVATAR, useExisting: MatChipAvatar}]
})
export class MatChipAvatar {}
/**
* Dummy directive to add CSS class to chip trailing icon.
* @docs-private
*/
@Directive({
selector: 'mat-chip-trailing-icon, [matChipTrailingIcon]',
host: {'class': 'mat-chip-trailing-icon'},
providers: [{provide: MAT_CHIP_TRAILING_ICON, useExisting: MatChipTrailingIcon}],
})
export class MatChipTrailingIcon {}
/**
* Material design styled Chip component. Used inside the MatChipList component.
*/
@Directive({
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',
'role': 'option',
'[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()',
},
})
export class MatChip extends _MatChipMixinBase implements FocusableOption, OnDestroy, CanColor,
CanDisableRipple, RippleTarget, HasTabIndex {
/** Reference to the RippleRenderer for the chip. */
private _chipRipple: RippleRenderer;
/**
* Reference to the element that acts as the chip's ripple target. This element is
* dynamically added as a child node of the chip. The chip itself cannot be used as the
* ripple target because it must be the host of the focus indicator.
*/
private _chipRippleTarget: HTMLElement;
/**
* Ripple configuration for ripples that are launched on pointer down. The ripple config
* is set to the global ripple options since we don't have any configurable options for
* the chip ripples.
* @docs-private
*/
rippleConfig: RippleConfig & RippleGlobalOptions;
/**
* Whether ripples are disabled on interaction
* @docs-private
*/
get rippleDisabled(): boolean {
return this.disabled || this.disableRipple || this._animationsDisabled ||
!!this.rippleConfig.disabled;
}
/** Whether the chip has focus. */
_hasFocus: boolean = false;
/** Whether animations for the chip are enabled. */
_animationsDisabled: boolean;
/** Whether the chip list is selectable */
chipListSelectable: boolean = true;
/** Whether the chip list is in multi-selection mode. */
_chipListMultiple: boolean = false;
/** Whether the chip list as a whole is disabled. */
_chipListDisabled: boolean = false;
/** The chip avatar */
@ContentChild(MAT_CHIP_AVATAR) avatar: MatChipAvatar;
/** The chip's trailing icon. */
@ContentChild(MAT_CHIP_TRAILING_ICON) trailingIcon: MatChipTrailingIcon;
/** The chip's remove toggler. */
@ContentChild(MAT_CHIP_REMOVE) removeIcon: MatChipRemove;
/** Whether the chip is selected. */
@Input()
get selected(): boolean { return this._selected; }
set selected(value: boolean) {
const coercedValue = coerceBooleanProperty(value);
if (coercedValue !== this._selected) {
this._selected = coercedValue;
this._dispatchSelectionChange();
}
}
protected _selected: boolean = false;
/** The value of the chip. Defaults to the content inside `<mat-chip>` tags. */
@Input()
get value(): any {
return this._value !== undefined
? this._value
: this._elementRef.nativeElement.textContent;
}
set value(value: any) { this._value = value; }
protected _value: any;
/**
* 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.
*/
@Input()
get selectable(): boolean { return this._selectable && this.chipListSelectable; }
set selectable(value: boolean) {
this._selectable = coerceBooleanProperty(value);
}
protected _selectable: boolean = true;
/** Whether the chip is disabled. */
@Input()
get disabled(): boolean { return this._chipListDisabled || this._disabled; }
set disabled(value: boolean) {
this._disabled = coerceBooleanProperty(value);
}
protected _disabled: boolean = false;
/**
* Determines whether or not the chip displays the remove styling and emits (removed) events.
*/
@Input()
get removable(): boolean { return this._removable; }
set removable(value: boolean) {
this._removable = coerceBooleanProperty(value);
}
protected _removable: boolean = true;
/** Emits when the chip is focused. */
readonly _onFocus = new Subject<MatChipEvent>();
/** Emits when the chip is blured. */
readonly _onBlur = new Subject<MatChipEvent>();
/** Emitted when the chip is selected or deselected. */
@Output() readonly selectionChange: EventEmitter<MatChipSelectionChange> =
new EventEmitter<MatChipSelectionChange>();
/** Emitted when the chip is destroyed. */
@Output() readonly destroyed: EventEmitter<MatChipEvent> = new EventEmitter<MatChipEvent>();
/** Emitted when a chip is to be removed. */
@Output() readonly removed: EventEmitter<MatChipEvent> = new EventEmitter<MatChipEvent>();
/** The ARIA selected applied to the chip. */
get ariaSelected(): string | null {
// 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;
}
constructor(public _elementRef: ElementRef<HTMLElement>,
private _ngZone: NgZone,
platform: Platform,
@Optional() @Inject(MAT_RIPPLE_GLOBAL_OPTIONS)
globalRippleOptions: RippleGlobalOptions | null,
private _changeDetectorRef: ChangeDetectorRef,
@Inject(DOCUMENT) _document: any,
@Optional() @Inject(ANIMATION_MODULE_TYPE) animationMode?: string,
@Attribute('tabindex') tabIndex?: string) {
super(_elementRef);
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;
}
_addHostClassName() {
const basicChipAttrName = 'mat-basic-chip';
const element = this._elementRef.nativeElement as HTMLElement;
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(): void {
if (!this._selected) {
this._selected = true;
this._dispatchSelectionChange();
this._changeDetectorRef.markForCheck();
}
}
/** Deselects the chip. */
deselect(): void {
if (this._selected) {
this._selected = false;
this._dispatchSelectionChange();
this._changeDetectorRef.markForCheck();
}
}
/** Select this chip and emit selected event */
selectViaInteraction(): void {
if (!this._selected) {
this._selected = true;
this._dispatchSelectionChange(true);
this._changeDetectorRef.markForCheck();
}
}
/** Toggles the current selected state of this chip. */
toggleSelected(isUserInput: boolean = false): boolean {
this._selected = !this.selected;
this._dispatchSelectionChange(isUserInput);
this._changeDetectorRef.markForCheck();
return this.selected;
}
/** Allows for programmatic focusing of the chip. */
focus(): void {
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(): void {
if (this.removable) {
this.removed.emit({chip: this});
}
}
/** Handles click events on the chip. */
_handleClick(event: Event) {
if (this.disabled) {
event.preventDefault();
} else {
event.stopPropagation();
}
}
/** Handle custom key presses. */
_handleKeydown(event: KeyboardEvent): void {
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(): void {
// 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});
});
});
}
private _dispatchSelectionChange(isUserInput = false) {
this.selectionChange.emit({
source: this,
isUserInput,
selected: this._selected
});
}
static ngAcceptInputType_selected: BooleanInput;
static ngAcceptInputType_selectable: BooleanInput;
static ngAcceptInputType_removable: BooleanInput;
static ngAcceptInputType_disabled: BooleanInput;
static ngAcceptInputType_disableRipple: BooleanInput;
static ngAcceptInputType_tabIndex: NumberInput;
}
/**
* 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.
*/
@Directive({
selector: '[matChipRemove]',
host: {
'class': 'mat-chip-remove mat-chip-trailing-icon',
'(click)': '_handleClick($event)',
},
providers: [{provide: MAT_CHIP_REMOVE, useExisting: MatChipRemove}],
})
export class MatChipRemove {
constructor(
protected _parentChip: MatChip,
elementRef: ElementRef<HTMLElement>) {
if (elementRef.nativeElement.nodeName === 'BUTTON') {
elementRef.nativeElement.setAttribute('type', 'button');
}
}
/** Calls the parent chip's public `remove()` method if applicable. */
_handleClick(event: Event): void {
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();
}
}