@bryntum/scheduler-react 7.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (296) hide show
  1. package/README.md +52 -0
  2. package/lib/BryntumAIFilterField.d.ts +231 -0
  3. package/lib/BryntumAIFilterField.js +168 -0
  4. package/lib/BryntumAIFilterField.js.map +1 -0
  5. package/lib/BryntumButton.d.ts +206 -0
  6. package/lib/BryntumButton.js +148 -0
  7. package/lib/BryntumButton.js.map +1 -0
  8. package/lib/BryntumButtonGroup.d.ts +201 -0
  9. package/lib/BryntumButtonGroup.js +154 -0
  10. package/lib/BryntumButtonGroup.js.map +1 -0
  11. package/lib/BryntumChatPanel.d.ts +246 -0
  12. package/lib/BryntumChatPanel.js +178 -0
  13. package/lib/BryntumChatPanel.js.map +1 -0
  14. package/lib/BryntumCheckbox.d.ts +239 -0
  15. package/lib/BryntumCheckbox.js +168 -0
  16. package/lib/BryntumCheckbox.js.map +1 -0
  17. package/lib/BryntumCheckboxGroup.d.ts +249 -0
  18. package/lib/BryntumCheckboxGroup.js +182 -0
  19. package/lib/BryntumCheckboxGroup.js.map +1 -0
  20. package/lib/BryntumChecklistFilterCombo.d.ts +268 -0
  21. package/lib/BryntumChecklistFilterCombo.js +205 -0
  22. package/lib/BryntumChecklistFilterCombo.js.map +1 -0
  23. package/lib/BryntumChipView.d.ts +208 -0
  24. package/lib/BryntumChipView.js +152 -0
  25. package/lib/BryntumChipView.js.map +1 -0
  26. package/lib/BryntumCodeEditor.d.ts +237 -0
  27. package/lib/BryntumCodeEditor.js +176 -0
  28. package/lib/BryntumCodeEditor.js.map +1 -0
  29. package/lib/BryntumColorField.d.ts +231 -0
  30. package/lib/BryntumColorField.js +169 -0
  31. package/lib/BryntumColorField.js.map +1 -0
  32. package/lib/BryntumCombo.d.ts +266 -0
  33. package/lib/BryntumCombo.js +202 -0
  34. package/lib/BryntumCombo.js.map +1 -0
  35. package/lib/BryntumContainer.d.ts +185 -0
  36. package/lib/BryntumContainer.js +148 -0
  37. package/lib/BryntumContainer.js.map +1 -0
  38. package/lib/BryntumDateField.d.ts +241 -0
  39. package/lib/BryntumDateField.js +178 -0
  40. package/lib/BryntumDateField.js.map +1 -0
  41. package/lib/BryntumDatePicker.d.ts +310 -0
  42. package/lib/BryntumDatePicker.js +213 -0
  43. package/lib/BryntumDatePicker.js.map +1 -0
  44. package/lib/BryntumDateRangeField.d.ts +242 -0
  45. package/lib/BryntumDateRangeField.js +179 -0
  46. package/lib/BryntumDateRangeField.js.map +1 -0
  47. package/lib/BryntumDateTimeField.d.ts +222 -0
  48. package/lib/BryntumDateTimeField.js +158 -0
  49. package/lib/BryntumDateTimeField.js.map +1 -0
  50. package/lib/BryntumDemoCodeEditor.d.ts +240 -0
  51. package/lib/BryntumDemoCodeEditor.js +179 -0
  52. package/lib/BryntumDemoCodeEditor.js.map +1 -0
  53. package/lib/BryntumDemoHeader.d.ts +30 -0
  54. package/lib/BryntumDemoHeader.js +84 -0
  55. package/lib/BryntumDemoHeader.js.map +1 -0
  56. package/lib/BryntumDisplayField.d.ts +227 -0
  57. package/lib/BryntumDisplayField.js +163 -0
  58. package/lib/BryntumDisplayField.js.map +1 -0
  59. package/lib/BryntumDurationField.d.ts +234 -0
  60. package/lib/BryntumDurationField.js +175 -0
  61. package/lib/BryntumDurationField.js.map +1 -0
  62. package/lib/BryntumEditor.d.ts +249 -0
  63. package/lib/BryntumEditor.js +167 -0
  64. package/lib/BryntumEditor.js.map +1 -0
  65. package/lib/BryntumEventColorField.d.ts +231 -0
  66. package/lib/BryntumEventColorField.js +169 -0
  67. package/lib/BryntumEventColorField.js.map +1 -0
  68. package/lib/BryntumFieldFilterPicker.d.ts +202 -0
  69. package/lib/BryntumFieldFilterPicker.js +161 -0
  70. package/lib/BryntumFieldFilterPicker.js.map +1 -0
  71. package/lib/BryntumFieldFilterPickerGroup.d.ts +207 -0
  72. package/lib/BryntumFieldFilterPickerGroup.js +164 -0
  73. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -0
  74. package/lib/BryntumFieldSet.d.ts +235 -0
  75. package/lib/BryntumFieldSet.js +174 -0
  76. package/lib/BryntumFieldSet.js.map +1 -0
  77. package/lib/BryntumFileField.d.ts +228 -0
  78. package/lib/BryntumFileField.js +164 -0
  79. package/lib/BryntumFileField.js.map +1 -0
  80. package/lib/BryntumFilePicker.d.ts +192 -0
  81. package/lib/BryntumFilePicker.js +153 -0
  82. package/lib/BryntumFilePicker.js.map +1 -0
  83. package/lib/BryntumFilterField.d.ts +234 -0
  84. package/lib/BryntumFilterField.js +171 -0
  85. package/lib/BryntumFilterField.js.map +1 -0
  86. package/lib/BryntumFullscreenButton.d.ts +8 -0
  87. package/lib/BryntumFullscreenButton.js +37 -0
  88. package/lib/BryntumFullscreenButton.js.map +1 -0
  89. package/lib/BryntumGrid.d.ts +844 -0
  90. package/lib/BryntumGrid.js +335 -0
  91. package/lib/BryntumGrid.js.map +1 -0
  92. package/lib/BryntumGridBase.d.ts +842 -0
  93. package/lib/BryntumGridBase.js +333 -0
  94. package/lib/BryntumGridBase.js.map +1 -0
  95. package/lib/BryntumGridChartDesigner.d.ts +162 -0
  96. package/lib/BryntumGridChartDesigner.js +127 -0
  97. package/lib/BryntumGridChartDesigner.js.map +1 -0
  98. package/lib/BryntumGridFieldFilterPicker.d.ts +203 -0
  99. package/lib/BryntumGridFieldFilterPicker.js +162 -0
  100. package/lib/BryntumGridFieldFilterPicker.js.map +1 -0
  101. package/lib/BryntumGridFieldFilterPickerGroup.d.ts +206 -0
  102. package/lib/BryntumGridFieldFilterPickerGroup.js +163 -0
  103. package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -0
  104. package/lib/BryntumGroupBar.d.ts +208 -0
  105. package/lib/BryntumGroupBar.js +152 -0
  106. package/lib/BryntumGroupBar.js.map +1 -0
  107. package/lib/BryntumHint.d.ts +260 -0
  108. package/lib/BryntumHint.js +184 -0
  109. package/lib/BryntumHint.js.map +1 -0
  110. package/lib/BryntumLabel.d.ts +161 -0
  111. package/lib/BryntumLabel.js +126 -0
  112. package/lib/BryntumLabel.js.map +1 -0
  113. package/lib/BryntumList.d.ts +205 -0
  114. package/lib/BryntumList.js +149 -0
  115. package/lib/BryntumList.js.map +1 -0
  116. package/lib/BryntumMenu.d.ts +264 -0
  117. package/lib/BryntumMenu.js +187 -0
  118. package/lib/BryntumMenu.js.map +1 -0
  119. package/lib/BryntumMonthPicker.d.ts +240 -0
  120. package/lib/BryntumMonthPicker.js +173 -0
  121. package/lib/BryntumMonthPicker.js.map +1 -0
  122. package/lib/BryntumNumberField.d.ts +234 -0
  123. package/lib/BryntumNumberField.js +170 -0
  124. package/lib/BryntumNumberField.js.map +1 -0
  125. package/lib/BryntumPagingToolbar.d.ts +210 -0
  126. package/lib/BryntumPagingToolbar.js +156 -0
  127. package/lib/BryntumPagingToolbar.js.map +1 -0
  128. package/lib/BryntumPanel.d.ts +231 -0
  129. package/lib/BryntumPanel.js +170 -0
  130. package/lib/BryntumPanel.js.map +1 -0
  131. package/lib/BryntumPasswordField.d.ts +226 -0
  132. package/lib/BryntumPasswordField.js +162 -0
  133. package/lib/BryntumPasswordField.js.map +1 -0
  134. package/lib/BryntumProjectCombo.d.ts +267 -0
  135. package/lib/BryntumProjectCombo.js +203 -0
  136. package/lib/BryntumProjectCombo.js.map +1 -0
  137. package/lib/BryntumRadio.d.ts +239 -0
  138. package/lib/BryntumRadio.js +168 -0
  139. package/lib/BryntumRadio.js.map +1 -0
  140. package/lib/BryntumRadioGroup.d.ts +239 -0
  141. package/lib/BryntumRadioGroup.js +178 -0
  142. package/lib/BryntumRadioGroup.js.map +1 -0
  143. package/lib/BryntumResourceCombo.d.ts +267 -0
  144. package/lib/BryntumResourceCombo.js +203 -0
  145. package/lib/BryntumResourceCombo.js.map +1 -0
  146. package/lib/BryntumResourceFilter.d.ts +214 -0
  147. package/lib/BryntumResourceFilter.js +154 -0
  148. package/lib/BryntumResourceFilter.js.map +1 -0
  149. package/lib/BryntumScheduler.d.ts +2037 -0
  150. package/lib/BryntumScheduler.js +642 -0
  151. package/lib/BryntumScheduler.js.map +1 -0
  152. package/lib/BryntumSchedulerBase.d.ts +2036 -0
  153. package/lib/BryntumSchedulerBase.js +641 -0
  154. package/lib/BryntumSchedulerBase.js.map +1 -0
  155. package/lib/BryntumSchedulerDatePicker.d.ts +313 -0
  156. package/lib/BryntumSchedulerDatePicker.js +216 -0
  157. package/lib/BryntumSchedulerDatePicker.js.map +1 -0
  158. package/lib/BryntumSchedulerProjectModel.d.ts +90 -0
  159. package/lib/BryntumSchedulerProjectModel.js +98 -0
  160. package/lib/BryntumSchedulerProjectModel.js.map +1 -0
  161. package/lib/BryntumSlideToggle.d.ts +239 -0
  162. package/lib/BryntumSlideToggle.js +168 -0
  163. package/lib/BryntumSlideToggle.js.map +1 -0
  164. package/lib/BryntumSlider.d.ts +184 -0
  165. package/lib/BryntumSlider.js +142 -0
  166. package/lib/BryntumSlider.js.map +1 -0
  167. package/lib/BryntumSplitter.d.ts +174 -0
  168. package/lib/BryntumSplitter.js +130 -0
  169. package/lib/BryntumSplitter.js.map +1 -0
  170. package/lib/BryntumTabPanel.d.ts +249 -0
  171. package/lib/BryntumTabPanel.js +178 -0
  172. package/lib/BryntumTabPanel.js.map +1 -0
  173. package/lib/BryntumTextAreaField.d.ts +228 -0
  174. package/lib/BryntumTextAreaField.js +164 -0
  175. package/lib/BryntumTextAreaField.js.map +1 -0
  176. package/lib/BryntumTextAreaPickerField.d.ts +232 -0
  177. package/lib/BryntumTextAreaPickerField.js +170 -0
  178. package/lib/BryntumTextAreaPickerField.js.map +1 -0
  179. package/lib/BryntumTextField.d.ts +229 -0
  180. package/lib/BryntumTextField.js +166 -0
  181. package/lib/BryntumTextField.js.map +1 -0
  182. package/lib/BryntumThemeCombo.d.ts +17 -0
  183. package/lib/BryntumThemeCombo.js +75 -0
  184. package/lib/BryntumThemeCombo.js.map +1 -0
  185. package/lib/BryntumTimeField.d.ts +238 -0
  186. package/lib/BryntumTimeField.js +175 -0
  187. package/lib/BryntumTimeField.js.map +1 -0
  188. package/lib/BryntumTimePicker.d.ts +192 -0
  189. package/lib/BryntumTimePicker.js +154 -0
  190. package/lib/BryntumTimePicker.js.map +1 -0
  191. package/lib/BryntumTimelineHistogram.d.ts +1183 -0
  192. package/lib/BryntumTimelineHistogram.js +448 -0
  193. package/lib/BryntumTimelineHistogram.js.map +1 -0
  194. package/lib/BryntumToolbar.d.ts +209 -0
  195. package/lib/BryntumToolbar.js +155 -0
  196. package/lib/BryntumToolbar.js.map +1 -0
  197. package/lib/BryntumTreeCombo.d.ts +266 -0
  198. package/lib/BryntumTreeCombo.js +202 -0
  199. package/lib/BryntumTreeCombo.js.map +1 -0
  200. package/lib/BryntumTreeGrid.d.ts +843 -0
  201. package/lib/BryntumTreeGrid.js +334 -0
  202. package/lib/BryntumTreeGrid.js.map +1 -0
  203. package/lib/BryntumUndoRedo.d.ts +189 -0
  204. package/lib/BryntumUndoRedo.js +152 -0
  205. package/lib/BryntumUndoRedo.js.map +1 -0
  206. package/lib/BryntumViewPresetCombo.d.ts +215 -0
  207. package/lib/BryntumViewPresetCombo.js +158 -0
  208. package/lib/BryntumViewPresetCombo.js.map +1 -0
  209. package/lib/BryntumWidget.d.ts +160 -0
  210. package/lib/BryntumWidget.js +125 -0
  211. package/lib/BryntumWidget.js.map +1 -0
  212. package/lib/BryntumYearPicker.d.ts +240 -0
  213. package/lib/BryntumYearPicker.js +177 -0
  214. package/lib/BryntumYearPicker.js.map +1 -0
  215. package/lib/WrapperHelper.d.ts +26 -0
  216. package/lib/WrapperHelper.js +569 -0
  217. package/lib/WrapperHelper.js.map +1 -0
  218. package/lib/index.d.ts +71 -0
  219. package/lib/index.js +72 -0
  220. package/lib/index.js.map +1 -0
  221. package/license.pdf +0 -0
  222. package/licenses.md +310 -0
  223. package/package.json +25 -0
  224. package/src/BryntumAIFilterField.tsx +998 -0
  225. package/src/BryntumButton.tsx +887 -0
  226. package/src/BryntumButtonGroup.tsx +902 -0
  227. package/src/BryntumChatPanel.tsx +1082 -0
  228. package/src/BryntumCheckbox.tsx +1000 -0
  229. package/src/BryntumCheckboxGroup.tsx +1116 -0
  230. package/src/BryntumChecklistFilterCombo.tsx +1241 -0
  231. package/src/BryntumChipView.tsx +914 -0
  232. package/src/BryntumCodeEditor.tsx +1065 -0
  233. package/src/BryntumColorField.tsx +995 -0
  234. package/src/BryntumCombo.tsx +1230 -0
  235. package/src/BryntumContainer.tsx +861 -0
  236. package/src/BryntumDateField.tsx +1055 -0
  237. package/src/BryntumDatePicker.tsx +1340 -0
  238. package/src/BryntumDateRangeField.tsx +1057 -0
  239. package/src/BryntumDateTimeField.tsx +942 -0
  240. package/src/BryntumDemoCodeEditor.tsx +1081 -0
  241. package/src/BryntumDemoHeader.tsx +160 -0
  242. package/src/BryntumDisplayField.tsx +979 -0
  243. package/src/BryntumDurationField.tsx +1038 -0
  244. package/src/BryntumEditor.tsx +1013 -0
  245. package/src/BryntumEventColorField.tsx +995 -0
  246. package/src/BryntumFieldFilterPicker.tsx +943 -0
  247. package/src/BryntumFieldFilterPickerGroup.tsx +976 -0
  248. package/src/BryntumFieldSet.tsx +1058 -0
  249. package/src/BryntumFileField.tsx +982 -0
  250. package/src/BryntumFilePicker.tsx +888 -0
  251. package/src/BryntumFilterField.tsx +1023 -0
  252. package/src/BryntumFullscreenButton.tsx +45 -0
  253. package/src/BryntumGrid.tsx +2402 -0
  254. package/src/BryntumGridBase.tsx +2399 -0
  255. package/src/BryntumGridChartDesigner.tsx +728 -0
  256. package/src/BryntumGridFieldFilterPicker.tsx +956 -0
  257. package/src/BryntumGridFieldFilterPickerGroup.tsx +970 -0
  258. package/src/BryntumGroupBar.tsx +914 -0
  259. package/src/BryntumHint.tsx +1125 -0
  260. package/src/BryntumLabel.tsx +720 -0
  261. package/src/BryntumList.tsx +891 -0
  262. package/src/BryntumMenu.tsx +1143 -0
  263. package/src/BryntumMonthPicker.tsx +1056 -0
  264. package/src/BryntumNumberField.tsx +1025 -0
  265. package/src/BryntumPagingToolbar.tsx +924 -0
  266. package/src/BryntumPanel.tsx +1035 -0
  267. package/src/BryntumPasswordField.tsx +969 -0
  268. package/src/BryntumProjectCombo.tsx +1232 -0
  269. package/src/BryntumRadio.tsx +1000 -0
  270. package/src/BryntumRadioGroup.tsx +1088 -0
  271. package/src/BryntumResourceCombo.tsx +1235 -0
  272. package/src/BryntumResourceFilter.tsx +930 -0
  273. package/src/BryntumScheduler.tsx +5182 -0
  274. package/src/BryntumSchedulerBase.tsx +5180 -0
  275. package/src/BryntumSchedulerDatePicker.tsx +1364 -0
  276. package/src/BryntumSchedulerProjectModel.tsx +423 -0
  277. package/src/BryntumSlideToggle.tsx +1000 -0
  278. package/src/BryntumSlider.tsx +815 -0
  279. package/src/BryntumSplitter.tsx +754 -0
  280. package/src/BryntumTabPanel.tsx +1087 -0
  281. package/src/BryntumTextAreaField.tsx +981 -0
  282. package/src/BryntumTextAreaPickerField.tsx +1002 -0
  283. package/src/BryntumTextField.tsx +987 -0
  284. package/src/BryntumThemeCombo.tsx +101 -0
  285. package/src/BryntumTimeField.tsx +1036 -0
  286. package/src/BryntumTimePicker.tsx +893 -0
  287. package/src/BryntumTimelineHistogram.tsx +3425 -0
  288. package/src/BryntumToolbar.tsx +917 -0
  289. package/src/BryntumTreeCombo.tsx +1230 -0
  290. package/src/BryntumTreeGrid.tsx +2401 -0
  291. package/src/BryntumUndoRedo.tsx +885 -0
  292. package/src/BryntumViewPresetCombo.tsx +914 -0
  293. package/src/BryntumWidget.tsx +715 -0
  294. package/src/BryntumYearPicker.tsx +1070 -0
  295. package/src/WrapperHelper.tsx +1125 -0
  296. package/src/index.ts +76 -0
@@ -0,0 +1,1036 @@
1
+ /**
2
+ * React wrapper for Bryntum TimeField
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AlignSpec, Base, ContainerItemConfig, DomConfig, DurationConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, TabConfig, TimeField, TimeFieldListeners, TooltipConfig, VueConfig, Widget, WidgetConfig } from '@bryntum/scheduler';
7
+
8
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
9
+
10
+ export type BryntumTimeFieldProps = {
11
+ // Configs
12
+ /**
13
+ * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
14
+ * content will be placed inside this element.
15
+ * ...
16
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-adopt)
17
+ */
18
+ adopt? : HTMLElement|string
19
+ /**
20
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
21
+ * ...
22
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-align)
23
+ */
24
+ align? : AlignSpec|string
25
+ /**
26
+ * When this widget is a child of a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container), it will by default be participating in a
27
+ * flexbox layout. This config allows you to set this widget's
28
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
29
+ */
30
+ alignSelf? : string
31
+ /**
32
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating) and being shown through [showBy](#Core/widget/Widget#function-showBy).*
33
+ * `true` to show a connector arrow pointing to the align target.
34
+ */
35
+ anchor? : boolean
36
+ /**
37
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
38
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
39
+ */
40
+ appendTo? : HTMLElement|string
41
+ /**
42
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
43
+ * into an element which will be linked using the `aria-describedby` attribute.
44
+ * ...
45
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-ariaDescription)
46
+ */
47
+ ariaDescription? : string
48
+ /**
49
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
50
+ * the `aria-label` attribute.
51
+ * ...
52
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-ariaLabel)
53
+ */
54
+ ariaLabel? : string
55
+ /**
56
+ * Sets the native `autocomplete` property of the underlying input element. For more information, please refer to
57
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
58
+ */
59
+ autoComplete? : string
60
+ /**
61
+ * Configure as `true` to have the picker expand upon focus enter.
62
+ */
63
+ autoExpand? : boolean
64
+ /**
65
+ * Specify `true` to auto select field contents on focus
66
+ */
67
+ autoSelect? : boolean
68
+ /**
69
+ * Initial text to show in badge.
70
+ */
71
+ badge? : string
72
+ /**
73
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
74
+ * hierarchy when triggered.
75
+ * ...
76
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-bubbleEvents)
77
+ */
78
+ bubbleEvents? : object
79
+ /**
80
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
81
+ * ...
82
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-callOnFunctions)
83
+ */
84
+ callOnFunctions? : boolean
85
+ /**
86
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
87
+ * application state is undefined. Code which follows the event handler will *not* be executed.
88
+ * ...
89
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-catchEventHandlerExceptions)
90
+ */
91
+ catchEventHandlerExceptions? : boolean
92
+ /**
93
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
94
+ * Set to `true` to centre the Widget in browser viewport space.
95
+ */
96
+ centered? : boolean
97
+ /**
98
+ * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#config-readOnly). The trigger is available
99
+ * in the [triggers](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
100
+ * configures the `clear` [trigger](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-triggers).
101
+ */
102
+ clearable? : boolean|FieldTriggerConfig
103
+ /**
104
+ * Custom CSS classes to add to element.
105
+ * May be specified as a space separated string, or as an object in which property names
106
+ * with truthy values are used as the class names:
107
+ * ...
108
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-cls)
109
+ */
110
+ cls? : string|object
111
+ /**
112
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
113
+ * `style` block.
114
+ * ...
115
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-color)
116
+ */
117
+ color? : string
118
+ /**
119
+ * Programmatic control over which column to start in when used in a grid layout.
120
+ */
121
+ column? : number
122
+ config? : object
123
+ /**
124
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating) or [positioned](#Core/widget/Widget#config-positioned).*
125
+ * Element, Widget or Rectangle to which this Widget is constrained.
126
+ */
127
+ constrainTo? : HTMLElement|Widget|Rectangle
128
+ /**
129
+ * The configuration for additional items associated to this field. This is typically used to add contextual
130
+ * fields related to a [checkbox](https://bryntum.com/products/scheduler/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
131
+ * these classes for examples of nested fields.
132
+ * ...
133
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-container)
134
+ */
135
+ container? : Record<string, ContainerItemConfig>|ContainerItemConfig[]|FieldContainerConfig|FieldContainer
136
+ /**
137
+ * The config controls how the value of nested items are handled when a parent container gets or sets its
138
+ * [values](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-values).
139
+ * ...
140
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-containValues)
141
+ * @param {Core.widget.Field} field Field instance
142
+ * @returns {boolean}
143
+ */
144
+ containValues? : boolean|string|((field: Field) => boolean)
145
+ /**
146
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
147
+ * May be specified as a space separated string, or as an object in which property names
148
+ * with truthy values are used as the class names:
149
+ * ...
150
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-contentElementCls)
151
+ */
152
+ contentElementCls? : string|object
153
+ /**
154
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
155
+ * field on the expanded record to use for populating this widget's store (if applicable)
156
+ */
157
+ dataField? : string
158
+ /**
159
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
160
+ */
161
+ dataset? : Record<string, string>
162
+ /**
163
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
164
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
165
+ */
166
+ defaultBindProperty? : string
167
+ /**
168
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
169
+ * ...
170
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-detectCSSCompatibilityIssues)
171
+ */
172
+ detectCSSCompatibilityIssues? : boolean
173
+ /**
174
+ * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
175
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
176
+ * ...
177
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-disabled)
178
+ */
179
+ disabled? : boolean|'inert'
180
+ /**
181
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel)
182
+ * [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
183
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
184
+ * body. Such widgets are called "edge strips".
185
+ * ...
186
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-dock)
187
+ */
188
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
189
+ /**
190
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
191
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
192
+ * property which controls when a drag should start.
193
+ * ...
194
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-draggable)
195
+ */
196
+ draggable? : boolean|{
197
+ handleSelector?: string
198
+ }
199
+ /**
200
+ * User can edit text in text field (otherwise only pick from attached picker)
201
+ */
202
+ editable? : boolean
203
+ /**
204
+ * An object specifying attributes to assign to the root element of this widget.
205
+ * Set `null` value to attribute to remove it.
206
+ * ...
207
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-elementAttributes)
208
+ */
209
+ elementAttributes? : Record<string, string|null>
210
+ extraData? : any
211
+ /**
212
+ * When this widget is a child of a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container), it will by default be participating in a
213
+ * flexbox layout. This config allows you to set this widget's
214
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
215
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
216
+ * numeric-only values are interpreted as the `flex-grow` value.
217
+ */
218
+ flex? : number|string
219
+ /**
220
+ * Set to `true` to move the widget out of the document flow and position it
221
+ * absolutely in browser viewport space.
222
+ */
223
+ floating? : boolean
224
+ /**
225
+ * Format for date displayed in field (see Core.helper.DateHelper#function-format-static for formatting
226
+ * options).
227
+ */
228
+ format? : string
229
+ /**
230
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
231
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
232
+ * cases this config is convenient.
233
+ */
234
+ height? : string|number
235
+ /**
236
+ * Configure with true to make widget initially hidden.
237
+ */
238
+ hidden? : boolean
239
+ /**
240
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
241
+ * ...
242
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-hideAnimation)
243
+ */
244
+ hideAnimation? : boolean|object
245
+ /**
246
+ * Specify `true` to highlight field after external value changes
247
+ */
248
+ highlightExternalChange? : boolean
249
+ /**
250
+ * An optional string to display inside the input field as an overlay. This can be useful for displaying
251
+ * a field's units.
252
+ * ...
253
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-hint)
254
+ * @param {object} data A data object
255
+ * @param {Core.widget.Field} data.source A reference to the field instance
256
+ * @param {any} data.value The current value of the field
257
+ * @returns {string}
258
+ */
259
+ hint? : string|((data: { source: Field, value: any }) => string)
260
+ /**
261
+ * This config is similar to [hint](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#config-hint) except that this config is used to display HTML content.
262
+ * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
263
+ * encode such data (see [encodeHtml](https://bryntum.com/products/scheduler/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
264
+ * ...
265
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-hintHtml)
266
+ * @param {object} data A data object
267
+ * @param {Core.widget.Field} data.source A reference to the field instance
268
+ * @param {any} data.value The current value of the field
269
+ * @returns {string}
270
+ */
271
+ hintHtml? : string|((data: { source: Field, value: any }) => string)
272
+ /**
273
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
274
+ */
275
+ id? : string
276
+ /**
277
+ * Determines if the widgets read-only state should be controlled by its parent.
278
+ * ...
279
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-ignoreParentReadOnly)
280
+ */
281
+ ignoreParentReadOnly? : boolean
282
+ /**
283
+ * Set this config to `true` to always display items horizontally along with this field. This assigns an
284
+ * [hbox](https://bryntum.com/products/scheduler/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
285
+ * [container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#config-container).
286
+ * ...
287
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-inline)
288
+ */
289
+ inline? : boolean
290
+ /**
291
+ * Text alignment for the input field.
292
+ */
293
+ inputAlign? : string
294
+ /**
295
+ * Sets custom attributes of the underlying input element. For more information, please refer to
296
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes)
297
+ */
298
+ inputAttributes? : Record<string, string>
299
+ /**
300
+ * If you need to use something else than a default `input` element, as the input element, provide the tag
301
+ * name here. Please note that this is used for advanced usage only, for example when using WebComponents
302
+ * (custom elements), and that the configured element must fulfil the same contract as a regular input
303
+ * element.
304
+ */
305
+ inputTag? : string
306
+ /**
307
+ * Sets the `type` attribute of the underlying input element (password, hidden, date, color, etc.).
308
+ */
309
+ inputType? : string
310
+ /**
311
+ * The width to apply to the `.b-field-inner` element, which encompasses the `input` element and any
312
+ * triggers. If a number is specified, `px` will be used.
313
+ */
314
+ inputWidth? : string|number
315
+ /**
316
+ * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
317
+ */
318
+ insertBefore? : HTMLElement|string
319
+ /**
320
+ * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
321
+ */
322
+ insertFirst? : HTMLElement|string
323
+ /**
324
+ * Set to true to not clean up the date part of the passed value. Set to false to reset the date part to
325
+ * January 1st
326
+ */
327
+ keepDate? : boolean
328
+ /**
329
+ * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
330
+ * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
331
+ * are the name of the instance method to call when the keystroke is received.
332
+ * ...
333
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-keyMap)
334
+ */
335
+ keyMap? : Record<string, KeyMapConfig>
336
+ /**
337
+ * The delay in milliseconds to wait after the last keystroke before triggering a change event.
338
+ * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
339
+ * immediate feedback, change will still be triggered on blur).
340
+ * ...
341
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-keyStrokeChangeDelay)
342
+ */
343
+ keyStrokeChangeDelay? : number
344
+ /**
345
+ * Label, prepended to field
346
+ */
347
+ label? : string
348
+ /**
349
+ * CSS class name or class names to add to any configured [label](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Labelable#config-label)
350
+ */
351
+ labelCls? : string|object
352
+ /**
353
+ * Label position, either 'before' the field or 'above' the field
354
+ * ...
355
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-labelPosition)
356
+ */
357
+ labelPosition? : 'before'|'above'|null
358
+ /**
359
+ * The labels to add either before or after the input field.
360
+ * Each label may have the following properties:
361
+ * ...
362
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-labels)
363
+ */
364
+ labels? : object[]
365
+ /**
366
+ * The width to apply to the `&lt;label&gt;` element. If a number is specified, `px` will be used.
367
+ */
368
+ labelWidth? : string|number
369
+ /**
370
+ * The listener set for this object.
371
+ * ...
372
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-listeners)
373
+ */
374
+ listeners? : TimeFieldListeners
375
+ /**
376
+ * A class translations of which are used for translating this entity.
377
+ * This is often used when translations of an item are defined on its container class.
378
+ * For example:
379
+ * ...
380
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-localeClass)
381
+ */
382
+ localeClass? : typeof Base
383
+ /**
384
+ * Set to `false` to disable localization of this object.
385
+ */
386
+ localizable? : boolean
387
+ /**
388
+ * List of properties which values should be translated automatically upon a locale applying.
389
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
390
+ * you could use 'localeKey' meta configuration.
391
+ * Example:
392
+ * ...
393
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-localizableProperties)
394
+ */
395
+ localizableProperties? : string[]
396
+ /**
397
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
398
+ * numeric-only values are interpreted as pixels.
399
+ */
400
+ margin? : number|string
401
+ /**
402
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) created for the
403
+ * [masked](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
404
+ * values.
405
+ */
406
+ maskDefaults? : MaskConfig
407
+ /**
408
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
409
+ * [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object.
410
+ */
411
+ masked? : boolean|string|MaskConfig
412
+ /**
413
+ * Max time value
414
+ */
415
+ max? : string|Date
416
+ /**
417
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
418
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
419
+ */
420
+ maxHeight? : string|number
421
+ /**
422
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
423
+ * ...
424
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-maximizeOnMobile)
425
+ */
426
+ maximizeOnMobile? : number|string
427
+ /**
428
+ * The max number of characters for the input field
429
+ */
430
+ maxLength? : number
431
+ /**
432
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
433
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
434
+ */
435
+ maxWidth? : string|number
436
+ /**
437
+ * Min time value
438
+ */
439
+ min? : string|Date
440
+ /**
441
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
442
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
443
+ */
444
+ minHeight? : string|number
445
+ /**
446
+ * The min number of characters for the input field
447
+ */
448
+ minLength? : number
449
+ /**
450
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
451
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
452
+ */
453
+ minWidth? : string|number
454
+ /**
455
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
456
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
457
+ * layout.
458
+ * ...
459
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-monitorResize)
460
+ */
461
+ monitorResize? : boolean|{
462
+ immediate?: boolean
463
+ }
464
+ /**
465
+ * Name of the field which is used as a key to get/set values from/to the field.
466
+ * Used prior to [ref](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
467
+ * [Container.values](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-values).
468
+ * ...
469
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-name)
470
+ */
471
+ name? : string
472
+ /**
473
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
474
+ * [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
475
+ * the owner is <strong>always</strong> the encapsulating Container.
476
+ * ...
477
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-owner)
478
+ */
479
+ owner? : Widget|any
480
+ /**
481
+ * Configuration object for the [picker](https://bryntum.com/products/scheduler/docs/api/Core/widget/List) on initialization. Returns the
482
+ * [picker](https://bryntum.com/products/scheduler/docs/api/Core/widget/List) instance at runtime.
483
+ * ...
484
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-picker)
485
+ */
486
+ picker? : object|Widget|WidgetConfig
487
+ /**
488
+ * The name of the element property to which the picker should size and align itself.
489
+ */
490
+ pickerAlignElement? : string
491
+ /**
492
+ * Text to display in empty field.
493
+ */
494
+ placeholder? : string
495
+ /**
496
+ * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement), but must
497
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
498
+ * widget's [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
499
+ * ...
500
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-positioned)
501
+ */
502
+ positioned? : boolean
503
+ /**
504
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
505
+ * menu on click etc, since the tooltip would be displayed at the same time.
506
+ */
507
+ preventTooltipOnTouch? : boolean
508
+ /**
509
+ * Makes the field unmodifiable by user action. The input area is not editable, and triggers
510
+ * are unresponsive.
511
+ * ...
512
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-readOnly)
513
+ */
514
+ readOnly? : boolean
515
+ relayStoreEvents? : boolean
516
+ /**
517
+ * Predefined style to use for the field. Possible values are:
518
+ * ...
519
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-rendition)
520
+ */
521
+ rendition? : 'outlined'|'filled'|string
522
+ /**
523
+ * Configure as `true` to indicate that a `null` field value is to be marked as invalid. This will
524
+ * optionally append a * to the field label if [showRequiredIndicator](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-showRequiredIndicator) is set.
525
+ */
526
+ required? : boolean
527
+ /**
528
+ * If this field is not [readOnly](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
529
+ * the `ESCAPE` key after editing the field will revert the field to the value it had when
530
+ * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#config-clearable)
531
+ * behaviour will be activated.
532
+ */
533
+ revertOnEscape? : boolean
534
+ /**
535
+ * Configure as `true` to have the component display a translucent ripple when its
536
+ * [focusElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
537
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
538
+ * ...
539
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-ripple)
540
+ */
541
+ ripple? : boolean|{
542
+ delegate?: string
543
+ color?: string
544
+ radius?: number
545
+ clip?: string
546
+ }
547
+ /**
548
+ * If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
549
+ */
550
+ rootElement? : ShadowRoot|HTMLElement
551
+ /**
552
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
553
+ * ...
554
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-rtl)
555
+ */
556
+ rtl? : boolean
557
+ /**
558
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
559
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
560
+ */
561
+ scrollAction? : 'hide'|'realign'|null
562
+ /**
563
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
564
+ * ...
565
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-showAnimation)
566
+ */
567
+ showAnimation? : boolean|object
568
+ /**
569
+ * `true` to automatically display a * after the label for this field when it is [required](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-required).
570
+ */
571
+ showRequiredIndicator? : string
572
+ /**
573
+ * Set to `false` to not show the tooltip when this widget is [disabled](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-disabled)
574
+ */
575
+ showTooltipWhenDisabled? : boolean
576
+ /**
577
+ * Set to `true`, completely bypasses validation logic (could be userful if your field is not `editable`
578
+ * to the user).
579
+ */
580
+ skipValidation? : boolean
581
+ /**
582
+ * Programmatic control over how many columns to span when used in a grid layout.
583
+ */
584
+ span? : number
585
+ /**
586
+ * Sets the native `spellcheck` property of the underlying input element. For more information, please refer to
587
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck)
588
+ */
589
+ spellCheck? : boolean
590
+ /**
591
+ * Time increment duration value. Defaults to 5 minutes.
592
+ * The value is taken to be a string consisting of the numeric magnitude and the units.
593
+ * The units may be a recognised unit abbreviation of this locale or the full local unit name.
594
+ * For example `"10m"` or `"5min"` or `"2 hours"`
595
+ */
596
+ step? : string|number|DurationConfig
597
+ /**
598
+ * Set to `false` to hide the forward and backward time step triggers.
599
+ */
600
+ stepTriggers? : boolean
601
+ /**
602
+ * A configuration for the [tab](https://bryntum.com/products/scheduler/docs/api/Core/widget/Tab) created for this widget when it is placed in a
603
+ * [TabPanel](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
604
+ * this widget:
605
+ * ...
606
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-tab)
607
+ */
608
+ tab? : boolean|TabConfig
609
+ /**
610
+ * The tab index of the input field or fields, or `null` for natural tab order (recommended). Setting to `0`
611
+ * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
612
+ * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
613
+ * to the element programmatically.
614
+ * ...
615
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-tabIndex)
616
+ */
617
+ tabIndex? : number
618
+ /**
619
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
620
+ * ...
621
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-textAlign)
622
+ */
623
+ textAlign? : 'left'|'center'|'right'|'start'|'end'
624
+ /**
625
+ * A title to display for the widget. Only in effect when inside a container that uses it (such as TabPanel)
626
+ */
627
+ title? : string
628
+ /**
629
+ * Tooltip for the widget, either as a string or as a Tooltip config object.
630
+ * ...
631
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-tooltip)
632
+ */
633
+ tooltip? : string|TooltipConfig|null
634
+ /**
635
+ * Widgets that trigger functionality upon click. Each trigger icon is a [Widget](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget) instance
636
+ * which may be hidden, shown and observed and styled just like any other widget.
637
+ */
638
+ triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
639
+ type? : 'timefield'|'time'
640
+ /**
641
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
642
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
643
+ * values are used as the class names.
644
+ * ...
645
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-ui)
646
+ */
647
+ ui? : string|object
648
+ /**
649
+ * Set to `false` to not highlight a field as invalid while typing, to instead show it on ENTER key press
650
+ * or similar.
651
+ */
652
+ validateOnInput? : boolean
653
+ /**
654
+ * Value, which can be a Date or a string. If a string is specified, it will be converted using the
655
+ * specified [format](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-format).
656
+ * *When converted to a [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date), the date part is set to January 1st of the year 2020.*
657
+ */
658
+ value? : string|Date
659
+ /**
660
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container).
661
+ * Higher weights go further down.
662
+ */
663
+ weight? : number
664
+ /**
665
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
666
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
667
+ * this config is convenient.
668
+ */
669
+ width? : string|number
670
+ /**
671
+ * The x position for the widget.
672
+ * ...
673
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-x)
674
+ */
675
+ x? : number
676
+ /**
677
+ * The y position for the widget.
678
+ * ...
679
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#config-y)
680
+ */
681
+ y? : number
682
+
683
+ // Events
684
+ /**
685
+ * User performed default action (typed into this field).
686
+ * @param {object} event Event object
687
+ * @param {Core.widget.Field,any} event.source This Field
688
+ * @param {string,number,boolean,any} event.value This field's value
689
+ * @param {string,number,boolean,any} event.oldValue This field's previous value
690
+ * @param {boolean} event.valid True if this field is in a valid state
691
+ * @param {Event} event.event The triggering DOM event if any
692
+ * @param {Core.data.Model} event.record Selected record. Available for fields with records selection functionality
693
+ * @param {Core.data.Model[]} event.records Selected records as an array. Available for fields with records selection functionality
694
+ * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
695
+ * @param {boolean} event.checked
696
+ */
697
+ onAction? : ((event: { source: Field|any, value: string|number|boolean|any, oldValue: string|number|boolean|any, valid: boolean, event: Event, record: Model, records: Model[], userAction: boolean, checked: boolean }) => void)|string
698
+ /**
699
+ * Fires before an object is destroyed.
700
+ * @param {object} event Event object
701
+ * @param {Core.Base} event.source The Object that is being destroyed.
702
+ */
703
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
704
+ /**
705
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
706
+ * @param {object} event Event object
707
+ * @param {Core.widget.Widget} event.source The widget being hidden.
708
+ */
709
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
710
+ /**
711
+ * Triggered before a widget is shown. Return `false` to prevent the action.
712
+ * @param {object} event Event object
713
+ * @param {Core.widget.Widget,any} event.source The widget being shown
714
+ */
715
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
716
+ /**
717
+ * Fires when any other event is fired from the object.
718
+ * ...
719
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#event-catchAll)
720
+ * @param {object} event Event object
721
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
722
+ * @param {string} event.event.type The type of the event which is caught by the listener
723
+ */
724
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
725
+ /**
726
+ * Fired when this field's value changes.
727
+ * @param {object} event Event object
728
+ * @param {Core.widget.Field,any} event.source This Field
729
+ * @param {string,number,boolean,any} event.value This field's value
730
+ * @param {string,number,boolean,any} event.oldValue This field's previous value
731
+ * @param {boolean} event.valid True if this field is in a valid state
732
+ * @param {Event} event.event The triggering DOM event if any
733
+ * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
734
+ * @param {boolean} event.checked
735
+ */
736
+ onChange? : ((event: { source: Field|any, value: string|number|boolean|any, oldValue: string|number|boolean|any, valid: boolean, event: Event, userAction: boolean, checked: boolean }) => void)|string
737
+ /**
738
+ * Fired when this field is [cleared](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#function-clear).
739
+ * ...
740
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#event-clear)
741
+ * @param {object} event Event object
742
+ * @param {Core.widget.Field,any} event.source This Field
743
+ */
744
+ onClear? : ((event: { source: Field|any }) => void)|string
745
+ /**
746
+ * Fires when an object is destroyed.
747
+ * @param {object} event Event object
748
+ * @param {Core.Base} event.source The Object that is being destroyed.
749
+ */
750
+ onDestroy? : ((event: { source: Base }) => void)|string
751
+ /**
752
+ * Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
753
+ * @param {object} event Event object
754
+ * @param {HTMLElement} event.element The Widget's element.
755
+ */
756
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
757
+ /**
758
+ * Fired when focus enters this Widget.
759
+ * @param {object} event Event object
760
+ * @param {Core.widget.Widget} event.source This Widget
761
+ * @param {HTMLElement} event.fromElement The element which lost focus.
762
+ * @param {HTMLElement} event.toElement The element which gained focus.
763
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
764
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
765
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
766
+ */
767
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
768
+ /**
769
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
770
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
771
+ * will not trigger this event. This is when focus exits this widget completely.
772
+ * @param {object} event Event object
773
+ * @param {Core.widget.Widget} event.source This Widget
774
+ * @param {HTMLElement} event.fromElement The element which lost focus.
775
+ * @param {HTMLElement} event.toElement The element which gained focus.
776
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
777
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
778
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
779
+ */
780
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
781
+ /**
782
+ * Triggered after a widget was hidden
783
+ * @param {object} event Event object
784
+ * @param {Core.widget.Widget} event.source The widget
785
+ */
786
+ onHide? : ((event: { source: Widget }) => void)|string
787
+ /**
788
+ * Fired when the user types into this field.
789
+ * @param {object} event Event object
790
+ * @param {Core.widget.Field,any} event.source This field
791
+ * @param {string,number,boolean,any} event.value This field's value
792
+ * @param {Event} event.event The triggering DOM event
793
+ */
794
+ onInput? : ((event: { source: Field|any, value: string|number|boolean|any, event: Event }) => void)|string
795
+ /**
796
+ * Triggered when a widget which had been in a non-visible state for any reason
797
+ * achieves visibility.
798
+ * ...
799
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/TimeField#event-paint)
800
+ * @param {object} event Event object
801
+ * @param {Core.widget.Widget} event.source The widget being painted.
802
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
803
+ */
804
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
805
+ /**
806
+ * Fired when a Widget's read only state is toggled
807
+ * @param {object} event Event object
808
+ * @param {boolean} event.readOnly Read only or not
809
+ */
810
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
811
+ /**
812
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
813
+ * to [recompose](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
814
+ */
815
+ onRecompose? : (() => void)|string
816
+ /**
817
+ * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
818
+ * @param {object} event Event object
819
+ * @param {Core.widget.Widget} event.source This Widget
820
+ * @param {number} event.width The new width
821
+ * @param {number} event.height The new height
822
+ * @param {number} event.oldWidth The old width
823
+ * @param {number} event.oldHeight The old height
824
+ */
825
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
826
+ /**
827
+ * Triggered after a widget is shown.
828
+ * @param {object} event Event object
829
+ * @param {Core.widget.Widget} event.source The widget
830
+ */
831
+ onShow? : ((event: { source: Widget }) => void)|string
832
+ /**
833
+ * User clicked one of this field's [triggers](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-triggers)
834
+ * @param {object} event Event object
835
+ * @param {Core.widget.Field,any} event.source This field
836
+ * @param {Core.widget.Widget} event.trigger The trigger activated by click or touch tap.
837
+ */
838
+ onTrigger? : ((event: { source: Field|any, trigger: Widget }) => void)|string
839
+
840
+ }
841
+
842
+ export class BryntumTimeField extends React.Component<BryntumTimeFieldProps> {
843
+
844
+ static instanceClass = TimeField;
845
+
846
+ static instanceName = 'TimeField';
847
+
848
+ processWidgetContent = processWidgetContent;
849
+
850
+ static configNames = [
851
+ 'adopt',
852
+ 'align',
853
+ 'anchor',
854
+ 'ariaDescription',
855
+ 'ariaLabel',
856
+ 'autoComplete',
857
+ 'autoExpand',
858
+ 'autoSelect',
859
+ 'bubbleEvents',
860
+ 'centered',
861
+ 'clearable',
862
+ 'color',
863
+ 'config',
864
+ 'constrainTo',
865
+ 'container',
866
+ 'containValues',
867
+ 'contentElementCls',
868
+ 'dataField',
869
+ 'defaultBindProperty',
870
+ 'detectCSSCompatibilityIssues',
871
+ 'dock',
872
+ 'draggable',
873
+ 'elementAttributes',
874
+ 'floating',
875
+ 'hideAnimation',
876
+ 'highlightExternalChange',
877
+ 'hint',
878
+ 'hintHtml',
879
+ 'ignoreParentReadOnly',
880
+ 'inline',
881
+ 'inputAlign',
882
+ 'inputAttributes',
883
+ 'inputTag',
884
+ 'inputType',
885
+ 'inputWidth',
886
+ 'keyStrokeChangeDelay',
887
+ 'labelCls',
888
+ 'labelPosition',
889
+ 'labels',
890
+ 'labelWidth',
891
+ 'listeners',
892
+ 'localeClass',
893
+ 'localizable',
894
+ 'localizableProperties',
895
+ 'maskDefaults',
896
+ 'masked',
897
+ 'maxLength',
898
+ 'minLength',
899
+ 'monitorResize',
900
+ 'name',
901
+ 'owner',
902
+ 'picker',
903
+ 'pickerAlignElement',
904
+ 'positioned',
905
+ 'preventTooltipOnTouch',
906
+ 'relayStoreEvents',
907
+ 'revertOnEscape',
908
+ 'ripple',
909
+ 'rootElement',
910
+ 'scrollAction',
911
+ 'showAnimation',
912
+ 'showTooltipWhenDisabled',
913
+ 'skipValidation',
914
+ 'spellCheck',
915
+ 'stepTriggers',
916
+ 'tab',
917
+ 'tabIndex',
918
+ 'textAlign',
919
+ 'title',
920
+ 'type',
921
+ 'ui',
922
+ 'validateOnInput',
923
+ 'weight'
924
+ ];
925
+
926
+ static propertyConfigNames = [
927
+ 'alignSelf',
928
+ 'appendTo',
929
+ 'badge',
930
+ 'callOnFunctions',
931
+ 'catchEventHandlerExceptions',
932
+ 'cls',
933
+ 'column',
934
+ 'dataset',
935
+ 'disabled',
936
+ 'editable',
937
+ 'extraData',
938
+ 'flex',
939
+ 'format',
940
+ 'height',
941
+ 'hidden',
942
+ 'id',
943
+ 'insertBefore',
944
+ 'insertFirst',
945
+ 'keepDate',
946
+ 'keyMap',
947
+ 'label',
948
+ 'margin',
949
+ 'max',
950
+ 'maxHeight',
951
+ 'maximizeOnMobile',
952
+ 'maxWidth',
953
+ 'min',
954
+ 'minHeight',
955
+ 'minWidth',
956
+ 'onAction',
957
+ 'onBeforeDestroy',
958
+ 'onBeforeHide',
959
+ 'onBeforeShow',
960
+ 'onCatchAll',
961
+ 'onChange',
962
+ 'onClear',
963
+ 'onDestroy',
964
+ 'onElementCreated',
965
+ 'onFocusIn',
966
+ 'onFocusOut',
967
+ 'onHide',
968
+ 'onInput',
969
+ 'onPaint',
970
+ 'onReadOnly',
971
+ 'onRecompose',
972
+ 'onResize',
973
+ 'onShow',
974
+ 'onTrigger',
975
+ 'placeholder',
976
+ 'readOnly',
977
+ 'rendition',
978
+ 'required',
979
+ 'rtl',
980
+ 'showRequiredIndicator',
981
+ 'span',
982
+ 'step',
983
+ 'tooltip',
984
+ 'triggers',
985
+ 'value',
986
+ 'width',
987
+ 'x',
988
+ 'y'
989
+ ];
990
+
991
+ static propertyNames = [
992
+ 'anchorSize',
993
+ 'content',
994
+ 'focusVisible',
995
+ 'formula',
996
+ 'html',
997
+ 'input',
998
+ 'parent',
999
+ 'scrollable'
1000
+ ];
1001
+
1002
+ // Component instance
1003
+ instance!: TimeField;
1004
+
1005
+ // Component element
1006
+ element! : HTMLElement;
1007
+
1008
+ componentDidMount(): void {
1009
+ this.instance = createWidget(this);
1010
+ }
1011
+
1012
+ componentWillUnmount(): void {
1013
+ // @ts-ignore
1014
+ this.instance?.destroy?.();
1015
+ }
1016
+
1017
+ /**
1018
+ * Component about to be updated, from changing a prop using state.
1019
+ * React to it depending on what changed and prevent react from re-rendering our component.
1020
+ * @param nextProps
1021
+ * @param nextState
1022
+ * @returns {boolean}
1023
+ */
1024
+ shouldComponentUpdate(nextProps: Readonly<BryntumTimeFieldProps>, nextState: Readonly<{}>): boolean {
1025
+ return shouldComponentUpdate(this, nextProps, nextState);
1026
+ }
1027
+
1028
+ render(): React.ReactNode {
1029
+
1030
+ const className = `b-react-time-field-container`;
1031
+ return (
1032
+ <div className={className} ref={(element) => (this.element = element!)}></div>
1033
+ );
1034
+
1035
+ }
1036
+ }