Skip to content

Latest commit

 

History

History
144 lines (69 loc) · 4.62 KB

README.md

File metadata and controls

144 lines (69 loc) · 4.62 KB
Raw

pickadate v3.3.0 pickadate build status

The mobile-friendly, responsive, and lightweight jQuery date & time input picker.

To get started, check out the:

Homepage - Date picker - Time picker - API

To get it:

Download v3.3.0 or git clone git://github.com/amsul/pickadate.js.git or bower install pickadate


## Upgrading from v2 to v3

The v3 API is significantly different from v2 (all for the greater good!). So if you’re upgrading to v3, make sure to read the changelog.


## Library files

The lib folder includes all the compiled files and a compressed folder with the minified counter-parts. These files are all generated from the _raw/lib folder using Grunt.

Pickers

There are currently two pickers: date and time.

File Contents Size (min & gzip)
picker.js Base * 1.33kb
picker.date.js Date picker 2.05kb
picker.time.js Time picker 1.38kb

* The base script is required for any of the pickers to function.

To support old browsers, namely IE8, also include the legacy.js file.

Themes

All themes are generated using LESS and compiled into the lib/themes folder.

File Contents Size (min & gzip)
default.css Base default * 0.49kb
default.date.css Default date picker 0.67kb
default.time.css Default time picker 0.35kb
classic.css Base classic * 0.32kb
classic.date.css Classic date picker 0.67kb
classic.time.css Classic time picker 0.35kb
rtl.css RTL language stylings ** 0.10kb

* One and only one base stylesheet is required. Choose a theme then include the respective pickers as well.

** For languages with text flowing from right-to-left, also include the rtl.css stylesheet.

Translations

The translations are copied into the lib/translations folder. There are currently 33 languages included.


## Building with Grunt

Grunt ~0.4.1 is used to build the project files. To get started, clone the project and then run:

  • npm install to get the required node modules.
  • grunt --verbose to confirm you have all the dependencies.

Read the Gruntfile to see the build tasks and relative directories of the source files.


## Styling with LESS

The picker themes are built using LESS with Grunt. To customize the CSS output, read the _variables.less file in the _raw/lib/themes folder. You can specify:

  • colors for the theme,
  • sizes for the picker,
  • media-query breakpoints,
  • and a whole bunch of other stuff.

After making any changes, run grunt less:themes to compile it into CSS.


## Versioning

To maintain some consistency in the sort of changes to expect with version bumps, Semantic Versioning guidelines will now be followed as closely as possible:

<major>.<minor>.<patch>

Constructed as such:

  • major: breaks backward compatibility (resets the minor and patch)
  • minor: new additions with backward compatibility (resets the patch)
  • patch: bug fixes and misc changes

## Bugs

Before opening a new issue, please search the existing Issues for anything similar – there might already be an answer to your problem. You might also wanna check out the Contributing guide.


## Contributing

Before contributing any code to the project, please take a look at the Contributing guide.



© 2013 Amsul

Licensed under MIT