Debian Codegraph @

src/docs/examples.html

raw
1 <!-- ############################################################################# -->
2 <!-- Examples
3 <!-- ############################################################################# -->
4 <div id="tp-examples">
5 <h2>Examples</h2>
6
7 <ul>
8 <li><a href="#basic_examples" title="Basic Initializations">Basic Initializations</a></li>
9 <li><a href="#timezone_examples" title="Using Timezones">Using Timezones</a></li>
10 <li><a href="#slider_examples" title="Slider Modifications">Slider Modifications</a></li>
11 <li><a href="#alt_examples" title="Alternate Field">Alternate Fields</a></li>
12 <li><a href="#input_examples" title="Time Input">Time Input</a></li>
13 <li><a href="#rest_examples" title="Time Restraints">Time Restraints</a></li>
14 <li><a href="#range_examples" title="Time Ranges">Time Ranges</a></li>
15 <li><a href="#utility_examples" title="Utilities">Utilities</a></li>
16 </ul>
17
18 <h3 id="basic_examples">Basic Initializations</h3>
19
20 <!-- ============= example -->
21 <div class="example-container">
22 <p>Add a simple datetimepicker to jQuery UI's datepicker</p>
23 <div>
24 <input type="text" name="basic_example_1" id="basic_example_1" value="" />
25 </div>
26 <pre>
27 $('#basic_example_1').datetimepicker();
28 </pre>
29 </div>
30
31
32 <!-- ============= example -->
33 <div class="example-container">
34 <p>Add only a timepicker:</p>
35 <div>
36 <input type="text" name="basic_example_2" id="basic_example_2" value="" />
37 </div>
38 <pre>
39 $('#basic_example_2').timepicker();
40 </pre>
41 </div>
42
43 <!-- ============= example -->
44 <div class="example-container">
45 <p>Format the time:</p>
46 <div>
47 <input type="text" name="basic_example_3" id="basic_example_3" value="" />
48 </div>
49 <pre>
50 $('#basic_example_3').datetimepicker({
51 timeFormat: "hh:mm tt"
52 });
53 </pre>
54 </div>
55
56
57 <!-- ============= example -->
58 <div class="example-container">
59 <p>Timepicker comes with a collection of localization files and one combined file with all available localizations. $.timepicker.regional["your localization code here"] is a simple object with preset options:</p>
60 <div>
61 <input type="text" name="basic_example_4" id="basic_example_4" value="" />
62 </div>
63 <pre>
64 $('#basic_example_4').timepicker(
65 $.timepicker.regional['es']
66 );
67 </pre>
68 </div>
69
70 <h3 id="timezone_examples">Using Timezones</h3>
71
72 <!-- ============= example -->
73 <div class="example-container">
74 <p>Simplest timezone usage:</p>
75 <div>
76 <input type="text" name="timezone_example_1" id="timezone_example_1" value="" />
77 </div>
78 <pre>
79 $('#timezone_example_1').datetimepicker({
80 timeFormat: 'hh:mm tt z'
81 });
82 </pre>
83 </div>
84
85 <!-- ============= example -->
86 <div class="example-container">
87 <p>Define your own timezone options:</p>
88 <div>
89 <input type="text" name="timezone_example_2" id="timezone_example_2" value="" />
90 </div>
91 <pre>
92 $('#timezone_example_2').datetimepicker({
93 timeFormat: 'HH:mm z',
94 timezoneList: [
95 { value: -300, label: 'Eastern'},
96 { value: -360, label: 'Central' },
97 { value: -420, label: 'Mountain' },
98 { value: -480, label: 'Pacific' }
99 ]
100 });
101 </pre>
102 </div>
103
104 <h3 id="slider_examples">Slider Modifications</h3>
105
106 <!-- ============= example -->
107 <div class="example-container">
108 <p>Add a grid to each slider:</p>
109 <div>
110 <input type="text" name="slider_example_1" id="slider_example_1" value="" />
111 </div>
112 <pre>
113 $('#slider_example_1').timepicker({
114 hourGrid: 4,
115 minuteGrid: 10,
116 timeFormat: 'hh:mm tt'
117 });
118 </pre>
119 </div>
120
121 <!-- ============= example -->
122 <div class="example-container">
123 <p>Set the interval step of sliders:</p>
124 <div>
125 <input type="text" name="slider_example_2" id="slider_example_2" value="" />
126 </div>
127 <pre>
128 $('#slider_example_2').datetimepicker({
129 timeFormat: 'HH:mm:ss',
130 stepHour: 2,
131 stepMinute: 10,
132 stepSecond: 10
133 });
134 </pre>
135 </div>
136
137 <!-- ============= example -->
138 <div class="example-container">
139 <p>Add sliderAccess plugin for touch devices:</p>
140 <div>
141 <input type="text" name="slider_example_3" id="slider_example_3" value="" />
142 </div>
143 <pre>
144 $('#slider_example_3').datetimepicker({
145 addSliderAccess: true,
146 sliderAccessArgs: { touchonly: false }
147 });</pre>
148 </div>
149
150 <!-- ============= example -->
151 <div class="example-container">
152 <p>Use dropdowns instead of sliders. By default if slider is not available dropdowns will be used.</p>
153 <div>
154 <input type="text" name="slider_example_4" id="slider_example_4" value="" />
155 </div>
156 <pre>
157 $('#slider_example_4').datetimepicker({
158 controlType: 'select',
159 timeFormat: 'hh:mm tt'
160 });</pre>
161 </div>
162
163 <!-- ============= example -->
164 <div class="example-container">
165 <p>Uses one line dropdowns instead of sliders.</p>
166 <div>
167 <input type="text" name="slider_example_4andHalf" id="slider_example_4andHalf" value="" />
168 </div>
169 <pre>
170 $('#slider_example_4andHalf').datetimepicker({
171 controlType: 'select',
172 oneLine: true,
173 timeFormat: 'hh:mm tt'
174 });</pre>
175 </div>
176
177 <!-- ============= example -->
178 <div class="example-container">
179 <p>Create your own control by implementing the create, options, and value methods. If you want to use your new control for all instances use the $.timepicker.setDefaults({controlType:myControl}). Here we implement jQueryUI's spinner control (jQueryUI 1.9+).</p>
180 <div>
181 <input type="text" name="slider_example_5" id="slider_example_5" value="" />
182 </div>
183 <pre>var myControl= {
184 create: function(tp_inst, obj, unit, val, min, max, step){
185 $('&lt;input class="ui-timepicker-input" value="'+val+'" style="width:50%"&gt;')
186 .appendTo(obj)
187 .spinner({
188 min: min,
189 max: max,
190 step: step,
191 change: function(e,ui){ // key events
192 // don't call if api was used and not key press
193 if(e.originalEvent !== undefined)
194 tp_inst._onTimeChange();
195 tp_inst._onSelectHandler();
196 },
197 spin: function(e,ui){ // spin events
198 tp_inst.control.value(tp_inst, obj, unit, ui.value);
199 tp_inst._onTimeChange();
200 tp_inst._onSelectHandler();
201 }
202 });
203 return obj;
204 },
205 options: function(tp_inst, obj, unit, opts, val){
206 if(typeof(opts) == 'string' && val !== undefined)
207 return obj.find('.ui-timepicker-input').spinner(opts, val);
208 return obj.find('.ui-timepicker-input').spinner(opts);
209 },
210 value: function(tp_inst, obj, unit, val){
211 if(val !== undefined)
212 return obj.find('.ui-timepicker-input').spinner('value', val);
213 return obj.find('.ui-timepicker-input').spinner('value');
214 }
215 };
216
217 $('#slider_example_5').datetimepicker({
218 controlType: myControl
219 });</pre>
220 </div>
221
222 <h3 id="alt_examples">Alternate Fields</h3>
223
224 <!-- ============= example -->
225 <div class="example-container">
226 <p>Alt field in the simplest form:</p>
227 <div>
228 <input type="text" name="alt_example_1" id="alt_example_1" value="09/15/2012" />
229 <input type="text" name="alt_example_1_alt" id="alt_example_1_alt" value="10:15" />
230 </div>
231 <pre>
232 $('#alt_example_1').datetimepicker({
233 altField: "#alt_example_1_alt"
234 });
235 </pre>
236 </div>
237
238 <!-- ============= example -->
239 <div class="example-container">
240 <p>With datetime in both:</p>
241 <div>
242 <input type="text" name="alt_example_2" id="alt_example_2" value="" />
243 <input type="text" name="alt_example_2_alt" id="alt_example_2_alt" value="" />
244 </div>
245 <pre>
246 $('#alt_example_2').datetimepicker({
247 altField: "#alt_example_2_alt",
248 altFieldTimeOnly: false
249 });
250 </pre>
251 </div>
252
253 <!-- ============= example -->
254 <div class="example-container">
255 <p>Format the altField differently:</p>
256 <div>
257 <input type="text" name="alt_example_3" id="alt_example_3" value="" />
258 <input type="text" name="alt_example_3_alt" id="alt_example_3_alt" value="" />
259 </div>
260 <pre>
261 $('#alt_example_3').datetimepicker({
262 altField: "#alt_example_3_alt",
263 altFieldTimeOnly: false,
264 altFormat: "yy-mm-dd",
265 altTimeFormat: "h:m t",
266 altSeparator: " @ "
267 });
268 </pre>
269 </div>
270
271 <!-- ============= example -->
272 <div class="example-container">
273 <p>With inline mode using altField:</p>
274 <div>
275 <input type="text" name="alt_example_4_alt" id="alt_example_4_alt" value="" />
276 <span id="alt_example_4" ></span>
277 </div>
278 <pre>
279 $('#alt_example_4').datetimepicker({
280 altField: "#alt_example_4_alt",
281 altFieldTimeOnly: false
282 });
283 </pre>
284 </div>
285
286 <h3 id="input_examples">Time Input</h3>
287
288 <!-- ============= example -->
289 <div class="example-container">
290 <p>Allows time displayed inside the picker to allow being typed in.</p>
291 <div>
292 <input type="text" name="input_example_1" id="input_example_1" value="08/20/2014 01:22 pm" />
293 </div>
294 <pre>
295 $('#input_example_1').datetimepicker({
296 timeInput: true,
297 timeFormat: "hh:mm tt"
298 });
299 </pre>
300 </div>
301
302 <!-- ============= example -->
303 <div class="example-container">
304 <p>Don't show any sliders, only the time input.</p>
305 <div>
306 <input type="text" name="input_example_1" id="input_example_2" value="08/20/2014 01:22 pm" />
307 </div>
308 <pre>
309 $('#input_example_2').datetimepicker({
310 timeInput: true,
311 timeFormat: "hh:mm tt",
312 showHour: false,
313 showMinute: false
314 });
315 </pre>
316 </div>
317
318 <h3 id="rest_examples">Time Restraints</h3>
319
320 <!-- ============= example -->
321 <div class="example-container">
322 <p>Set the min/max hour of every date:</p>
323 <div>
324 <input type="text" name="rest_example_1" id="rest_example_1" value="" />
325 </div>
326 <pre>
327 $('#rest_example_1').timepicker({
328 hourMin: 8,
329 hourMax: 16
330 });
331 </pre>
332 </div>
333
334 <!-- ============= example -->
335 <div class="example-container">
336 <p>Set the min/max date numerically:</p>
337 <div>
338 <input type="text" name="rest_example_2" id="rest_example_2" value="" />
339 </div>
340 <pre>
341 $('#rest_example_2').datetimepicker({
342 numberOfMonths: 2,
343 minDate: 0,
344 maxDate: 30
345 });
346 </pre>
347 </div>
348
349 <!-- ============= example -->
350 <div class="example-container">
351 <p>Set the min/max date and time with a Date object:</p>
352 <div>
353 <input type="text" name="rest_example_3" id="rest_example_3" value="" />
354 </div>
355 <pre>
356 $('#rest_example_3').datetimepicker({
357 minDate: new Date(2010, 11, 20, 8, 30),
358 maxDate: new Date(2010, 11, 31, 17, 30)
359 });
360 </pre>
361 </div>
362
363
364 <h3 id="range_examples">Time Ranges</h3>
365
366 <!-- ============= example -->
367 <div class="example-container">
368 <p>Restrict a start and end date by using onSelect and onClose events for more control over functionality:</p>
369 <p>For more examples and advanced usage grab the <a href="http://trentrichardson.com/ebooks/handling-time/" title="Handling Time eBook">Handling Time eBook</a>.</p>
370 <div>
371 <input type="text" name="range_example_1_start" id="range_example_1_start" value="08/20/2014 09:22 -0400" />
372 <input type="text" name="range_example_1_end" id="range_example_1_end" value="08/21/2014 08:00 -0400" />
373 </div>
374 <pre>
375 var startDateTextBox = $('#range_example_1_start');
376 var endDateTextBox = $('#range_example_1_end');
377
378 startDateTextBox.datetimepicker({
379 timeFormat: 'HH:mm z',
380 onClose: function(dateText, inst) {
381 if (endDateTextBox.val() != '') {
382 var testStartDate = startDateTextBox.datetimepicker('getDate');
383 var testEndDate = endDateTextBox.datetimepicker('getDate');
384 if (testStartDate > testEndDate)
385 endDateTextBox.datetimepicker('setDate', testStartDate);
386 }
387 else {
388 endDateTextBox.val(dateText);
389 }
390 },
391 onSelect: function (selectedDateTime){
392 endDateTextBox.datetimepicker('option', 'minDate', startDateTextBox.datetimepicker('getDate') );
393 }
394 });
395 endDateTextBox.datetimepicker({
396 timeFormat: 'HH:mm z',
397 onClose: function(dateText, inst) {
398 if (startDateTextBox.val() != '') {
399 var testStartDate = startDateTextBox.datetimepicker('getDate');
400 var testEndDate = endDateTextBox.datetimepicker('getDate');
401 if (testStartDate > testEndDate)
402 startDateTextBox.datetimepicker('setDate', testEndDate);
403 }
404 else {
405 startDateTextBox.val(dateText);
406 }
407 },
408 onSelect: function (selectedDateTime){
409 startDateTextBox.datetimepicker('option', 'maxDate', endDateTextBox.datetimepicker('getDate') );
410 }
411 });
412 </pre>
413 </div>
414
415 <!-- ============= example -->
416 <div class="example-container">
417 <p>Timepicker also includes some shortcut methods for ranges:</p>
418 <div>
419 <input type="text" name="range_example_2_start" id="range_example_2_start" value="" />
420 <input type="text" name="range_example_2_end" id="range_example_2_end" value="" />
421 </div>
422 <pre>
423 var startDateTextBox = $('#range_example_2_start');
424 var endDateTextBox = $('#range_example_2_end');
425
426 $.timepicker.datetimeRange(
427 startDateTextBox,
428 endDateTextBox,
429 {
430 minInterval: (1000*60*60), // 1hr
431 dateFormat: 'dd M yy',
432 timeFormat: 'HH:mm',
433 start: {}, // start picker options
434 end: {} // end picker options
435 }
436 );
437 </pre>
438 </div>
439
440 <!-- ============= example -->
441 <div class="example-container">
442 <p>To use only times for a time range use $.timepicker.timeRange():</p>
443 <div>
444 <input type="text" name="range_example_3_start" id="range_example_3_start" value="09:16" />
445 <input type="text" name="range_example_3_end" id="range_example_3_end" value="10:16" />
446 </div>
447 <pre>
448 var startTimeTextBox = $('#range_example_3_start');
449 var endTimeTextBox = $('#range_example_3_end');
450
451 $.timepicker.timeRange(
452 startTimeTextBox,
453 endTimeTextBox,
454 {
455 minInterval: (1000*60*60), // 1hr
456 timeFormat: 'HH:mm',
457 start: {}, // start picker options
458 end: {} // end picker options
459 }
460 );
461 </pre>
462 </div>
463
464 <!-- ============= example -->
465 <div class="example-container">
466 <p>Even though this plugin focuses on datetime, it also provides a dateRange function:</p>
467 <div>
468 <input type="text" name="range_example_4_start" id="range_example_4_start" value="" />
469 <input type="text" name="range_example_4_end" id="range_example_4_end" value="" />
470 </div>
471 <pre>
472 var startDateTextBox = $('#range_example_4_start');
473 var endDateTextBox = $('#range_example_4_end');
474
475 $.timepicker.dateRange(
476 startDateTextBox,
477 endDateTextBox,
478 {
479 minInterval: (1000*60*60*24*4), // 4 days
480 maxInterval: (1000*60*60*24*8), // 8 days
481 start: {}, // start picker options
482 end: {} // end picker options
483 }
484 );
485 </pre>
486 </div>
487
488 <h3 id="utility_examples">Utilities</h3>
489
490 <!-- ============= example -->
491 <div class="example-container">
492 <p>Get and Set Datetime with the getDate and setDate methods. This example uses timezone to demonstrate the timepicker regonizes the timezones and computes the offsets when getting and setting.</p>
493 <div>
494 <input type="text" name="utility_example_1" id="utility_example_1" value="" />
495 <button id="utility_example_1_setdt" value="1">Set Datetime</button>
496 <button id="utility_example_1_getdt" value="1">Get Datetime</button>
497 </div>
498
499 <pre>
500 var ex13 = $('#utility_example_1');
501
502 ex13.datetimepicker({
503 timeFormat: 'hh:mm tt z',
504 separator: ' @ ',
505 showTimezone: true
506 });
507
508 $('#utility_example_1_setdt').click(function(){
509 ex13.datetimepicker('setDate', (new Date()) );
510 });
511
512 $('#utility_example_1_getdt').click(function(){
513 alert(ex13.datetimepicker('getDate'));
514 });
515 </pre>
516 </div>
517
518 <!-- ============= example -->
519 <div class="example-container">
520 <p>Use the utility function to format your own time. $.datepicker.formatTime(format, time, options)</p>
521 <dl class="defs">
522 <dt>format</dt><dd>required - string represenation of the time format to use</dd>
523 <dt>time</dt><dd>required - hash: { hour, minute, second, millisecond, timezone }</dd>
524 <dt>options</dt><dd>optional - hash of any options in regional translation (ampm, amNames, pmNames..)</dd>
525 </dl>
526 <p>Returns a time string in the specified format.</p>
527 <div>
528 <div id="utility_example_2"></div>
529 </div>
530
531 <pre>
532 $('#utility_example_2').text(
533 $.datepicker.formatTime('HH:mm z', { hour: 14, minute: 36, timezone: '+2000' }, {})
534 );
535 </pre>
536 </div>
537
538 <!-- ============= example -->
539 <div class="example-container">
540 <p>Use the utility function to parses a formatted time. $.datepicker.parseTime(format, timeString, options)</p>
541 <dl class="defs">
542 <dt>format</dt><dd>required - string represenation of the time format to use</dd>
543 <dt>time</dt><dd>required - time string matching the format given in parameter 1</dd>
544 <dt>options</dt><dd>optional - hash of any options in regional translation (ampm, amNames, pmNames..)</dd>
545 </dl>
546 <p>Returns an object with hours, minutes, seconds, milliseconds, timezone.</p>
547 <div>
548 <div id="utility_example_3"></div>
549 </div>
550
551 <pre>
552 $('#utility_example_3').text(JSON.stringify(
553 $.datepicker.parseTime('HH:mm:ss:l z', "14:36:21:765 +2000", {})
554 ));
555 </pre>
556 </div>