From 0fb297fe344c3cb51de187f264ae8a00e8e20fd5 Mon Sep 17 00:00:00 2001 From: mhartington Date: Tue, 2 Feb 2016 14:16:16 -0500 Subject: [PATCH] docs(select): update docs --- ionic/components/select/select.ts | 52 ++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/ionic/components/select/select.ts b/ionic/components/select/select.ts index 2d4efb199c..272147659b 100644 --- a/ionic/components/select/select.ts +++ b/ionic/components/select/select.ts @@ -92,7 +92,13 @@ import {Option} from '../option/option'; * subTitle: 'Select your toppings' * }; * ``` - * + * @property [cancelText] - The text of the cancel button. Defatuls to 'cancel' + * @property [okText] - The text of the ok button. Defatuls to 'OK' + * @property [alertOptions] - Any addition options that an alert can take. Title, Subtitle, etc. + * @property [multiple] - Whether or not the select component can accept multipl selections + * @property [disabled] - Whether or not the select component is disabled or not + * @property (change) - Any expression you want to evaluate when the selection has changed + */ @Component({ selector: 'ion-select', @@ -125,11 +131,29 @@ export class Select { */ id: string; + /** + * @private + */ @Input() cancelText: string = 'Cancel'; + + /** + * @private + */ @Input() okText: string = 'OK'; + + /** + * @private + */ @Input() alertOptions: any = {}; + + /** + * @private + */ @Input() checked: any = false; + /** + * @private + */ @Output() change: EventEmitter = new EventEmitter(); constructor( @@ -215,6 +239,10 @@ export class Select { this._nav.present(alert, alertOptions); } + + /** + * @private + */ @Input() get multiple() { return this._multi; @@ -224,6 +252,10 @@ export class Select { this._multi = isTrueProperty(val); } + + /** + * @private + */ @Input() get value(): any { return (this._multi ? this._values : this._values.join()); @@ -235,10 +267,17 @@ export class Select { this.updateOptions(); } + + /** + * @private + */ get text() { return (this._multi ? this._texts : this._texts.join()); } + /** + * @private + */ @ContentChildren(Option) private set options(val: QueryList