Timepicker

Bootstrap 5 Timepicker component

Use MDB custom Timepicker component to select time.

Note: Read the API tab to find all available options and advanced customization

Basic example

MDB allows us to automatically initialize a Timepicker when the page is loaded. You have to have a class timepicker in your picker wrapper.

Select a time

Inline Timepicker with 12h

MDB Timepicker allows you to use a inline version timepicker. Default version is with 12h.

Select a time

Inline Timepicker with 24h

MDB Timepicker allows you to use a inline version timepicker. You have to add options format24 to true.

Select a time

Custom Icon

You can set your custom icon to input. If you will add the icon, the main icon from the input will be replaced with yours. You have to add class timepicker-toggle-button to your element with data-mdb-toggle and timepicker-icon to your icon.

With button

Select a time

With icon

Select a time

Without icon

MDBTimepicker allows to set input without icon. You can set this with data-mdb-with-icon set to false or with the options withIcon set to false if you are initiate timepicker with js.

Select a time

Default time

MDB Timepicker allows to initialize a default time in the picker and input. You can set it with option defaultTime. This options accepts strings like:

12:34
12:34 PM
12:34 AM

and also new Date() format like:

new Date()
new Date().toLocaleTimeString([],{timeStyle: 'short'})

Note: If you are using string with PM/AM, you have to have option format24 set to false otherwise your default time will be formate to 24h. Also if you are using string without PM/AM and you would like have 24h format hour you have to set option format24 to true. If you will only put a string without PM/AM and format24 set to false you are gonna have a timepicker with 12h and format set to AM with default.

With string PM

With string AM

With string without AM/PM

With string 24h

With new Date with 12h

With new Date with 24h

HTML
JavaScript


          <div class="form-outline timepicker-default-time-string-pm">
            <input type="text" class="form-control" id="form2" />
            <label class="form-label" for="form2">With string PM</label>
          </div>

          <div class="form-outline timepicker-default-time-string-am">
            <input type="text" class="form-control" id="form2" />
            <label class="form-label" for="form2">With string AM</label>
          </div>

          <div class="form-outline timepicker-default-time-string-without-pm-am">
            <input type="text" class="form-control" id="form2" />
            <label class="form-label" for="form2">With string without AM/PM</label>
          </div>

          <div class="form-outline timepicker-default-time-string-24h ">
            <input type="text" class="form-control" id="form2" />
            <label class="form-label" for="form2">With string 24h</label>
          </div>

          <div class="form-outline timepicker-default-time-with-new-date-12h">
            <input type="text" class="form-control" id="form2" />
            <label class="form-label" for="form2">With new Date with 12h</label>
          </div>

          <div class="form-outline timepicker-default-time-with-new-date-24h">
            <input type="text" class="form-control" id="form2" />
            <label class="form-label" for="form2">With new Date with 24h</label>
          </div>


          //Default time string PM
          const pickerStartedPM = document.querySelector('.timepicker-default-time-string-pm ');
          const tmStartedPM = new mdb.Timepicker(pickerStartedPM, {
            defaultTime: '02:12 PM'
          });

          //Default time string AM
          const pickerStartedAM = document.querySelector('.timepicker-default-time-string-am');
          const tmStartedAM = new mdb.Timepicker(pickerStartedAM, {
            defaultTime: '05:12 AM'
          });


          //Default time without PM/AM
          const pickerStartedWithoutPmAm = document.querySelector(
            '.timepicker-default-time-string-without-pm-am'
          );
          const tmStartedWithoutPmAm = new mdb.Timepicker(pickerStartedWithoutPmAm, {
            defaultTime: '05:12',
          });

          //Default time with 24h
          const pickerStartedWith24h = document.querySelector('.timepicker-default-time-string-24h');
          const tmStartedWith24h = new mdb.Timepicker(pickerStartedWith24h, {
            defaultTime: '23:44',
            format24: true,
          });

          //Default time date 12h
          const pickerStartedWithDate12h = document.querySelector('.timepicker-default-time-with-new-date-12h');
          const tmStartedWithDate12h = new mdb.Timepicker(pickerStartedWithDate12h, {
            defaultTime: new Date(),
          });

          //Default time date 24h
          const pickerStartedWithDate24h = document.querySelector('.timepicker-default-time-with-new-date-24h');
          const tmStartedWithDate24h = new mdb.Timepicker(pickerStartedWithDate24h, {
            defaultTime: new Date(),
            format24: true,
          });

Handle input value

If you want handle input value on modal approve, you have to add custom event to selected picker.

Select a time

Input value:

Format 24h

Timepicker allows you to use time format with 24 hours. You can set it with the JavaScript options or with data-mdb-format24 and set it to true.

Select a time

Just Input

You can set a timepicker to just an input.

Select a time

Increment

You can set a increment value by 5 to a minutes.

Select a time

Max time

You can max time to timepicker with options.

Select a time

Max time with PM

You can max time to timepicker with options.

Select a time

Max time with AM

You can max time to timepicker with options.

Select a time

Min time

You can min time to timepicker with options.

Select a time

Min time with PM

You can min time to timepicker with options.

Select a time

Min time with AM

You can min time to timepicker with options.

Select a time

Max/Min hours

You can max and min hour to timepicker with options.

Select a time

Maximum hour

You can set only maximum hour to timepicker.

Select a time

Minimum hour

You can set only minimum hour to timepicker.

Select a time

Accessibility

We added proper aria attributes to the timepicker controls to make the component accessible. It's possible to change the values of those attributes by modyfing the component options:

If you want to support our friends from Tailwind Elements you can also check out the Tailwind timepicker documentation.

Timepicker - API

Usage

Via data attributes or JavaScript, the timepicker plugin allows to select a time and show it on the selected output.

Via classes

Add class timepicker to your selected wrapper with input. It automaticly set timepicker to this element. Timepicker will be toggling with dynamic icon created in this container.

HTML


        <div class="form-outline timepicker">
          <input type="text" class="form-control" id="form1" />
          <label class="form-label" for="form1">Example label</label>
        </div>

Via data attributes

Add data-mdb-toggle="timepicker" to a input or selected element like button.

HTML


        <div class="form-outline timepicker">
          <input type="text" class="form-control" id="form1" />
          <label class="form-label" for="form1" data-mdb-toggle="timepicker">Example label</label>
        </div>

Via JavaScript

Via JavaScript plugin required a class or ID wrapper element with timepicker class.

JavaScript


        const myTimepicker = new mdb.Timepicker(document.getElementById('wrapper-id'), options)

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-mdb-, as in data-mdb-format24.

Name	Type	Default	Description
appendValidationInfo	boolean	true	Allows to append div with information about invalid format
bodyID	string	""	Allows to set Timepicker modal body ID.
cancelLabel	string	"Cancel"	Text of cancel button.
clearLabel	string	"Clear"	Text of clear button.
closeModalOnMinutesClick	boolean	true	Allows to close modal if minutes are selected.
disabled	boolean	false	Set a disabled attribute to input in wrapper
enableValidation	boolean	true	Enables input validation
footerID	string	false	Allows to set Timepicker modal footer ID
format12	boolean	true	Allows to use format 12h
format24	boolean	false	Allows to use format 24h
headID	string	""	Allows to set Timepicker modal head ID
increment	boolean	false	Allows to set increment minutes by 5
inline	boolean	false	Allows to use a inline version of timepicker
invalidLabel	string	"Invalid Time Format"	Allows to change a text in the invalid div
maxHour	string \| number	""	Allows to set max hour for picker
minHour	string \| number	""	Allows to set min hour for picker
modalID	string	""	Allows to set Timepicker modal ID
okLabel	string	"Ok"	Allows to change a text inside submit button
overflowHidden	boolean	true	Allows to disable/enable a overflow hidden to body if modal is shown
pickerID	string	""	Allows to set Timepicker picker ID
readOnly	boolean	false	Allows to set readonly property to input inside wrapper
showClearBtn	boolean	true	Allows to attach/remove clear button in modal.
switchHoursToMinutesOnClick	boolean	true	Allows to enable/disable switching to minutes if hours are selected
withicon	boolean	true	Allows to enable/disable append a icon to input
iconClass	string	'fas fas fa-clock fa-sm timepicker-icon'	Allows to set custom classes to timepicker icon
pmLabel	string	'PM'	Allows to set custom text to PM button
amLabel	string	'AM'	Allows to set custom text to AM button

Methods

Name	Description	Example
`dispose`	Destroy timepicker with this method	`timepicker.dispose()`
`getInstance`	Static method which allows you to get the timepicker instance associated to a DOM element.	`Timepicker.getInstance(myTimepicker)`

Events

Name	Description
`input.mdb.timepicker`	This event fires when timepicker modal is approved and showing current elements with data-mdb-toggle. You can use it for taking a value when you are saving value to input.