Adding a Timepicker to jQuery UI Datepicker

Getting Started

Highly Recommended

Subscribe to my blog via email and follow @PracticalWeb on Twitter. I post for nearly every new version, so you know about updates.

Download

Download Timepicker Addon

Download/Contribute on GitHub (Need the entire repo? Find a bug? See if its fixed here)

There is a small bit of required CSS (Download):

/* css for timepicker */
.ui-timepicker-div .ui-widget-header { margin-bottom: 8px; }
.ui-timepicker-div dl { text-align: left; }
.ui-timepicker-div dl dt { height: 25px; margin-bottom: -25px; }
.ui-timepicker-div dl dd { margin: 0 10px 10px 65px; }
.ui-timepicker-div td { font-size: 90%; }
.ui-tpicker-grid-label { background: none; border: none; margin: 0; padding: 0; }

.ui-timepicker-rtl{ direction: rtl; }
.ui-timepicker-rtl dl { text-align: right; }
.ui-timepicker-rtl dl dd { margin: 0 65px 10px 10px; }

Requirements

You also need to include jQuery and jQuery UI with datepicker and slider wigits. You should include them in your page in the following order:

1. jQuery
2. jQueryUI (with datepicker and slider wigits)
3. Timepicker

Version

Version 1.2

Last updated on 02/02/2013

jQuery Timepicker Addon is currently available for use in all personal or commercial projects under both MIT and GPL licenses. This means that you can choose the license that best suits your project, and use it accordingly.

GPL License

MIT License

Options

The timepicker does inherit all options from datepicker. However, there are many options that are shared by them both, and many timepicker only options:

Localization Options

currentText

Default: "Now", A Localization Setting - Text for the Now button.

closeText

Default: "Done", A Localization Setting - Text for the Close button.

amNames

Default: ['AM', 'A'], A Localization Setting - Array of strings to try and parse against to determine AM.

pmNames

Default: ['PM', 'P'], A Localization Setting - Array of strings to try and parse against to determine PM.

timeFormat

Default: "HH:mm", A Localization Setting - String of format tokens to be replaced with the time. See Formatting.

timeSuffix

Default: "", A Localization Setting - String to place after the formatted time.

timeOnlyTitle

Default: "Choose Time", A Localization Setting - Title of the wigit when using only timepicker.

timeText

Default: "Time", A Localization Setting - Label used within timepicker for the formatted time.

hourText

Default: "Hour", A Localization Setting - Label used to identify the hour slider.

minuteText

Default: "Minute", A Localization Setting - Label used to identify the minute slider.

secondText

Default: "Second", A Localization Setting - Label used to identify the second slider.

millisecText

Default: "Millisecond", A Localization Setting - Label used to identify the millisecond slider.

timezoneText

Default: "Timezone", A Localization Setting - Label used to identify the timezone slider.

isRTL

Default: false, A Localization Setting - Right to Left support.

Alt Field Options

altFieldTimeOnly

Default: true - When altField is used from datepicker altField will only receive the formatted time and the original field only receives date.

altSeparator

Default: (separator option) - String placed between formatted date and formatted time in the altField.

altTimeSuffix

Default: (timeSuffix option) - String always placed after the formatted time in the altField.

altTimeFormat

Default: (timeFormat option) - The time format to use with the altField.

Timezone Options

useLocalTimezone

Default: false - Whether to default timezone to the browser's set timezone.

defaultTimezone

Default: "+0000" - If not set, the default timezone used.

timezoneIso8601

Default: false - Whether to follow the ISO 8601 standard.

timezoneList

Default: [generated timezones] - An array of timezones used to populate the timezone select. Can be an array of values or an array of objects: { label: "EST", value: "+0400" }

Time Field Options

controlType

Default: 'slider' - Whether to use 'slider' or 'select'. If 'slider' is unavailable through jQueryUI, 'select' will be used. For advanced usage you may pass an object which implements "create", "options", "value" methods to use controls other than sliders or selects. See the _controls property in the source code for more details.

{
	create: function(tp_inst, obj, unit, val, min, max, step){	
		// generate whatever controls you want here, just return obj
	},
	options: function(tp_inst, obj, unit, opts, val){
		// if val==undefined return the value, else return obj
	},
	value: function(tp_inst, obj, unit, val){
		// if val==undefined return the value, else return obj
	}
}

showHour

Default: true - Whether to show the hour slider.

showMinute

Default: true - Whether to show the minute slider.

showSecond

Default: false - Whether to show the second slider.

showMillisec

Default: false - Whether to show the millisecond slider.

showTimezone

Default: false - Whether to show the timezone select.

showTime

Default: true - Whether to show the time selected within the datetimepicker.

stepHour

Default: 1 - Hours per step the slider makes.

stepMinute

Default: 1 - Minutes per step the slider makes.

stepSecond

Default: 1 - Seconds per step the slider makes.

stepMilliSec

Default: 1 - Milliseconds per step the slider makes.

hour

Default: 0 - Initial hour set.

minute

Default: 0 - Initial minute set.

second

Default: 0 - Initial second set.

millisec

Default: 0 - Initial millisecond set.

timezone

Default: 0 - Initial timezone set.

hourMin

Default: 0 - The minimum hour allowed for all dates.

minuteMin

Default: 0 - The minimum minute allowed for all dates.

secondMin

Default: 0 - The minimum second allowed for all dates.

millisecMin

Default: 0 - The minimum millisecond allowed for all dates.

hourMax

Default: 23 - The maximum hour allowed for all dates.

minuteMax

Default: 59 - The maximum minute allowed for all dates.

secondMax

Default: 59 - The maximum second allowed for all dates.

millisecMax

Default: 999 - The maximum millisecond allowed for all dates.

hourGrid

Default: 0 - When greater than 0 a label grid will be generated under the slider. This number represents the units (in hours) between labels.

minuteGrid

Default: 0 - When greater than 0 a label grid will be generated under the slider. This number represents the units (in minutes) between labels.

secondGrid

Default: 0 - When greater than 0 a label grid will be genereated under the slider. This number represents the units (in seconds) between labels.

millisecGrid

Default: 0 - When greater than 0 a label grid will be genereated under the slider. This number represents the units (in milliseconds) between labels.

Other Options

showButtonPanel

Default: true - Whether to show the button panel at the bottom. This is generally needed.

timeOnly

Default: false - Hide the datepicker and only provide a time interface.

onSelect

Default: null - Function to be called when a date is chosen or time has changed (parameters: datetimeText, datepickerInstance).

alwaysSetTime

Default: true - Always have a time set internally, even before user has chosen one.

separator

Default: " " - When formatting the time this string is placed between the formatted date and formatted time.

pickerTimeFormat

Default: (timeFormat option) - How to format the time displayed within the timepicker.

pickerTimeSuffix

Default: (timeSuffix option) - String to place after the formatted time within the timepicker.

showTimepicker

Default: true - Whether to show the timepicker within the datepicker.

addSliderAccess

Default: false - Adds the sliderAccess plugin to sliders within timepicker

sliderAccessArgs

Default: null - Object to pass to sliderAccess when used.

defaultValue

Default: null - String of the default time value placed in the input on focus when the input is empty.

minDateTime

Default: null - Date object of the minimum datetime allowed. Also available as minDate.

maxDateTime

Default: null - Date object of the maximum datetime allowed. Also Available as maxDate.

parse

Default: 'strict' - How to parse the time string. Two methods are provided: 'strict' which must match the timeFormat exactly, and 'loose' which uses javascript's new Date(timeString) to guess the time. You may also pass in a function(timeFormat, timeString, options) to handle the parsing yourself, returning a simple object:

{
	hour: 19,
	minute: 10,
	second: 23,
	millisec: 45,
	timezone: '-0400'
}

Formatting Your Time

The default format is "HH:mm". To use 12 hour time use something similar to: "hh:mm tt". When both "t" and lower case "h" are present in the timeFormat, 12 hour time will be used.

H

Hour with no leading 0 (24 hour)

HH

Hour with leading 0 (24 hour)

h

Hour with no leading 0 (12 hour)

hh

Hour with leading 0 (12 hour)

m

Minute with no leading 0

mm

Minute with leading 0

s

Second with no leading 0

ss

Second with leading 0

l

Milliseconds always with leading 0

t

a or p for AM/PM

T

A or P for AM/PM

tt

am or pm for AM/PM

TT

AM or PM for AM/PM

z

Timezone as defined by timezoneList

'...'

Literal text (Uses single quotes)

Formats are used in the following ways:

• timeFormat option
• altTimeFormat option
• pickerTimeFormat option
• $.datepicker.formatTime(format, timeObj, options) utility method
• $.datepicker.parseTime(format, timeStr, options) utility method

For help with formatting the date portion, visit the datepicker documentation for formatting dates.

Working with Localizations

Timepicker comes with many translations and localizations, thanks to all the contributors. They can be found in the localization folder in the git repo.

The quick and cheap way to use localizations is to pass in options to a timepicker instance:

$('#example123').timepicker({
	timeOnlyTitle: 'Выберите время',
	timeText: 'Время',
	hourText: 'Часы',
	minuteText: 'Минуты',
	secondText: 'Секунды',
	currentText: 'Теперь',
	closeText: 'Закрыть'
});

However, if you plan to use timepicker extensively you will need to include (build your own) localization. It is simply assigning those same variables to an object. As you see in the example below we maintain a separate object for timepicker. This way we aren't bound to any changes within datepicker.

$.datepicker.regional['ru'] = {
	closeText: 'Закрыть',
	prevText: '<Пред',
	nextText: 'След>',
	currentText: 'Сегодня',
	monthNames: ['Январь','Февраль','Март','Апрель','Май','Июнь',
	'Июль','Август','Сентябрь','Октябрь','Ноябрь','Декабрь'],
	monthNamesShort: ['Янв','Фев','Мар','Апр','Май','Июн',
	'Июл','Авг','Сен','Окт','Ноя','Дек'],
	dayNames: ['воскресенье','понедельник','вторник','среда','четверг','пятница','суббота'],
	dayNamesShort: ['вск','пнд','втр','срд','чтв','птн','сбт'],
	dayNamesMin: ['Вс','Пн','Вт','Ср','Чт','Пт','Сб'],
	weekHeader: 'Не',
	dateFormat: 'dd.mm.yy',
	firstDay: 1,
	isRTL: false,
	showMonthAfterYear: false,
	yearSuffix: ''
};
$.datepicker.setDefaults($.datepicker.regional['ru']);


$.timepicker.regional['ru'] = {
	timeOnlyTitle: 'Выберите время',
	timeText: 'Время',
	hourText: 'Часы',
	minuteText: 'Минуты',
	secondText: 'Секунды',
	millisecText: 'Миллисекунды',
	timezoneText: 'Часовой пояс',
	currentText: 'Сейчас',
	closeText: 'Закрыть',
	timeFormat: 'HH:mm',
	amNames: ['AM', 'A'],
	pmNames: ['PM', 'P'],
	isRTL: false
};
$.timepicker.setDefaults($.timepicker.regional['ru']);

Now all you have to do is call timepicker and the Russian localization is used. Generally you only need to include the localization file, it will setDefaults() for you.

You can also visit localization for datepicker for more information about datepicker localizations.

Examples

• Basic Initializations
• Using Timezones
• Slider Modifications
• Alternate Fields
• Time Restraints
• Utilities

Basic Initializations

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

$('#basic_example_2').timepicker();

$('#basic_example_3').datetimepicker({
	timeFormat: "hh:mm tt"
});

Using Timezones

$('#timezone_example_1').datetimepicker({
	timeFormat: 'hh:mm tt z',
	showTimezone: true
});

$('#timezone_example_2').datetimepicker({
	timeFormat: 'HH:mm z',
	showTimezone: true,
	timezoneList: [ 
			{ value: '-0500', label: 'Eastern'}, 
			{ value: '-0600', label: 'Central' }, 
			{ value: '-0700', label: 'Mountain' }, 
			{ value: '-0800', label: 'Pacific' } 
		]
});

$('#timezone_example_3').datetimepicker({
	timeFormat: 'HH:mm z',
	showTimezone: true,
	timezone: 'MT',
	timezoneList: [ 
			{ value: 'ET', label: 'Eastern'}, 
			{ value: 'CT', label: 'Central' }, 
			{ value: 'MT', label: 'Mountain' }, 
			{ value: 'PT', label: 'Pacific' } 
		]
});

Slider Modifications

$('#slider_example_1').timepicker({
	hourGrid: 4,
	minuteGrid: 10,
	timeFormat: 'hh:mm tt'
});

$('#slider_example_2').datetimepicker({
	showSecond: true,
	timeFormat: 'HH:mm:ss',
	stepHour: 2,
	stepMinute: 10,
	stepSecond: 10
});

$('#slider_example_3').datetimepicker({
	addSliderAccess: true,
	sliderAccessArgs: { touchonly: false }
});

$('#slider_example_4').datetimepicker({
	controlType: 'select',
	timeFormat: 'hh:mm tt'
});

var myControl=  {
	create: function(tp_inst, obj, unit, val, min, max, step){
		$('<input class="ui-timepicker-input" value="'+val+'" style="width:50%">')
			.appendTo(obj)
			.spinner({
				min: min,
				max: max,
				step: step,
				change: function(e,ui){ // key events
						// don't call if api was used and not key press
						if(e.originalEvent !== undefined)
							tp_inst._onTimeChange();
						tp_inst._onSelectHandler();
					},
				spin: function(e,ui){ // spin events
						tp_inst.control.value(tp_inst, obj, unit, ui.value);
						tp_inst._onTimeChange();
						tp_inst._onSelectHandler();
					}
			});
		return obj;
	},
	options: function(tp_inst, obj, unit, opts, val){
		if(typeof(opts) == 'string' && val !== undefined)
				return obj.find('.ui-timepicker-input').spinner(opts, val);
		return obj.find('.ui-timepicker-input').spinner(opts);
	},
	value: function(tp_inst, obj, unit, val){
		if(val !== undefined)
			return obj.find('.ui-timepicker-input').spinner('value', val);
		return obj.find('.ui-timepicker-input').spinner('value');
	}
};

$('#slider_example_5').datetimepicker({
	controlType: myControl
});

Alternate Fields

$('#alt_example_1').datetimepicker({
	altField: "#alt_example_1_alt"
});

$('#alt_example_2').datetimepicker({
	altField: "#alt_example_2_alt",
	altFieldTimeOnly: false
});

$('#alt_example_3').datetimepicker({
	altField: "#alt_example_3_alt",
	altFieldTimeOnly: false,
	altFormat: "yy-mm-dd",
	altTimeFormat: "h:m t",
	altSeparator: " @ "
});

$('#alt_example_4').datetimepicker({
	altField: "#alt_example_4_alt",
	altFieldTimeOnly: false
});

Time Restraints

$('#rest_example_1').timepicker({
	hourMin: 8,
	hourMax: 16
});

$('#rest_example_2').datetimepicker({
	numberOfMonths: 2,
	minDate: 0,
	maxDate: 30
});

$('#rest_example_3').datetimepicker({
	minDate: new Date(2010, 11, 20, 8, 30),
	maxDate: new Date(2010, 11, 31, 17, 30)
});

var startDateTextBox = $('#rest_example_4_start');
var endDateTextBox = $('#rest_example_4_end');

startDateTextBox.datetimepicker({ 
	onClose: function(dateText, inst) {
		if (endDateTextBox.val() != '') {
			var testStartDate = startDateTextBox.datetimepicker('getDate');
			var testEndDate = endDateTextBox.datetimepicker('getDate');
			if (testStartDate > testEndDate)
				endDateTextBox.datetimepicker('setDate', testStartDate);
		}
		else {
			endDateTextBox.val(dateText);
		}
	},
	onSelect: function (selectedDateTime){
		endDateTextBox.datetimepicker('option', 'minDate', startDateTextBox.datetimepicker('getDate') );
	}
});
endDateTextBox.datetimepicker({ 
	onClose: function(dateText, inst) {
		if (startDateTextBox.val() != '') {
			var testStartDate = startDateTextBox.datetimepicker('getDate');
			var testEndDate = endDateTextBox.datetimepicker('getDate');
			if (testStartDate > testEndDate)
				startDateTextBox.datetimepicker('setDate', testEndDate);
		}
		else {
			startDateTextBox.val(dateText);
		}
	},
	onSelect: function (selectedDateTime){
		startDateTextBox.datetimepicker('option', 'maxDate', endDateTextBox.datetimepicker('getDate') );
	}
});

Utilities

var ex13 = $('#utility_example_1');

ex13.datetimepicker({
	dateFormat: "D MM d, yy",
	separator: ' @ '
});

$('#utility_example_1_setdt').click(function(){
	ex13.datetimepicker('setDate', (new Date()) );
});

$('#utility_example_1_getdt').click(function(){
	alert(ex13.datetimepicker('getDate'));
});

$('#utility_example_2').text(
	$.datepicker.formatTime('HH:mm z', { hour: 14, minute: 36, timezone: '+2000' }, {})
);

$('#utility_example_3').text(JSON.stringify( 
	$.datepicker.parseTime('HH:mm:ss:l z', "14:36:21:765 +2000", {}) 
));