Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vitalets/bootstrap-datepicker

Bootstrap datepicker originally by Stefan Petre, improved by @eternicode
https://github.com/vitalets/bootstrap-datepicker

Last synced: 3 months ago
JSON representation

Bootstrap datepicker originally by Stefan Petre, improved by @eternicode

Awesome Lists containing this project

README 

        
## This fork was created for *inline* version of datepicker and currently merged into upstream https://github.com/eternicode/bootstrap-datepicker.

Please use original repo for pull requests, thanks!



# Home



This is a fork of Stefan Petre's [original code](http://www.eyecon.ro/bootstrap-datepicker/);

thanks go to him for getting this thing started!



Please note that this fork is not used on Stefan's page at this time, nor is it maintained or

contributed to by him (yet?)



# Example



Attached to a field with the format specified via options:



```html



```

```javascript

$('#datepicker').datepicker({

    format: 'mm-dd-yyyy'

});

```



Attached to a field with the format specified via data tag:



```html



```

```javascript

$('#datepicker').datepicker();

```



As component:



```html



    

    



```

```javascript

$('#datepicker').datepicker();

```



Attached to non-field element, using events to work with the date values.



```html



    Oh snap!




    

        

          

              Start date

              Change

          

          

              End date

              Change

          

        

    

    

        

          2012-02-20

          2012-02-25

        

    



```

```javascript

var startDate = new Date(2012,1,20);

var endDate = new Date(2012,1,25);

$('#date-start')

    .datepicker()

    .on('changeDate', function(ev){

        if (ev.date.valueOf() > endDate.valueOf()){

            $('#alert').show().find('strong').text('The start date must be before the end date.');

        } else {

            $('#alert').hide();

            startDate = new Date(ev.date);

            $('#date-start-display').text($('#date-start').data('date'));

        }

        $('#date-start').datepicker('hide');

    });

$('#date-end')

    .datepicker()

    .on('changeDate', function(ev){

        if (ev.date.valueOf() < startDate.valueOf()){

            $('#alert').show().find('strong').text('The end date must be after the start date.');

        } else {

            $('#alert').hide();

            endDate = new Date(ev.date);

            $('#date-end-display').text($('#date-end').data('date'));

        }

        $('#date-end').datepicker('hide');

    });

```



As inline datepicker:



```html



```

```javascript

$('#datepicker').datepicker();

```



# Using bootstrap-datepicker.js



Call the datepicker via javascript:



```javascript

$('#datepicker').datepicker()

```



## Dependencies



Requires bootstrap's dropdown component (`dropdowns.less`) for some styles, and bootstrap's sprites (`sprites.less` and associated images) for arrows.



A standalone .css file (including necessary dropdown styles and alternative, text-based arrows) can be generated by running `build/build_standalone.less` through the `lessc` compiler:



```bash

$ lessc build/build_standalone.less datepicker.css

```



## Options



All options that take a "Date" can handle a `Date` object; a String formatted according to the given `format`; or a timedelta relative to today, eg '-1d', '+6m +1y', etc, where valid units are 'd' (day), 'w' (week), 'm' (month), and 'y' (year).



### format



String.  Default: 'mm/dd/yyyy'



The date format, combination of d, dd, D, DD, m, mm, M, MM, yy, yyyy.



* d, dd: Numeric date, no leading zero and leading zero, respectively.  Eg, 5, 05.

* D, DD: Abbreviated and full weekday names, respectively.  Eg, Mon, Monday.

* m, mm: Numeric month, no leading zero and leading zero, respectively.  Eg, 7, 07.

* M, MM: Abbreviated and full month names, respectively.  Eg, Jan, January

* yy, yyyy: 2- and 4-digit years, respectively.  Eg, 12, 2012.



### weekStart



Integer.  Default: 0



Day of the week start. 0 (Sunday) to 6 (Saturday)



### startDate



Date.  Default: Beginning of time



The earliest date that may be selected; all earlier dates will be disabled.



### endDate



Date.  Default: End of time



The latest date that may be selected; all later dates will be disabled.



### daysOfWeekDisabled



String, Array.  Default: '', []



Days of the week that should be disabled. Values are 0 (Sunday) to 6 (Saturday). Multiple values should be comma-separated. Example: disable weekends: `'0,6'` or `[0,6]`.



### autoclose



Boolean.  Default: false



Whether or not to close the datepicker immediately when a date is selected.



### startView



Number, String.  Default: 0, 'month'



The view that the datepicker should show when it is opened.  Accepts values of 0 or 'month' for month view (the default), 1 or 'year' for the 12-month overview, and 2 or 'decade' for the 10-year overview.  Useful for date-of-birth datepickers.



### todayBtn



Boolean, "linked".  Default: false



If true or "linked", displays a "Today" button at the bottom of the datepicker to select the current date.  If true, the "Today" button will only move the current date into view; if "linked", the current date will also be selected.



### todayHighlight



Boolean.  Default: false



If true, highlights the current date.



### keyboardNavigation



Boolean.  Default: true



Whether or not to allow date navigation by arrow keys.



### language



String.  Default: 'en'



The two-letter code of the language to use for month and day names.  These will also be used as the input's value (and subsequently sent to the server in the case of form submissions).  If an unknown language code is given, English will be used.  See I18N below.



### forceParse



Boolean.  Default: true



Whether or not to force parsing of the input value when the picker is closed.  That is, when an invalid date is left in the input field by the user, the picker will forcibly parse that value, and set the input's value to the new, valid date, conforming to the given `format`.



## Markup



Format a component.



```html



    

    



```



## Methods



### .datepicker(options)



Initializes an datepicker.



### remove



Arguments: None



Remove the datepicker.  Removes attached events, internal attached objects, and

added HTML elements.



    $('#datepicker').datepicker('remove');



### show



Arguments: None



Show the datepicker.



```javascript

$('#datepicker').datepicker('show');

```



### hide



Arguments: None



Hide the datepicker.



```javascript

$('#datepicker').datepicker('hide');

```



### update



Arguments: None



Update the datepicker with the current input value.



```javascript

$('#datepicker').datepicker('update');

```



### setStartDate



Arguments:



* startDate (String)



Sets a new lower date limit on the datepicker.



```javascript

$('#datepicker').datepicker('setStartDate', '2012-01-01');

```



Omit startDate (or provide an otherwise falsey value) to unset the limit.



```javascript

$('#datepicker').datepicker('setStartDate');

$('#datepicker').datepicker('setStartDate', null);

```



### setEndDate



Arguments:



* endDate (String)



Sets a new upper date limit on the datepicker.



```javascript

$('#datepicker').datepicker('setEndDate', '2012-12-31');

```



Omit endDate (or provide an otherwise falsey value) to unset the limit.



```javascript

$('#datepicker').datepicker('setEndDate');

$('#datepicker').datepicker('setEndDate', null);

```



### setDaysOfWeekDisabled



Arguments:



* daysOfWeekDisabled (String|Array)



Sets the days of week that should be disabled.



```javascript

$('#datepicker').datepicker('setDaysOfWeekDisabled', [0,6]);

```



Omit daysOfWeekDisabled (or provide an otherwise falsey value) to unset the disabled days.



```javascript

$('#datepicker').datepicker('setDaysOfWeekDisabled');

$('#datepicker').datepicker('setDaysOfWeekDisabled', null);

```



## Events



Datepicker class exposes a few events for manipulating the dates.



### show



Fired when the date picker is displayed.



### hide



Fired when the date picker is hidden.



### changeDate



Fired when the date is changed.



```javascript

$('#date-end')

    .datepicker()

    .on('changeDate', function(ev){

        if (ev.date.valueOf() < date-start-display.valueOf()){

            ....

        }

    });

```



### changeYear



Fired when the *view* year is changed from decade view.



### changeMonth



Fired when the *view* month is changed from year view.



## Keyboard support



The datepicker includes some keyboard navigation:



### up, down, left, right arrow keys



By themselves, left/right will move backward/forward one day, up/down will move back/forward one week.



With the shift key, up/left will move backward one month, down/right will move forward one month.



With the ctrl key, up/left will move backward one year, down/right will move forward oone year.



Shift+ctrl behaves the same as ctrl -- that is, it does not change both month and year simultaneously, only the year.



### escape



The escape key can be used to hide and re-show the datepicker; this is necessary if the user wants to manually edit the value.



### enter



When the picker is visible, enter will simply hide it.  When the picker is not visible, enter will have normal effects -- submitting the current form, etc.



## I18N



The plugin supports i18n for the month and weekday names and the `weekStart` option.  The default is English ('en'); other available translations are avilable in the `js/locales/` directory, simply include your desired locale after the plugin.  To add more languages, simply add a key to `$.fn.datepicker.dates`, before calling `.datepicker()`.  Example:



```javascript

$.fn.datepicker.dates['en'] = {

    days: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"],

    daysShort: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"],

    daysMin: ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa", "Su"],

    months: ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"],

    monthsShort: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"],

    today: "Today"

};

```



Right-to-left languages may also include `rtl: true` to make the calendar display appropriately.



If your browser (or those of your users) is displaying characters wrong, chances are the browser is loading the javascript file with a non-unicode encoding.  Simply add `charset="UTF-8"` to your `script` tag:



```html



```