@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,1013 @@
1
+ /**
2
+ * React wrapper for Bryntum Editor
3
+ */
4
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
+ import React, { RefObject } from 'react';
6
+ import { AlignSpec, Base, Container, ContainerItemConfig, ContainerLayoutConfig, DomConfig, Editor, EditorListeners, InputFieldConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, Rectangle, Scroller, ScrollerConfig, TabConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/scheduler';
7
+
8
+ import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
9
+
10
+ export type BryntumEditorProps = {
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/Editor#config-adopt)
17
+ */
18
+ adopt? : HTMLElement|string
19
+ /**
20
+ * The alignment config for how this editor aligns to a target when asked to [startEdit](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#function-startEdit)
21
+ */
22
+ align? : AlignSpec
23
+ /**
24
+ * 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
25
+ * flexbox layout. This config allows you to set this widget's
26
+ * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
27
+ */
28
+ alignSelf? : string
29
+ /**
30
+ * *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).*
31
+ * `true` to show a connector arrow pointing to the align target.
32
+ */
33
+ anchor? : boolean
34
+ /**
35
+ * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
36
+ * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
37
+ */
38
+ appendTo? : HTMLElement|string
39
+ /**
40
+ * Set to `true` to automatically append the Editor's element to the parent element of the element being edited.
41
+ */
42
+ appendToTargetParent? : boolean
43
+ /**
44
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
45
+ * into an element which will be linked using the `aria-describedby` attribute.
46
+ * ...
47
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-ariaDescription)
48
+ */
49
+ ariaDescription? : string
50
+ /**
51
+ * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
52
+ * the `aria-label` attribute.
53
+ * ...
54
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-ariaLabel)
55
+ */
56
+ ariaLabel? : string
57
+ /**
58
+ * Update assigned [record](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-record) automatically on field changes
59
+ */
60
+ autoUpdateRecord? : boolean
61
+ /**
62
+ * What action should be taken when focus moves out of the editor, either by `TAB` or clicking outside.
63
+ * May be `'complete'` or `'cancel`'. Any other value results in no action being taken upon focus leaving the editor
64
+ * leaving the application to listen for the [focusOut](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#event-focusOut) event.
65
+ */
66
+ blurAction? : 'complete'|'cancel'|null
67
+ /**
68
+ * An object where property names with a truthy value indicate which events should bubble up the ownership
69
+ * hierarchy when triggered.
70
+ * ...
71
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-bubbleEvents)
72
+ */
73
+ bubbleEvents? : object
74
+ /**
75
+ * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
76
+ * ...
77
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-callOnFunctions)
78
+ */
79
+ callOnFunctions? : boolean
80
+ /**
81
+ * The name of the `key` which cancels the edit.
82
+ * ...
83
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-cancelKey)
84
+ */
85
+ cancelKey? : string
86
+ /**
87
+ * By default, if an event handler throws an exception, the error propagates up the stack and the
88
+ * application state is undefined. Code which follows the event handler will *not* be executed.
89
+ * ...
90
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-catchEventHandlerExceptions)
91
+ */
92
+ catchEventHandlerExceptions? : boolean
93
+ /**
94
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
95
+ * Set to `true` to centre the Widget in browser viewport space.
96
+ */
97
+ centered? : boolean
98
+ /**
99
+ * Custom CSS classes to add to element.
100
+ * May be specified as a space separated string, or as an object in which property names
101
+ * with truthy values are used as the class names:
102
+ * ...
103
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-cls)
104
+ */
105
+ cls? : string|object
106
+ /**
107
+ * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
108
+ * `style` block.
109
+ * ...
110
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-color)
111
+ */
112
+ color? : string
113
+ /**
114
+ * Programmatic control over which column to start in when used in a grid layout.
115
+ */
116
+ column? : number
117
+ /**
118
+ * The name of the `key` which completes the edit.
119
+ * ...
120
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-completeKey)
121
+ */
122
+ completeKey? : string
123
+ /**
124
+ * Configure as `true` to have editing complete as soon as the field fires its `change` event.
125
+ */
126
+ completeOnChange? : boolean
127
+ config? : object
128
+ /**
129
+ * *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).*
130
+ * Element, Widget or Rectangle to which this Widget is constrained.
131
+ */
132
+ constrainTo? : HTMLElement|Widget|Rectangle
133
+ /**
134
+ * The HTML content that coexists with sibling elements which may have been added to the
135
+ * [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement) by plugins and features.
136
+ * When specifying html, this widget's element will also have the [htmlCls](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-htmlCls)
137
+ * class added to its classList, to allow targeted styling.
138
+ */
139
+ content? : string
140
+ /**
141
+ * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
142
+ * May be specified as a space separated string, or as an object in which property names
143
+ * with truthy values are used as the class names:
144
+ * ...
145
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-contentElementCls)
146
+ */
147
+ contentElementCls? : string|object
148
+ /**
149
+ * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
150
+ * field on the expanded record to use for populating this widget's store (if applicable)
151
+ */
152
+ dataField? : string
153
+ /**
154
+ * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
155
+ */
156
+ dataset? : Record<string, string>
157
+ /**
158
+ * The name of the property to set when a single value is to be applied to this Widget. Such as when used
159
+ * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
160
+ */
161
+ defaultBindProperty? : string
162
+ /**
163
+ * A [query](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
164
+ * focus should be directed by default.
165
+ * ...
166
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-defaultFocus)
167
+ * @param {Core.widget.Widget} widget Widget passed to method
168
+ * @returns {boolean} truthy value if widget is the default one
169
+ */
170
+ defaultFocus? : ((widget: Widget) => boolean)|string
171
+ /**
172
+ * A config object containing default settings to apply to all child widgets.
173
+ */
174
+ defaults? : ContainerItemConfig
175
+ /**
176
+ * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
177
+ * ...
178
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-detectCSSCompatibilityIssues)
179
+ */
180
+ detectCSSCompatibilityIssues? : boolean
181
+ /**
182
+ * 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
183
+ * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
184
+ * ...
185
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-disabled)
186
+ */
187
+ disabled? : boolean|'inert'
188
+ /**
189
+ * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel)
190
+ * [strips collection](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
191
+ * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
192
+ * body. Such widgets are called "edge strips".
193
+ * ...
194
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-dock)
195
+ */
196
+ dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
197
+ /**
198
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
199
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
200
+ * property which controls when a drag should start.
201
+ * ...
202
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-draggable)
203
+ */
204
+ draggable? : boolean|{
205
+ handleSelector?: string
206
+ }
207
+ /**
208
+ * An object specifying attributes to assign to the root element of this widget.
209
+ * Set `null` value to attribute to remove it.
210
+ * ...
211
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-elementAttributes)
212
+ */
213
+ elementAttributes? : Record<string, string|null>
214
+ extraData? : any
215
+ /**
216
+ * Controls whether the editor should expand its width if the input field has overflow [startEdit](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#function-startEdit)
217
+ */
218
+ fitTargetContent? : boolean
219
+ /**
220
+ * 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
221
+ * flexbox layout. This config allows you to set this widget's
222
+ * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
223
+ * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
224
+ * numeric-only values are interpreted as the `flex-grow` value.
225
+ */
226
+ flex? : number|string
227
+ /**
228
+ * Set to `true` to render the editor field outside the cell element in the browser viewport space, aligned to
229
+ * bottom of the cell. This will also default [scrollAction](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-scrollAction) to `realign` and
230
+ * [matchSize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-matchSize) to `false`. It is also recommended to set a `minHeight` and/or `minWidth` property
231
+ * on the [align](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-align) config.
232
+ */
233
+ floating? : boolean
234
+ /**
235
+ * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
236
+ * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
237
+ * cases this config is convenient.
238
+ */
239
+ height? : string|number
240
+ /**
241
+ * Configure with true to make widget initially hidden.
242
+ */
243
+ hidden? : boolean
244
+ /**
245
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
246
+ * ...
247
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-hideAnimation)
248
+ */
249
+ hideAnimation? : boolean|object
250
+ /**
251
+ * Controls whether to hide the target element when asked to [startEdit](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#function-startEdit)
252
+ */
253
+ hideTarget? : boolean
254
+ /**
255
+ * Specify `true` to make this container hide when it has no visible children (Either empty
256
+ * or all children hidden).
257
+ * ...
258
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-hideWhenEmpty)
259
+ */
260
+ hideWhenEmpty? : boolean
261
+ /**
262
+ * The HTML to display initially or a function returning the markup (called at widget construction time).
263
+ * ...
264
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-html)
265
+ * @param {Core.widget.Widget} widget The calling Widget
266
+ * @returns {string}
267
+ */
268
+ html? : string|((widget: Widget) => string)|DomConfig|DomConfig[]|VueConfig
269
+ /**
270
+ * The CSS class(es) to add when HTML content is being applied to this widget.
271
+ */
272
+ htmlCls? : string|object
273
+ /**
274
+ * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
275
+ */
276
+ id? : string
277
+ /**
278
+ * Determines if the widgets read-only state should be controlled by its parent.
279
+ * ...
280
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-ignoreParentReadOnly)
281
+ */
282
+ ignoreParentReadOnly? : boolean
283
+ /**
284
+ * A config object, or the `type` string of the widget (usually a [Field](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field) subclass,
285
+ * i.e. [TextField](https://bryntum.com/products/scheduler/docs/api/Core/widget/TextField)) which this editor will encapsulate.
286
+ */
287
+ inputField? : InputFieldConfig|string|Widget
288
+ /**
289
+ * Convenience setting to align input fields of child widgets. By default, the Field input element is
290
+ * placed immediately following the `label`. If you prefer to have all input fields aligned to the
291
+ * right, set this config to `'end'`.
292
+ * ...
293
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-inputFieldAlign)
294
+ */
295
+ inputFieldAlign? : 'start'|'end'
296
+ /**
297
+ * 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.
298
+ */
299
+ insertBefore? : HTMLElement|string
300
+ /**
301
+ * 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.
302
+ */
303
+ insertFirst? : HTMLElement|string
304
+ /**
305
+ * How to handle a request to complete the edit if the field is invalid. There are three choices:
306
+ * ...
307
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-invalidAction)
308
+ */
309
+ invalidAction? : 'block'|'allow'|'revert'
310
+ /**
311
+ * An optional CSS class to add to child items of this container.
312
+ */
313
+ itemCls? : string
314
+ /**
315
+ * An object containing typed child widget config objects or Widgets. May also be specified
316
+ * as an array.
317
+ * ...
318
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-items)
319
+ */
320
+ items? : Record<string, ContainerItemConfig|MenuItemEntry>|(ContainerItemConfig|MenuItemEntry|Widget)[]
321
+ /**
322
+ * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
323
+ * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
324
+ * are the name of the instance method to call when the keystroke is received.
325
+ * ...
326
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-keyMap)
327
+ */
328
+ keyMap? : Record<string, KeyMapConfig>
329
+ /**
330
+ * Convenience setting to use same label placement on all child widgets.
331
+ * ...
332
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-labelPosition)
333
+ */
334
+ labelPosition? : 'before'|'above'|'align-before'|'auto'|null
335
+ /**
336
+ * The short name of a helper class which manages rendering and styling of child items.
337
+ * ...
338
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-layout)
339
+ */
340
+ layout? : string|ContainerLayoutConfig
341
+ /**
342
+ * The CSS style properties to apply to the [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
343
+ * ...
344
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-layoutStyle)
345
+ */
346
+ layoutStyle? : object
347
+ /**
348
+ * An array of [child item](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-items) *config objects* which is to be converted into
349
+ * instances only when this Container is rendered, rather than eagerly at construct time.
350
+ * ...
351
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-lazyItems)
352
+ */
353
+ lazyItems? : Record<string, ContainerItemConfig>|ContainerItemConfig[]|Widget[]
354
+ /**
355
+ * The listener set for this object.
356
+ * ...
357
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-listeners)
358
+ */
359
+ listeners? : EditorListeners
360
+ /**
361
+ * A class translations of which are used for translating this entity.
362
+ * This is often used when translations of an item are defined on its container class.
363
+ * For example:
364
+ * ...
365
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-localeClass)
366
+ */
367
+ localeClass? : typeof Base
368
+ /**
369
+ * Set to `false` to disable localization of this object.
370
+ */
371
+ localizable? : boolean
372
+ /**
373
+ * List of properties which values should be translated automatically upon a locale applying.
374
+ * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
375
+ * you could use 'localeKey' meta configuration.
376
+ * Example:
377
+ * ...
378
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-localizableProperties)
379
+ */
380
+ localizableProperties? : string[]
381
+ /**
382
+ * Widget's margin. This may be configured as a single number or a `TRBL` format string.
383
+ * numeric-only values are interpreted as pixels.
384
+ */
385
+ margin? : number|string
386
+ /**
387
+ * This config object contains the defaults for the [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) created for the
388
+ * [masked](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
389
+ * values.
390
+ */
391
+ maskDefaults? : MaskConfig
392
+ /**
393
+ * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
394
+ * [Mask](https://bryntum.com/products/scheduler/docs/api/Core/widget/Mask) config object.
395
+ */
396
+ masked? : boolean|string|MaskConfig
397
+ /**
398
+ * Controls whether the editor should match target element's font when asked to [startEdit](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#function-startEdit)
399
+ */
400
+ matchFont? : boolean
401
+ /**
402
+ * By default, an Editor matches both dimensions, width and height of the element it is targeted at in the
403
+ * [startEdit](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#function-startEdit) function.
404
+ * ...
405
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-matchSize)
406
+ */
407
+ matchSize? : boolean|{
408
+ width?: boolean
409
+ height?: boolean
410
+ }
411
+ /**
412
+ * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
413
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
414
+ */
415
+ maxHeight? : string|number
416
+ /**
417
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
418
+ * ...
419
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-maximizeOnMobile)
420
+ */
421
+ maximizeOnMobile? : number|string
422
+ /**
423
+ * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
424
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
425
+ */
426
+ maxWidth? : string|number
427
+ /**
428
+ * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
429
+ * like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
430
+ */
431
+ minHeight? : string|number
432
+ /**
433
+ * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
434
+ * like [width](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
435
+ */
436
+ minWidth? : string|number
437
+ /**
438
+ * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
439
+ * is used to monitor this element for size changes caused by either style manipulation, or by CSS
440
+ * layout.
441
+ * ...
442
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-monitorResize)
443
+ */
444
+ monitorResize? : boolean|{
445
+ immediate?: boolean
446
+ }
447
+ /**
448
+ * An object containing default config objects which may be referenced by name in the [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-items)
449
+ * config. For example, a specialized [Menu](https://bryntum.com/products/scheduler/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
450
+ * value defined like this:
451
+ * ...
452
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-namedItems)
453
+ */
454
+ namedItems? : Record<string, ContainerItemConfig>
455
+ /**
456
+ * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
457
+ * [items](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
458
+ * the owner is <strong>always</strong> the encapsulating Container.
459
+ * ...
460
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-owner)
461
+ */
462
+ owner? : Widget|any
463
+ /**
464
+ * 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
465
+ * not participate in the standard layout of that widget, and must be positioned relatively to that
466
+ * widget's [contentElement](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-contentElement).
467
+ * ...
468
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-positioned)
469
+ */
470
+ positioned? : boolean
471
+ /**
472
+ * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
473
+ * menu on click etc, since the tooltip would be displayed at the same time.
474
+ */
475
+ preventTooltipOnTouch? : boolean
476
+ /**
477
+ * Whether this widget is read-only. This is only valid if the widget is an input
478
+ * field, <strong>or contains input fields at any depth</strong>.
479
+ * ...
480
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-readOnly)
481
+ */
482
+ readOnly? : boolean
483
+ /**
484
+ * [Record](https://bryntum.com/products/scheduler/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
485
+ * ...
486
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-record)
487
+ */
488
+ record? : Model
489
+ relayStoreEvents? : boolean
490
+ /**
491
+ * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
492
+ * `type`.
493
+ * ...
494
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-rendition)
495
+ */
496
+ rendition? : string|Record<string, string>|null
497
+ /**
498
+ * Configure as `true` to have the component display a translucent ripple when its
499
+ * [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
500
+ * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
501
+ * ...
502
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-ripple)
503
+ */
504
+ ripple? : boolean|{
505
+ delegate?: string
506
+ color?: string
507
+ radius?: number
508
+ clip?: string
509
+ }
510
+ /**
511
+ * 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`
512
+ */
513
+ rootElement? : ShadowRoot|HTMLElement
514
+ /**
515
+ * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
516
+ * ...
517
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-rtl)
518
+ */
519
+ rtl? : boolean
520
+ /**
521
+ * Specifies whether (and optionally in which axes) a Widget may scroll. `true` means this widget may scroll
522
+ * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
523
+ * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
524
+ * CSS overflow properties thus:
525
+ * ...
526
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-scrollable)
527
+ */
528
+ scrollable? : boolean|ScrollerConfig|Scroller
529
+ /**
530
+ * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
531
+ * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
532
+ */
533
+ scrollAction? : 'hide'|'realign'|null
534
+ /**
535
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
536
+ * ...
537
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-showAnimation)
538
+ */
539
+ showAnimation? : boolean|object
540
+ /**
541
+ * 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)
542
+ */
543
+ showTooltipWhenDisabled? : boolean
544
+ /**
545
+ * Programmatic control over how many columns to span when used in a grid layout.
546
+ */
547
+ span? : number
548
+ /**
549
+ * Specify `true` to match fields by their `name` property only when assigning a [record](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#config-record),
550
+ * without falling back to `ref`.
551
+ */
552
+ strictRecordMapping? : boolean
553
+ /**
554
+ * 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
555
+ * [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
556
+ * this widget:
557
+ * ...
558
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-tab)
559
+ */
560
+ tab? : boolean|TabConfig
561
+ /**
562
+ * When this container is used as a tab in a TabPanel, these items are added to the
563
+ * [TabBar](https://bryntum.com/products/scheduler/docs/api/Core/widget/TabBar) when this container is the active tab.
564
+ * ...
565
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-tabBarItems)
566
+ */
567
+ tabBarItems? : ToolbarItems[]|Widget[]
568
+ /**
569
+ * The tag name of this Widget's root element
570
+ */
571
+ tag? : string
572
+ /**
573
+ * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
574
+ * ...
575
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-textAlign)
576
+ */
577
+ textAlign? : 'left'|'center'|'right'|'start'|'end'
578
+ /**
579
+ * Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
580
+ * which specifies a default max-width that makes long text more readable.
581
+ * ...
582
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-textContent)
583
+ */
584
+ textContent? : boolean
585
+ /**
586
+ * A title to display for the widget. Only in effect when inside a container that uses it (such as TabPanel)
587
+ */
588
+ title? : string
589
+ /**
590
+ * Tooltip for the widget, either as a string or as a Tooltip config object.
591
+ * ...
592
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-tooltip)
593
+ */
594
+ tooltip? : string|TooltipConfig|null
595
+ type? : 'Editor'|'editor'
596
+ /**
597
+ * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
598
+ * as a space separated string, an array of strings, or as an object in which property names with truthy
599
+ * values are used as the class names.
600
+ * ...
601
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-ui)
602
+ */
603
+ ui? : string|object
604
+ /**
605
+ * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container).
606
+ * Higher weights go further down.
607
+ */
608
+ weight? : number
609
+ /**
610
+ * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
611
+ * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
612
+ * this config is convenient.
613
+ */
614
+ width? : string|number
615
+ /**
616
+ * The x position for the widget.
617
+ * ...
618
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-x)
619
+ */
620
+ x? : number
621
+ /**
622
+ * The y position for the widget.
623
+ * ...
624
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-y)
625
+ */
626
+ y? : number
627
+
628
+ // Events
629
+ /**
630
+ * Fired after the editor is finalized and hidden, regardless whether it was completed or aborted.
631
+ * @param {object} event Event object
632
+ * @param {Core.widget.Editor} event.source The Editor that triggered the event.
633
+ * @param {Core.data.Model} event.record The record that was edited.
634
+ */
635
+ onAfterEdit? : ((event: { source: Editor, record?: Model }) => void)|string
636
+ /**
637
+ * Fired when cancellation has been requested, either by `ESC`, or focus loss (if configured to cancel on blur).
638
+ * The cancellation may be vetoed, in which case, focus is moved back into the editor.
639
+ * @param {object} event Event object
640
+ * @param {object} event.oldValue The original value.
641
+ * @param {object} event.value The new value.
642
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
643
+ * @param {Core.widget.Editor} event.source The Editor that triggered the event.
644
+ */
645
+ onBeforeCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string
646
+ /**
647
+ * Fired when an edit completion has been requested, either by `ENTER`, or focus loss (if configured to complete on blur).
648
+ * The completion may be vetoed, in which case, focus is moved back into the editor.
649
+ * @param {object} event Event object
650
+ * @param {object} event.oldValue The original value.
651
+ * @param {object} event.value The new value.
652
+ * @param {Core.widget.Editor} event.source The Editor that triggered the event.
653
+ * @param {Function} event.finalize An async function may be injected into this property which performs asynchronous finalization tasks such as complex validation of confirmation. The value `true` or `false` must be returned.
654
+ * @param {object} event.finalize.context An object describing the editing context upon requested completion of the edit.
655
+ */
656
+ onBeforeComplete? : ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => Promise<boolean>|boolean|void)|string
657
+ /**
658
+ * Fires before an object is destroyed.
659
+ * @param {object} event Event object
660
+ * @param {Core.Base} event.source The Object that is being destroyed.
661
+ */
662
+ onBeforeDestroy? : ((event: { source: Base }) => void)|string
663
+ /**
664
+ * Triggered before a widget is hidden. Return `false` to prevent the action.
665
+ * @param {object} event Event object
666
+ * @param {Core.widget.Widget} event.source The widget being hidden.
667
+ */
668
+ onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
669
+ /**
670
+ * Fired before this container will load record values into its child fields. This is useful if you
671
+ * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
672
+ * @param {object} event Event object
673
+ * @param {Core.widget.Container} event.source The container
674
+ * @param {Core.data.Model} event.record The record
675
+ */
676
+ onBeforeSetRecord? : ((event: { source: Container, record: Model }) => void)|string
677
+ /**
678
+ * Triggered before a widget is shown. Return `false` to prevent the action.
679
+ * @param {object} event Event object
680
+ * @param {Core.widget.Widget,any} event.source The widget being shown
681
+ */
682
+ onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
683
+ /**
684
+ * Fired before the editor is shown to start an edit operation. Returning `false` from a handler vetoes the edit operation.
685
+ * @param {object} event Event object
686
+ * @param {HTMLElement} event.target The element which the Editor is to overlay to edit its content.
687
+ * @param {Core.data.Model} event.record The record being edited.
688
+ * @param {string} event.field The name of the field if a record is being edited.
689
+ * @param {object} event.value The value to be edited.
690
+ * @param {string,AlignSpec} event.align How to align the editor.
691
+ * @param {boolean} event.hideTarget `true` if the target is to be hidden during the edit.
692
+ * @param {boolean,object} event.matchSize Whether to match the target size. See [matchSize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-matchSize)
693
+ * @param {boolean} event.matchSize.width Match width
694
+ * @param {boolean} event.matchSize.height Match height
695
+ * @param {boolean} event.matchFont Whether to match the target's font. See [matchFont](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#config-matchFont)
696
+ * @param {boolean} event.focus Whether to focus the editor's field.
697
+ */
698
+ onBeforeStart? : ((event: { target: HTMLElement, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => Promise<boolean>|boolean|void)|string
699
+ /**
700
+ * Edit has been canceled without updating the associated record or element.
701
+ * @param {object} event Event object
702
+ * @param {object} event.oldValue The original value.
703
+ * @param {object} event.value The value of the field.
704
+ * @param {Event} event.event Included if the cancellation was triggered by a DOM event
705
+ * @param {Core.widget.Editor} event.source The Editor that triggered the event.
706
+ */
707
+ onCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) => void)|string
708
+ /**
709
+ * Fires when any other event is fired from the object.
710
+ * ...
711
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#event-catchAll)
712
+ * @param {object} event Event object
713
+ * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
714
+ * @param {string} event.event.type The type of the event which is caught by the listener
715
+ */
716
+ onCatchAll? : ((event: {[key: string]: any, type: string}) => void)|string
717
+ /**
718
+ * Edit has been completed, and any associated record or element has been updated.
719
+ * @param {object} event Event object
720
+ * @param {object} event.oldValue The original value.
721
+ * @param {object} event.value The new value.
722
+ * @param {Core.widget.Editor} event.source The Editor that triggered the event.
723
+ */
724
+ onComplete? : ((event: { oldValue: object, value: object, source: Editor }) => void)|string
725
+ /**
726
+ * Fires when an object is destroyed.
727
+ * @param {object} event Event object
728
+ * @param {Core.Base} event.source The Object that is being destroyed.
729
+ */
730
+ onDestroy? : ((event: { source: Base }) => void)|string
731
+ /**
732
+ * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-hasChanges) property changes
733
+ * @param {object} event Event object
734
+ * @param {Core.widget.Container} event.source The container.
735
+ * @param {boolean} event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
736
+ */
737
+ onDirtyStateChange? : ((event: { source: Container, dirty: boolean }) => void)|string
738
+ /**
739
+ * Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
740
+ * @param {object} event Event object
741
+ * @param {HTMLElement} event.element The Widget's element.
742
+ */
743
+ onElementCreated? : ((event: { element: HTMLElement }) => void)|string
744
+ /**
745
+ * Fired when focus enters this Widget.
746
+ * @param {object} event Event object
747
+ * @param {Core.widget.Widget} event.source This Widget
748
+ * @param {HTMLElement} event.fromElement The element which lost focus.
749
+ * @param {HTMLElement} event.toElement The element which gained focus.
750
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
751
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
752
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
753
+ */
754
+ onFocusIn? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
755
+ /**
756
+ * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
757
+ * focus moving from within this Widget's ownership tree, even if there are floating widgets
758
+ * will not trigger this event. This is when focus exits this widget completely.
759
+ * @param {object} event Event object
760
+ * @param {Core.widget.Widget} event.source This Widget
761
+ * @param {HTMLElement} event.fromElement The element which lost focus.
762
+ * @param {HTMLElement} event.toElement The element which gained focus.
763
+ * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
764
+ * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
765
+ * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
766
+ */
767
+ onFocusOut? : ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string
768
+ /**
769
+ * Triggered after a widget was hidden
770
+ * @param {object} event Event object
771
+ * @param {Core.widget.Widget} event.source The widget
772
+ */
773
+ onHide? : ((event: { source: Widget }) => void)|string
774
+ /**
775
+ * Fire to relay a `keydown` event from the field.
776
+ * @param {object} event Event object
777
+ * @param {Event} event.event The key event.
778
+ */
779
+ onKeyDown? : ((event: { event: Event }) => void)|string
780
+ /**
781
+ * Triggered when a widget which had been in a non-visible state for any reason
782
+ * achieves visibility.
783
+ * ...
784
+ * [View online docs...](https://bryntum.com/products/scheduler/docs/api/Core/widget/Editor#event-paint)
785
+ * @param {object} event Event object
786
+ * @param {Core.widget.Widget} event.source The widget being painted.
787
+ * @param {boolean} event.firstPaint `true` if this is the first paint.
788
+ */
789
+ onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
790
+ /**
791
+ * Fired when a Widget's read only state is toggled
792
+ * @param {object} event Event object
793
+ * @param {boolean} event.readOnly Read only or not
794
+ */
795
+ onReadOnly? : ((event: { readOnly: boolean }) => void)|string
796
+ /**
797
+ * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
798
+ * 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.
799
+ */
800
+ onRecompose? : (() => void)|string
801
+ /**
802
+ * 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`*.
803
+ * @param {object} event Event object
804
+ * @param {Core.widget.Widget} event.source This Widget
805
+ * @param {number} event.width The new width
806
+ * @param {number} event.height The new height
807
+ * @param {number} event.oldWidth The old width
808
+ * @param {number} event.oldHeight The old height
809
+ */
810
+ onResize? : ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string
811
+ /**
812
+ * Triggered after a widget is shown.
813
+ * @param {object} event Event object
814
+ * @param {Core.widget.Widget} event.source The widget
815
+ */
816
+ onShow? : ((event: { source: Widget }) => void)|string
817
+ /**
818
+ * Fired when an edit operation has begun.
819
+ * @param {object} event Event object
820
+ * @param {object} event.value The starting value of the field.
821
+ * @param {Core.widget.Editor} event.source The Editor that triggered the event.
822
+ */
823
+ onStart? : ((event: { value: object, source: Editor }) => void)|string
824
+
825
+ }
826
+
827
+ export class BryntumEditor extends React.Component<BryntumEditorProps> {
828
+
829
+ static instanceClass = Editor;
830
+
831
+ static instanceName = 'Editor';
832
+
833
+ processWidgetContent = processWidgetContent;
834
+
835
+ static configNames = [
836
+ 'adopt',
837
+ 'align',
838
+ 'anchor',
839
+ 'appendToTargetParent',
840
+ 'ariaDescription',
841
+ 'ariaLabel',
842
+ 'autoUpdateRecord',
843
+ 'blurAction',
844
+ 'bubbleEvents',
845
+ 'cancelKey',
846
+ 'centered',
847
+ 'color',
848
+ 'completeKey',
849
+ 'completeOnChange',
850
+ 'config',
851
+ 'constrainTo',
852
+ 'contentElementCls',
853
+ 'dataField',
854
+ 'defaultBindProperty',
855
+ 'defaultFocus',
856
+ 'defaults',
857
+ 'detectCSSCompatibilityIssues',
858
+ 'dock',
859
+ 'draggable',
860
+ 'elementAttributes',
861
+ 'fitTargetContent',
862
+ 'floating',
863
+ 'hideAnimation',
864
+ 'hideTarget',
865
+ 'hideWhenEmpty',
866
+ 'htmlCls',
867
+ 'ignoreParentReadOnly',
868
+ 'invalidAction',
869
+ 'itemCls',
870
+ 'lazyItems',
871
+ 'listeners',
872
+ 'localeClass',
873
+ 'localizable',
874
+ 'localizableProperties',
875
+ 'maskDefaults',
876
+ 'masked',
877
+ 'matchFont',
878
+ 'matchSize',
879
+ 'monitorResize',
880
+ 'namedItems',
881
+ 'owner',
882
+ 'positioned',
883
+ 'preventTooltipOnTouch',
884
+ 'relayStoreEvents',
885
+ 'ripple',
886
+ 'rootElement',
887
+ 'scrollAction',
888
+ 'showAnimation',
889
+ 'showTooltipWhenDisabled',
890
+ 'tab',
891
+ 'tabBarItems',
892
+ 'tag',
893
+ 'textAlign',
894
+ 'textContent',
895
+ 'title',
896
+ 'type',
897
+ 'ui',
898
+ 'weight'
899
+ ];
900
+
901
+ static propertyConfigNames = [
902
+ 'alignSelf',
903
+ 'appendTo',
904
+ 'callOnFunctions',
905
+ 'catchEventHandlerExceptions',
906
+ 'cls',
907
+ 'column',
908
+ 'content',
909
+ 'dataset',
910
+ 'disabled',
911
+ 'extraData',
912
+ 'flex',
913
+ 'height',
914
+ 'hidden',
915
+ 'html',
916
+ 'id',
917
+ 'inputField',
918
+ 'inputFieldAlign',
919
+ 'insertBefore',
920
+ 'insertFirst',
921
+ 'items',
922
+ 'keyMap',
923
+ 'labelPosition',
924
+ 'layout',
925
+ 'layoutStyle',
926
+ 'margin',
927
+ 'maxHeight',
928
+ 'maximizeOnMobile',
929
+ 'maxWidth',
930
+ 'minHeight',
931
+ 'minWidth',
932
+ 'onAfterEdit',
933
+ 'onBeforeCancel',
934
+ 'onBeforeComplete',
935
+ 'onBeforeDestroy',
936
+ 'onBeforeHide',
937
+ 'onBeforeSetRecord',
938
+ 'onBeforeShow',
939
+ 'onBeforeStart',
940
+ 'onCancel',
941
+ 'onCatchAll',
942
+ 'onComplete',
943
+ 'onDestroy',
944
+ 'onDirtyStateChange',
945
+ 'onElementCreated',
946
+ 'onFocusIn',
947
+ 'onFocusOut',
948
+ 'onHide',
949
+ 'onKeyDown',
950
+ 'onPaint',
951
+ 'onReadOnly',
952
+ 'onRecompose',
953
+ 'onResize',
954
+ 'onShow',
955
+ 'onStart',
956
+ 'readOnly',
957
+ 'record',
958
+ 'rendition',
959
+ 'rtl',
960
+ 'scrollable',
961
+ 'span',
962
+ 'strictRecordMapping',
963
+ 'tooltip',
964
+ 'width',
965
+ 'x',
966
+ 'y'
967
+ ];
968
+
969
+ static propertyNames = [
970
+ 'anchorSize',
971
+ 'focusVisible',
972
+ 'hasChanges',
973
+ 'isSettingValues',
974
+ 'isValid',
975
+ 'parent',
976
+ 'values'
977
+ ];
978
+
979
+ // Component instance
980
+ instance!: Editor;
981
+
982
+ // Component element
983
+ element! : HTMLElement;
984
+
985
+ componentDidMount(): void {
986
+ this.instance = createWidget(this);
987
+ }
988
+
989
+ componentWillUnmount(): void {
990
+ // @ts-ignore
991
+ this.instance?.destroy?.();
992
+ }
993
+
994
+ /**
995
+ * Component about to be updated, from changing a prop using state.
996
+ * React to it depending on what changed and prevent react from re-rendering our component.
997
+ * @param nextProps
998
+ * @param nextState
999
+ * @returns {boolean}
1000
+ */
1001
+ shouldComponentUpdate(nextProps: Readonly<BryntumEditorProps>, nextState: Readonly<{}>): boolean {
1002
+ return shouldComponentUpdate(this, nextProps, nextState);
1003
+ }
1004
+
1005
+ render(): React.ReactNode {
1006
+
1007
+ const className = `b-react-editor-container`;
1008
+ return (
1009
+ <div className={className} ref={(element) => (this.element = element!)}></div>
1010
+ );
1011
+
1012
+ }
1013
+ }