Update combobox and calendar with directives (#95)

reshaw · bengry · commit 8ccbaa5e3efa · 2019-03-06T21:23:51.000+02:00
Add directives for the ComboBox and Calendar to enable the Angular-style template localization pattern.

Change wrapper to fix some timing bugs
diff --git a/apps/demo/src/app/app.component.html b/apps/demo/src/app/app.component.html
@@ -142,6 +142,30 @@ <h2>Getting up and running...</h2>
 
   <fab-calendar [strings]="strings" (onSelectDate)="onSelectDate($event)"></fab-calendar>
 
+  <fab-calendar (onSelectDate)="onSelectDate($event)">
+    <fab-calendar-strings
+      [months]="[
+        'January',
+        'Fabruary',
+        'March',
+        'April',
+        'May',
+        'June',
+        'July',
+        'August',
+        'September',
+        'October',
+        'November',
+        'December'
+      ]"
+      [shortMonths]="['Jan', 'Fab', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']"
+      [days]="['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']"
+      [shortDays]="['S', 'M', 'T', 'W', 'T', 'F', 'S']"
+      goToToday="Go to tomorrow"
+      weekNumberFormatString="Week number {0}"
+    ></fab-calendar-strings>
+  </fab-calendar>
+
   <fab-marquee-selection [isEnabled]="marqueeEnabled" [selection]="selection">
     <fab-details-list
       [selection]="selection"
diff --git a/apps/docs/src/app/containers/component-docs/fabric/fabric.component.html b/apps/docs/src/app/containers/component-docs/fabric/fabric.component.html
@@ -1,7 +1,7 @@
 <h1>Microsoft Fabric [React] Components</h1>
 
 <h2>Button</h2>
-<fab-default-button text="Toggle Disabled" (onClick)="toggle()"></fab-default-button>
+<fab-default-button text="Toggle Disabled" (onClick)="toggle()" contentStyle="margin-right: 10px;"></fab-default-button>
 <fab-default-button
   [disabled]="disabled"
   (onClick)="click()"
@@ -22,7 +22,46 @@ <h2>Dialog</h2>
 >
   {{ sampleContent2 }} {{ sampleContent3 }}
   <fab-dialog-footer>
-    <fab-default-button (onClick)="clickSave()" text="Save" contentStyle="margin-right: 10px;"></fab-default-button>
+    <fab-default-button (onClick)="clickSave()" text="Save"></fab-default-button>
     <fab-default-button (onClick)="toggleDialog()" text="Cancel"></fab-default-button>
   </fab-dialog-footer>
 </fab-dialog>
+
+<hr />
+
+<h2>Combo box</h2>
+<fab-combo-box contentStyle="width: 300px;" (onChange)="comboChange($event)">
+  <options>
+    <fab-combo-box-option optionKey="A" text="See option A"></fab-combo-box-option>
+    <fab-combo-box-option optionKey="B" text="See option B"></fab-combo-box-option>
+  </options>
+</fab-combo-box>
+{{ selectedComboBoxKey }}: {{ selectedComboBoxValue }}
+
+<hr />
+
+<h2>Directive Calendar</h2>
+<fab-calendar (onSelectDate)="onSelectDate($event)">
+  <fab-calendar-strings
+    [months]="[
+      'January',
+      'Fabruary',
+      'March',
+      'April',
+      'May',
+      'June',
+      'July',
+      'August',
+      'September',
+      'October',
+      'November',
+      'December'
+    ]"
+    [shortMonths]="['Jan', 'Fab', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']"
+    [days]="['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']"
+    [shortDays]="['S', 'M', 'T', 'W', 'T', 'F', 'S']"
+    goToToday="Go to tomorrow"
+    weekNumberFormatString="Week number {0}"
+  ></fab-calendar-strings>
+</fab-calendar>
+{{ selectedDate }}
diff --git a/apps/docs/src/app/containers/component-docs/fabric/fabric.component.ts b/apps/docs/src/app/containers/component-docs/fabric/fabric.component.ts
@@ -1,4 +1,5 @@
 import { Component } from '@angular/core';
+import { IComboBoxOption, ICalendarStrings } from 'office-ui-fabric-react';
 
 @Component({
   selector: 'app-fabric',
@@ -12,6 +13,23 @@ export class FabricComponent {
   secondsCounter = 0;
   sampleContent2 = '0 Seconds Passed';
   sampleContent3 = '';
+  selectedComboBoxKey: string = "None";
+  selectedComboBoxValue: string = "None";
+  selectedDate: Date;
+
+  comboBoxOptions: IComboBoxOption[] = [
+    { key: 'A', text: 'See option A' },
+    { key: 'B', text: 'See option B' },
+  ];
+
+  onSelectDate(event) {
+    this.selectedDate = event.date;
+  }
+
+  comboChange(event) {
+    this.selectedComboBoxKey = event.option.key;
+    this.selectedComboBoxValue = event.option.text;
+  }
 
   get sampleContent() {
     return `Button clicked ${this.sampleContentCounter} times.`;
diff --git a/apps/docs/src/app/fabric.module.ts b/apps/docs/src/app/fabric.module.ts
@@ -1,7 +1,17 @@
 import { NgModule } from '@angular/core';
-import { FabButtonModule, FabDialogModule } from '@angular-react/fabric';
+import { 
+  FabButtonModule,
+  FabDialogModule,
+  FabComboBoxModule, 
+  FabCalendarModule
+} from '@angular-react/fabric';
 
-const componentModules = [FabButtonModule, FabDialogModule];
+const componentModules = [
+  FabButtonModule,
+  FabDialogModule,
+  FabComboBoxModule,
+  FabCalendarModule
+];
 @NgModule({
   imports: componentModules,
   exports: componentModules,
diff --git a/libs/core/src/lib/components/wrapper-component.ts b/libs/core/src/lib/components/wrapper-component.ts
@@ -97,7 +97,7 @@ export abstract class ReactWrapperComponent<TProps extends {}> implements AfterV
     this._contentClass = value;
     if (isReactNode(this.reactNodeRef.nativeElement)) {
       this.reactNodeRef.nativeElement.setProperty('className', classnames(value));
-      this.changeDetectorRef.detectChanges();
+      this.markForCheck();
     }
   }
 
@@ -118,7 +118,7 @@ export abstract class ReactWrapperComponent<TProps extends {}> implements AfterV
     if (isReactNode(this.reactNodeRef.nativeElement)) {
       const stringValue = typeof value === 'string' ? value : stylenames(value);
       this.reactNodeRef.nativeElement.setProperty('style', toStyle(stringValue));
-      this.changeDetectorRef.detectChanges();
+      this.markForCheck();
     }
   }
 
@@ -142,9 +142,11 @@ export abstract class ReactWrapperComponent<TProps extends {}> implements AfterV
     this._shouldSetHostDisplay = setHostDisplay;
   }
 
-  ngAfterViewInit() {
+  ngAfterContentInit() {
     this._passAttributesAsProps();
+  }
 
+  ngAfterViewInit() {
     if (this._shouldSetHostDisplay) {
       this._setHostDisplay();
     }
diff --git a/libs/fabric/src/lib/components/button/base-button.component.ts b/libs/fabric/src/lib/components/button/base-button.component.ts
@@ -129,6 +129,7 @@ export abstract class FabBaseButtonComponent extends ReactWrapperComponent<IButt
 
       setItems(this.menuItemsDirectives.toArray());
     }
+    super.ngAfterContentInit();
   }
 
   ngOnDestroy() {
diff --git a/libs/fabric/src/lib/components/calendar/calendar.component.ts b/libs/fabric/src/lib/components/calendar/calendar.component.ts
@@ -12,8 +12,11 @@ import {
   Output,
   Renderer2,
   ViewChild,
+  ContentChild,
+  AfterContentInit,
 } from '@angular/core';
 import { ICalendarProps } from 'office-ui-fabric-react/lib/Calendar';
+import { CalendarStringsDirective } from './directives/calendar-strings-directive.component';
 
 @Component({
   selector: 'fab-calendar',
@@ -57,7 +60,7 @@ import { ICalendarProps } from 'office-ui-fabric-react/lib/Calendar';
   styles: ['react-renderer'],
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
-export class FabCalendarComponent extends ReactWrapperComponent<ICalendarProps> {
+export class FabCalendarComponent extends ReactWrapperComponent<ICalendarProps> implements AfterContentInit {
   @ViewChild('reactNode') protected reactNodeRef: ElementRef;
 
   @Input() componentRef?: ICalendarProps['componentRef'];
@@ -91,14 +94,22 @@ export class FabCalendarComponent extends ReactWrapperComponent<ICalendarProps>
   @Output() readonly onSelectDate = new EventEmitter<{ date: Date; selectedDateRangeArray?: Date[] }>();
   @Output() readonly onDismiss = new EventEmitter<void>();
 
+  @ContentChild(CalendarStringsDirective) readonly calendarStringsDirective?: CalendarStringsDirective;
+
   constructor(elementRef: ElementRef, changeDetectorRef: ChangeDetectorRef, renderer: Renderer2) {
     super(elementRef, changeDetectorRef, renderer);
-
     // coming from React context - we need to bind to this so we can access the Angular Component properties
     this.onSelectDateHandler = this.onSelectDateHandler.bind(this);
     this.onDismissHandler = this.onDismissHandler.bind(this);
   }
 
+  ngAfterContentInit() {
+    if (this.calendarStringsDirective) {
+      this._initDirective(this.calendarStringsDirective);
+      super.ngAfterContentInit();
+    }
+  }
+
   onSelectDateHandler(date: Date, selectedDateRangeArray?: Date[]) {
     this.onSelectDate.emit({
       date,
@@ -109,4 +120,8 @@ export class FabCalendarComponent extends ReactWrapperComponent<ICalendarProps>
   onDismissHandler() {
     this.onDismiss.emit();
   }
+
+  private _initDirective(calendarStringsDirective: CalendarStringsDirective) {
+    this.strings = calendarStringsDirective.strings;
+  }
 }
diff --git a/libs/fabric/src/lib/components/calendar/calendar.module.ts b/libs/fabric/src/lib/components/calendar/calendar.module.ts
@@ -8,16 +8,17 @@ import * as CalendarCss from 'office-ui-fabric-react/lib-amd/components/Calendar
 import { Calendar } from 'office-ui-fabric-react';
 import { noop } from '../../utils/noop';
 import { FabCalendarComponent } from './calendar.component';
+import { CalendarStringsDirective } from './directives/calendar-strings-directive.component';
 
 // Dummy action to force CalendarCss to load and not be tree-shaken away.
 noop(CalendarCss);
 
-const components = [FabCalendarComponent];
+const declarations = [FabCalendarComponent, CalendarStringsDirective];
 
 @NgModule({
   imports: [CommonModule],
-  declarations: components,
-  exports: components,
+  declarations: declarations,
+  exports: declarations,
   schemas: [NO_ERRORS_SCHEMA],
 })
 export class FabCalendarModule {
diff --git a/libs/fabric/src/lib/components/calendar/directives/calendar-strings-directive.component.ts b/libs/fabric/src/lib/components/calendar/directives/calendar-strings-directive.component.ts
@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { Directive, Input } from '@angular/core';
+import { ICalendarStrings } from 'office-ui-fabric-react';
+
+/**
+ * Wrapper directive for calendar strings
+ */
+@Directive({ selector: 'fab-calendar > fab-calendar-strings' })
+export class CalendarStringsDirective {
+
+  @Input() months: ICalendarStrings['months'];
+  @Input() shortMonths: ICalendarStrings['shortMonths'];
+  @Input() days: ICalendarStrings['days'];
+  @Input() shortDays: ICalendarStrings['shortDays'];
+  @Input() goToToday: ICalendarStrings['goToToday'];
+  @Input() weekNumberFormatString: ICalendarStrings['weekNumberFormatString'];
+
+  
+  get strings(): ICalendarStrings {
+    return {
+      months: this.months,
+      shortMonths: this.shortMonths,
+      days: this.days,
+      shortDays: this.shortDays,
+      goToToday: this.goToToday,
+      weekNumberFormatString: this.weekNumberFormatString
+    }
+  }
+}
diff --git a/libs/fabric/src/lib/components/combo-box/base-combo-box.component.ts b/libs/fabric/src/lib/components/combo-box/base-combo-box.component.ts
@@ -2,10 +2,26 @@
 // Licensed under the MIT License.
 
 import { InputRendererOptions, JsxRenderFunc, ReactWrapperComponent } from '@angular-react/core';
-import { ChangeDetectorRef, ElementRef, EventEmitter, Input, NgZone, OnInit, Output, Renderer2 } from '@angular/core';
+import {
+  ChangeDetectorRef,
+  ElementRef,
+  EventEmitter,
+  Input,
+  NgZone,
+  OnInit,
+  Output,
+  Renderer2,
+  ContentChild,
+  AfterContentInit,
+} from '@angular/core';
 import { IComboBox, IComboBoxOption, IComboBoxProps } from 'office-ui-fabric-react/lib/ComboBox';
+import { ComboBoxOptionDirective } from './directives/combo-box-option.directive';
+import { ComboBoxOptionsDirective } from './directives/combo-box-options.directive';
+
+export abstract class FabBaseComboBoxComponent extends ReactWrapperComponent<IComboBoxProps>
+  implements OnInit, AfterContentInit {
+  @ContentChild(ComboBoxOptionDirective) readonly optionsDirective?: ComboBoxOptionDirective;
 
-export abstract class FabBaseComboBoxComponent extends ReactWrapperComponent<IComboBoxProps> implements OnInit {
   @Input() componentRef?: IComboBoxProps['componentRef'];
   @Input() options: IComboBoxProps['options'];
   @Input() allowFreeform?: IComboBoxProps['allowFreeform'];
@@ -49,6 +65,8 @@ export abstract class FabBaseComboBoxComponent extends ReactWrapperComponent<ICo
   @Output() readonly onMenuDismissed = new EventEmitter<void>();
   @Output() readonly onScrollToItem = new EventEmitter<{ itemIndex: number }>();
 
+  @ContentChild(ComboBoxOptionsDirective) readonly comboBoxOptionsDirective?: ComboBoxOptionsDirective;
+
   onRenderLowerContent: (props?: IComboBoxProps, defaultRender?: JsxRenderFunc<IComboBoxProps>) => JSX.Element;
 
   constructor(elementRef: ElementRef, changeDetectorRef: ChangeDetectorRef, renderer: Renderer2, ngZone: NgZone) {
@@ -65,6 +83,13 @@ export abstract class FabBaseComboBoxComponent extends ReactWrapperComponent<ICo
     this.onRenderLowerContent = this.createRenderPropHandler(this.renderLowerContent);
   }
 
+  ngAfterContentInit() {
+    if (this.comboBoxOptionsDirective) {
+      this._initDirective(this.comboBoxOptionsDirective);
+    }
+    super.ngAfterContentInit();
+  }
+
   onItemClickHandler(event: React.FormEvent<IComboBox>, option?: IComboBoxOption, index?: number) {
     this.onItemClick.emit({
       event: event.nativeEvent,
@@ -95,4 +120,9 @@ export abstract class FabBaseComboBoxComponent extends ReactWrapperComponent<ICo
       itemIndex,
     });
   }
+
+  private _initDirective(directive: ComboBoxOptionsDirective) {
+    this.options = directive.items;
+    this.markForCheck();
+  }
 }
diff --git a/libs/fabric/src/lib/components/combo-box/combo-box.module.ts b/libs/fabric/src/lib/components/combo-box/combo-box.module.ts
@@ -7,13 +7,20 @@ import { NgModule, NO_ERRORS_SCHEMA } from '@angular/core';
 import { ComboBox, VirtualizedComboBox } from 'office-ui-fabric-react';
 import { FabComboBoxComponent } from './combo-box.component';
 import { FabVirtualizedComboBoxComponent } from './virtualized-combo-box.component';
+import { ComboBoxOptionDirective } from './directives/combo-box-option.directive';
+import { ComboBoxOptionsDirective } from './directives/combo-box-options.directive';
 
-const components = [FabComboBoxComponent, FabVirtualizedComboBoxComponent];
+const declarations = [
+  FabComboBoxComponent,
+  FabVirtualizedComboBoxComponent,
+  ComboBoxOptionDirective,
+  ComboBoxOptionsDirective
+];
 
 @NgModule({
   imports: [CommonModule],
-  declarations: components,
-  exports: components,
+  declarations: declarations,
+  exports: declarations,
   schemas: [NO_ERRORS_SCHEMA],
 })
 export class FabComboBoxModule {
diff --git a/libs/fabric/src/lib/components/combo-box/directives/combo-box-option.directive.ts b/libs/fabric/src/lib/components/combo-box/directives/combo-box-option.directive.ts
@@ -0,0 +1,25 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { Directive, Input } from '@angular/core';
+import { IComboBoxOption } from 'office-ui-fabric-react';
+
+/**
+ * Wrapper directive for creating a ComboBoxOption
+ * @paramName optionKey Binds to React 'key' property.
+ *                      Name change necessary because key is a reserved attribute in the wrapper component. 
+ */
+@Directive({ selector: 'fab-combo-box-option' })
+export class ComboBoxOptionDirective {
+  @Input() optionKey: IComboBoxOption['key'];
+  @Input() text: IComboBoxOption['text'];
+  @Input() title?: IComboBoxOption['title'];
+  @Input() itemType: IComboBoxOption['itemType'];
+  @Input() index?: IComboBoxOption['index'];
+  @Input() ariaLabel?: IComboBoxOption['ariaLabel'];
+  @Input() selected?: IComboBoxOption['selected'];
+  @Input() disabled?: IComboBoxOption['disabled'];
+  @Input() data?: IComboBoxOption['data'];
+  @Input() styles?: IComboBoxOption['styles'];
+  @Input() useAriaLabelAsText?: IComboBoxOption['useAriaLabelAsText'];
+}
diff --git a/libs/fabric/src/lib/components/combo-box/directives/combo-box-options.directive.ts b/libs/fabric/src/lib/components/combo-box/directives/combo-box-options.directive.ts
diff --git a/libs/fabric/src/lib/components/command-bar/command-bar.component.ts b/libs/fabric/src/lib/components/command-bar/command-bar.component.ts
diff --git a/libs/fabric/src/lib/components/details-list/details-list.component.ts b/libs/fabric/src/lib/components/details-list/details-list.component.ts

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ export abstract class ReactWrapperComponent<TProps extends {}> implements AfterV`
`97`	`97`	`this._contentClass = value;`
`98`	`98`	`if (isReactNode(this.reactNodeRef.nativeElement)) {`
`99`	`99`	`this.reactNodeRef.nativeElement.setProperty('className', classnames(value));`
`100`		`- this.changeDetectorRef.detectChanges();`
	`100`	`+ this.markForCheck();`
`101`	`101`	`}`
`102`	`102`	`}`
`103`	`103`
`@@ -118,7 +118,7 @@ export abstract class ReactWrapperComponent<TProps extends {}> implements AfterV`
`118`	`118`	`if (isReactNode(this.reactNodeRef.nativeElement)) {`
`119`	`119`	`const stringValue = typeof value === 'string' ? value : stylenames(value);`
`120`	`120`	`this.reactNodeRef.nativeElement.setProperty('style', toStyle(stringValue));`
`121`		`- this.changeDetectorRef.detectChanges();`
	`121`	`+ this.markForCheck();`
`122`	`122`	`}`
`123`	`123`	`}`
`124`	`124`
`@@ -142,9 +142,11 @@ export abstract class ReactWrapperComponent<TProps extends {}> implements AfterV`
`142`	`142`	`this._shouldSetHostDisplay = setHostDisplay;`
`143`	`143`	`}`
`144`	`144`
`145`		`- ngAfterViewInit() {`
	`145`	`+ ngAfterContentInit() {`
`146`	`146`	`this._passAttributesAsProps();`
	`147`	`+ }`
`147`	`148`
	`149`	`+ ngAfterViewInit() {`
`148`	`150`	`if (this._shouldSetHostDisplay) {`
`149`	`151`	`this._setHostDisplay();`
`150`	`152`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@ export abstract class FabBaseButtonComponent extends ReactWrapperComponent<IButt`
`129`	`129`
`130`	`130`	`setItems(this.menuItemsDirectives.toArray());`
`131`	`131`	`}`
	`132`	`+ super.ngAfterContentInit();`
`132`	`133`	`}`
`133`	`134`
`134`	`135`	`ngOnDestroy() {`