awesome-cordova-plugins/src/plugins/datepicker.ts

102 lines
2.3 KiB
TypeScript
Raw Normal View History

2016-02-16 06:22:50 +08:00
import {Plugin, Cordova} from './plugin';
export interface datePickerOptions {
/**
* Platforms: iOS, Android, Windows
* The mode of the date picker
* Values: date | time | datetime
*/
mode: string,
/**
* Platforms: iOS, Android, Windows
* Selected date
*/
date: Date,
/**
* Platforms: iOS, Android, Windows
* Minimum date
* Type: Date | empty String
* Default: empty String
*/
2016-03-09 03:23:22 +08:00
minDate: Date,
/**
* Platforms: iOS, Android, Windows
* Maximum date
* Type: Date | empty String
* Default: empty String
*/
2016-03-09 03:23:22 +08:00
maxDate: Date,
/**
* Platforms: Android
* Label for the dialog title. If empty, uses android default (Set date/Set time).
* Type: String
* Default: empty String
*/
2016-03-09 03:23:22 +08:00
titleText: string,
/**
* Platforms: Android
* Label of BUTTON_POSITIVE (done button) on Android
*/
2016-03-09 03:23:22 +08:00
okText: string,
// TODO complete documentation here, and copy params & docs to main plugin docs
2016-03-09 03:23:22 +08:00
cancelText: string,
todayText: string,
nowText: string,
is24Hour: boolean,
androidTheme: number,
allowOldDate: boolean,
allowFutureDates: boolean,
doneButtonLabel: string,
doneButtonColor: string,
cancelButtonLabel: string,
cancelButtonColor: string,
x: number,
y: number,
minuteInterval: number,
popoverArrowDirection: string,
locale: string
}
2016-02-16 06:22:50 +08:00
/**
2016-03-14 03:45:07 +08:00
* @name Date Picker
* @description
2016-02-16 06:22:50 +08:00
* The DatePicker plugin allows the user to fetch date or time using native dialogs.
*
* Platforms supported: iOS, Android, Windows
*
* Requires Cordova plugin: `cordova-plugin-datepicker`. For more info, please see the [DatePicker plugin docs](https://github.com/VitaliiBlagodir/cordova-plugin-datepicker).
2016-02-16 06:22:50 +08:00
*
* @usage
* ```js
* DatePicker.show({
* date: new Date(),
* mode: 'date'
* }).then(
* date => console.log("Got date: ", date),
* err => console.log("Error occurred while getting date:", err)
* );
2016-02-16 06:22:50 +08:00
* ```
*
*/
@Plugin({
plugin: 'cordova-plugin-datepicker',
2016-03-13 08:08:47 +08:00
pluginRef: 'datePicker',
repo: 'https://github.com/VitaliiBlagodir/cordova-plugin-datepicker'
2016-02-16 06:22:50 +08:00
})
export class DatePicker {
/**
* Shows the date and/or time picker dialog(s)
* @param options
* @returns {Promise<Date>} Returns a promise that resolves with the picked date and/or time, or rejects with an error.
*/
2016-03-05 05:42:21 +08:00
@Cordova()
static show(options: datePickerOptions): Promise<Date> { return }
2016-02-16 06:22:50 +08:00
}