feat(material-experimental/chips): MDC chip APIs match existing APIs (#…

…16145)
angular · Jun 24, 2019 · 86aad59 · 86aad59
1 parent d511fbe
commit 86aad59
Show file tree

Hide file tree

Showing 26 changed files with 2,865 additions and 294 deletions.
diff --git a/package.json b/package.json
@@ -35,7 +35,7 @@
   },
   "version": "8.0.1",
   "requiredAngularVersion": "^8.0.0 || ^9.0.0-0",
-  "requiredMDCVersion": "^1.1.0",
+  "requiredMDCVersion": "^2.3.1",
   "dependencies": {
     "@angular/animations": "^8.0.1",
     "@angular/common": "^8.0.1",
@@ -46,7 +46,7 @@
     "@angular/platform-browser": "^8.0.1",
     "@webcomponents/custom-elements": "^1.1.0",
     "core-js": "^2.6.1",
-    "material-components-web": "^1.1.0",
+    "material-components-web": "^2.3.1",
     "rxjs": "^6.4.0",
     "systemjs": "0.19.43",
     "tsickle": "^0.35.0",

diff --git a/src/dev-app/mdc-chips/mdc-chips-demo-module.ts b/src/dev-app/mdc-chips/mdc-chips-demo-module.ts
@@ -6,14 +6,31 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import {CommonModule} from '@angular/common';
 import {NgModule} from '@angular/core';
+import {FormsModule, ReactiveFormsModule} from '@angular/forms';
+import {MatButtonModule} from '@angular/material/button';
+import {MatCardModule} from '@angular/material/card';
+import {MatCheckboxModule} from '@angular/material/checkbox';
+import {MatFormFieldModule} from '@angular/material/form-field';
+import {MatToolbarModule} from '@angular/material/toolbar';
 import {MatChipsModule} from '@angular/material-experimental/mdc-chips';
+import {MatIconModule} from '@angular/material/icon';
 import {RouterModule} from '@angular/router';
 import {MdcChipsDemo} from './mdc-chips-demo';
 
 @NgModule({
   imports: [
+    CommonModule,
+    FormsModule,
+    MatButtonModule,
+    MatCardModule,
+    MatCheckboxModule,
     MatChipsModule,
+    MatFormFieldModule,
+    MatIconModule,
+    MatToolbarModule,
+    ReactiveFormsModule,
     RouterModule.forChild([{path: '', component: MdcChipsDemo}]),
   ],
   declarations: [MdcChipsDemo],

diff --git a/src/dev-app/mdc-chips/mdc-chips-demo.html b/src/dev-app/mdc-chips/mdc-chips-demo.html
@@ -1,2 +1,219 @@
-<!-- TODO: copy in demo template from existing mat-chip demo. -->
-Not yet implemented.
+<div class="demo-chips">
+  <mat-card>
+    <mat-toolbar color="primary">Static Chips</mat-toolbar>
+
+    <mat-card-content>
+      <h4>Simple</h4>
+
+      <mat-chip-set>
+        <mat-chip>Chip 1</mat-chip>
+        <mat-chip>Chip 2</mat-chip>
+        <mat-chip disabled>Chip 3</mat-chip>
+      </mat-chip-set>
+
+      <h4>Unstyled</h4>
+
+      <mat-chip-set>
+        <mat-basic-chip>Basic Chip 1</mat-basic-chip>
+        <mat-basic-chip>Basic Chip 2</mat-basic-chip>
+        <mat-basic-chip>Basic Chip 3</mat-basic-chip>
+      </mat-chip-set>
+
+      <h4>With avatar, icons, and color</h4>
+
+      <mat-chip-set>
+        <mat-chip disabled>
+          <mat-icon matChipAvatar>home</mat-icon>
+          Home
+          <mat-icon matChipRemove>cancel</mat-icon>
+        </mat-chip>
+
+        <mat-chip highlighted="true" color="accent">
+          <mat-chip-avatar>P</mat-chip-avatar>
+          Portel
+          <mat-icon matChipRemove>cancel</mat-icon>
+        </mat-chip>
+
+        <mat-chip>
+          <mat-chip-avatar>M</mat-chip-avatar>
+          Molly
+        </mat-chip>
+
+        <mat-chip>
+          Koby
+          <mat-icon matChipRemove>cancel</mat-icon>
+        </mat-chip>
+
+        <mat-chip>
+          Razzle
+        </mat-chip>
+
+        <mat-chip>
+          <img src="https://material.angularjs.org/material2_assets/ngconf/Mal.png" matChipAvatar>
+          Mal
+        </mat-chip>
+
+        <mat-chip highlighted="true" color="warn">
+          <img src="https://material.angularjs.org/material2_assets/ngconf/Husi.png" matChipAvatar>
+          Husi
+          <mat-icon matChipRemove>cancel</mat-icon>
+        </mat-chip>
+
+        <mat-chip>
+          Good
+          <mat-icon matChipTrailingIcon>star</mat-icon>
+        </mat-chip>
+
+        <mat-chip>
+          Bad
+          <mat-icon matChipTrailingIcon>star_border</mat-icon>
+        </mat-chip>
+
+      </mat-chip-set>
+
+      <h4>With Events</h4>
+
+      <mat-chip-set>
+        <mat-chip highlighted="true" color="warn" *ngIf="visible"
+                 (destroyed)="displayMessage('chip destroyed')" (removed)="toggleVisible()">
+          With Events
+          <mat-icon matChipRemove>cancel</mat-icon>
+        </mat-chip>
+      </mat-chip-set>
+      <div>{{message}}</div>
+
+    </mat-card-content>
+  </mat-card>
+
+  <mat-card>
+    <mat-toolbar color="primary">Selectable Chips</mat-toolbar>
+
+    <mat-card-content>
+      <button mat-button (click)="disabledListboxes = !disabledListboxes">
+       {{disabledListboxes ? "Enable" : "Disable"}}
+      </button>
+
+      <h4>Single selection</h4>
+
+      <mat-chip-listbox multiple="false" [disabled]="disabledListboxes">
+        <mat-chip-option>Extra Small</mat-chip-option>
+        <mat-chip-option>Small</mat-chip-option>
+        <mat-chip-option>Medium</mat-chip-option>
+        <mat-chip-option>Large</mat-chip-option>
+      </mat-chip-listbox>
+
+      <h4>Multi selection</h4>
+
+      <mat-chip-listbox multiple="true" [disabled]="disabledListboxes">
+        <mat-chip-option selected="true">Open Now</mat-chip-option>
+        <mat-chip-option>Takes Reservations</mat-chip-option>
+        <mat-chip-option selected="true">Pet Friendly</mat-chip-option>
+        <mat-chip-option>Good for Brunch</mat-chip-option>
+      </mat-chip-listbox>
+
+    </mat-card-content>
+  </mat-card>
+
+  <mat-card>
+    <mat-toolbar color="primary">Input Chips</mat-toolbar>
+
+    <mat-card-content>
+      <p>
+        The <code>&lt;mat-chip-grid&gt;</code> component pairs with the <code>matChipInputFor</code> directive
+        to convert user input text into chips.
+        They can be used inside a <code>&lt;mat-form-field&gt;</code>.
+      </p>
+
+      <button mat-button (click)="disableInputs = !disableInputs">
+       {{disableInputs ? "Enable" : "Disable"}}
+      </button>
+
+      <h4>Input is last child of chip grid</h4>
+
+      <mat-form-field class="demo-has-chip-list">
+        <mat-chip-grid #chipGrid1 [(ngModel)]="selectedPeople" required [disabled]="disableInputs">
+          <mat-chip-row *ngFor="let person of people"
+                   (removed)="remove(person)">
+            {{person.name}}
+            <mat-icon matChipRemove>cancel</mat-icon>
+          </mat-chip-row>
+          <input [disabled]="disableInputs"
+                 placeholder="New Contributor..."
+                 [matChipInputFor]="chipGrid1"
+                 [matChipInputSeparatorKeyCodes]="separatorKeysCodes"
+                 [matChipInputAddOnBlur]="addOnBlur"
+                 (matChipInputTokenEnd)="add($event)" />
+        </mat-chip-grid>
+      </mat-form-field>
+
+      <h4>Input is next sibling child of chip grid</h4>
+
+      <mat-form-field>
+        <mat-chip-grid #chipGrid2 [(ngModel)]="selectedPeople" required [disabled]="disableInputs">
+          <mat-chip-row *ngFor="let person of people" (removed)="remove(person)">
+            {{person.name}}
+            <mat-icon matChipRemove>cancel</mat-icon>
+          </mat-chip-row>
+        </mat-chip-grid>
+        <input placeholder="New Contributor..."
+               [matChipInputFor]="chipGrid2"
+               [matChipInputSeparatorKeyCodes]="separatorKeysCodes"
+               [matChipInputAddOnBlur]="addOnBlur"
+               (matChipInputTokenEnd)="add($event)" />
+      </mat-form-field>
+
+      <p>
+        The example above has overridden the <code>[separatorKeys]</code> input to allow for
+        <code>ENTER</code>, <code>COMMA</code> and <code>SEMICOLON</code> keys.
+      </p>
+
+      <h4>Options</h4>
+      <p>
+        <mat-checkbox name="addOnBlur" [(ngModel)]="addOnBlur">Add on Blur</mat-checkbox>
+      </p>
+
+    </mat-card-content>
+  </mat-card>
+
+  <mat-card>
+    <mat-toolbar color="primary">Miscellaneous</mat-toolbar>
+    <mat-card-content>
+      <h4>Stacked</h4>
+
+      <p>
+        You can also stack the chips if you want them on top of each other.
+      </p>
+
+      <mat-chip-set class="mat-mdc-chip-set-stacked" aria-orientation="vertical">
+        <mat-chip *ngFor="let aColor of availableColors" highlighted="true"
+                  [color]="aColor.color">
+          {{aColor.name}}
+        </mat-chip>
+      </mat-chip-set>
+
+      <h4>NgModel with multi selection</h4>
+
+      <mat-chip-listbox [multiple]="true" [(ngModel)]="selectedColors">
+        <mat-chip-option *ngFor="let aColor of availableColors" [color]="aColor.color"
+                 [value]="aColor.name">
+          {{aColor.name}}
+        </mat-chip-option>
+      </mat-chip-listbox>
+
+      The selected colors are
+      <span *ngFor="let color of selectedColors; let isLast=last">
+        {{color}}{{isLast ? '' : ', '}}</span>.
+
+      <h4>NgModel with single selection</h4>
+
+      <mat-chip-listbox [(ngModel)]="selectedColor">
+        <mat-chip-option *ngFor="let aColor of availableColors" [color]="aColor.color"
+                 [value]="aColor.name">
+          {{aColor.name}}
+        </mat-chip-option>
+      </mat-chip-listbox>
+
+      The selected color is {{selectedColor}}.
+    </mat-card-content>
+  </mat-card>
+</div>
diff --git a/src/dev-app/mdc-chips/mdc-chips-demo.scss b/src/dev-app/mdc-chips/mdc-chips-demo.scss
@@ -1 +1,31 @@
-// TODO: copy in demo styles from existing mat-chips demo.
+.demo-chips {
+  .mat-mdc-chip-set-stacked {
+    display: block;
+    max-width: 200px;
+  }
+
+  .mat-card {
+    padding: 0;
+    margin: 16px;
+
+    & .mat-toolbar {
+      margin: 0;
+    }
+
+    & .mat-card-content {
+      padding: 24px;
+    }
+  }
+
+  mat-basic-chip {
+    margin: auto 10px;
+  }
+
+  mat-chip-grid input {
+    width: 150px;
+  }
+}
+
+.demo-has-chip-list {
+  width: 100%;
+}
diff --git a/src/dev-app/mdc-chips/mdc-chips-demo.ts b/src/dev-app/mdc-chips/mdc-chips-demo.ts
@@ -6,7 +6,19 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import {COMMA, ENTER} from '@angular/cdk/keycodes';
 import {Component} from '@angular/core';
+import {ThemePalette} from '@angular/material/core';
+import {MatChipInputEvent} from '@angular/material-experimental/mdc-chips';
+
+export interface Person {
+  name: string;
+}
+
+export interface DemoColor {
+  name: string;
+  color: ThemePalette;
+}
 
 @Component({
   moduleId: module.id,
@@ -15,4 +27,65 @@ import {Component} from '@angular/core';
   styleUrls: ['mdc-chips-demo.css'],
 })
 export class MdcChipsDemo {
+  visible = true;
+  selectable = true;
+  removable = true;
+  addOnBlur = true;
+  disabledListboxes = false;
+  disableInputs = false;
+  message = '';
+
+  // Enter, comma, semi-colon
+  separatorKeysCodes = [ENTER, COMMA, 186];
+
+  selectedPeople = null;
+
+  people: Person[] = [
+    {name: 'Kara'},
+    {name: 'Jeremy'},
+    {name: 'Topher'},
+    {name: 'Elad'},
+    {name: 'Kristiyan'},
+    {name: 'Paul'}
+  ];
+
+  availableColors: DemoColor[] = [
+    {name: 'none', color: undefined},
+    {name: 'Primary', color: 'primary'},
+    {name: 'Accent', color: 'accent'},
+    {name: 'Warn', color: 'warn'}
+  ];
+
+  displayMessage(message: string): void {
+    this.message = message;
+  }
+
+  add(event: MatChipInputEvent): void {
+    const {input, value} = event;
+
+    // Add our person
+    if ((value || '').trim()) {
+      this.people.push({ name: value.trim() });
+    }
+
+    // Reset the input value
+    if (input) {
+      input.value = '';
+    }
+  }
+
+  remove(person: Person): void {
+    const index = this.people.indexOf(person);
+
+    if (index >= 0) {
+      this.people.splice(index, 1);
+    }
+  }
+
+  toggleVisible(): void {
+    this.visible = false;
+  }
+
+  selectedColors: string[] = ['Primary', 'Warn'];
+  selectedColor = 'Accent';
 }
diff --git a/src/material-examples/example-module.ts b/src/material-examples/example-module.ts