cuppa-datepicker
v1.0.1
Published
A cool javascript datepicker component for mobile and web.
Downloads
4
Maintainers
cuppalabsReadme
Cuppa DatePicker
Cuppa Datepicker is a cool responsive Javascript Datepicker for Web and Mobile. Developed by Cuppa Labs.
Demo
View the Demo here of Date Picker. Click here for JSFiddle.
Getting Started
- Install with npm:
npm install cuppa-datepicker
OR
Steps to Download git repositroy and setup
1. Add Datepicker Library
Include the cuppa-datepicker.js script file in the <head> section or at the bottom of your html page.
<script src="cuppa-datepicker.js" type="text/javascript"></script>2. CSS
Include the CSS file in <head> section of your page.
<link href="cuppa-datepicker-styles.css" rel="stylesheet">3. Initialize
Initialize datepicker component with the following script
var cal = new WinkelCalendar({
container: 'cuppaDatePickerContainer',
bigBanner: true,
defaultDate: '2016-1-12',
format : "DD-MM-YYYY",
onSelect : onDateChange
});
4. HTML
HTML container where the datepicker to be rendered
<div id="cuppaDatePickerContainer"></div>5. External Dependencies
We have font awesome icons and moment.js as dependencies for the component. Don't forget to include the following dependencies.
<script src="https://use.fontawesome.com/698aa4e2c2.js"></script>
<script src="https://cdn.jsdelivr.net/momentjs/2.15.2/moment.min.js"></script>API Documentation
Configuration
Following options can be passed as a JSON config object to the datepicker
|Property|Type|Required|Default|Description|
|:--- |:--- |:--- |:--- |:--- |
|container|string|YES|''| ID of the container in which the datepicker needs to be initialized|
|defaultDate|string|Optional|Today Date|Date to show on load of the component. If not set todays date will be show as default.|
|format|string|Optional|DD/MM/YYYY|Date format of the calendar. This will be bound to the model as the date's value.|
|bigBanner|boolean|optional|true|Set to true to have a cool banner above the month table. Set false to have a simple datepicker|
|onSelect|function/method|optional|none|Callback method to call on select of date.|
Methods
setDate(String dateString)Sets the date to the value passed as parameter.
Parameter
- dateString: String
Example : setDate('06-11-2016')
today()Sets the date to todays's date.
Example : today()
open()Opens the datepicker popover.
close()Closes the datepicker popover.
Events
onSelect
Define a callback method to call on select of the date.
Example :
var cal = new WinkelCalendar({
onSelect : onDateChange
}); Licence
This project is licensed under the MIT license. See the LICENSE file for more info.
--
The MIT License (MIT) Copyright (c) 2016 Cuppa Labs
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Credits
Thanks to Font Awesome and Moment.js for the libraries.
Author
Pradeep Kumar Terli