From 35285be80f252a2a4b1a19d45e9ffb23885d0da2 Mon Sep 17 00:00:00 2001 From: tinayuangao Date: Wed, 9 Nov 2016 10:43:18 -0800 Subject: [PATCH] docs(button-toggle): clarify ngModel w/ multiple not yet supported (#1757) --- src/lib/button-toggle/README.md | 2 +- src/lib/button-toggle/button-toggle.ts | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/src/lib/button-toggle/README.md b/src/lib/button-toggle/README.md index 330daacd4fc..893f950e124 100644 --- a/src/lib/button-toggle/README.md +++ b/src/lib/button-toggle/README.md @@ -44,7 +44,7 @@ Output: `md-button-toggle` can be used in a multiple selection group when surrounded by `md-button-toggle-group multiple`. This styles all buttons within the group to appear as a single -group of button toggles. +group of button toggles. This component does not yet support `NgModel` when using `multiple` mode. ```html diff --git a/src/lib/button-toggle/button-toggle.ts b/src/lib/button-toggle/button-toggle.ts index c1b922055da..28d2f0b34d0 100644 --- a/src/lib/button-toggle/button-toggle.ts +++ b/src/lib/button-toggle/button-toggle.ts @@ -66,7 +66,10 @@ export class MdButtonToggleGroup implements AfterViewInit, ControlValueAccessor /** Whether the button toggle group is initialized or not. */ private _isInitialized: boolean = false; - /** The method to be called in order to update ngModel. */ + /** + * The method to be called in order to update ngModel. + * Now `ngModel` binding is not supported in multiple selection mode. + */ private _controlValueAccessorChangeFn: (value: any) => void = (value) => {}; /** onTouch function registered via registerOnTouch (ControlValueAccessor). */ @@ -200,7 +203,7 @@ export class MdButtonToggleGroup implements AfterViewInit, ControlValueAccessor } } -/** Multiple selection button-toggle group. */ +/** Multiple selection button-toggle group. `ngModel` is not supported in this mode. */ @Directive({ selector: 'md-button-toggle-group[multiple]', exportAs: 'mdButtonToggleGroup',