From 0743f46d5d103b751cf4c1fb6e384fdf9eba485e Mon Sep 17 00:00:00 2001 From: mhartington Date: Fri, 24 Jun 2016 11:55:36 -0400 Subject: [PATCH] docs(toggle): update docs --- src/components/toggle/toggle.ts | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/src/components/toggle/toggle.ts b/src/components/toggle/toggle.ts index 914184220d..a092b72deb 100644 --- a/src/components/toggle/toggle.ts +++ b/src/components/toggle/toggle.ts @@ -22,8 +22,6 @@ const TOGGLE_VALUE_ACCESSOR = new Provider( * * See the [Angular 2 Docs](https://angular.io/docs/ts/latest/guide/forms.html) * for more info on forms and inputs. - * @property {boolean} [checked] - whether the toggle it toggled or not - * @property {boolean} [disabled] - whether the toggle is disabled or not * * @usage * ```html @@ -108,12 +106,18 @@ export class Toggle implements ControlValueAccessor { } } + /** + * @private + */ private pointerDown(ev: UIEvent): boolean { this._startX = pointerCoord(ev).x; this._activated = true; return true; } + /** + * @private + */ private pointerMove(ev: UIEvent) { if (this._startX) { let currentX = pointerCoord(ev).x; @@ -134,6 +138,9 @@ export class Toggle implements ControlValueAccessor { } } + /** + * @private + */ private pointerUp(ev: UIEvent) { if (this._startX) { let endX = pointerCoord(ev).x; @@ -152,6 +159,9 @@ export class Toggle implements ControlValueAccessor { } } + /** + * @input {boolean} whether the toggle it toggled or not + */ @Input() get checked(): boolean { return this._checked; @@ -198,6 +208,9 @@ export class Toggle implements ControlValueAccessor { */ registerOnTouched(fn: any) { this.onTouched = fn; } + /** + * @input {boolean} whether the toggle is disabled or not + */ @Input() get disabled(): boolean { return this._disabled;