refactor(wheel-selector): fixed the interfaces and default values (#1544)

This commit is contained in:
jasonmamy 2017-05-13 19:46:19 -07:00 committed by Ibby Hadeed
parent 2d477ba9a0
commit 8ea8ac40e5

View File

@ -14,12 +14,12 @@ export interface WheelSelectorOptions {
/** /**
* The items to display (array of items). * The items to display (array of items).
*/ */
items: WheelSelectorItem[]; items: Array<Array<WheelSelectorItem>>;
/** /**
* Which items to display by default, example ["2","Apple"] (if items.length is 2 for instance) * Which items to display by default, example ["2","Apple"] (if items.length is 2 for instance)
*/ */
defaultItems?: WheelSelectorItem[]; defaultItems?: Array<WheelSelectorItem>;
/** /**
* The 'ok' button text * The 'ok' button text
@ -44,13 +44,6 @@ export interface WheelSelectorOptions {
* Default: false * Default: false
*/ */
wrapWheelText?: boolean; wrapWheelText?: boolean;
/**
* The json key to display, by default it is description, this allows for setting any
* key/value to be displayed
* Default: description
*/
displayKey?: string;
} }
export interface WheelSelectorData { export interface WheelSelectorData {
@ -84,12 +77,13 @@ export interface WheelSelectorData {
* ], * ],
* }; * };
* *
* //use most of the default values
* this.selector.show({ * this.selector.show({
* title: "Select some Fruit", * title: "Select some Fruit",
* items: [ * items: [
* [jsonData.numbers], * jsonData.numbers,
* [jsonData.fruits] * jsonData.fruits
* ], * ]
* }).then( * }).then(
* result => { * result => {
* console.log('Selected: ' + result[0].description + ' at index: ' + result[0].index * console.log('Selected: ' + result[0].description + ' at index: ' + result[0].index
@ -98,6 +92,28 @@ export interface WheelSelectorData {
* err => console.log('Error occurred while getting result: ', err) * err => console.log('Error occurred while getting result: ', err)
* ); * );
* *
* ...
*
* //set some initial default values to display: "2", "Tangerine"
* this.selector.show({
* title: "Select some Fruit",
* items: [
* jsonData.numbers,
* jsonData.fruits
* ],
* defaultItems: [
* jsonData.numbers[1],
* jsonData.fruits[2]
* ]
* }).then(
* result => {
* console.log('Selected: ' + result[0].description + ' at index: ' + result[0].index
* + ' and ' + result[1].description + ' at index: ' + result[1].index);
* },
* err => console.log('Error occurred while getting result: ', err)
* );
*
*
* ``` * ```
* *
* @interfaces * @interfaces