@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,715 @@
1
+ /**
2
+ * React wrapper for Bryntum Widget
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AlignSpec, Base, DomConfig, KeyMapConfig, MaskConfig, Rectangle, Scroller, ScrollerConfig, TabConfig, TooltipConfig, VueConfig, Widget, WidgetListeners } from '@bryntum/scheduler';
7
+
8
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
9
+
10
+ export type BryntumWidgetProps = {
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/Widget#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/Widget#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/Widget#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/Widget#config-ariaLabel)
53
+ */
54
+ ariaLabel? : string
55
+ /**
56
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
57
+ * hierarchy when triggered.
58
+ * ...
59
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-bubbleEvents)
60
+ */
61
+ bubbleEvents? : object
62
+ /**
63
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
64
+ * ...
65
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-callOnFunctions)
66
+ */
67
+ callOnFunctions? : boolean
68
+ /**
69
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
70
+ * application state is undefined. Code which follows the event handler will *not* be executed.
71
+ * ...
72
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-catchEventHandlerExceptions)
73
+ */
74
+ catchEventHandlerExceptions? : boolean
75
+ /**
76
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
77
+ * Set to `true` to centre the Widget in browser viewport space.
78
+ */
79
+ centered? : boolean
80
+ /**
81
+ * Custom CSS classes to add to element.
82
+ * May be specified as a space separated string, or as an object in which property names
83
+ * with truthy values are used as the class names:
84
+ * ...
85
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-cls)
86
+ */
87
+ cls? : string|object
88
+ /**
89
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
90
+ * `style` block.
91
+ * ...
92
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-color)
93
+ */
94
+ color? : string
95
+ /**
96
+ * Programmatic control over which column to start in when used in a grid layout.
97
+ */
98
+ column? : number
99
+ config? : object
100
+ /**
101
+ * *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).*
102
+ * Element, Widget or Rectangle to which this Widget is constrained.
103
+ */
104
+ constrainTo? : HTMLElement|Widget|Rectangle
105
+ /**
106
+ * The HTML content that coexists with sibling elements which may have been added to the
107
+ * [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement) by plugins and features.
108
+ * When specifying html, this widget's element will also have the [htmlCls](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-htmlCls)
109
+ * class added to its classList, to allow targeted styling.
110
+ */
111
+ content? : string
112
+ /**
113
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
114
+ * May be specified as a space separated string, or as an object in which property names
115
+ * with truthy values are used as the class names:
116
+ * ...
117
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-contentElementCls)
118
+ */
119
+ contentElementCls? : string|object
120
+ /**
121
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
122
+ * field on the expanded record to use for populating this widget's store (if applicable)
123
+ */
124
+ dataField? : string
125
+ /**
126
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
127
+ */
128
+ dataset? : Record<string, string>
129
+ /**
130
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
131
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
132
+ */
133
+ defaultBindProperty? : string
134
+ /**
135
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
136
+ * ...
137
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-detectCSSCompatibilityIssues)
138
+ */
139
+ detectCSSCompatibilityIssues? : boolean
140
+ /**
141
+ * 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
142
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
143
+ * ...
144
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-disabled)
145
+ */
146
+ disabled? : boolean|'inert'
147
+ /**
148
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel)
149
+ * [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
150
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
151
+ * body. Such widgets are called "edge strips".
152
+ * ...
153
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-dock)
154
+ */
155
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
156
+ /**
157
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
158
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
159
+ * property which controls when a drag should start.
160
+ * ...
161
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-draggable)
162
+ */
163
+ draggable? : boolean|{
164
+ handleSelector?: string
165
+ }
166
+ /**
167
+ * An object specifying attributes to assign to the root element of this widget.
168
+ * Set `null` value to attribute to remove it.
169
+ * ...
170
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-elementAttributes)
171
+ */
172
+ elementAttributes? : Record<string, string|null>
173
+ extraData? : any
174
+ /**
175
+ * 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
176
+ * flexbox layout. This config allows you to set this widget's
177
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
178
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
179
+ * numeric-only values are interpreted as the `flex-grow` value.
180
+ */
181
+ flex? : number|string
182
+ /**
183
+ * Set to `true` to move the widget out of the document flow and position it
184
+ * absolutely in browser viewport space.
185
+ */
186
+ floating? : boolean
187
+ /**
188
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
189
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
190
+ * cases this config is convenient.
191
+ */
192
+ height? : string|number
193
+ /**
194
+ * Configure with true to make widget initially hidden.
195
+ */
196
+ hidden? : boolean
197
+ /**
198
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
199
+ * ...
200
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-hideAnimation)
201
+ */
202
+ hideAnimation? : boolean|object
203
+ /**
204
+ * The HTML to display initially or a function returning the markup (called at widget construction time).
205
+ * ...
206
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-html)
207
+ * @param {Core.widget.Widget} widget The calling Widget
208
+ * @returns {string}
209
+ */
210
+ html? : string|((widget: Widget) => string)|DomConfig|DomConfig[]|VueConfig
211
+ /**
212
+ * The CSS class(es) to add when HTML content is being applied to this widget.
213
+ */
214
+ htmlCls? : string|object
215
+ /**
216
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
217
+ */
218
+ id? : string
219
+ /**
220
+ * Determines if the widgets read-only state should be controlled by its parent.
221
+ * ...
222
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-ignoreParentReadOnly)
223
+ */
224
+ ignoreParentReadOnly? : boolean
225
+ /**
226
+ * 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.
227
+ */
228
+ insertBefore? : HTMLElement|string
229
+ /**
230
+ * 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.
231
+ */
232
+ insertFirst? : HTMLElement|string
233
+ /**
234
+ * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
235
+ * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
236
+ * are the name of the instance method to call when the keystroke is received.
237
+ * ...
238
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-keyMap)
239
+ */
240
+ keyMap? : Record<string, KeyMapConfig>
241
+ /**
242
+ * The listener set for this object.
243
+ * ...
244
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-listeners)
245
+ */
246
+ listeners? : WidgetListeners
247
+ /**
248
+ * A class translations of which are used for translating this entity.
249
+ * This is often used when translations of an item are defined on its container class.
250
+ * For example:
251
+ * ...
252
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-localeClass)
253
+ */
254
+ localeClass? : typeof Base
255
+ /**
256
+ * Set to `false` to disable localization of this object.
257
+ */
258
+ localizable? : boolean
259
+ /**
260
+ * List of properties which values should be translated automatically upon a locale applying.
261
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
262
+ * you could use 'localeKey' meta configuration.
263
+ * Example:
264
+ * ...
265
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-localizableProperties)
266
+ */
267
+ localizableProperties? : string[]
268
+ /**
269
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
270
+ * numeric-only values are interpreted as pixels.
271
+ */
272
+ margin? : number|string
273
+ /**
274
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) created for the
275
+ * [masked](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
276
+ * values.
277
+ */
278
+ maskDefaults? : MaskConfig
279
+ /**
280
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
281
+ * [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object.
282
+ */
283
+ masked? : boolean|string|MaskConfig
284
+ /**
285
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
286
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
287
+ */
288
+ maxHeight? : string|number
289
+ /**
290
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
291
+ * ...
292
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-maximizeOnMobile)
293
+ */
294
+ maximizeOnMobile? : number|string
295
+ /**
296
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
297
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
298
+ */
299
+ maxWidth? : string|number
300
+ /**
301
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
302
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
303
+ */
304
+ minHeight? : string|number
305
+ /**
306
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
307
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
308
+ */
309
+ minWidth? : string|number
310
+ /**
311
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
312
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
313
+ * layout.
314
+ * ...
315
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize)
316
+ */
317
+ monitorResize? : boolean|{
318
+ immediate?: boolean
319
+ }
320
+ /**
321
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
322
+ * [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
323
+ * the owner is <strong>always</strong> the encapsulating Container.
324
+ * ...
325
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-owner)
326
+ */
327
+ owner? : Widget|any
328
+ /**
329
+ * 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
330
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
331
+ * widget's [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
332
+ * ...
333
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-positioned)
334
+ */
335
+ positioned? : boolean
336
+ /**
337
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
338
+ * menu on click etc, since the tooltip would be displayed at the same time.
339
+ */
340
+ preventTooltipOnTouch? : boolean
341
+ /**
342
+ * Whether this widget is read-only. This is only valid if the widget is an input
343
+ * field, <strong>or contains input fields at any depth</strong>.
344
+ * ...
345
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-readOnly)
346
+ */
347
+ readOnly? : boolean
348
+ relayStoreEvents? : boolean
349
+ /**
350
+ * Configure as `true` to have the component display a translucent ripple when its
351
+ * [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
352
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
353
+ * ...
354
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-ripple)
355
+ */
356
+ ripple? : boolean|{
357
+ delegate?: string
358
+ color?: string
359
+ radius?: number
360
+ clip?: string
361
+ }
362
+ /**
363
+ * 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`
364
+ */
365
+ rootElement? : ShadowRoot|HTMLElement
366
+ /**
367
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
368
+ * ...
369
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-rtl)
370
+ */
371
+ rtl? : boolean
372
+ /**
373
+ * Specifies whether (and optionally in which axes) a Widget may scroll. `true` means this widget may scroll
374
+ * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
375
+ * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
376
+ * CSS overflow properties thus:
377
+ * ...
378
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-scrollable)
379
+ */
380
+ scrollable? : boolean|ScrollerConfig|Scroller
381
+ /**
382
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
383
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
384
+ */
385
+ scrollAction? : 'hide'|'realign'|null
386
+ /**
387
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
388
+ * ...
389
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-showAnimation)
390
+ */
391
+ showAnimation? : boolean|object
392
+ /**
393
+ * 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)
394
+ */
395
+ showTooltipWhenDisabled? : boolean
396
+ /**
397
+ * Programmatic control over how many columns to span when used in a grid layout.
398
+ */
399
+ span? : number
400
+ /**
401
+ * 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
402
+ * [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
403
+ * this widget:
404
+ * ...
405
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-tab)
406
+ */
407
+ tab? : boolean|TabConfig
408
+ /**
409
+ * The tag name of this Widget's root element
410
+ */
411
+ tag? : string
412
+ /**
413
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
414
+ * ...
415
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-textAlign)
416
+ */
417
+ textAlign? : 'left'|'center'|'right'|'start'|'end'
418
+ /**
419
+ * A title to display for the widget. Only in effect when inside a container that uses it (such as TabPanel)
420
+ */
421
+ title? : string
422
+ /**
423
+ * Tooltip for the widget, either as a string or as a Tooltip config object.
424
+ * ...
425
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-tooltip)
426
+ */
427
+ tooltip? : string|TooltipConfig|null
428
+ type? : 'widget'
429
+ /**
430
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
431
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
432
+ * values are used as the class names.
433
+ * ...
434
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-ui)
435
+ */
436
+ ui? : string|object
437
+ /**
438
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container).
439
+ * Higher weights go further down.
440
+ */
441
+ weight? : number
442
+ /**
443
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
444
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
445
+ * this config is convenient.
446
+ */
447
+ width? : string|number
448
+ /**
449
+ * The x position for the widget.
450
+ * ...
451
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-x)
452
+ */
453
+ x? : number
454
+ /**
455
+ * The y position for the widget.
456
+ * ...
457
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-y)
458
+ */
459
+ y? : number
460
+
461
+ // Events
462
+ /**
463
+ * Fires before an object is destroyed.
464
+ * @param {object} event Event object
465
+ * @param {Core.Base} event.source The Object that is being destroyed.
466
+ */
467
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
468
+ /**
469
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
470
+ * @param {object} event Event object
471
+ * @param {Core.widget.Widget} event.source The widget being hidden.
472
+ */
473
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
474
+ /**
475
+ * Triggered before a widget is shown. Return `false` to prevent the action.
476
+ * @param {object} event Event object
477
+ * @param {Core.widget.Widget,any} event.source The widget being shown
478
+ */
479
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
480
+ /**
481
+ * Fires when any other event is fired from the object.
482
+ * ...
483
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#event-catchAll)
484
+ * @param {object} event Event object
485
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
486
+ * @param {string} event.event.type The type of the event which is caught by the listener
487
+ */
488
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
489
+ /**
490
+ * Fires when an object is destroyed.
491
+ * @param {object} event Event object
492
+ * @param {Core.Base} event.source The Object that is being destroyed.
493
+ */
494
+ onDestroy? : ((event: { source: Base }) => void)|string
495
+ /**
496
+ * Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
497
+ * @param {object} event Event object
498
+ * @param {HTMLElement} event.element The Widget's element.
499
+ */
500
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
501
+ /**
502
+ * Fired when focus enters this Widget.
503
+ * @param {object} event Event object
504
+ * @param {Core.widget.Widget} event.source This Widget
505
+ * @param {HTMLElement} event.fromElement The element which lost focus.
506
+ * @param {HTMLElement} event.toElement The element which gained focus.
507
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
508
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
509
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
510
+ */
511
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
512
+ /**
513
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
514
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
515
+ * will not trigger this event. This is when focus exits this widget completely.
516
+ * @param {object} event Event object
517
+ * @param {Core.widget.Widget} event.source This Widget
518
+ * @param {HTMLElement} event.fromElement The element which lost focus.
519
+ * @param {HTMLElement} event.toElement The element which gained focus.
520
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
521
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
522
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
523
+ */
524
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
525
+ /**
526
+ * Triggered after a widget was hidden
527
+ * @param {object} event Event object
528
+ * @param {Core.widget.Widget} event.source The widget
529
+ */
530
+ onHide? : ((event: { source: Widget }) => void)|string
531
+ /**
532
+ * Triggered when a widget which had been in a non-visible state for any reason
533
+ * achieves visibility.
534
+ * ...
535
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#event-paint)
536
+ * @param {object} event Event object
537
+ * @param {Core.widget.Widget} event.source The widget being painted.
538
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
539
+ */
540
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
541
+ /**
542
+ * Fired when a Widget's read only state is toggled
543
+ * @param {object} event Event object
544
+ * @param {boolean} event.readOnly Read only or not
545
+ */
546
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
547
+ /**
548
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
549
+ * 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.
550
+ */
551
+ onRecompose? : (() => void)|string
552
+ /**
553
+ * 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`*.
554
+ * @param {object} event Event object
555
+ * @param {Core.widget.Widget} event.source This Widget
556
+ * @param {number} event.width The new width
557
+ * @param {number} event.height The new height
558
+ * @param {number} event.oldWidth The old width
559
+ * @param {number} event.oldHeight The old height
560
+ */
561
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
562
+ /**
563
+ * Triggered after a widget is shown.
564
+ * @param {object} event Event object
565
+ * @param {Core.widget.Widget} event.source The widget
566
+ */
567
+ onShow? : ((event: { source: Widget }) => void)|string
568
+
569
+ }
570
+
571
+ export class BryntumWidget extends React.Component<BryntumWidgetProps> {
572
+
573
+ static instanceClass = Widget;
574
+
575
+ static instanceName = 'Widget';
576
+
577
+ processWidgetContent = processWidgetContent;
578
+
579
+ static configNames = [
580
+ 'adopt',
581
+ 'align',
582
+ 'anchor',
583
+ 'ariaDescription',
584
+ 'ariaLabel',
585
+ 'bubbleEvents',
586
+ 'centered',
587
+ 'color',
588
+ 'config',
589
+ 'constrainTo',
590
+ 'contentElementCls',
591
+ 'dataField',
592
+ 'defaultBindProperty',
593
+ 'detectCSSCompatibilityIssues',
594
+ 'dock',
595
+ 'draggable',
596
+ 'elementAttributes',
597
+ 'floating',
598
+ 'hideAnimation',
599
+ 'htmlCls',
600
+ 'ignoreParentReadOnly',
601
+ 'listeners',
602
+ 'localeClass',
603
+ 'localizable',
604
+ 'localizableProperties',
605
+ 'maskDefaults',
606
+ 'masked',
607
+ 'monitorResize',
608
+ 'owner',
609
+ 'positioned',
610
+ 'preventTooltipOnTouch',
611
+ 'relayStoreEvents',
612
+ 'ripple',
613
+ 'rootElement',
614
+ 'scrollAction',
615
+ 'showAnimation',
616
+ 'showTooltipWhenDisabled',
617
+ 'tab',
618
+ 'tag',
619
+ 'textAlign',
620
+ 'title',
621
+ 'type',
622
+ 'ui',
623
+ 'weight'
624
+ ];
625
+
626
+ static propertyConfigNames = [
627
+ 'alignSelf',
628
+ 'appendTo',
629
+ 'callOnFunctions',
630
+ 'catchEventHandlerExceptions',
631
+ 'cls',
632
+ 'column',
633
+ 'content',
634
+ 'dataset',
635
+ 'disabled',
636
+ 'extraData',
637
+ 'flex',
638
+ 'height',
639
+ 'hidden',
640
+ 'html',
641
+ 'id',
642
+ 'insertBefore',
643
+ 'insertFirst',
644
+ 'keyMap',
645
+ 'margin',
646
+ 'maxHeight',
647
+ 'maximizeOnMobile',
648
+ 'maxWidth',
649
+ 'minHeight',
650
+ 'minWidth',
651
+ 'onBeforeDestroy',
652
+ 'onBeforeHide',
653
+ 'onBeforeShow',
654
+ 'onCatchAll',
655
+ 'onDestroy',
656
+ 'onElementCreated',
657
+ 'onFocusIn',
658
+ 'onFocusOut',
659
+ 'onHide',
660
+ 'onPaint',
661
+ 'onReadOnly',
662
+ 'onRecompose',
663
+ 'onResize',
664
+ 'onShow',
665
+ 'readOnly',
666
+ 'rtl',
667
+ 'scrollable',
668
+ 'span',
669
+ 'tooltip',
670
+ 'width',
671
+ 'x',
672
+ 'y'
673
+ ];
674
+
675
+ static propertyNames = [
676
+ 'anchorSize',
677
+ 'focusVisible',
678
+ 'parent'
679
+ ];
680
+
681
+ // Component instance
682
+ instance!: Widget;
683
+
684
+ // Component element
685
+ element! : HTMLElement;
686
+
687
+ componentDidMount(): void {
688
+ this.instance = createWidget(this);
689
+ }
690
+
691
+ componentWillUnmount(): void {
692
+ // @ts-ignore
693
+ this.instance?.destroy?.();
694
+ }
695
+
696
+ /**
697
+ * Component about to be updated, from changing a prop using state.
698
+ * React to it depending on what changed and prevent react from re-rendering our component.
699
+ * @param nextProps
700
+ * @param nextState
701
+ * @returns {boolean}
702
+ */
703
+ shouldComponentUpdate(nextProps: Readonly<BryntumWidgetProps>, nextState: Readonly<{}>): boolean {
704
+ return shouldComponentUpdate(this, nextProps, nextState);
705
+ }
706
+
707
+ render(): React.ReactNode {
708
+
709
+ const className = `b-react-widget-container`;
710
+ return (
711
+ <div className={className} ref={(element) => (this.element = element!)}></div>
712
+ );
713
+
714
+ }
715
+ }