PHPackages                             components/bootstrap-datetimepicker - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. components/bootstrap-datetimepicker

AbandonedArchivedComponent[Utility & Helpers](/categories/utility)

components/bootstrap-datetimepicker
===================================

Both Date and Time picker widget based on twitter bootstrap

2.4.4(9y ago)699.4k↓25%1[1 issues](https://github.com/sabinus52/bootstrap-datetimepicker/issues)1Apache-2.0JavaScript

Since Apr 5Pushed 9y ago1 watchersCompare

[ Source](https://github.com/sabinus52/bootstrap-datetimepicker)[ Packagist](https://packagist.org/packages/components/bootstrap-datetimepicker)[ Docs](http://www.malot.fr/bootstrap-datetimepicker/)[ RSS](/packages/components-bootstrap-datetimepicker/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (18)Used By (1)

Project : bootstrap-datetimepicker
==================================

[](#project--bootstrap-datetimepicker)

======================================

[![Build Status](https://camo.githubusercontent.com/d42c1ae480c5a365da044868c04dc76ceda77c6f398b52c8fd19f7d4ebec1642/68747470733a2f2f7472617669732d63692e6f72672f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/smalot/bootstrap-datetimepicker)

[Homepage](http://www.malot.fr/bootstrap-datetimepicker/)

[Demo page](http://www.malot.fr/bootstrap-datetimepicker/demo.php)

Project forked
==============

[](#project-forked)

This project is a fork of [bootstrap-datepicker project](https://github.com/eternicode/bootstrap-datepicker).

Home
====

[](#home)

As 'bootstrap-datepicker' is restricted to the date scope (day, month, year), this project aims to support too the time picking (hour, minutes).

Screenshots
===========

[](#screenshots)

Decade year view
----------------

[](#decade-year-view)

[![Datetimepicker decade year view](https://camo.githubusercontent.com/5ebba4feaf20a1a81f6146c3f053c122e4ca3f038f69b3ebdd295e0f9fb95b52/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6465636164652e706e67)](https://camo.githubusercontent.com/5ebba4feaf20a1a81f6146c3f053c122e4ca3f038f69b3ebdd295e0f9fb95b52/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6465636164652e706e67)

This view allows to select the day in the selected month.

Year view
---------

[](#year-view)

[![Datetimepicker year view](https://camo.githubusercontent.com/ab61495b3f24cd2e229579a334ec007e59a78f6d9c287254668a3ec02d4e02c9/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f796561722e706e67)](https://camo.githubusercontent.com/ab61495b3f24cd2e229579a334ec007e59a78f6d9c287254668a3ec02d4e02c9/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f796561722e706e67)

This view allows to select the month in the selected year.

Month view
----------

[](#month-view)

[![Datetimepicker month view](https://camo.githubusercontent.com/690b37937c524d3b072e98860ce126ef35123b86923c5fa0c4eb72834edf8854/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6d6f6e74682e706e67)](https://camo.githubusercontent.com/690b37937c524d3b072e98860ce126ef35123b86923c5fa0c4eb72834edf8854/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6d6f6e74682e706e67)

This view allows to select the year in a range of 10 years.

Day view
--------

[](#day-view)

[![Datetimepicker day view](https://camo.githubusercontent.com/9d182e377d22f472c8f542adca9a30a8b83678ad98e29d8c6f69d9665ad0cdb4/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6461792e706e67)](https://camo.githubusercontent.com/9d182e377d22f472c8f542adca9a30a8b83678ad98e29d8c6f69d9665ad0cdb4/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6461792e706e67)

This view allows to select the hour in the selected day.

Hour view
---------

[](#hour-view)

[![Datetimepicker hour view](https://camo.githubusercontent.com/8e6064bea0b0539598a072582c43e665d5b64dcaef94279bb61cfa2438fc1939/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f686f75722e706e67)](https://camo.githubusercontent.com/8e6064bea0b0539598a072582c43e665d5b64dcaef94279bb61cfa2438fc1939/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f686f75722e706e67)

This view allows to select the preset of minutes in the selected hour. The range of 5 minutes (by default) has been selected to restrict buttons quantity to an acceptable value, but it can be overrided by the `minuteStep` property.

Day view - meridian
-------------------

[](#day-view---meridian)

[![Datetimepicker day view meridian](https://camo.githubusercontent.com/a13c2f2b1c076339c599754a9681708411aea685bee91d88449825c3310774c8/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6461795f6d6572696469616e2e706e67)](https://camo.githubusercontent.com/a13c2f2b1c076339c599754a9681708411aea685bee91d88449825c3310774c8/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f6461795f6d6572696469616e2e706e67)

Meridian is supported in both the day and hour views. To use it, just enable the `showMeridian` property.

Hour view - meridian
--------------------

[](#hour-view---meridian)

[![Datetimepicker hour view meridian](https://camo.githubusercontent.com/e62b808c47ed443b6f174ace1263ca16f52bf8d4e98bed143d028e62f1194a94/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f686f75725f6d6572696469616e2e706e67)](https://camo.githubusercontent.com/e62b808c47ed443b6f174ace1263ca16f52bf8d4e98bed143d028e62f1194a94/68747470733a2f2f7261772e6769746875622e636f6d2f736d616c6f742f626f6f7473747261702d6461746574696d657069636b65722f6d61737465722f73637265656e73686f742f7374616e646172645f686f75725f6d6572696469616e2e706e67)

Example
=======

[](#example)

Attached to a field with the format specified via options:

```

```

```
$('#datetimepicker').datetimepicker({
    format: 'yyyy-mm-dd hh:ii'
});
```

Attached to a field with the format specified via markup:

```

```

```
$('#datetimepicker').datetimepicker();
```

As component:

```

```

```
$('#datetimepicker').datetimepicker();
```

As inline datetimepicker:

```

```

```
$('#datetimepicker').datetimepicker();
```

Using bootstrap-datetimepicker.js
=================================

[](#using-bootstrap-datetimepickerjs)

Call the datetimepicker via javascript:

```
$('.datetimepicker').datetimepicker()
```

Dependencies
------------

[](#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:

```
$ lessc build/build_standalone.less > datetimepicker.css
```

Options
-------

[](#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).

You can also specify an ISO-8601 valid datetime, despite of the given `format` :

- yyyy-mm-dd
- yyyy-mm-dd hh:ii
- yyyy-mm-ddThh:ii
- yyyy-mm-dd hh:ii:ss
- yyyy-mm-ddThh:ii:ssZ

### format

[](#format)

String. Default: 'mm/dd/yyyy'

The date format, combination of p, P, h, hh, i, ii, s, ss, d, dd, m, mm, M, MM, yy, yyyy.

- p : meridian in lower case ('am' or 'pm') - according to locale file
- P : meridian in upper case ('AM' or 'PM') - according to locale file
- s : seconds without leading zeros
- ss : seconds, 2 digits with leading zeros
- i : minutes without leading zeros
- ii : minutes, 2 digits with leading zeros
- h : hour without leading zeros - 24-hour format
- hh : hour, 2 digits with leading zeros - 24-hour format
- H : hour without leading zeros - 12-hour format
- HH : hour, 2 digits with leading zeros - 12-hour format
- d : day of the month without leading zeros
- dd : day of the month, 2 digits with leading zeros
- m : numeric representation of month without leading zeros
- mm : numeric representation of the month, 2 digits with leading zeros
- M : short textual representation of a month, three letters
- MM : full textual representation of a month, such as January or March
- yy : two digit representation of a year
- yyyy : full numeric representation of a year, 4 digits
- t : unix epoch timestamp
- Z : abbreviated timezone name

### weekStart

[](#weekstart)

Integer. Default: 0

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

### startDate

[](#startdate)

Date. Default: Beginning of time

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

### endDate

[](#enddate)

Date. Default: End of time

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

### daysOfWeekDisabled

[](#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

[](#autoclose)

Boolean. Default: false

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

### startView

[](#startview)

Number, String. Default: 2, 'month'

The view that the datetimepicker should show when it is opened. Accepts values of :

- 0 or 'hour' for the hour view
- 1 or 'day' for the day view
- 2 or 'month' for month view (the default)
- 3 or 'year' for the 12-month overview
- 4 or 'decade' for the 10-year overview. Useful for date-of-birth datetimepickers.

### minView

[](#minview)

Number, String. Default: 0, 'hour'

The lowest view that the datetimepicker should show.

### maxView

[](#maxview)

Number, String. Default: 4, 'decade'

The highest view that the datetimepicker should show.

### clearBtn

[](#clearbtn)

Boolean. Default: false

If true, displays a "Clear" button at the bottom of the datetimepicker to clear the current selection. Moreover, the datetimepicker will be closed if autoclose is set to true.

### todayBtn

[](#todaybtn)

Boolean, "linked". Default: false

If true or "linked", displays a "Today" button at the bottom of the datetimepicker 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

[](#todayhighlight)

Boolean. Default: false

If true, highlights the current date.

### keyboardNavigation

[](#keyboardnavigation)

Boolean. Default: true

Whether or not to allow date navigation by arrow keys.

### language

[](#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). Currently ships with English ('en'), German ('de'), Brazilian ('br'), and Spanish ('es') translations, but others can be added (see I18N below). If an unknown language code is given, English will be used.

### forceParse

[](#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`.

### bootcssVer

[](#bootcssver)

Number.

You can override the auto-detect functionality of the different bootstrap versions (e.g., 2 or 3) by using this option.

### minuteStep

[](#minutestep)

Number. Default: 5

The increment used to build the hour view. A button is created for each `minuteStep` minutes.

### pickerReferer : deprecated

[](#pickerreferer--deprecated)

String. Default: 'default'

The referer element to place the picker for the component implementation. If you want to place the picker just under the input field, just specify `input`.

### pickerPosition

[](#pickerposition)

String. Default: 'bottom-right' (supported values are: 'bottom-right', 'bottom-left', 'top-right', 'top-left')

This option allows to place the picker just under the input field for the component implementation instead of the default position which is at the bottom right of the button.

### viewSelect

[](#viewselect)

Number or String. Default: `same as minView` (supported values are: 'decade', 'year', 'month', 'day', 'hour')

With this option you can select the view from which the date will be selected. By default it's the last one, however you can choose the first one, so at each click the date will be updated.

### showMeridian

[](#showmeridian)

Boolean. Default: false

This option will enable meridian views for day and hour views.

### initialDate

[](#initialdate)

Date or String. Default: new Date()

You can initialize the viewer with a date. By default it's now, so you can specify yesterday or today at midnight ...

### zIndex

[](#zindex)

Number. Default: undefined

zIndex value is being automatically calculated based on the DOM tree, where we seek the highest value. To skip this process you can set the value manually.

### timezone

[](#timezone)

String. Default: Clients current timezone abbreviated name

You can allow the viewer to display the date along with the given timezone. Note that this has to be used in conjunction with the `Z` format option. Example below:

```
$('#date-end').datetimepicker({
        format: 'yyyy-mm-dd hh:ii P Z'
        timezone: 'GMT'
    });
```

[![](https://camo.githubusercontent.com/d2fc2b5edbb4da390e12ca90a33184a160f68b1e2691159d974357401384e237/687474703a2f2f7333322e706f7374696d672e6f72672f3535783466756430352f53637265656e5f53686f745f323031365f30355f31375f61745f355f34335f33345f504d2e706e67)](https://camo.githubusercontent.com/d2fc2b5edbb4da390e12ca90a33184a160f68b1e2691159d974357401384e237/687474703a2f2f7333322e706f7374696d672e6f72672f3535783466756430352f53637265656e5f53686f745f323031365f30355f31375f61745f355f34335f33345f504d2e706e67)

### onRenderYear

[](#onrenderyear)

This event is fired when a year is rendered inside the datepicker. Should return an array of classes to add to this element. Return \['disabled'\] to disable the day from being selected.

```
$('#date')
    .datetimepicker({
        onRenderYear: function(date) {
            //Disable picking dates from any year apart from 2015/2016
            if (date.getFullYear()  2016)
                return ['disabled']
        }
    });
```

### onRenderMonth

[](#onrendermonth)

This event is fired when a month is rendered inside the datepicker. Should return an array of classes to add to this element. Return \['disabled'\] to disable the day from being selected.

```
$('#date')
    .datetimepicker({
        onRenderMonth: function(date) {
            //Disable every other month in the year 2016
            if (date.getUTCMonth() % 2 === 0 && date.getUTCFullYear() === 2016)
                return ['disabled']
        }
    });
```

### onRenderDay

[](#onrenderday)

This event is fired when a day is rendered inside the datepicker. Should return an array of classes to add to this element. Return \['disabled'\] to disable the day from being selected.

```
$('#date')
    .datetimepicker({
        onRenderDay: function(date) {
            //Disable dates 18-24 of every month
            if (date.getDate() >= 18 && date.getDate() = 30 && date.getUTCMinutes()

```

Format as component with reset button to clear the input field.

```

```

Methods
-------

[](#methods)

### .datetimepicker(options)

[](#datetimepickeroptions)

Initializes an datetimepicker.

### remove

[](#remove)

Arguments: None

Remove the datetimepicker. Removes attached events, internal attached objects, and added HTML elements.

```
$('#datetimepicker').datetimepicker('remove');

```

### show

[](#show)

Arguments: None

Show the datetimepicker.

```
$('#datetimepicker').datetimepicker('show');
```

### hide

[](#hide)

Arguments: None

Hide the datetimepicker.

```
$('#datetimepicker').datetimepicker('hide');
```

### update

[](#update)

Arguments:

- currentDate (Date).

Update the datetimepicker with the specified date.

```
$('#datetimepicker').datetimepicker('update', new Date());
```

Omit currentDate to update the datetimepicker with the current input value.

```
$('#datetimepicker').datetimepicker('update');
```

### setStartDate

[](#setstartdate)

Arguments:

- startDate (String)

Sets a new lower date limit on the datetimepicker.

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

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

```
$('#datetimepicker').datetimepicker('setStartDate');
$('#datetimepicker').datetimepicker('setStartDate', null);
```

### setEndDate

[](#setenddate)

Arguments:

- endDate (String)

Sets a new upper date limit on the datetimepicker.

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

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

```
$('#datetimepicker').datetimepicker('setEndDate');
$('#datetimepicker').datetimepicker('setEndDate', null);
```

### setDaysOfWeekDisabled

[](#setdaysofweekdisabled)

Arguments:

- daysOfWeekDisabled (String|Array)

Sets the days of week that should be disabled.

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

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

```
$('#datetimepicker').datetimepicker('setDaysOfWeekDisabled');
$('#datetimepicker').datetimepicker('setDaysOfWeekDisabled', null);
```

### setMinutesDisabled

[](#setminutesdisabled)

Arguments:

- minutesDisabled (String|Array)

Sets the minutes that should be disabled.

```
$('#datetimepicker').datetimepicker('setMinutesDisabled', [25,59]);
```

Omit minutesDisabled (or provide an otherwise falsey value) to unset the disabled minutes.

```
$('#datetimepicker').datetimepicker('setMinutesDisabled');
$('#datetimepicker').datetimepicker('setMinutesDisabled', null);
```

### setHoursDisabled

[](#sethoursdisabled)

Arguments:

- hoursDisabled (String|Array)

Sets the hours that should be disabled.

```
$('#datetimepicker').datetimepicker('setHoursDisabled', [12,19]);
```

Omit hoursDisabled (or provide an otherwise falsey value) to unset the disabled hours.

```
$('#datetimepicker').datetimepicker('setHoursDisabled');
$('#datetimepicker').datetimepicker('setHoursDisabled', null);
```

### setInitialDate

[](#setinitialdate)

Arguments:

- setInitialDate (String)

Sets a new inital date on the datetimepicker.

```
$('#datetimepicker').datetimepicker('setInitialDate', '2012-12-31');
```

Get the inital date on the datetimepicker.

```
$('#datetimepicker').datetimepicker('getInitialDate');
```

Events
------

[](#events)

Datetimepicker class exposes a few events for manipulating the dates.

### show

[](#show-1)

Fired when the date picker is displayed.

### hide

[](#hide-1)

Fired when the date picker is hidden.

### changeDate

[](#changedate)

Fired when the date is changed.

```
$('#date-end')
    .datetimepicker()
    .on('changeDate', function(ev){
        if (ev.date.valueOf()