@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,914 @@
1
+ /**
2
+ * React wrapper for Bryntum ViewPresetCombo
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AlignSpec, Base, Combo, ComboModel, Duration, DurationConfig, Field, KeyMapConfig, List, ListConfig, MaskConfig, Model, Rectangle, TabConfig, TimelineBase, TooltipConfig, ViewPresetCombo, ViewPresetComboListeners, Widget } from '@bryntum/scheduler';
7
+
8
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
9
+
10
+ export type BryntumViewPresetComboProps = {
11
+ // Configs
12
+ /**
13
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
14
+ * ...
15
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-align)
16
+ */
17
+ align? : AlignSpec|string
18
+ /**
19
+ * 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
20
+ * flexbox layout. This config allows you to set this widget's
21
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
22
+ */
23
+ alignSelf? : string
24
+ /**
25
+ * *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).*
26
+ * `true` to show a connector arrow pointing to the align target.
27
+ */
28
+ anchor? : boolean
29
+ /**
30
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
31
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
32
+ */
33
+ appendTo? : HTMLElement|string
34
+ /**
35
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
36
+ * into an element which will be linked using the `aria-describedby` attribute.
37
+ * ...
38
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-ariaDescription)
39
+ */
40
+ ariaDescription? : string
41
+ /**
42
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
43
+ * the `aria-label` attribute.
44
+ * ...
45
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-ariaLabel)
46
+ */
47
+ ariaLabel? : string
48
+ /**
49
+ * Initial text to show in badge.
50
+ */
51
+ badge? : string
52
+ /**
53
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
54
+ * hierarchy when triggered.
55
+ * ...
56
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-bubbleEvents)
57
+ */
58
+ bubbleEvents? : object
59
+ /**
60
+ * Enable caching of the last retrieved result until the timeout is reached.
61
+ * ...
62
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-cacheLastResult)
63
+ */
64
+ cacheLastResult? : number|string|Duration|DurationConfig
65
+ /**
66
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
67
+ * ...
68
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-callOnFunctions)
69
+ */
70
+ callOnFunctions? : boolean
71
+ /**
72
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
73
+ * application state is undefined. Code which follows the event handler will *not* be executed.
74
+ * ...
75
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-catchEventHandlerExceptions)
76
+ */
77
+ catchEventHandlerExceptions? : boolean
78
+ /**
79
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
80
+ * Set to `true` to centre the Widget in browser viewport space.
81
+ */
82
+ centered? : boolean
83
+ /**
84
+ * Specify `false` to not clear value typed to a multiselect combo when an item is selected.
85
+ */
86
+ clearTextOnSelection? : boolean
87
+ /**
88
+ * Set to `true` to clear this field when user empties the input element
89
+ */
90
+ clearWhenInputEmpty? : boolean
91
+ /**
92
+ * If not added to a toolbar, provide a Scheduler, SchedulerPro or Gantt component instance to which the
93
+ * ViewPresetCombo should be connected.
94
+ */
95
+ client? : TimelineBase
96
+ /**
97
+ * Custom CSS classes to add to element.
98
+ * May be specified as a space separated string, or as an object in which property names
99
+ * with truthy values are used as the class names:
100
+ * ...
101
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-cls)
102
+ */
103
+ cls? : string|object
104
+ /**
105
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
106
+ * `style` block.
107
+ * ...
108
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-color)
109
+ */
110
+ color? : string
111
+ /**
112
+ * Programmatic control over which column to start in when used in a grid layout.
113
+ */
114
+ column? : number
115
+ config? : object
116
+ /**
117
+ * *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).*
118
+ * Element, Widget or Rectangle to which this Widget is constrained.
119
+ */
120
+ constrainTo? : HTMLElement|Widget|Rectangle
121
+ /**
122
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
123
+ * May be specified as a space separated string, or as an object in which property names
124
+ * with truthy values are used as the class names:
125
+ * ...
126
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-contentElementCls)
127
+ */
128
+ contentElementCls? : string|object
129
+ /**
130
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
131
+ * field on the expanded record to use for populating this widget's store (if applicable)
132
+ */
133
+ dataField? : string
134
+ /**
135
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
136
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
137
+ */
138
+ defaultBindProperty? : string
139
+ /**
140
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
141
+ * ...
142
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-detectCSSCompatibilityIssues)
143
+ */
144
+ detectCSSCompatibilityIssues? : boolean
145
+ /**
146
+ * 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
147
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
148
+ * ...
149
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-disabled)
150
+ */
151
+ disabled? : boolean|'inert'
152
+ /**
153
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel)
154
+ * [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
155
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
156
+ * body. Such widgets are called "edge strips".
157
+ * ...
158
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-dock)
159
+ */
160
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
161
+ /**
162
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
163
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
164
+ * property which controls when a drag should start.
165
+ * ...
166
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-draggable)
167
+ */
168
+ draggable? : boolean|{
169
+ handleSelector?: string
170
+ }
171
+ /**
172
+ * User can edit text in text field (otherwise only pick from attached picker)
173
+ */
174
+ editable? : boolean
175
+ /**
176
+ * An object specifying attributes to assign to the root element of this widget.
177
+ * Set `null` value to attribute to remove it.
178
+ * ...
179
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-elementAttributes)
180
+ */
181
+ elementAttributes? : Record<string, string|null>
182
+ extraData? : any
183
+ /**
184
+ * 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
185
+ * flexbox layout. This config allows you to set this widget's
186
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
187
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
188
+ * numeric-only values are interpreted as the `flex-grow` value.
189
+ */
190
+ flex? : number|string
191
+ /**
192
+ * Set to `true` to move the widget out of the document flow and position it
193
+ * absolutely in browser viewport space.
194
+ */
195
+ floating? : boolean
196
+ /**
197
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
198
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
199
+ * cases this config is convenient.
200
+ */
201
+ height? : string|number
202
+ /**
203
+ * Configure with true to make widget initially hidden.
204
+ */
205
+ hidden? : boolean
206
+ /**
207
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
208
+ * ...
209
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-hideAnimation)
210
+ */
211
+ hideAnimation? : boolean|object
212
+ /**
213
+ * By default, the picker is hidden on selection in single select mode, and
214
+ * remains to allow more selections when [multiSelect](https://bryntum.com/products/scheduler/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
215
+ * Setting this to a `Boolean` value can override that default.
216
+ */
217
+ hidePickerOnSelect? : boolean
218
+ /**
219
+ * An optional string to display inside the input field as an overlay. This can be useful for displaying
220
+ * a field's units.
221
+ * ...
222
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-hint)
223
+ * @param {object} data A data object
224
+ * @param {Core.widget.Field} data.source A reference to the field instance
225
+ * @param {any} data.value The current value of the field
226
+ * @returns {string}
227
+ */
228
+ hint? : string|((data: { source: Field, value: any }) => string)
229
+ /**
230
+ * 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.
231
+ * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
232
+ * encode such data (see [encodeHtml](https://bryntum.com/products/scheduler/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
233
+ * ...
234
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-hintHtml)
235
+ * @param {object} data A data object
236
+ * @param {Core.widget.Field} data.source A reference to the field instance
237
+ * @param {any} data.value The current value of the field
238
+ * @returns {string}
239
+ */
240
+ hintHtml? : string|((data: { source: Field, value: any }) => string)
241
+ /**
242
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
243
+ */
244
+ id? : string
245
+ /**
246
+ * Determines if the widgets read-only state should be controlled by its parent.
247
+ * ...
248
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-ignoreParentReadOnly)
249
+ */
250
+ ignoreParentReadOnly? : boolean
251
+ /**
252
+ * Text alignment for the input field.
253
+ */
254
+ inputAlign? : string
255
+ /**
256
+ * Sets custom attributes of the underlying input element. For more information, please refer to
257
+ * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes)
258
+ */
259
+ inputAttributes? : Record<string, string>
260
+ /**
261
+ * If you need to use something else than a default `input` element, as the input element, provide the tag
262
+ * name here. Please note that this is used for advanced usage only, for example when using WebComponents
263
+ * (custom elements), and that the configured element must fulfil the same contract as a regular input
264
+ * element.
265
+ */
266
+ inputTag? : string
267
+ /**
268
+ * The width to apply to the `.b-field-inner` element, which encompasses the `input` element and any
269
+ * triggers. If a number is specified, `px` will be used.
270
+ */
271
+ inputWidth? : string|number
272
+ /**
273
+ * 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.
274
+ */
275
+ insertBefore? : HTMLElement|string
276
+ /**
277
+ * 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.
278
+ */
279
+ insertFirst? : HTMLElement|string
280
+ /**
281
+ * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
282
+ * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
283
+ * are the name of the instance method to call when the keystroke is received.
284
+ * ...
285
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-keyMap)
286
+ */
287
+ keyMap? : Record<string, KeyMapConfig>
288
+ /**
289
+ * Label, prepended to field
290
+ */
291
+ label? : string
292
+ /**
293
+ * 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)
294
+ */
295
+ labelCls? : string|object
296
+ /**
297
+ * Label position, either 'before' the field or 'above' the field
298
+ * ...
299
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-labelPosition)
300
+ */
301
+ labelPosition? : 'before'|'above'|null
302
+ /**
303
+ * The labels to add either before or after the input field.
304
+ * Each label may have the following properties:
305
+ * ...
306
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-labels)
307
+ */
308
+ labels? : object[]
309
+ /**
310
+ * The width to apply to the `&lt;label&gt;` element. If a number is specified, `px` will be used.
311
+ */
312
+ labelWidth? : string|number
313
+ /**
314
+ * CSS class to add to picker
315
+ */
316
+ listCls? : string
317
+ /**
318
+ * The listener set for this object.
319
+ * ...
320
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-listeners)
321
+ */
322
+ listeners? : ViewPresetComboListeners
323
+ /**
324
+ * Template string used to render the list items in the dropdown list
325
+ * ...
326
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-listItemTpl)
327
+ * @param {Core.data.Model} record The record representing the item being rendered
328
+ * @returns {string,void}
329
+ */
330
+ listItemTpl? : (record: Model|ComboModel) => string|void
331
+ /**
332
+ * A class translations of which are used for translating this entity.
333
+ * This is often used when translations of an item are defined on its container class.
334
+ * For example:
335
+ * ...
336
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-localeClass)
337
+ */
338
+ localeClass? : typeof Base
339
+ /**
340
+ * Set to `false` to disable localization of this object.
341
+ */
342
+ localizable? : boolean
343
+ /**
344
+ * List of properties which values should be translated automatically upon a locale applying.
345
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
346
+ * you could use 'localeKey' meta configuration.
347
+ * Example:
348
+ * ...
349
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-localizableProperties)
350
+ */
351
+ localizableProperties? : string[]
352
+ /**
353
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
354
+ * numeric-only values are interpreted as pixels.
355
+ */
356
+ margin? : number|string
357
+ /**
358
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) created for the
359
+ * [masked](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
360
+ * values.
361
+ */
362
+ maskDefaults? : MaskConfig
363
+ /**
364
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
365
+ * [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object.
366
+ */
367
+ masked? : boolean|string|MaskConfig
368
+ /**
369
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
370
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
371
+ */
372
+ maxHeight? : string|number
373
+ /**
374
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
375
+ * ...
376
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-maximizeOnMobile)
377
+ */
378
+ maximizeOnMobile? : number|string
379
+ /**
380
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
381
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
382
+ */
383
+ maxWidth? : string|number
384
+ /**
385
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
386
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
387
+ */
388
+ minHeight? : string|number
389
+ /**
390
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
391
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
392
+ */
393
+ minWidth? : string|number
394
+ /**
395
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
396
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
397
+ * layout.
398
+ * ...
399
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-monitorResize)
400
+ */
401
+ monitorResize? : boolean|{
402
+ immediate?: boolean
403
+ }
404
+ /**
405
+ * Name of the field which is used as a key to get/set values from/to the field.
406
+ * Used prior to [ref](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
407
+ * [Container.values](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-values).
408
+ * ...
409
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-name)
410
+ */
411
+ name? : string
412
+ /**
413
+ * This implies that the picker will display an anchor pointer, but also means that the picker will align closer
414
+ * to the input field so that the pointer pierces the [pickerAlignElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Combo#config-pickerAlignElement)
415
+ */
416
+ overlayAnchor? : boolean
417
+ /**
418
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
419
+ * [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
420
+ * the owner is <strong>always</strong> the encapsulating Container.
421
+ * ...
422
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-owner)
423
+ */
424
+ owner? : Widget|any
425
+ /**
426
+ * Width of picker, defaults to this combo's [pickerAlignElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Combo#config-pickerAlignElement) width
427
+ */
428
+ pickerWidth? : number|string
429
+ /**
430
+ * 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
431
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
432
+ * widget's [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
433
+ * ...
434
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-positioned)
435
+ */
436
+ positioned? : boolean
437
+ /**
438
+ * An array containing string [ViewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset) ids available for selection. The specified
439
+ * presets must be [available](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-presets) for the
440
+ * [client](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-client) (Scheduler, SchedulerPro or Gantt) for it to work properly. The selectable presets
441
+ * will be arranged in the order provided here.
442
+ */
443
+ presets? : any[]
444
+ /**
445
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
446
+ * menu on click etc, since the tooltip would be displayed at the same time.
447
+ */
448
+ preventTooltipOnTouch? : boolean
449
+ /**
450
+ * Makes the field unmodifiable by user action. The input area is not editable, and triggers
451
+ * are unresponsive.
452
+ * ...
453
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-readOnly)
454
+ */
455
+ readOnly? : boolean
456
+ relayStoreEvents? : boolean
457
+ /**
458
+ * Predefined style to use for the field. Possible values are:
459
+ * ...
460
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-rendition)
461
+ */
462
+ rendition? : 'outlined'|'filled'|string
463
+ /**
464
+ * Configure as `true` to have the component display a translucent ripple when its
465
+ * [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
466
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
467
+ * ...
468
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-ripple)
469
+ */
470
+ ripple? : boolean|{
471
+ delegate?: string
472
+ color?: string
473
+ radius?: number
474
+ clip?: string
475
+ }
476
+ /**
477
+ * 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`
478
+ */
479
+ rootElement? : ShadowRoot|HTMLElement
480
+ /**
481
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
482
+ * ...
483
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-rtl)
484
+ */
485
+ rtl? : boolean
486
+ /**
487
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
488
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
489
+ */
490
+ scrollAction? : 'hide'|'realign'|null
491
+ /**
492
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
493
+ * ...
494
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-showAnimation)
495
+ */
496
+ showAnimation? : boolean|object
497
+ /**
498
+ * `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).
499
+ */
500
+ showRequiredIndicator? : string
501
+ /**
502
+ * 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)
503
+ */
504
+ showTooltipWhenDisabled? : boolean
505
+ /**
506
+ * Set to `true`, completely bypasses validation logic (could be userful if your field is not `editable`
507
+ * to the user).
508
+ */
509
+ skipValidation? : boolean
510
+ /**
511
+ * Programmatic control over how many columns to span when used in a grid layout.
512
+ */
513
+ span? : number
514
+ /**
515
+ * 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
516
+ * [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
517
+ * this widget:
518
+ * ...
519
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-tab)
520
+ */
521
+ tab? : boolean|TabConfig
522
+ /**
523
+ * The tab index of the input field or fields, or `null` for natural tab order (recommended). Setting to `0`
524
+ * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
525
+ * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
526
+ * to the element programmatically.
527
+ * ...
528
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-tabIndex)
529
+ */
530
+ tabIndex? : number
531
+ /**
532
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
533
+ * ...
534
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-textAlign)
535
+ */
536
+ textAlign? : 'left'|'center'|'right'|'start'|'end'
537
+ type? : 'viewpresetcombo'
538
+ /**
539
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
540
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
541
+ * values are used as the class names.
542
+ * ...
543
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-ui)
544
+ */
545
+ ui? : string|object
546
+ /**
547
+ * As default, a preset change by the ViewPresetCombo will result in that the `startDate` will be calculated to
548
+ * the beginning of the [mainUnit](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset#field-mainUnit) of the
549
+ * [viewportCenterDate](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineDateMapper#property-viewportCenterDate). If the ViewPreset has a
550
+ * [start](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset#field-start) configured, this will be added to the calculation. The
551
+ * `endDate` will then be calculated by adding the ViewPreset's
552
+ * [defaultSpan](https://bryntum.com/products/scheduler/docs/api/Scheduler/preset/ViewPreset#field-defaultSpan) to the `startDate`.
553
+ * ...
554
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-useFixedDuration)
555
+ */
556
+ useFixedDuration? : boolean
557
+ /**
558
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container).
559
+ * Higher weights go further down.
560
+ */
561
+ weight? : number
562
+ /**
563
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
564
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
565
+ * this config is convenient.
566
+ */
567
+ width? : string|number
568
+ /**
569
+ * The x position for the widget.
570
+ * ...
571
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-x)
572
+ */
573
+ x? : number
574
+ /**
575
+ * The y position for the widget.
576
+ * ...
577
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-y)
578
+ */
579
+ y? : number
580
+
581
+ // Events
582
+ /**
583
+ * The default action was performed (an item in the list was selected)
584
+ * @param {object} event Event object
585
+ * @param {Core.widget.Combo} event.source The combo
586
+ * @param {any} event.value The [value](https://bryntum.com/products/scheduler/docs/api/Core/widget/Combo#config-valueField) of the selected record
587
+ * @param {Core.data.Model} event.record Selected record
588
+ * @param {Core.data.Model[]} event.records Selected records as an array if [multiSelect](https://bryntum.com/products/scheduler/docs/api/Core/widget/Combo#config-multiSelect) is `true`
589
+ * @param {boolean} event.userAction `true` if the value change is due to user interaction
590
+ */
591
+ onAction? : ((event: { source: Combo, value: any, record: Model, records: Model[], userAction: boolean }) => void)|string
592
+ /**
593
+ * Fires before an object is destroyed.
594
+ * @param {object} event Event object
595
+ * @param {Core.Base} event.source The Object that is being destroyed.
596
+ */
597
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
598
+ /**
599
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
600
+ * @param {object} event Event object
601
+ * @param {Core.widget.Widget} event.source The widget being hidden.
602
+ */
603
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
604
+ /**
605
+ * Triggered before a widget is shown. Return `false` to prevent the action.
606
+ * @param {object} event Event object
607
+ * @param {Core.widget.Widget,any} event.source The widget being shown
608
+ */
609
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
610
+ /**
611
+ * Fires when any other event is fired from the object.
612
+ * ...
613
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#event-catchAll)
614
+ * @param {object} event Event object
615
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
616
+ * @param {string} event.event.type The type of the event which is caught by the listener
617
+ */
618
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
619
+ /**
620
+ * Fired when this field's value changes.
621
+ * @param {object} event Event object
622
+ * @param {Core.widget.Field,any} event.source This Field
623
+ * @param {string,number,boolean,any} event.value This field's value
624
+ * @param {string,number,boolean,any} event.oldValue This field's previous value
625
+ * @param {boolean} event.valid True if this field is in a valid state
626
+ * @param {Event} event.event The triggering DOM event if any
627
+ * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
628
+ * @param {boolean} event.checked
629
+ */
630
+ 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
631
+ /**
632
+ * Fired when this field is [cleared](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#function-clear).
633
+ * ...
634
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#event-clear)
635
+ * @param {object} event Event object
636
+ * @param {Core.widget.Field,any} event.source This Field
637
+ */
638
+ onClear? : ((event: { source: Field|any }) => void)|string
639
+ /**
640
+ * Fires when an object is destroyed.
641
+ * @param {object} event Event object
642
+ * @param {Core.Base} event.source The Object that is being destroyed.
643
+ */
644
+ onDestroy? : ((event: { source: Base }) => void)|string
645
+ /**
646
+ * Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
647
+ * @param {object} event Event object
648
+ * @param {HTMLElement} event.element The Widget's element.
649
+ */
650
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
651
+ /**
652
+ * Fired when focus enters this Widget.
653
+ * @param {object} event Event object
654
+ * @param {Core.widget.Widget} event.source This Widget
655
+ * @param {HTMLElement} event.fromElement The element which lost focus.
656
+ * @param {HTMLElement} event.toElement The element which gained focus.
657
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
658
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
659
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
660
+ */
661
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
662
+ /**
663
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
664
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
665
+ * will not trigger this event. This is when focus exits this widget completely.
666
+ * @param {object} event Event object
667
+ * @param {Core.widget.Widget} event.source This Widget
668
+ * @param {HTMLElement} event.fromElement The element which lost focus.
669
+ * @param {HTMLElement} event.toElement The element which gained focus.
670
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
671
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
672
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
673
+ */
674
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
675
+ /**
676
+ * Triggered after a widget was hidden
677
+ * @param {object} event Event object
678
+ * @param {Core.widget.Widget} event.source The widget
679
+ */
680
+ onHide? : ((event: { source: Widget }) => void)|string
681
+ /**
682
+ * Triggered when a widget which had been in a non-visible state for any reason
683
+ * achieves visibility.
684
+ * ...
685
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#event-paint)
686
+ * @param {object} event Event object
687
+ * @param {Core.widget.Widget} event.source The widget being painted.
688
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
689
+ */
690
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
691
+ /**
692
+ * Fired when a Widget's read only state is toggled
693
+ * @param {object} event Event object
694
+ * @param {boolean} event.readOnly Read only or not
695
+ */
696
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
697
+ /**
698
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
699
+ * 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.
700
+ */
701
+ onRecompose? : (() => void)|string
702
+ /**
703
+ * 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`*.
704
+ * @param {object} event Event object
705
+ * @param {Core.widget.Widget} event.source This Widget
706
+ * @param {number} event.width The new width
707
+ * @param {number} event.height The new height
708
+ * @param {number} event.oldWidth The old width
709
+ * @param {number} event.oldHeight The old height
710
+ */
711
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
712
+ /**
713
+ * An item in the list was selected
714
+ * @param {object} event Event object
715
+ * @param {Core.widget.Combo} event.source The combo
716
+ * @param {Core.data.Model} event.record Selected record
717
+ * @param {Core.data.Model[]} event.records Selected records as an array if [multiSelect](https://bryntum.com/products/scheduler/docs/api/Core/widget/Combo#config-multiSelect) is `true`
718
+ * @param {boolean} event.userAction `true` if the value change is due to user interaction
719
+ */
720
+ onSelect? : ((event: { source: Combo, record: Model, records: Model[], userAction: boolean }) => void)|string
721
+ /**
722
+ * Triggered after a widget is shown.
723
+ * @param {object} event Event object
724
+ * @param {Core.widget.Widget} event.source The widget
725
+ */
726
+ onShow? : ((event: { source: Widget }) => void)|string
727
+ /**
728
+ * User clicked one of this field's [triggers](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-triggers)
729
+ * @param {object} event Event object
730
+ * @param {Core.widget.Field,any} event.source This field
731
+ * @param {Core.widget.Widget} event.trigger The trigger activated by click or touch tap.
732
+ */
733
+ onTrigger? : ((event: { source: Field|any, trigger: Widget }) => void)|string
734
+
735
+ }
736
+
737
+ export class BryntumViewPresetCombo extends React.Component<BryntumViewPresetComboProps> {
738
+
739
+ static instanceClass = ViewPresetCombo;
740
+
741
+ static instanceName = 'ViewPresetCombo';
742
+
743
+ processWidgetContent = processWidgetContent;
744
+
745
+ static configNames = [
746
+ 'align',
747
+ 'anchor',
748
+ 'ariaDescription',
749
+ 'ariaLabel',
750
+ 'bubbleEvents',
751
+ 'cacheLastResult',
752
+ 'centered',
753
+ 'clearTextOnSelection',
754
+ 'clearWhenInputEmpty',
755
+ 'client',
756
+ 'color',
757
+ 'config',
758
+ 'constrainTo',
759
+ 'contentElementCls',
760
+ 'dataField',
761
+ 'defaultBindProperty',
762
+ 'detectCSSCompatibilityIssues',
763
+ 'dock',
764
+ 'draggable',
765
+ 'elementAttributes',
766
+ 'floating',
767
+ 'hideAnimation',
768
+ 'hidePickerOnSelect',
769
+ 'hint',
770
+ 'hintHtml',
771
+ 'ignoreParentReadOnly',
772
+ 'inputAlign',
773
+ 'inputAttributes',
774
+ 'inputTag',
775
+ 'inputWidth',
776
+ 'labelCls',
777
+ 'labelPosition',
778
+ 'labels',
779
+ 'labelWidth',
780
+ 'listCls',
781
+ 'listeners',
782
+ 'listItemTpl',
783
+ 'localeClass',
784
+ 'localizable',
785
+ 'localizableProperties',
786
+ 'maskDefaults',
787
+ 'masked',
788
+ 'monitorResize',
789
+ 'name',
790
+ 'overlayAnchor',
791
+ 'owner',
792
+ 'pickerWidth',
793
+ 'positioned',
794
+ 'presets',
795
+ 'preventTooltipOnTouch',
796
+ 'relayStoreEvents',
797
+ 'ripple',
798
+ 'rootElement',
799
+ 'scrollAction',
800
+ 'showAnimation',
801
+ 'showTooltipWhenDisabled',
802
+ 'skipValidation',
803
+ 'tab',
804
+ 'tabIndex',
805
+ 'textAlign',
806
+ 'type',
807
+ 'ui',
808
+ 'useFixedDuration',
809
+ 'weight'
810
+ ];
811
+
812
+ static propertyConfigNames = [
813
+ 'alignSelf',
814
+ 'appendTo',
815
+ 'badge',
816
+ 'callOnFunctions',
817
+ 'catchEventHandlerExceptions',
818
+ 'cls',
819
+ 'column',
820
+ 'disabled',
821
+ 'editable',
822
+ 'extraData',
823
+ 'flex',
824
+ 'height',
825
+ 'hidden',
826
+ 'id',
827
+ 'insertBefore',
828
+ 'insertFirst',
829
+ 'keyMap',
830
+ 'label',
831
+ 'margin',
832
+ 'maxHeight',
833
+ 'maximizeOnMobile',
834
+ 'maxWidth',
835
+ 'minHeight',
836
+ 'minWidth',
837
+ 'onAction',
838
+ 'onBeforeDestroy',
839
+ 'onBeforeHide',
840
+ 'onBeforeShow',
841
+ 'onCatchAll',
842
+ 'onChange',
843
+ 'onClear',
844
+ 'onDestroy',
845
+ 'onElementCreated',
846
+ 'onFocusIn',
847
+ 'onFocusOut',
848
+ 'onHide',
849
+ 'onPaint',
850
+ 'onReadOnly',
851
+ 'onRecompose',
852
+ 'onResize',
853
+ 'onSelect',
854
+ 'onShow',
855
+ 'onTrigger',
856
+ 'readOnly',
857
+ 'rendition',
858
+ 'rtl',
859
+ 'showRequiredIndicator',
860
+ 'span',
861
+ 'width',
862
+ 'x',
863
+ 'y'
864
+ ];
865
+
866
+ static propertyNames = [
867
+ 'anchorSize',
868
+ 'focusVisible',
869
+ 'formula',
870
+ 'input',
871
+ 'multiSelect',
872
+ 'parent',
873
+ 'picker',
874
+ 'placeholder',
875
+ 'required',
876
+ 'tooltip',
877
+ 'value'
878
+ ];
879
+
880
+ // Component instance
881
+ instance!: ViewPresetCombo;
882
+
883
+ // Component element
884
+ element! : HTMLElement;
885
+
886
+ componentDidMount(): void {
887
+ this.instance = createWidget(this);
888
+ }
889
+
890
+ componentWillUnmount(): void {
891
+ // @ts-ignore
892
+ this.instance?.destroy?.();
893
+ }
894
+
895
+ /**
896
+ * Component about to be updated, from changing a prop using state.
897
+ * React to it depending on what changed and prevent react from re-rendering our component.
898
+ * @param nextProps
899
+ * @param nextState
900
+ * @returns {boolean}
901
+ */
902
+ shouldComponentUpdate(nextProps: Readonly<BryntumViewPresetComboProps>, nextState: Readonly<{}>): boolean {
903
+ return shouldComponentUpdate(this, nextProps, nextState);
904
+ }
905
+
906
+ render(): React.ReactNode {
907
+
908
+ const className = `b-react-view-preset-combo-container`;
909
+ return (
910
+ <div className={className} ref={(element) => (this.element = element!)}></div>
911
+ );
912
+
913
+ }
914
+ }