Sharinglabs / cordova-plugin-datepicker

MIT License
8 stars 7 forks source link

DatePicker Plugin for Cordova/PhoneGap 3.0 (iOS and Android)

This is a combined version of DatePicker iOS and Android plugin for Cordova/Phonegap 3.0.

Installation

1) Make sure that you have Node and Cordova CLI or PhoneGap's CLI installed on your machine.

2) Add a plugin to your project using Cordova CLI:

cordova plugin add https://github.com/Sharinglabs/cordova-plugin-datepicker

Or using PhoneGap CLI:

phonegap local plugin add https://github.com/Sharinglabs/cordova-plugin-datepicker

3a) Register plugin within config.xml of your app

<feature name="DatePicker">
    <param name="ios-package" value="DatePicker"/>
</feature>

<feature name="DatePickerPlugin">
    <param name="android-package" value="com.sharinglabs.cordova.plugin.datepicker.DatePickerPlugin"/>
</feature>

3b) If you are using PhoneGap build service add to config.xml

<gap:plugin name="com.sharinglabs.cordova.plugin.datepicker" />

Usage

var options = {
  date: new Date(),
  mode: 'date'
};

datePicker.show(options, function(date){
  alert("date result " + date);  
});

Options

mode - iOS, Android

The mode of the date picker.

Type: String

Values: date | time | datetime (datetime only works starting Android 4.4)

Default: date

date - iOS, Android

Selected date.

Type: String

Default: new Date()

minDate - iOS, Android

Minimum date.

Type: Date | empty String

Default: (empty String)

maxDate - iOS, Android

Maximum date.

Type: Date | empty String

Default: (empty String)

allowOldDates - iOS

Shows or hide dates earlier then selected date.

Type: Boolean

Values: true | false

Default: true

allowFutureDates - iOS

Shows or hide dates after selected date.

Type: Boolean

Values: true | false

Default: true

doneButtonLabel - iOS, Android

Label of done button.

Typ: String

Default: Done

doneButtonColor - iOS

Hex color of done button.

Typ: String

Default: #0000FF

cancelButtonLabel - iOS, Android

Label of cancel button.

Type: String

Default: Cancel

cancelButtonColor - iOS

Hex color of cancel button.

Type: String

Default: #000000

clearButtonLabel - iOS, Android

Label of clear button.

Type: String

Default: Clear

clearButtonColor - iOS

Hex color of clear button.

Type: String

Default: #FF0000

clearButton - iOS, Android

Show or hide clear button

Type: Boolean

Default: false

Return: "clear" will be returned when the user clicks the button

x - iOS (iPad only)

X position of date picker. The position is absolute to the root view of the application.

Type: String

Default: 0

y - iOS (iPad only)

Y position of date picker. The position is absolute to the root view of the application.

Type: String

Default: 0

Requirements

Example

var options = {
  date: new Date(),
  mode: 'date'
};

datePicker.show(options, function(date){
  alert("date result " + date);  
});