-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(wheel-selector): add Native wheel Selector plugin (#1522)
- Loading branch information
Showing
1 changed file
with
126 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
import { Injectable } from '@angular/core'; | ||
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core'; | ||
|
||
export interface WheelSelectorOptions { | ||
/** | ||
* The title of the selector's input box | ||
*/ | ||
title: string; | ||
|
||
/** | ||
* The items to display (array of items). | ||
* Example, 2 wheels: | ||
* [{description: "1", description: "2", description: "3"}, | ||
* {description: "Apple", description: "Pear", description: "Banana"}] | ||
*/ | ||
items: {}; | ||
|
||
/** | ||
* Which items to display by default, example ["2","Apple"] (if items.length is 2 for instance) | ||
*/ | ||
defaultItems?: any; | ||
|
||
/** | ||
* The 'ok' button text | ||
* Default: Done | ||
*/ | ||
positiveButtonText?: string; | ||
|
||
/** | ||
* The 'cancel' button text | ||
* Default: Cancel | ||
*/ | ||
negativeButtonText?: string; | ||
|
||
/** | ||
* Android only - theme color, 'light' or 'dark'. | ||
* Default: light | ||
*/ | ||
theme?: string; | ||
|
||
/** | ||
* Whether to have the wheels 'wrap' (Android only) | ||
* Default: false | ||
*/ | ||
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 { | ||
|
||
data: any; | ||
|
||
} | ||
/** | ||
* @name WheelSelector Plugin | ||
* @description Native wheel selector for Cordova (Android/iOS). | ||
* | ||
* @usage | ||
* ``` | ||
* import { WheelSelector } from 'ionic-native'; | ||
* | ||
* | ||
* constructor(private selector: WheelSelector) { } | ||
* | ||
* ... | ||
* | ||
* let jsonData = { | ||
* numbers: [ | ||
* { description: "1" }, | ||
* { description: "2" }, | ||
* { description: "3" } | ||
* ], | ||
* fruits: [ | ||
* { description: "Apple" }, | ||
* { description: "Banana" }, | ||
* { description: "Tangerine" } | ||
* ], | ||
* }; | ||
* | ||
* this.selector.show({ | ||
* title: "Select some Fruit", | ||
* items: [ | ||
* [jsonData.numbers], | ||
* [jsonData.fruits] | ||
* ], | ||
* }).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 | ||
* WheelSelectorOptions | ||
*/ | ||
@Plugin({ | ||
pluginName: 'WheelSelector', | ||
plugin: 'cordova-wheel-selector-plugin', | ||
pluginRef: 'SelectorCordovaPlugin', | ||
repo: 'https://github.com/jasonmamy/cordova-wheel-selector-plugin', | ||
platforms: ['Android', 'iOS'] | ||
}) | ||
|
||
@Injectable() | ||
export class WheelSelector extends IonicNativePlugin { | ||
|
||
/** | ||
* Shows the wheel selector | ||
* @param {WheelSelectorOptions} options Options for the wheel selector | ||
* @returns {Promise<WheelSelectorData>} Returns a promise that resolves with the selected items, or an error. | ||
*/ | ||
@Cordova() | ||
show(options: WheelSelectorOptions): Promise<WheelSelectorData> { | ||
return; | ||
} | ||
|
||
} |