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