MCPcopy
hub / github.com/jonthornton/jquery-timepicker / Options

Interface Options

src/jquery.timepicker.d.ts:12–151  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

10 * Options object for the jquery.timepicker
11 */
12 export interface Options {
13 /**
14 * Default: 'body'
15 * Override where the dropdown is appended.
16 * Takes either a string to use as a selector, a function that gets passed the clicked input element as argument or a jquery object to use directly.
17 */
18 appendTo?: string | JQuery | ((clickedElement: JQuery) => JQuery);
19 /**
20 * Default: null
21 * A class name to apply to the HTML element that contains the timepicker dropdown.
22 */
23 className?: string;
24 /**
25 * Default: false
26 * Close the timepicker when the chosen element is scrolled. (Replicates <select> behavior.) Takes either a string to use as a selector, an HTMLelemtn, or a boolean (true binds to ```document``` scrolling).
27 */
28 closeOnScroll?: boolean | string | HTMLelement;
29 /**
30 * Default: false
31 * DEPRECATED.
32 * Close the timepicker when the window is scrolled. (Replicates <select> behavior.)
33 */
34 closeOnWindowScroll?: boolean;
35 /**
36 * Default: false
37 * Disable typing in the timepicker input box; force users to select from list.
38 * More information https://github.com/jonthornton/jquery-timepicker/issues/425#issuecomment-133262458
39 */
40 disableTextInput?: boolean;
41 /**
42 * Default: []
43 * Disable selection of certain time ranges. Input is an array of time pairs, like `[['3:00am', '4:30am'], ['5:00pm', '8:00pm']].
44 * The start of the interval will be disabled but the end won't.
45 */
46 disableTimeRanges?: Array<string[]>;
47 /**
48 * Default: false
49 * Disables the onscreen keyboard for touch devices. There can be instances where Firefox or Chrome have touch events enabled
50 * (such as on Surface tablets but not actually be a touch device. In this case disableTouchKeyboard will prevent the timepicker
51 * input field from being focused.
52 * More information: https://github.com/jonthornton/jquery-timepicker/issues/413
53 */
54 disableTouchKeyboard?: boolean;
55 /**
56 * Default: Same as the minTime
57 * The time against which showDuration will compute relative times. This should be given as a formatted date string.
58 */
59 durationTime?: string | Date | (() => string | Date);
60 /**
61 * Default: false
62 * Force update the time to step settings as soon as it loses focus`.
63 */
64 forceRoundTime?: boolean;
65 /**
66 * Default: 24 hours after minTime
67 * The time that should appear last in the dropdown list. Can be used to limit the range of time options.
68 */
69 listWidth?: number;

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected