Professional Documents
Culture Documents
Adminlte
Adminlte
Release
eternicode
1 Requirements 3
2 Dependencies 5
3 Usage 7
3.1 Data API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3 Stylesheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.4 No Conflict mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4 Table of Contents 9
4.1 Markup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2 Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.3 Quick reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.4 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.5 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
4.6 Keyboard support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
4.7 I18N . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
i
ii
bootstrap-datepicker Documentation, Release
Contents 1
bootstrap-datepicker Documentation, Release
2 Contents
CHAPTER 1
Requirements
• Bootstrap 2.0.4+
• jQuery 1.7.1+
These are the specific versions bootstrap-datepicker is tested against (js files) and built against (css files). Use other
versions at your own risk.
3
bootstrap-datepicker Documentation, Release
4 Chapter 1. Requirements
CHAPTER 2
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:
5
bootstrap-datepicker Documentation, Release
6 Chapter 2. Dependencies
CHAPTER 3
Usage
Data API
As with bootstrap’s own plugins, datepicker provides a data-api that can be used to instantiate datepickers without
the need for custom javascript. For most datepickers, simply set data-provide="datepicker" on the ele-
ment you want to initialize, and it will be intialized lazily, in true bootstrap fashion. For inline datepickers, use
data-provide="datepicker-inline"; these will be immediately initialized on page load, and cannot be
lazily loaded.
<input data-provide="datepicker">
You can disable datepicker’s data-api in the same way as you would disable other bootstrap plugins:
$(document).off('.datepicker.data-api');
Configuration
Options are passed to the datepicker function via an options hash at instantiation:
7
bootstrap-datepicker Documentation, Release
$('.datepicker').datepicker({
format: 'mm/dd/yyyy',
startDate: '-3d'
});
$('.datepicker').datepicker({
startDate: '-3d'
});
Defaults for all options can be modified directly by changing values in the $.fn.datepicker.defaults hash:
$.fn.datepicker.defaults.format = "mm/dd/yyyy";
$('.datepicker').datepicker({
startDate: '-3d'
});
Stylesheets
There are a few different stylesheets included in the library. This is an overview of what each file is to be used for:
bootstrap-datepicker.css gives legacy support for twitter bootstrap v2, bootstrap-datepicker3.
css is used for twitter bootstrap v3 support and bootstrap-datepicker.standalone.css can be used to
include the datepicker without depending on the twitter bootstrap library.
No Conflict mode
$.fn.datepicker.noConflict provides a way to avoid conflict with other jQuery datepicker plugins:
8 Chapter 3. Usage
CHAPTER 4
Table of Contents
Markup
The following are examples of supported markup. On their own, these will not provide a datepicker widget; you will
need to instantiate the datepicker on the markup.
input
The simplest case: focusing the input (clicking or tabbing into it) will show the picker.
component
Adding the date class to an input-group bootstrap component will allow the input-group-addon elements
to trigger the picker.
date-range
Using the input-daterange construct with multiple child inputs will instantiate one picker per input and link
them together to allow selecting ranges.
9
bootstrap-datepicker Documentation, Release
Note that that input-daterange itself does not implement the datepicker methods. Methods should be di-
rectly called to the inputs. For example:
$('.input-daterange input').each(function() {
$(this).datepicker('clearDates');
});
inline or embedded
Instantiating the datepicker on a simple div will give an embedded picker that is always visible.
<div data-date="12/03/2012"></div>
$('#datepicker').datepicker();
$('#datepicker').on('changeDate', function() {
$('#my_hidden_input').val(
$('#datepicker').datepicker('getFormattedDate')
);
});
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
4.2. Options 11
bootstrap-datepicker Documentation, Release
“y” (year). Use “0” as today. There are also aliases for the relative timedelta’s: “yesterday” equals “-1d”, “today” is
equal to “+0d” and “tomorrow” is equal to “+1d”.
Most options can be provided via data-attributes. An option can be converted to a data-attribute by taking its name,
replacing each uppercase letter with its lowercase equivalent preceded by a dash, and prepending “data-date-” to the re-
sult. For example, startDate would be data-date-start-date, format would be data-date-format,
and daysOfWeekDisabled would be data-date-days-of-week-disabled.
See the quick reference for an overview of all options and their default values
autoclose
assumeNearbyYear
beforeShowDay
A function that takes a date as a parameter and returns one of the following values:
• undefined to have no effect
• A Boolean, indicating whether or not this date is selectable
• A String representing additional CSS classes to apply to the date’s cell
• An object with the following properties:
– enabled: same as the Boolean value above
– classes: same as the String value above
– tooltip: a tooltip to apply to this date, via the title HTML attribute
– content: the content to display in the day cell, rather than the default (day of month as text)
beforeShowMonth
beforeShowYear
4.2. Options 13
bootstrap-datepicker Documentation, Release
beforeShowDecade
beforeShowCentury
calendarWeeks
clearBtn
container
4.2. Options 15
bootstrap-datepicker Documentation, Release
datesDisabled
daysOfWeekDisabled
daysOfWeekHighlighted
defaultViewDate
Date, String or Object with keys year, month, and day. Default: today
Date to view when initially opening the calendar. The internal value of the date remains today as default, but when the
datepicker is first opened the calendar will open to defaultViewDate rather than today. If this option is not used,
“today” remains the default view date.
This option can be:
• A date, which should be in local timezone.
• A string which must be parsable with format.
• An object with keys year, month and day (can’t be set from a data attribute). If the given object is
missing any of the required keys, their defaults are:
– year: the current year
– month: 0 (Note that it starts with 0 for January)
– day: 1
disableTouchKeyboard
enableOnReadonly
endDate
forceParse
4.2. Options 17
bootstrap-datepicker Documentation, Release
format
$('.datepicker').datepicker({
format: {
/*
* Say our UI should display a week ahead,
* but textbox should store the actual date.
* This is useful if we need UI to select local dates,
* but store in UTC
*/
immediateUpdates
inputs
<div id="event_period">
<input type="text" class="actual_range">
<input type="text" class="actual_range">
</div>
$('#event_period').datepicker({
inputs: $('.actual_range')
});
keepEmptyValues
keyboardNavigation
4.2. Options 19
bootstrap-datepicker Documentation, Release
language
maxViewMode
minViewMode
year or a decade. The day is set to the 1st for “months”, and the month is set to January for “years”, the year is set to
the first year from the decade for “decades”, and the year is set to the first from the millennium for “centuries”.
multidate
multidateSeparator
orientation
4.2. Options 21
bootstrap-datepicker Documentation, Release
showOnFocus
startDate
startView
templates
Object. Default:
{
leftArrow: '«',
rightArrow: '»'
}
The templates used to generate some parts of the picker. Each property must be a string with only text, or valid html.
You can use this property to use custom icons libs. for example:
{
leftArrow: '<i class="fa fa-long-arrow-left"></i>',
rightArrow: '<i class="fa fa-long-arrow-right"></i>'
}
showWeekDays
title
String. Default: “”
The string that will appear on top of the datepicker. If empty the title will be hidden.
todayBtn
todayHighlight
toggleActive
updateViewDate
4.2. Options 23
bootstrap-datepicker Documentation, Release
If false viewDate is set according to value on initialization and updated * if a day in last oder next month is selected
or * if dates are changed by setDate, setDates, setUTCDate and setUTCDates methods. If multidate option is true the
last selected date or the last date in array passed to setDates or setUTCDates is used.
weekStart
Integer. Default: 0
Day of the week start. 0 (Sunday) to 6 (Saturday)
zIndexOffset
Integer. Default: 10
The CSS z-index of the open datepicker is the maximum z-index of the input and all of its DOM ancestors plus the
zIndexOffset.
Quick reference
This is a quick overview of all the options and their default values
Methods
Methods are called on a datepicker by calling the datepicker function with a string first argument, followed by
any arguments the method takes
destroy
Arguments: None
Remove the datepicker. Removes attached events, internal attached objects, and added HTML elements.
Alias: remove
show
Arguments: None
Show the picker.
hide
Arguments: None
Hide the picker.
update
Arguments:
• date (String|Date|Array, optional)
• date (String|Date, optional)
• ...
Update the datepicker with given arguments or the current input value. The arguments can be either an array of strings,
an array of Date objects, multiples strings or multiples Date objects. If date arguments are provided and they are
Date objects, it is assumed to be “local” Date objects, and will be converted to UTC for internal use.
$('.datepicker').datepicker('update');
$('.datepicker').datepicker('update', '2011-03-05');
$('.datepicker').datepicker('update', '2011-03-05', '2011-03-07');
$('.datepicker').datepicker('update', new Date(2011, 2, 5));
$('.datepicker').datepicker('update', [new Date(2011, 2, 5), new Date(2011, 2, 7)]);
To reset the datepicker and clear the selected date, pass an empty string with update:
$('.datepicker').datepicker('update', '');
setDate
Arguments:
• date (Date)
Sets the internal date. date is assumed to be a “local” date object, and will be converted to UTC for internal use.
setUTCDate
Arguments:
• date (Date)
Sets the internal date. date is assumed to be a UTC date object, and will not be converted.
setDates
Arguments:
• date[, date[, ...]] (Date)
or
• [date[, date[, ...]]] (Array)
Sets the internal date list; accepts multiple dates or a single array of dates as arguments. Each date is assumed to be
a “local” date object, and will be converted to UTC for internal use. For use with multidate pickers.
4.4. Methods 27
bootstrap-datepicker Documentation, Release
clearDates
Arguments: None
Clear dates.
setUTCDates
Arguments:
• date[, date[, ...]] (Date)
or
• [date[, date[, ...]]] (Array)
Sets the internal date list. Each date is assumed to be a UTC date object, and will not be converted. For use with
multidate pickers.
getDate
Arguments: None
Returns a localized date object representing the internal date object of the first datepicker in the selection. For multidate
pickers, returns the latest date selected.
getUTCDate
Arguments: None
Returns the internal UTC date object, as-is and unconverted to local time, of the first datepicker in the selection. For
multidate pickers, returns the latest date selected.
getDates
Arguments: None
Returns a list of localized date objects representing the internal date objects of the first datepicker in the selection. For
use with multidate pickers.
getUTCDates
Arguments: None
Returns the internal list of UTC date objects, as they are and unconverted to local time, of the first datepicker in the
selection. For use with multidate pickers.
getStartDate
Arguments: None
Returns the lower date limit on the datepicker.
getEndDate
Arguments: None
Returns the upper date limit on the datepicker.
setStartDate
Arguments:
• startDate (Date)
Sets a new lower date limit on the datepicker. See startDate for valid values.
Omit startDate (or provide an otherwise falsey value) to unset the limit.
setEndDate
Arguments:
• endDate (Date)
Sets a new upper date limit on the datepicker. See endDate for valid values.
Omit endDate (or provide an otherwise falsey value) to unset the limit.
setDatesDisabled
Arguments:
• datesDisabled (String|Array)
Sets the days that should be disabled. See datesDisabled for valid values.
Omit datesDisabled (or provide an otherwise falsey value) to unset the disabled days.
setDaysOfWeekDisabled
Arguments:
• daysOfWeekDisabled (String|Array)
Sets the days of week that should be disabled. See daysOfWeekDisabled for valid values.
Omit daysOfWeekDisabled (or provide an otherwise falsey value) to unset the disabled days of week.
setDaysOfWeekHighlighted
Arguments:
• daysOfWeekHighlighted (String|Array)
Sets the days of week that should be highlighted. See daysOfWeekHighlighted for valid values.
Omit daysOfWeekHighlighted (or provide an otherwise falsey value) to unset the highlighted days of week.
4.4. Methods 29
bootstrap-datepicker Documentation, Release
Events
Datepicker triggers a number of events in certain circumstances. All events have extra data attached to the event object
that is passed to any event handlers
$('.datepicker').datepicker()
.on(picker_event, function(e) {
// `e` here contains the extra attributes
});
• date: the relevant Date object, in local timezone. For a multidate picker, this will be the latest date picked.
• dates: an Array of Date objects, in local timezone, when using a multidate picker.
• format([ix], [format]): a function to make formatting date easier. ix can be the index of a Date in
the dates array to format; if absent, the last date selected will be used. format can be any format string that
datepicker supports; if absent, the format set on the datepicker will be used. Both arguments are optional.
show
hide
clearDate
Fired when the date is cleared, normally when the “clear” button (enabled with the clearBtn option) is pressed.
changeDate
changeMonth
changeYear
changeDecade
changeCentury
Keyboard support
The datepicker includes keyboard navigation. The “focused date” is kept track of and highlighted (as with mouse
hover) during keyboard nav, and is cleared when a date is toggled or the picker is hidden.
By themselves, left/right will move focus backward/forward one day, up/down will move focus back/forward one
week.
With the shift key, up/left will move focus backward one month, down/right will move focus forward one month.
With the ctrl key, up/left will move focus backward one year, down/right will move focus forward one year.
Shift+ctrl behaves the same as ctrl – that is, it does not change both month and year simultaneously, only the year.
enter
When the picker is visible, enter will toggle the focused date (if there is one). When the picker is not visible, enter will
have normal effects – submitting the current form, etc.
When the date is deselected, the clearDate event is triggered; otherwise, the changeDate event is triggered. If
autoclose is enabled, the picker will be hidden after selection or deselection.
escape
The escape key can be used to clear the focused date and hide and re-show the datepicker; hiding the picker is necessary
if the user wants to manually edit the value.
I18N
The plugin supports i18n for the month and weekday names and the weekStart option. The default is English
(“en”); other available translations are available in the js/locales/ directory, simply include your desired lo-
cale 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
˓→"],
monthsShort: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct
˓→", "Nov", "Dec"],
today: "Today",
clear: "Clear",
format: "mm/dd/yyyy",
titleFormat: "MM yyyy", /* Leverages same syntax as 'format' */
weekStart: 0
};
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:
$('.datepicker').datepicker({
language: 'XX'
});