Unify styled filter inputs into reusable widget

Author: psybuzz

tensorboard/webapp/metrics/views/main_view/BUILD

@@ -95,6 +95,7 @@ tf_ng_module(
         "//tensorboard/webapp/types:ui",
         "//tensorboard/webapp/util:string",
         "//tensorboard/webapp/util:types",
+        "//tensorboard/webapp/widgets/filter_input",
         "@npm//@angular/common",
         "@npm//@angular/core",
         "@npm//@ngrx/store",
@@ -117,7 +118,6 @@ tf_ts_library(
         "//tensorboard/webapp/angular:expect_angular_core_testing",
         "//tensorboard/webapp/angular:expect_angular_material_autocomplete",
         "//tensorboard/webapp/angular:expect_angular_material_button",
-        "//tensorboard/webapp/angular:expect_angular_material_input",
         "//tensorboard/webapp/angular:expect_angular_platform_browser_animations",
         "//tensorboard/webapp/angular:expect_ngrx_store_testing",
         "//tensorboard/webapp/core/store",
@@ -131,6 +131,7 @@ tf_ts_library(
         "//tensorboard/webapp/testing:mat_icon",
         "//tensorboard/webapp/testing:material",
         "//tensorboard/webapp/types:ui",
+        "//tensorboard/webapp/widgets/filter_input",
         "@npm//@angular/core",
         "@npm//@angular/platform-browser",
         "@npm//@ngrx/store",

tensorboard/webapp/metrics/views/main_view/filter_input_component.ng.html

@@ -16,15 +16,13 @@
 -->
 <div class="tag-filter">
   <mat-icon svgIcon="search_24px"></mat-icon>
-  <input
-    matInput
-    autocomplete="off"
+  <tb-filter-input
     placeholder="Filter tags (regex)"
     [value]="regexFilterValue"
     (input)="onRegexFilterValueChange.emit($event.target.value)"
     (keyup)="onFilterKeyUp($event)"
     [matAutocomplete]="filterMatches"
-  />
+  ></tb-filter-input>
   <mat-icon
     svgIcon="error_24px"
     *ngIf="!isRegexFilterValid"

tensorboard/webapp/metrics/views/main_view/filter_input_component.scss

@@ -25,6 +25,10 @@ mat-icon {
   margin-right: 5px;
 }
 
+tb-filter-input {
+  flex-grow: 1;
+}
+
 :host {
   color: mat-color($tb-foreground, text);
   font-size: 13px;

tensorboard/webapp/metrics/views/main_view/filter_input_component.ts

@@ -21,9 +21,9 @@ import {
   Output,
   ViewChild,
 } from '@angular/core';
-import {MatAutocompleteTrigger} from '@angular/material/autocomplete';
 
 import {escapeForRegex} from '../../../util/string';
+import {FilterInputComponent} from '../../../widgets/filter_input/filter_input_component';
 
 @Component({
   selector: 'metrics-tag-filter-component',
@@ -37,12 +37,12 @@ export class MetricsFilterInputComponent {
   @Input() completions!: string[];
   @Output() onRegexFilterValueChange = new EventEmitter<string>();
 
-  @ViewChild(MatAutocompleteTrigger, {static: true})
-  autocompleteTrigger!: MatAutocompleteTrigger;
+  @ViewChild(FilterInputComponent)
+  filterInput!: FilterInputComponent;
 
   onFilterKeyUp(event: KeyboardEvent) {
     if (event.key === 'Enter') {
-      this.autocompleteTrigger.closePanel();
+      this.filterInput.getAutocompleteTrigger().closePanel();
     }
   }
 

tensorboard/webapp/metrics/views/main_view/filter_input_test.ts

@@ -17,16 +17,16 @@ import {NO_ERRORS_SCHEMA} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
 import {MatAutocompleteModule} from '@angular/material/autocomplete';
 import {MatButtonModule} from '@angular/material/button';
-import {MatInputModule} from '@angular/material/input';
 import {By} from '@angular/platform-browser';
 import {NoopAnimationsModule} from '@angular/platform-browser/animations';
 import {Action, Store} from '@ngrx/store';
 import {MockStore, provideMockStore} from '@ngrx/store/testing';
 
 import {State} from '../../../app_state';
-import {sendKeys} from '../../../testing/dom';
+import {KeyType, sendKey, sendKeys} from '../../../testing/dom';
 import {MatIconTestingModule} from '../../../testing/mat_icon_module';
 import {getAutocompleteOptions} from '../../../testing/material';
+import {FilterInputModule} from '../../../widgets/filter_input/filter_input_module';
 import {metricsTagFilterChanged} from '../../actions';
 import {PluginType} from '../../data_source';
 import * as selectors from '../../store/metrics_selectors';
@@ -47,7 +47,7 @@ describe('metrics filter input', () => {
         MatAutocompleteModule,
         MatButtonModule,
         MatIconTestingModule,
-        MatInputModule,
+        FilterInputModule,
       ],
       declarations: [MetricsFilterInputComponent, MetricsFilterInputContainer],
       providers: [
@@ -239,9 +239,12 @@ describe('metrics filter input', () => {
       const options = getAutocompleteOptions(overlayContainer);
       expect(options.length).toBeGreaterThan(1);
 
-      input.nativeElement.dispatchEvent(
-        new KeyboardEvent('keyup', {key: 'Enter'})
-      );
+      sendKey(fixture, input, {
+        type: KeyType.SPECIAL,
+        prevString: input.properties.value,
+        key: 'Enter',
+        startingCursorIndex: input.properties.selectionStart,
+      });
 
       const options2 = getAutocompleteOptions(overlayContainer);
       expect(options2.length).toBe(0);

tensorboard/webapp/metrics/views/main_view/main_view_module.ts

@@ -20,6 +20,7 @@ import {MatButtonModule} from '@angular/material/button';
 import {MatIconModule} from '@angular/material/icon';
 import {MatInputModule} from '@angular/material/input';
 
+import {FilterInputModule} from '../../../widgets/filter_input/filter_input_module';
 import {CardRendererModule} from '../card_renderer/card_renderer_module';
 import {RightPaneModule} from '../right_pane/right_pane_module';
 
@@ -55,6 +56,7 @@ import {PinnedViewContainer} from './pinned_view_container';
   imports: [
     CardRendererModule,
     CommonModule,
+    FilterInputModule,
     MatAutocompleteModule,
     MatButtonModule,
     MatIconModule,

tensorboard/webapp/runs/views/runs_table/BUILD

@@ -29,7 +29,6 @@ tf_ng_module(
         "//tensorboard/webapp/angular:expect_angular_material_button",
         "//tensorboard/webapp/angular:expect_angular_material_checkbox",
         "//tensorboard/webapp/angular:expect_angular_material_icon",
-        "//tensorboard/webapp/angular:expect_angular_material_input",
         "//tensorboard/webapp/angular:expect_angular_material_menu",
         "//tensorboard/webapp/angular:expect_angular_material_paginator",
         "//tensorboard/webapp/angular:expect_angular_material_progress_spinner",
@@ -43,6 +42,7 @@ tf_ng_module(
         "//tensorboard/webapp/runs/store:types",
         "//tensorboard/webapp/types",
         "//tensorboard/webapp/types:ui",
+        "//tensorboard/webapp/widgets/filter_input",
         "//tensorboard/webapp/widgets/range_input",
         "@npm//@angular/common",
         "@npm//@angular/core",
@@ -86,6 +86,7 @@ tf_ts_library(
         "//tensorboard/webapp/testing:mat_icon",
         "//tensorboard/webapp/types",
         "//tensorboard/webapp/types:ui",
+        "//tensorboard/webapp/widgets/filter_input",
         "//tensorboard/webapp/widgets/range_input",
         "@npm//@angular/core",
         "@npm//@angular/platform-browser",

tensorboard/webapp/runs/views/runs_table/runs_table_component.ng.html

@@ -17,13 +17,10 @@
 <div class="filter-row">
   <div class="run-filter">
     <mat-icon svgIcon="search_24px"></mat-icon>
-    <input
-      #filter
-      matInput
-      autocomplete="off"
+    <tb-filter-input
       (keyup)="onFilterKeyUp($event)"
       placeholder="Filter runs (regex)"
-    />
+    ></tb-filter-input>
   </div>
 </div>
 <div class="table-container">

tensorboard/webapp/runs/views/runs_table/runs_table_component.scss

@@ -140,6 +140,10 @@ $_border-color: #0000001f;
     margin-left: 5px;
     margin-right: 5px;
   }
+
+  tb-filter-input {
+    flex-grow: 1;
+  }
 }
 
 // Prevents the table column for checkbox and run_color from growing beyond

tensorboard/webapp/runs/views/runs_table/runs_table_module.ts

@@ -21,7 +21,6 @@ import {NgModule} from '@angular/core';
 import {MatButtonModule} from '@angular/material/button';
 import {MatCheckboxModule} from '@angular/material/checkbox';
 import {MatIconModule} from '@angular/material/icon';
-import {MatInputModule} from '@angular/material/input';
 import {MatMenuModule} from '@angular/material/menu';
 import {MatPaginatorModule} from '@angular/material/paginator';
 import {MatProgressSpinnerModule} from '@angular/material/progress-spinner';
@@ -30,6 +29,7 @@ import {MatTableModule} from '@angular/material/table';
 import {ColorPickerModule} from 'ngx-color-picker';
 
 import {AlertModule} from '../../../alert/alert_module';
+import {FilterInputModule} from '../../../widgets/filter_input/filter_input_module';
 import {RangeInputModule} from '../../../widgets/range_input/range_input_module';
 import {RunsTableComponent} from './runs_table_component';
 import {RunsTableContainer} from './runs_table_container';
@@ -38,10 +38,10 @@ import {RunsTableContainer} from './runs_table_container';
   imports: [
     ColorPickerModule,
     CommonModule,
+    FilterInputModule,
     MatButtonModule,
     MatCheckboxModule,
     MatIconModule,
-    MatInputModule,
     MatMenuModule,
     MatPaginatorModule,
     MatProgressSpinnerModule,

tensorboard/webapp/runs/views/runs_table/runs_table_test.ts

@@ -68,6 +68,7 @@ import {sendKeys} from '../../../testing/dom';
 import {MatIconTestingModule} from '../../../testing/mat_icon_module';
 import {DataLoadState} from '../../../types/data';
 import {SortDirection} from '../../../types/ui';
+import {FilterInputModule} from '../../../widgets/filter_input/filter_input_module';
 import {RangeInputModule} from '../../../widgets/range_input/range_input_module';
 import {
   runColorChanged,
@@ -180,6 +181,7 @@ describe('runs_table', () => {
         MatSortModule,
         MatTableModule,
         NoopAnimationsModule,
+        FilterInputModule,
         RangeInputModule,
       ],
       declarations: [

tensorboard/webapp/testing/dom.ts

@@ -126,9 +126,16 @@ export function sendKey<T>(
     el.setSelectionRange(startingCursorIndex, startingCursorIndex);
   }
 
+  // Use to override default options on programmatic events to be closer to
+  // user-initiated events, which bubble and cancel.
+  const baseEventOptions = {
+    bubbles: true,
+    cancellable: true,
+  };
+
   // Convert typing to object. Sadly, because keyCode is deprecated, it is not
   // typed properly.
-  const keyboardEventArg = {key, keyCode} as {};
+  const keyboardEventArg = {...baseEventOptions, key, keyCode} as {};
   el.dispatchEvent(new KeyboardEvent('keydown', keyboardEventArg));
 
   // This is technically incorrect. For modifier key event, the keydown triggers
@@ -144,10 +151,10 @@ export function sendKey<T>(
   }
 
   if (emitKeyPressAndInput) {
-    el.dispatchEvent(new InputEvent('input', {data: key}));
+    el.dispatchEvent(new InputEvent('input', {...baseEventOptions, data: key}));
   }
 
-  document.dispatchEvent(new Event('selectionchange'));
+  document.dispatchEvent(new Event('selectionchange', baseEventOptions));
 
   el.dispatchEvent(new KeyboardEvent('keyup', keyboardEventArg));
   fixture.detectChanges();

tensorboard/webapp/widgets/filter_input/BUILD

@@ -0,0 +1,18 @@
+load("//tensorboard/defs:defs.bzl", "tf_ng_module")
+
+package(default_visibility = ["//tensorboard:internal"])
+
+licenses(["notice"])
+
+tf_ng_module(
+    name = "filter_input",
+    srcs = [
+        "filter_input_component.ts",
+        "filter_input_module.ts",
+    ],
+    deps = [
+        "//tensorboard/webapp/angular:expect_angular_material_autocomplete",
+        "@npm//@angular/common",
+        "@npm//@angular/core",
+    ],
+)

tensorboard/webapp/widgets/filter_input/filter_input_component.ts

@@ -0,0 +1,59 @@
+/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+==============================================================================*/
+import {Component, Input, ViewChild} from '@angular/core';
+import {MatAutocompleteTrigger} from '@angular/material/autocomplete';
+
+/**
+ * A text input field intended for filtering items.
+ */
+@Component({
+  selector: 'tb-filter-input',
+  template: `
+    <input
+      type="text"
+      autocomplete="off"
+      [placeholder]="placeholder"
+      [matAutocomplete]="matAutocomplete"
+      [matAutocompleteDisabled]="!matAutocomplete"
+    />
+  `,
+  styles: [
+    `
+      :host {
+        display: flex;
+      }
+
+      input {
+        font: inherit;
+        border: none;
+        outline: none;
+        padding: 0;
+        width: 100%;
+      }
+    `,
+  ],
+})
+export class FilterInputComponent {
+  @Input() value!: string;
+  @Input() matAutocomplete?: string;
+  @Input() placeholder?: string;
+
+  @ViewChild(MatAutocompleteTrigger)
+  autocompleteTrigger!: MatAutocompleteTrigger;
+
+  getAutocompleteTrigger(): MatAutocompleteTrigger {
+    return this.autocompleteTrigger;
+  }
+}

tensorboard/webapp/widgets/filter_input/filter_input_module.ts

@@ -0,0 +1,26 @@
+/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+==============================================================================*/
+import {CommonModule} from '@angular/common';
+import {NgModule} from '@angular/core';
+import {MatAutocompleteModule} from '@angular/material/autocomplete';
+
+import {FilterInputComponent} from './filter_input_component';
+
+@NgModule({
+  declarations: [FilterInputComponent],
+  exports: [FilterInputComponent],
+  imports: [CommonModule, MatAutocompleteModule],
+})
+export class FilterInputModule {}