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