Datepicker for Bootstrap bootstrap-datepicker.js

About

Add datepicker picker to field or to any other element.

• can be used as a component
• formats: dd, d, mm, m, yyyy, yy
• separators: -, /, .

Download v1.0.1

Download Development

• Examples
• Using bootstrap-datepicker.js
• Options
• Markup
• Methods
• Events
• Keyboard support
• I18N
• Sandbox

Examples

Attached to a field with the format specified via options.

<input type="text" id="dp1">

$('#dp1').datepicker({
  format: 'mm-dd-yyyy'
});

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

<input type="text" value="02/16/13" data-date-format="mm/dd/yy" id="dp2">

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

As component.

<div class="input-append date" id="dp3" data-date-format="dd-mm-yyyy">
    <input class="span2" size="16" type="text" value="12-02-2013" readonly><span class="add-on"><i class="icon-th"></i></span>
</div>

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

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

<a href="#" class="btn small" id="dp4" data-date-format="yyyy-mm-dd" data-date="2013-02-20">Change</a>

$('#dp4').datepicker()
    .on('changeDate', function(e){
        var y = e.date.getFullYear(),
            _m = e.date.getMonth() + 1,
            m = (_m > 9 ? _m : '0'+_m),
            _d = e.date.getDate(),
            d = (_d > 9 ? _d : '0'+_d);
        $(this).text(y + '-' + m + '-' + d);
    });

Inline/embedded picker

<div id="dp5" data-date="12-02-2013" data-date-format="dd-mm-yyyy"></div>

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

Using bootstrap-datepicker.js

Call the datepicker via javascript:

$('.datepicker').datepicker()

Options

Markup data-attributes

Any option can be specified as a data-attribute by taking the option name, replacing each uppercase letter with a corresponding lowercase letter prepended by a dash, and prepending the whole name with data-date-. For example, autoclose would become data-date-autoclose and daysOfWeekDisabled would become data-date-days-of-week-disabled.

Format a component.

<div class="input-append date" id="datepicker" data-date-format="dd-mm-yyyy">
  <input type="text" value="12-02-2013"><span class="add-on"><i class="icon-th"></i></span>
</div>

Format inline.

<div data-date="12-02-2012" data-date-format="dd-mm-yyyy"></div>

Methods

Events

Datepicker class exposes a few events for manipulating the dates.

$('.datepicker').datepicker()
    .on('changeDate', function(e){
        alert(e.date.toString());
    });

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:

$.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"]
};

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:

<script type="text/javascript" src="bootstrap-datepicker.XX.js" charset="UTF-8"></script>

$('.datepicker').datepicker({
    language: 'XX' // as defined in bootstrap-datepicker.XX.js
});

Sandbox αlphα

Use the form below to tweak the options; results and code appear in realtime below.

As you change options, your address bar will update to reflect the current configuration (requires a browser with history.replaceState support). This url can be used to link to the sandbox with the given configuration pre-loaded.