javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 12:29:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(API): update descriptions to be more clear

Browse Source 
also update descriptions for the same properties to be more consistent,
and reword all events to start and end the same.

closes #10248 closes driftyco/ionic-site#613 closes
driftyco/ionic-site#899
This commit is contained in:
Brandy Carney
2017-01-31 17:47:52 -05:00
parent ace727e627
commit cc21f93b87
39 changed files with 304 additions and 202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/components/select/select.ts
View File

@ -191,7 +191,9 @@ export class Select extends Ion implements AfterContentInit, ControlValueAccesso
@Input() selectedText: string = '';
/**
* @input {string} The mode to apply to this component. Mode can be `ios`, `wp`, or `md`.
* @input {string} The mode determines which platform styles to use.
* Possible values are: `"ios"`, `"md"`, or `"wp"`.
* For more information, see [Platform Styles](/docs/v2/theming/platform-specific-styles).
*/
@Input()
set mode(val: string) {
@ -199,12 +201,12 @@ export class Select extends Ion implements AfterContentInit, ControlValueAccesso
}
/**
* @output {any} Any expression you want to evaluate when the selection has changed.
* @output {any} Emitted when the selection has changed.
*/
@Output() ionChange: EventEmitter<any> = new EventEmitter();
/**
* @output {any} Any expression you want to evaluate when the selection was cancelled.
* @output {any} Emitted when the selection was cancelled.
*/
@Output() ionCancel: EventEmitter<any> = new EventEmitter();
@ -366,7 +368,7 @@ export class Select extends Ion implements AfterContentInit, ControlValueAccesso
/**
* @input {boolean} Whether or not the select component can accept multiple values. Default: `false`.
* @input {boolean} If true, the element can accept multiple values.
*/
@Input()
get multiple(): any {
@ -424,14 +426,14 @@ export class Select extends Ion implements AfterContentInit, ControlValueAccesso
}
/**
* @input {boolean} Whether or not the select component is disabled. Default `false`.
* @input {boolean} If true, the user cannot interact with this element.
*/
@Input()
get disabled() {
get disabled(): boolean {
return this._disabled;
}
set disabled(val) {
set disabled(val: boolean) {
this._disabled = isTrueProperty(val);
this._item && this._item.setElementClass('item-select-disabled', this._disabled);
}