javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-22 13:32:54 +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

13
src/components/range/range.ts
View File

@ -152,8 +152,9 @@ export class Range extends Ion implements AfterViewInit, ControlValueAccessor, O
value: any;
/**
* @input {string} The predefined color to use. For example: `"primary"`,
* `"secondary"`, `"danger"`.
* @input {string} The color to use from your Sass `$colors` map.
* Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`.
* For more information, see [Theming your App](/docs/v2/theming/theming-your-app).
*/
@Input()
set color(val: string) {
@ -161,7 +162,9 @@ export class Range extends Ion implements AfterViewInit, ControlValueAccessor, O
}
/**
* @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) {
@ -263,7 +266,7 @@ export class Range extends Ion implements AfterViewInit, ControlValueAccessor, O
}
/**
* @input {boolean} Whether or not the range is disabled. Defaults to `false`.
* @input {boolean} If true, the user cannot interact with this element.
*/
@Input()
get disabled(): boolean {
@ -300,7 +303,7 @@ export class Range extends Ion implements AfterViewInit, ControlValueAccessor, O
}
/**
* @output {Range} Expression to evaluate when the range value changes.
* @output {Range} Emitted when the range value changes.
*/
@Output() ionChange: EventEmitter<Range> = new EventEmitter<Range>();