feat(material/chips): add (optional) edit icon to input chips (angular#31041)

Author: adolgachev

goldens/material/chips/index.api.md

@@ -35,6 +35,9 @@ export const MAT_CHIP: InjectionToken<unknown>;
 // @public
 export const MAT_CHIP_AVATAR: InjectionToken<unknown>;
 
+// @public
+export const MAT_CHIP_EDIT: InjectionToken<unknown>;
+
 // @public
 export const MAT_CHIP_LISTBOX_CONTROL_VALUE_ACCESSOR: any;
 
@@ -50,6 +53,7 @@ export const MAT_CHIPS_DEFAULT_OPTIONS: InjectionToken<MatChipsDefaultOptions>;
 // @public
 export class MatChip implements OnInit, AfterViewInit, AfterContentInit, DoCheck, OnDestroy {
     constructor(...args: unknown[]);
+    protected _allEditIcons: QueryList<MatChipEdit>;
     protected _allLeadingIcons: QueryList<MatChipAvatar>;
     protected _allRemoveIcons: QueryList<MatChipRemove>;
     protected _allTrailingIcons: QueryList<MatChipTrailingIcon>;
@@ -68,6 +72,8 @@ export class MatChip implements OnInit, AfterViewInit, AfterContentInit, DoCheck
     disableRipple: boolean;
     // (undocumented)
     protected _document: Document;
+    _edit(event: Event): void;
+    editIcon: MatChipEdit;
     // (undocumented)
     _elementRef: ElementRef<HTMLElement>;
     focus(): void;
@@ -119,7 +125,7 @@ export class MatChip implements OnInit, AfterViewInit, AfterContentInit, DoCheck
     // (undocumented)
     protected _value: any;
     // (undocumented)
-    static ɵcmp: i0.ɵɵComponentDeclaration<MatChip, "mat-basic-chip, [mat-basic-chip], mat-chip, [mat-chip]", ["matChip"], { "role": { "alias": "role"; "required": false; }; "id": { "alias": "id"; "required": false; }; "ariaLabel": { "alias": "aria-label"; "required": false; }; "ariaDescription": { "alias": "aria-description"; "required": false; }; "value": { "alias": "value"; "required": false; }; "color": { "alias": "color"; "required": false; }; "removable": { "alias": "removable"; "required": false; }; "highlighted": { "alias": "highlighted"; "required": false; }; "disableRipple": { "alias": "disableRipple"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "removed": "removed"; "destroyed": "destroyed"; }, ["leadingIcon", "trailingIcon", "removeIcon", "_allLeadingIcons", "_allTrailingIcons", "_allRemoveIcons"], ["mat-chip-avatar, [matChipAvatar]", "*", "mat-chip-trailing-icon,[matChipRemove],[matChipTrailingIcon]"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatChip, "mat-basic-chip, [mat-basic-chip], mat-chip, [mat-chip]", ["matChip"], { "role": { "alias": "role"; "required": false; }; "id": { "alias": "id"; "required": false; }; "ariaLabel": { "alias": "aria-label"; "required": false; }; "ariaDescription": { "alias": "aria-description"; "required": false; }; "value": { "alias": "value"; "required": false; }; "color": { "alias": "color"; "required": false; }; "removable": { "alias": "removable"; "required": false; }; "highlighted": { "alias": "highlighted"; "required": false; }; "disableRipple": { "alias": "disableRipple"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "removed": "removed"; "destroyed": "destroyed"; }, ["leadingIcon", "editIcon", "trailingIcon", "removeIcon", "_allLeadingIcons", "_allTrailingIcons", "_allEditIcons", "_allRemoveIcons"], ["mat-chip-avatar, [matChipAvatar]", "*", "mat-chip-trailing-icon,[matChipRemove],[matChipTrailingIcon]"], true, never>;
     // (undocumented)
     static ɵfac: i0.ɵɵFactoryDeclaration<MatChip, never>;
 }
@@ -132,6 +138,22 @@ export class MatChipAvatar {
     static ɵfac: i0.ɵɵFactoryDeclaration<MatChipAvatar, never>;
 }
 
+// @public
+export class MatChipEdit extends MatChipAction {
+    // (undocumented)
+    _handleClick(event: MouseEvent): void;
+    // (undocumented)
+    _handleKeydown(event: KeyboardEvent): void;
+    // (undocumented)
+    _isLeading: boolean;
+    // (undocumented)
+    _isPrimary: boolean;
+    // (undocumented)
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatChipEdit, "[matChipEdit]", never, {}, {}, never, never, true, never>;
+    // (undocumented)
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatChipEdit, never>;
+}
+
 // @public
 export interface MatChipEditedEvent extends MatChipEvent {
     value: string;
@@ -420,6 +442,8 @@ export class MatChipRow extends MatChip implements AfterViewInit {
     contentEditInput?: MatChipEditInput;
     defaultEditInput?: MatChipEditInput;
     // (undocumented)
+    _edit(): void;
+    // (undocumented)
     editable: boolean;
     readonly edited: EventEmitter<MatChipEditedEvent>;
     // (undocumented)
@@ -430,6 +454,8 @@ export class MatChipRow extends MatChip implements AfterViewInit {
     // (undocumented)
     _handleKeydown(event: KeyboardEvent): void;
     // (undocumented)
+    protected _hasLeadingActionIcon(): boolean;
+    // (undocumented)
     _hasTrailingIcon(): boolean;
     // (undocumented)
     _isEditing: boolean;
@@ -438,7 +464,7 @@ export class MatChipRow extends MatChip implements AfterViewInit {
     // (undocumented)
     ngAfterViewInit(): void;
     // (undocumented)
-    static ɵcmp: i0.ɵɵComponentDeclaration<MatChipRow, "mat-chip-row, [mat-chip-row], mat-basic-chip-row, [mat-basic-chip-row]", never, { "editable": { "alias": "editable"; "required": false; }; }, { "edited": "edited"; }, ["contentEditInput"], ["mat-chip-avatar, [matChipAvatar]", "[matChipEditInput]", "*", "mat-chip-trailing-icon,[matChipRemove],[matChipTrailingIcon]"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatChipRow, "mat-chip-row, [mat-chip-row], mat-basic-chip-row, [mat-basic-chip-row]", never, { "editable": { "alias": "editable"; "required": false; }; }, { "edited": "edited"; }, ["contentEditInput"], ["[matChipEdit]", "mat-chip-avatar, [matChipAvatar]", "[matChipEditInput]", "*", "mat-chip-trailing-icon,[matChipRemove],[matChipTrailingIcon]"], true, never>;
     // (undocumented)
     static ɵfac: i0.ɵɵFactoryDeclaration<MatChipRow, never>;
 }
@@ -515,7 +541,7 @@ export class MatChipsModule {
     // (undocumented)
     static ɵinj: i0.ɵɵInjectorDeclaration<MatChipsModule>;
     // (undocumented)
-    static ɵmod: i0.ɵɵNgModuleDeclaration<MatChipsModule, never, [typeof MatCommonModule, typeof MatRippleModule, typeof MatChipAction, typeof MatChip, typeof MatChipAvatar, typeof MatChipEditInput, typeof MatChipGrid, typeof MatChipInput, typeof MatChipListbox, typeof MatChipOption, typeof MatChipRemove, typeof MatChipRow, typeof MatChipSet, typeof MatChipTrailingIcon], [typeof MatCommonModule, typeof MatChip, typeof MatChipAvatar, typeof MatChipEditInput, typeof MatChipGrid, typeof MatChipInput, typeof MatChipListbox, typeof MatChipOption, typeof MatChipRemove, typeof MatChipRow, typeof MatChipSet, typeof MatChipTrailingIcon]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MatChipsModule, never, [typeof MatCommonModule, typeof MatRippleModule, typeof MatChipAction, typeof MatChip, typeof MatChipAvatar, typeof MatChipEdit, typeof MatChipEditInput, typeof MatChipGrid, typeof MatChipInput, typeof MatChipListbox, typeof MatChipOption, typeof MatChipRemove, typeof MatChipRow, typeof MatChipSet, typeof MatChipTrailingIcon], [typeof MatCommonModule, typeof MatChip, typeof MatChipAvatar, typeof MatChipEdit, typeof MatChipEditInput, typeof MatChipGrid, typeof MatChipInput, typeof MatChipListbox, typeof MatChipOption, typeof MatChipRemove, typeof MatChipRow, typeof MatChipSet, typeof MatChipTrailingIcon]>;
 }
 
 // @public

goldens/material/chips/testing/index.api.md

@@ -16,6 +16,10 @@ import { TestKey } from '@angular/cdk/testing';
 export interface ChipAvatarHarnessFilters extends BaseHarnessFilters {
 }
 
+// @public (undocumented)
+export interface ChipEditHarnessFilters extends BaseHarnessFilters {
+}
+
 // @public (undocumented)
 export interface ChipEditInputHarnessFilters extends BaseHarnessFilters {
 }
@@ -67,6 +71,14 @@ export class MatChipAvatarHarness extends ComponentHarness {
     static with<T extends MatChipAvatarHarness>(this: ComponentHarnessConstructor<T>, options?: ChipAvatarHarnessFilters): HarnessPredicate<T>;
 }
 
+// @public
+export class MatChipEditHarness extends ComponentHarness {
+    click(): Promise<void>;
+    // (undocumented)
+    static hostSelector: string;
+    static with<T extends MatChipEditHarness>(this: ComponentHarnessConstructor<T>, options?: ChipEditHarnessFilters): HarnessPredicate<T>;
+}
+
 // @public
 export class MatChipEditInputHarness extends ComponentHarness {
     // (undocumented)
@@ -89,6 +101,7 @@ export class MatChipGridHarness extends ComponentHarness {
 
 // @public
 export class MatChipHarness extends ContentContainerComponentHarness {
+    geEditButton(filter?: ChipEditHarnessFilters): Promise<MatChipEditHarness>;
     getAvatar(filter?: ChipAvatarHarnessFilters): Promise<MatChipAvatarHarness | null>;
     getRemoveButton(filter?: ChipRemoveHarnessFilters): Promise<MatChipRemoveHarness>;
     getText(): Promise<string>;

src/components-examples/material/chips/chips-input/chips-input-example.html

@@ -8,6 +8,9 @@
         (edited)="edit(fruit, $event)"
         [aria-description]="'press enter to edit ' + fruit.name"
       >
+        <button matChipEdit [attr.aria-label]="'edit ' + fruit.name">
+          <mat-icon>edit</mat-icon>
+        </button>      
         {{fruit.name}}
         <button matChipRemove [attr.aria-label]="'remove ' + fruit.name">
           <mat-icon>cancel</mat-icon>

src/dev-app/chips/chips-demo.html

@@ -160,6 +160,8 @@ <h4>Multi selection</h4>
 
       <mat-checkbox [(ngModel)]="disableInputs">Disabled</mat-checkbox>
       <mat-checkbox [(ngModel)]="editable">Editable</mat-checkbox>
+      <mat-checkbox [(ngModel)]="peopleWithAvatar">Show Avatar</mat-checkbox>
+      <mat-checkbox [(ngModel)]="showEditIcon">Show Edit Icon</mat-checkbox>
       <mat-checkbox [(ngModel)]="disabledInteractive">Disabled Interactive</mat-checkbox>
 
       <h4>Input is last child of chip grid</h4>
@@ -172,6 +174,14 @@ <h4>Input is last child of chip grid</h4>
               [editable]="editable"
               (removed)="remove(person)"
               (edited)="edit(person, $event)">
+              @if (showEditIcon) {
+                <button matChipEdit aria-label="Edit contributor">
+                  <mat-icon>edit</mat-icon>
+                </button>
+              }
+              @if (peopleWithAvatar && person.avatar) {
+                <mat-chip-avatar>{{person.avatar}}</mat-chip-avatar>
+              }
               {{person.name}}
               <button matChipRemove aria-label="Remove contributor">
                 <mat-icon>close</mat-icon>

src/dev-app/chips/chips-demo.ts

@@ -20,6 +20,7 @@ import {MatIconModule} from '@angular/material/icon';
 
 export interface Person {
   name: string;
+  avatar?: string;
 }
 
 export interface DemoColor {
@@ -52,6 +53,8 @@ export class ChipsDemo {
   listboxesWithAvatar = false;
   disableInputs = false;
   editable = false;
+  peopleWithAvatar = false;
+  showEditIcon = false;
   disabledInteractive = false;
   message = '';
 
@@ -75,12 +78,12 @@ export class ChipsDemo {
   selectedPeople = null;
 
   people: Person[] = [
-    {name: 'Kara'},
-    {name: 'Jeremy'},
-    {name: 'Topher'},
-    {name: 'Elad'},
-    {name: 'Kristiyan'},
-    {name: 'Paul'},
+    {name: 'Kara', avatar: 'K'},
+    {name: 'Jeremy', avatar: 'J'},
+    {name: 'Topher', avatar: 'T'},
+    {name: 'Elad', avatar: 'E'},
+    {name: 'Kristiyan', avatar: 'K'},
+    {name: 'Paul', avatar: 'P'},
   ];
 
   availableColors: DemoColor[] = [

src/material/chips/chip-action.ts

@@ -29,7 +29,8 @@ import {_StructuralStylesLoader} from '../core';
     'class': 'mdc-evolution-chip__action mat-mdc-chip-action',
     '[class.mdc-evolution-chip__action--primary]': '_isPrimary',
     '[class.mdc-evolution-chip__action--presentational]': '!isInteractive',
-    '[class.mdc-evolution-chip__action--trailing]': '!_isPrimary',
+    '[class.mdc-evolution-chip__action--secondary]': '!_isPrimary',
+    '[class.mdc-evolution-chip__action--trailing]': '!_isPrimary && !_isLeading',
     '[attr.tabindex]': '_getTabindex()',
     '[attr.disabled]': '_getDisabledAttribute()',
     '[attr.aria-disabled]': 'disabled',
@@ -43,6 +44,7 @@ export class MatChipAction {
     _handlePrimaryActionInteraction(): void;
     remove(): void;
     disabled: boolean;
+    _edit(): void;
     _isEditing?: boolean;
   }>(MAT_CHIP);
 
@@ -52,6 +54,9 @@ export class MatChipAction {
   /** Whether this is the primary action in the chip. */
   _isPrimary = true;
 
+  /** Whether this is the leading action in the chip. */
+  _isLeading = false; // TODO(adolgachev): consolidate usage to secondary css class
+
   /** Whether the action is disabled. */
   @Input({transform: booleanAttribute})
   get disabled(): boolean {

src/material/chips/chip-grid.spec.ts

@@ -270,7 +270,7 @@ describe('MatChipGrid', () => {
           fixture = createComponent(ChipGridWithRemove);
           flush();
           trailingActions = chipGridNativeElement.querySelectorAll(
-            '.mdc-evolution-chip__action--trailing',
+            '.mdc-evolution-chip__action--secondary',
           );
         }));
 
@@ -595,7 +595,7 @@ describe('MatChipGrid', () => {
       const fixture = createComponent(ChipGridWithRemove, undefined, [NoopAnimationsModule]);
       flush();
       const trailingActions = chipGridNativeElement.querySelectorAll<HTMLElement>(
-        '.mdc-evolution-chip__action--trailing',
+        '.mdc-evolution-chip__action--secondary',
       );
       const chip = chips.get(2)!;
       chip.focus();

src/material/chips/chip-icons.ts

@@ -9,7 +9,7 @@
 import {ENTER, SPACE} from '@angular/cdk/keycodes';
 import {Directive} from '@angular/core';
 import {MatChipAction} from './chip-action';
-import {MAT_CHIP_AVATAR, MAT_CHIP_REMOVE, MAT_CHIP_TRAILING_ICON} from './tokens';
+import {MAT_CHIP_AVATAR, MAT_CHIP_EDIT, MAT_CHIP_REMOVE, MAT_CHIP_TRAILING_ICON} from './tokens';
 
 /** Avatar image within a chip. */
 @Directive({
@@ -42,6 +42,56 @@ export class MatChipTrailingIcon extends MatChipAction {
   override _isPrimary = false;
 }
 
+/**
+ * Directive to edit the parent chip when the leading action icon is clicked or
+ * when the ENTER key is pressed on it.
+ *
+ * Recommended for use with the Material Design "edit" icon
+ * available at https://material.io/icons/#ic_edit.
+ *
+ * Example:
+ *
+ * ```
+ * <mat-chip>
+ *   <button matChipEdit aria-label="Edit">
+ *     <mat-icon>edit</mat-icon>
+ *   </button>
+ * </mat-chip>
+ * ```
+ */
+
+@Directive({
+  selector: '[matChipEdit]',
+  host: {
+    'class':
+      'mat-mdc-chip-edit mat-mdc-chip-avatar mat-focus-indicator ' +
+      'mdc-evolution-chip__icon mdc-evolution-chip__icon--primary',
+    'role': 'button',
+    '[attr.aria-hidden]': 'null',
+  },
+  providers: [{provide: MAT_CHIP_EDIT, useExisting: MatChipEdit}],
+})
+export class MatChipEdit extends MatChipAction {
+  override _isPrimary = false;
+  override _isLeading = true;
+
+  override _handleClick(event: MouseEvent): void {
+    if (!this.disabled) {
+      event.stopPropagation();
+      event.preventDefault();
+      this._parentChip._edit();
+    }
+  }
+
+  override _handleKeydown(event: KeyboardEvent) {
+    if ((event.keyCode === ENTER || event.keyCode === SPACE) && !this.disabled) {
+      event.stopPropagation();
+      event.preventDefault();
+      this._parentChip._edit();
+    }
+  }
+}
+
 /**
  * Directive to remove the parent chip when the trailing icon is clicked or
  * when the ENTER key is pressed on it.

src/material/chips/chip-row.html

@@ -2,6 +2,11 @@
   <span class="mat-mdc-chip-focus-overlay"></span>
 }
 
+@if (_hasLeadingActionIcon()) {
+  <span class="mdc-evolution-chip__cell mdc-evolution-chip__cell--leading" role="gridcell">
+    <ng-content select="[matChipEdit]"></ng-content>
+  </span>
+}
 <span class="mdc-evolution-chip__cell mdc-evolution-chip__cell--primary" role="gridcell"
     matChipAction
     [disabled]="disabled"

src/material/chips/chip-row.spec.ts

@@ -436,6 +436,21 @@ describe('Row Chips', () => {
       }));
     });
 
+    describe('with edit icon', () => {
+      beforeEach(async () => {
+        testComponent.showEditIcon = true;
+        fixture.changeDetectorRef.markForCheck();
+        fixture.detectChanges();
+      });
+
+      it('should begin editing on edit click', () => {
+        expect(chipNativeElement.querySelector('.mat-chip-edit-input')).toBeFalsy();
+        dispatchFakeEvent(chipNativeElement.querySelector('.mat-mdc-chip-edit')!, 'click');
+        fixture.detectChanges();
+        expect(chipNativeElement.querySelector('.mat-chip-edit-input')).toBeTruthy();
+      });
+    });
+
     describe('a11y', () => {
       it('should apply `ariaLabel` and `ariaDesciption` to the primary gridcell', () => {
         fixture.componentInstance.ariaLabel = 'chip name';
@@ -488,6 +503,9 @@ describe('Row Chips', () => {
                   (destroyed)="chipDestroy($event)"
                   (removed)="chipRemove($event)" (edited)="chipEdit($event)"
                   [aria-label]="ariaLabel" [aria-description]="ariaDescription">
+            @if (showEditIcon) {
+              <button matChipEdit>edit</button>
+            }
             {{name}}
             <button matChipRemove>x</button>
             @if (useCustomEditInput) {
@@ -509,6 +527,7 @@ class SingleChip {
   removable: boolean = true;
   shouldShow: boolean = true;
   editable: boolean = false;
+  showEditIcon: boolean = false;
   useCustomEditInput: boolean = true;
   ariaLabel: string | null = null;
   ariaDescription: string | null = null;