@bryntum/core-react-thin 7.2.4 → 7.3.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 (204) hide show
  1. package/lib/BryntumBooleanCombo.d.ts +262 -0
  2. package/lib/BryntumBooleanCombo.js +205 -0
  3. package/lib/BryntumBooleanCombo.js.map +1 -0
  4. package/lib/BryntumButton.d.ts +9 -17
  5. package/lib/BryntumButton.js +1 -2
  6. package/lib/BryntumButton.js.map +1 -1
  7. package/lib/BryntumButtonGroup.d.ts +9 -16
  8. package/lib/BryntumButtonGroup.js +2 -5
  9. package/lib/BryntumButtonGroup.js.map +1 -1
  10. package/lib/BryntumChatPanel.d.ts +19 -23
  11. package/lib/BryntumChatPanel.js +7 -6
  12. package/lib/BryntumChatPanel.js.map +1 -1
  13. package/lib/BryntumCheckbox.d.ts +10 -17
  14. package/lib/BryntumCheckbox.js +2 -2
  15. package/lib/BryntumCheckbox.js.map +1 -1
  16. package/lib/BryntumCheckboxGroup.d.ts +12 -24
  17. package/lib/BryntumCheckboxGroup.js +2 -6
  18. package/lib/BryntumCheckboxGroup.js.map +1 -1
  19. package/lib/BryntumChipView.d.ts +8 -16
  20. package/lib/BryntumChipView.js +1 -2
  21. package/lib/BryntumChipView.js.map +1 -1
  22. package/lib/BryntumCodeEditor.d.ts +12 -23
  23. package/lib/BryntumCodeEditor.js +2 -5
  24. package/lib/BryntumCodeEditor.js.map +1 -1
  25. package/lib/BryntumColorField.d.ts +9 -16
  26. package/lib/BryntumColorField.js +2 -2
  27. package/lib/BryntumColorField.js.map +1 -1
  28. package/lib/BryntumCombo.d.ts +12 -19
  29. package/lib/BryntumCombo.js +2 -2
  30. package/lib/BryntumCombo.js.map +1 -1
  31. package/lib/BryntumContainer.d.ts +8 -15
  32. package/lib/BryntumContainer.js +2 -5
  33. package/lib/BryntumContainer.js.map +1 -1
  34. package/lib/BryntumDateField.d.ts +9 -16
  35. package/lib/BryntumDateField.js +2 -2
  36. package/lib/BryntumDateField.js.map +1 -1
  37. package/lib/BryntumDatePicker.d.ts +12 -23
  38. package/lib/BryntumDatePicker.js +2 -5
  39. package/lib/BryntumDatePicker.js.map +1 -1
  40. package/lib/BryntumDateRangeField.d.ts +12 -19
  41. package/lib/BryntumDateRangeField.js +2 -2
  42. package/lib/BryntumDateRangeField.js.map +1 -1
  43. package/lib/BryntumDateTimeField.d.ts +9 -16
  44. package/lib/BryntumDateTimeField.js +2 -2
  45. package/lib/BryntumDateTimeField.js.map +1 -1
  46. package/lib/BryntumDemoCodeEditor.d.ts +12 -23
  47. package/lib/BryntumDemoCodeEditor.js +2 -5
  48. package/lib/BryntumDemoCodeEditor.js.map +1 -1
  49. package/lib/BryntumDisplayField.d.ts +9 -16
  50. package/lib/BryntumDisplayField.js +2 -2
  51. package/lib/BryntumDisplayField.js.map +1 -1
  52. package/lib/BryntumDurationField.d.ts +9 -16
  53. package/lib/BryntumDurationField.js +2 -2
  54. package/lib/BryntumDurationField.js.map +1 -1
  55. package/lib/BryntumEditor.d.ts +14 -24
  56. package/lib/BryntumEditor.js +2 -5
  57. package/lib/BryntumEditor.js.map +1 -1
  58. package/lib/BryntumFieldFilterPicker.d.ts +8 -15
  59. package/lib/BryntumFieldFilterPicker.js +2 -5
  60. package/lib/BryntumFieldFilterPicker.js.map +1 -1
  61. package/lib/BryntumFieldFilterPickerGroup.d.ts +9 -16
  62. package/lib/BryntumFieldFilterPickerGroup.js +2 -5
  63. package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
  64. package/lib/BryntumFieldSet.d.ts +12 -24
  65. package/lib/BryntumFieldSet.js +2 -6
  66. package/lib/BryntumFieldSet.js.map +1 -1
  67. package/lib/BryntumFileField.d.ts +9 -16
  68. package/lib/BryntumFileField.js +2 -2
  69. package/lib/BryntumFileField.js.map +1 -1
  70. package/lib/BryntumFilePicker.d.ts +8 -15
  71. package/lib/BryntumFilePicker.js +2 -5
  72. package/lib/BryntumFilePicker.js.map +1 -1
  73. package/lib/BryntumFilterField.d.ts +9 -16
  74. package/lib/BryntumFilterField.js +2 -2
  75. package/lib/BryntumFilterField.js.map +1 -1
  76. package/lib/BryntumHint.d.ts +24 -33
  77. package/lib/BryntumHint.js +2 -5
  78. package/lib/BryntumHint.js.map +1 -1
  79. package/lib/BryntumLabel.d.ts +7 -15
  80. package/lib/BryntumLabel.js +1 -2
  81. package/lib/BryntumLabel.js.map +1 -1
  82. package/lib/BryntumList.d.ts +8 -16
  83. package/lib/BryntumList.js +1 -2
  84. package/lib/BryntumList.js.map +1 -1
  85. package/lib/BryntumMenu.d.ts +23 -28
  86. package/lib/BryntumMenu.js +2 -6
  87. package/lib/BryntumMenu.js.map +1 -1
  88. package/lib/BryntumMonthPicker.d.ts +12 -23
  89. package/lib/BryntumMonthPicker.js +2 -5
  90. package/lib/BryntumMonthPicker.js.map +1 -1
  91. package/lib/BryntumNumberField.d.ts +9 -16
  92. package/lib/BryntumNumberField.js +2 -2
  93. package/lib/BryntumNumberField.js.map +1 -1
  94. package/lib/BryntumPagingToolbar.d.ts +12 -19
  95. package/lib/BryntumPagingToolbar.js +2 -5
  96. package/lib/BryntumPagingToolbar.js.map +1 -1
  97. package/lib/BryntumPanel.d.ts +12 -23
  98. package/lib/BryntumPanel.js +2 -5
  99. package/lib/BryntumPanel.js.map +1 -1
  100. package/lib/BryntumPasswordField.d.ts +9 -16
  101. package/lib/BryntumPasswordField.js +2 -2
  102. package/lib/BryntumPasswordField.js.map +1 -1
  103. package/lib/BryntumProgressBar.d.ts +7 -15
  104. package/lib/BryntumProgressBar.js +1 -2
  105. package/lib/BryntumProgressBar.js.map +1 -1
  106. package/lib/BryntumRadio.d.ts +10 -17
  107. package/lib/BryntumRadio.js +2 -2
  108. package/lib/BryntumRadio.js.map +1 -1
  109. package/lib/BryntumRadioGroup.d.ts +12 -24
  110. package/lib/BryntumRadioGroup.js +2 -6
  111. package/lib/BryntumRadioGroup.js.map +1 -1
  112. package/lib/BryntumSlideToggle.d.ts +10 -17
  113. package/lib/BryntumSlideToggle.js +2 -2
  114. package/lib/BryntumSlideToggle.js.map +1 -1
  115. package/lib/BryntumSlider.d.ts +8 -15
  116. package/lib/BryntumSlider.js +2 -2
  117. package/lib/BryntumSlider.js.map +1 -1
  118. package/lib/BryntumSplitter.d.ts +7 -15
  119. package/lib/BryntumSplitter.js +1 -2
  120. package/lib/BryntumSplitter.js.map +1 -1
  121. package/lib/BryntumTabPanel.d.ts +13 -24
  122. package/lib/BryntumTabPanel.js +2 -5
  123. package/lib/BryntumTabPanel.js.map +1 -1
  124. package/lib/BryntumTextAreaField.d.ts +10 -16
  125. package/lib/BryntumTextAreaField.js +3 -2
  126. package/lib/BryntumTextAreaField.js.map +1 -1
  127. package/lib/BryntumTextAreaPickerField.d.ts +10 -17
  128. package/lib/BryntumTextAreaPickerField.js +2 -2
  129. package/lib/BryntumTextAreaPickerField.js.map +1 -1
  130. package/lib/BryntumTextField.d.ts +9 -16
  131. package/lib/BryntumTextField.js +2 -2
  132. package/lib/BryntumTextField.js.map +1 -1
  133. package/lib/BryntumTimeField.d.ts +10 -17
  134. package/lib/BryntumTimeField.js +2 -2
  135. package/lib/BryntumTimeField.js.map +1 -1
  136. package/lib/BryntumTimePicker.d.ts +8 -15
  137. package/lib/BryntumTimePicker.js +2 -5
  138. package/lib/BryntumTimePicker.js.map +1 -1
  139. package/lib/BryntumToolbar.d.ts +12 -19
  140. package/lib/BryntumToolbar.js +2 -5
  141. package/lib/BryntumToolbar.js.map +1 -1
  142. package/lib/BryntumWidget.d.ts +7 -15
  143. package/lib/BryntumWidget.js +1 -2
  144. package/lib/BryntumWidget.js.map +1 -1
  145. package/lib/BryntumYearPicker.d.ts +12 -23
  146. package/lib/BryntumYearPicker.js +2 -5
  147. package/lib/BryntumYearPicker.js.map +1 -1
  148. package/lib/WrapperHelper.js +2 -2
  149. package/lib/WrapperHelper.js.map +1 -1
  150. package/lib/index.d.ts +1 -0
  151. package/lib/index.js +1 -0
  152. package/lib/index.js.map +1 -1
  153. package/package.json +1 -1
  154. package/src/BryntumBooleanCombo.tsx +1190 -0
  155. package/src/BryntumButton.tsx +72 -118
  156. package/src/BryntumButtonGroup.tsx +79 -124
  157. package/src/BryntumChatPanel.tsx +142 -172
  158. package/src/BryntumCheckbox.tsx +85 -119
  159. package/src/BryntumCheckboxGroup.tsx +112 -182
  160. package/src/BryntumChipView.tsx +67 -107
  161. package/src/BryntumCodeEditor.tsx +109 -170
  162. package/src/BryntumColorField.tsx +84 -118
  163. package/src/BryntumCombo.tsx +103 -153
  164. package/src/BryntumContainer.tsx +79 -125
  165. package/src/BryntumDateField.tsx +91 -124
  166. package/src/BryntumDatePicker.tsx +122 -196
  167. package/src/BryntumDateRangeField.tsx +90 -127
  168. package/src/BryntumDateTimeField.tsx +84 -118
  169. package/src/BryntumDemoCodeEditor.tsx +109 -170
  170. package/src/BryntumDisplayField.tsx +85 -120
  171. package/src/BryntumDurationField.tsx +91 -126
  172. package/src/BryntumEditor.tsx +95 -145
  173. package/src/BryntumFieldFilterPicker.tsx +81 -129
  174. package/src/BryntumFieldFilterPickerGroup.tsx +84 -134
  175. package/src/BryntumFieldSet.tsx +108 -175
  176. package/src/BryntumFileField.tsx +84 -118
  177. package/src/BryntumFilePicker.tsx +79 -125
  178. package/src/BryntumFilterField.tsx +87 -124
  179. package/src/BryntumHint.tsx +136 -193
  180. package/src/BryntumLabel.tsx +60 -96
  181. package/src/BryntumList.tsx +64 -103
  182. package/src/BryntumMenu.tsx +131 -191
  183. package/src/BryntumMonthPicker.tsx +109 -170
  184. package/src/BryntumNumberField.tsx +88 -122
  185. package/src/BryntumPagingToolbar.tsx +84 -131
  186. package/src/BryntumPanel.tsx +109 -170
  187. package/src/BryntumPasswordField.tsx +84 -118
  188. package/src/BryntumProgressBar.tsx +59 -94
  189. package/src/BryntumRadio.tsx +85 -119
  190. package/src/BryntumRadioGroup.tsx +112 -181
  191. package/src/BryntumSlideToggle.tsx +85 -119
  192. package/src/BryntumSlider.tsx +68 -102
  193. package/src/BryntumSplitter.tsx +62 -100
  194. package/src/BryntumTabPanel.tsx +111 -173
  195. package/src/BryntumTextAreaField.tsx +92 -120
  196. package/src/BryntumTextAreaPickerField.tsx +86 -121
  197. package/src/BryntumTextField.tsx +85 -120
  198. package/src/BryntumTimeField.tsx +90 -121
  199. package/src/BryntumTimePicker.tsx +79 -125
  200. package/src/BryntumToolbar.tsx +84 -131
  201. package/src/BryntumWidget.tsx +60 -96
  202. package/src/BryntumYearPicker.tsx +110 -172
  203. package/src/WrapperHelper.tsx +2 -2
  204. package/src/index.ts +1 -0
@@ -3,7 +3,7 @@
3
3
  */
4
4
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
5
  import React, { RefObject } from 'react';
6
- import { AlignSpec, Base, Color, CoreContainerItemConfig, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, FileField, FileFieldListeners, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, CoreContainerItemConfig, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, FileField, FileFieldListeners, KeyMapConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
7
7
 
8
8
  import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
9
9
 
@@ -17,14 +17,12 @@ export type BryntumFileFieldProps = {
17
17
  /**
18
18
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
19
19
  * content will be placed inside this element.
20
- * ...
21
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-adopt)
20
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-adopt)
22
21
  */
23
22
  adopt? : HTMLElement|string
24
23
  /**
25
24
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
26
- * ...
27
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-align)
25
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-align)
28
26
  */
29
27
  align? : AlignSpec|string
30
28
  /**
@@ -46,15 +44,13 @@ export type BryntumFileFieldProps = {
46
44
  /**
47
45
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
48
46
  * into an element which will be linked using the `aria-describedby` attribute.
49
- * ...
50
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ariaDescription)
47
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ariaDescription)
51
48
  */
52
49
  ariaDescription? : string
53
50
  /**
54
51
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
55
52
  * the `aria-label` attribute.
56
- * ...
57
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ariaLabel)
53
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ariaLabel)
58
54
  */
59
55
  ariaLabel? : string
60
56
  /**
@@ -73,21 +69,18 @@ export type BryntumFileFieldProps = {
73
69
  /**
74
70
  * An object where property names with a truthy value indicate which events should bubble up the ownership
75
71
  * hierarchy when triggered.
76
- * ...
77
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-bubbleEvents)
72
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-bubbleEvents)
78
73
  */
79
74
  bubbleEvents? : object
80
75
  /**
81
76
  * 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/grid/docs/api/Core/widget/FileField#config-callOnFunctions)
77
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-callOnFunctions)
84
78
  */
85
79
  callOnFunctions? : boolean
86
80
  /**
87
81
  * By default, if an event handler throws an exception, the error propagates up the stack and the
88
82
  * application state is undefined. Code which follows the event handler will *not* be executed.
89
- * ...
90
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-catchEventHandlerExceptions)
83
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-catchEventHandlerExceptions)
91
84
  */
92
85
  catchEventHandlerExceptions? : boolean
93
86
  /**
@@ -95,6 +88,15 @@ export type BryntumFileFieldProps = {
95
88
  * Set to `true` to centre the Widget in browser viewport space.
96
89
  */
97
90
  centered? : boolean
91
+ /**
92
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
93
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
94
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
95
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-checkValidity)
96
+ * @param {Core.widget.Field} field The field being validated
97
+ * @returns {void}
98
+ */
99
+ checkValidity? : ((field: Field) => void)|string
98
100
  /**
99
101
  * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
100
102
  * in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -105,15 +107,13 @@ export type BryntumFileFieldProps = {
105
107
  * Custom CSS classes to add to element.
106
108
  * May be specified as a space separated string, or as an object in which property names
107
109
  * with truthy values are used as the class names:
108
- * ...
109
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-cls)
110
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-cls)
110
111
  */
111
112
  cls? : string|object
112
113
  /**
113
114
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
114
115
  * `style` block.
115
- * ...
116
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-color)
116
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-color)
117
117
  */
118
118
  color? : Color
119
119
  /**
@@ -130,15 +130,13 @@ export type BryntumFileFieldProps = {
130
130
  * The configuration for additional items associated to this field. This is typically used to add contextual
131
131
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
132
132
  * these classes for examples of nested fields.
133
- * ...
134
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-container)
133
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-container)
135
134
  */
136
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
135
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
137
136
  /**
138
137
  * The config controls how the value of nested items are handled when a parent container gets or sets its
139
138
  * [values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
140
- * ...
141
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-containValues)
139
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-containValues)
142
140
  * @param {Core.widget.Field} field Field instance
143
141
  * @returns {boolean}
144
142
  */
@@ -147,8 +145,7 @@ export type BryntumFileFieldProps = {
147
145
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
148
146
  * May be specified as a space separated string, or as an object in which property names
149
147
  * with truthy values are used as the class names:
150
- * ...
151
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-contentElementCls)
148
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-contentElementCls)
152
149
  */
153
150
  contentElementCls? : string|object
154
151
  /**
@@ -166,16 +163,15 @@ export type BryntumFileFieldProps = {
166
163
  */
167
164
  defaultBindProperty? : string
168
165
  /**
169
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
170
- * ...
171
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-detectCSSCompatibilityIssues)
166
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
167
+ * checks:
168
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-detectCSSCompatibilityIssues)
172
169
  */
173
170
  detectCSSCompatibilityIssues? : boolean
174
171
  /**
175
172
  * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
176
173
  * 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/grid/docs/api/Core/widget/FileField#config-disabled)
174
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-disabled)
179
175
  */
180
176
  disabled? : boolean|'inert'
181
177
  /**
@@ -183,33 +179,28 @@ export type BryntumFileFieldProps = {
183
179
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
184
180
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
185
181
  * body. Such widgets are called "edge strips".
186
- * ...
187
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-dock)
182
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-dock)
188
183
  */
189
184
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
190
185
  /**
191
186
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
192
187
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
193
188
  * property which controls when a drag should start.
194
- * ...
195
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-draggable)
189
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-draggable)
190
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
196
191
  */
197
- draggable? : boolean|{
198
- handleSelector?: string
199
- }
192
+ draggable? : boolean|object
200
193
  /**
201
194
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
202
195
  * [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly), but for PickerFields there is a distinction where it allows you to pick a value
203
196
  * but not to type one in the field.
204
- * ...
205
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-editable)
197
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-editable)
206
198
  */
207
199
  editable? : boolean
208
200
  /**
209
201
  * An object specifying attributes to assign to the root element of this widget.
210
202
  * Set `null` value to attribute to remove it.
211
- * ...
212
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-elementAttributes)
203
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-elementAttributes)
213
204
  */
214
205
  elementAttributes? : Record<string, string|null>
215
206
  extraData? : any
@@ -238,8 +229,7 @@ export type BryntumFileFieldProps = {
238
229
  hidden? : boolean
239
230
  /**
240
231
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
241
- * ...
242
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-hideAnimation)
232
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-hideAnimation)
243
233
  */
244
234
  hideAnimation? : boolean|object
245
235
  /**
@@ -249,8 +239,7 @@ export type BryntumFileFieldProps = {
249
239
  /**
250
240
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
251
241
  * a field's units.
252
- * ...
253
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-hint)
242
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-hint)
254
243
  * @param {object} data A data object
255
244
  * @param {Core.widget.Field} data.source A reference to the field instance
256
245
  * @param {any} data.value The current value of the field
@@ -261,8 +250,7 @@ export type BryntumFileFieldProps = {
261
250
  * This config is similar to [hint](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-hint) except that this config is used to display HTML content.
262
251
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
263
252
  * encode such data (see [encodeHtml](https://bryntum.com/products/core/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
264
- * ...
265
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-hintHtml)
253
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-hintHtml)
266
254
  * @param {object} data A data object
267
255
  * @param {Core.widget.Field} data.source A reference to the field instance
268
256
  * @param {any} data.value The current value of the field
@@ -275,16 +263,14 @@ export type BryntumFileFieldProps = {
275
263
  id? : string
276
264
  /**
277
265
  * Determines if the widgets read-only state should be controlled by its parent.
278
- * ...
279
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ignoreParentReadOnly)
266
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ignoreParentReadOnly)
280
267
  */
281
268
  ignoreParentReadOnly? : boolean
282
269
  /**
283
270
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
284
271
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
285
272
  * [container](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-container).
286
- * ...
287
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-inline)
273
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-inline)
288
274
  */
289
275
  inline? : boolean
290
276
  /**
@@ -324,16 +310,14 @@ export type BryntumFileFieldProps = {
324
310
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
325
311
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
326
312
  * are the name of the instance method to call when the keystroke is received.
327
- * ...
328
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-keyMap)
313
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-keyMap)
329
314
  */
330
315
  keyMap? : Record<string, KeyMapConfig>
331
316
  /**
332
317
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
333
318
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
334
319
  * immediate feedback, change will still be triggered on blur).
335
- * ...
336
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-keyStrokeChangeDelay)
320
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-keyStrokeChangeDelay)
337
321
  */
338
322
  keyStrokeChangeDelay? : number
339
323
  /**
@@ -346,15 +330,15 @@ export type BryntumFileFieldProps = {
346
330
  labelCls? : string|object
347
331
  /**
348
332
  * Label position, either 'before' the field or 'above' the field
349
- * ...
350
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-labelPosition)
333
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-labelPosition)
351
334
  */
352
335
  labelPosition? : 'before'|'above'|null
353
336
  /**
354
337
  * The labels to add either before or after the input field.
355
338
  * Each label may have the following properties:
356
- * ...
357
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-labels)
339
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-labels)
340
+ * @property {string} html Label text
341
+ * @property {'start','end'} align Which end of the file the label should go
358
342
  */
359
343
  labels? : object[]
360
344
  /**
@@ -363,16 +347,14 @@ export type BryntumFileFieldProps = {
363
347
  labelWidth? : string|number
364
348
  /**
365
349
  * The listener set for this object.
366
- * ...
367
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-listeners)
350
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-listeners)
368
351
  */
369
352
  listeners? : FileFieldListeners
370
353
  /**
371
354
  * A class translations of which are used for translating this entity.
372
355
  * This is often used when translations of an item are defined on its container class.
373
356
  * For example:
374
- * ...
375
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-localeClass)
357
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-localeClass)
376
358
  */
377
359
  localeClass? : typeof Base
378
360
  /**
@@ -384,8 +366,7 @@ export type BryntumFileFieldProps = {
384
366
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
385
367
  * you could use 'localeKey' meta configuration.
386
368
  * Example:
387
- * ...
388
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-localizableProperties)
369
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-localizableProperties)
389
370
  */
390
371
  localizableProperties? : string[]
391
372
  /**
@@ -411,8 +392,7 @@ export type BryntumFileFieldProps = {
411
392
  maxHeight? : string|number
412
393
  /**
413
394
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
414
- * ...
415
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-maximizeOnMobile)
395
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-maximizeOnMobile)
416
396
  */
417
397
  maximizeOnMobile? : number|string
418
398
  /**
@@ -434,12 +414,10 @@ export type BryntumFileFieldProps = {
434
414
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
435
415
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
436
416
  * layout.
437
- * ...
438
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-monitorResize)
417
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-monitorResize)
418
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
439
419
  */
440
- monitorResize? : boolean|{
441
- immediate?: boolean
442
- }
420
+ monitorResize? : boolean|object
443
421
  /**
444
422
  * Set to `true` to allow picking multiple files. Note that when set to a truthy value,
445
423
  * the field is set to accept multiple files, but the value returned will be
@@ -450,8 +428,7 @@ export type BryntumFileFieldProps = {
450
428
  * Name of the field which is used as a key to get/set values from/to the field.
451
429
  * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
452
430
  * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
453
- * ...
454
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-name)
431
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-name)
455
432
  */
456
433
  name? : string
457
434
  /**
@@ -462,8 +439,7 @@ export type BryntumFileFieldProps = {
462
439
  * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement), but must
463
440
  * not participate in the standard layout of that widget, and must be positioned relatively to that
464
441
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
465
- * ...
466
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-positioned)
442
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-positioned)
467
443
  */
468
444
  positioned? : boolean
469
445
  /**
@@ -474,8 +450,7 @@ export type BryntumFileFieldProps = {
474
450
  /**
475
451
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
476
452
  * are unresponsive.
477
- * ...
478
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-readOnly)
453
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-readOnly)
479
454
  */
480
455
  readOnly? : boolean
481
456
  relayStoreEvents? : boolean
@@ -495,23 +470,26 @@ export type BryntumFileFieldProps = {
495
470
  * Configure as `true` to have the component display a translucent ripple when its
496
471
  * [focusElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
497
472
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
498
- * ...
499
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ripple)
500
- */
501
- ripple? : boolean|{
502
- delegate?: string
503
- color?: string
504
- radius?: number
505
- clip?: string
506
- }
473
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ripple)
474
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
475
+ * @property {string} [color] A CSS color name or specification.
476
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
477
+ * @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
478
+ */
479
+ ripple? : boolean|object
480
+ /**
481
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
482
+ * accidentally applying a role which may interfere with screen readers.
483
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-role)
484
+ */
485
+ role? : string
507
486
  /**
508
487
  * 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`
509
488
  */
510
489
  rootElement? : ShadowRoot|HTMLElement
511
490
  /**
512
491
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
513
- * ...
514
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-rtl)
492
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-rtl)
515
493
  */
516
494
  rtl? : boolean
517
495
  /**
@@ -521,8 +499,7 @@ export type BryntumFileFieldProps = {
521
499
  scrollAction? : 'hide'|'realign'|null
522
500
  /**
523
501
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
524
- * ...
525
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-showAnimation)
502
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-showAnimation)
526
503
  */
527
504
  showAnimation? : boolean|object
528
505
  /**
@@ -551,8 +528,7 @@ export type BryntumFileFieldProps = {
551
528
  * A configuration for the [tab](https://bryntum.com/products/core/docs/api/Core/widget/Tab) created for this widget when it is placed in a
552
529
  * [TabPanel](https://bryntum.com/products/core/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
553
530
  * this widget:
554
- * ...
555
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-tab)
531
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-tab)
556
532
  */
557
533
  tab? : boolean|TabConfig
558
534
  /**
@@ -560,14 +536,12 @@ export type BryntumFileFieldProps = {
560
536
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
561
537
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
562
538
  * to the element programmatically.
563
- * ...
564
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-tabIndex)
539
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-tabIndex)
565
540
  */
566
541
  tabIndex? : number
567
542
  /**
568
543
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
569
- * ...
570
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-textAlign)
544
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-textAlign)
571
545
  */
572
546
  textAlign? : 'left'|'center'|'right'|'start'|'end'
573
547
  /**
@@ -576,24 +550,21 @@ export type BryntumFileFieldProps = {
576
550
  title? : string
577
551
  /**
578
552
  * Tooltip for the widget, either as a string or as a Tooltip config object.
579
- * ...
580
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-tooltip)
553
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-tooltip)
581
554
  */
582
555
  tooltip? : string|TooltipConfig|null
583
556
  /**
584
557
  * The triggers to add either before or after the input field. Each property name is the reference by which
585
558
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
586
- * ...
587
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-triggers)
559
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-triggers)
588
560
  */
589
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
561
+ triggers? : Record<string, FieldTriggerConfig>
590
562
  type? : 'filefield'
591
563
  /**
592
564
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
593
565
  * as a space separated string, an array of strings, or as an object in which property names with truthy
594
566
  * values are used as the class names.
595
- * ...
596
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ui)
567
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-ui)
597
568
  */
598
569
  ui? : string|object
599
570
  /**
@@ -618,14 +589,12 @@ export type BryntumFileFieldProps = {
618
589
  width? : string|number
619
590
  /**
620
591
  * The x position for the widget.
621
- * ...
622
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-x)
592
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-x)
623
593
  */
624
594
  x? : number
625
595
  /**
626
596
  * The y position for the widget.
627
- * ...
628
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-y)
597
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-y)
629
598
  */
630
599
  y? : number
631
600
 
@@ -655,7 +624,7 @@ export type BryntumFileFieldProps = {
655
624
  * @param {object} event Event object
656
625
  * @param {Core.widget.Widget} event.source The widget being hidden.
657
626
  */
658
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
627
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
659
628
  /**
660
629
  * Triggered before a widget is shown. Return `false` to prevent the action.
661
630
  * @param {object} event Event object
@@ -664,8 +633,7 @@ export type BryntumFileFieldProps = {
664
633
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
665
634
  /**
666
635
  * Fires when any other event is fired from the object.
667
- * ...
668
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#event-catchAll)
636
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#event-catchAll)
669
637
  * @param {object} event Event object
670
638
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
671
639
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -685,8 +653,7 @@ export type BryntumFileFieldProps = {
685
653
  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
686
654
  /**
687
655
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
688
- * ...
689
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#event-clear)
656
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#event-clear)
690
657
  * @param {object} event Event object
691
658
  * @param {Core.widget.Field,any} event.source This Field
692
659
  */
@@ -744,8 +711,7 @@ export type BryntumFileFieldProps = {
744
711
  /**
745
712
  * Triggered when a widget which had been in a non-visible state for any reason
746
713
  * achieves visibility.
747
- * ...
748
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#event-paint)
714
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#event-paint)
749
715
  * @param {object} event Event object
750
716
  * @param {Core.widget.Widget} event.source The widget being painted.
751
717
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -807,6 +773,7 @@ export class BryntumFileField extends React.Component<BryntumFileFieldProps> {
807
773
  'autoSelect',
808
774
  'bubbleEvents',
809
775
  'centered',
776
+ 'checkValidity',
810
777
  'clearable',
811
778
  'color',
812
779
  'config',
@@ -851,6 +818,7 @@ export class BryntumFileField extends React.Component<BryntumFileFieldProps> {
851
818
  'relayStoreEvents',
852
819
  'revertOnEscape',
853
820
  'ripple',
821
+ 'role',
854
822
  'rootElement',
855
823
  'scrollAction',
856
824
  'showAnimation',
@@ -927,9 +895,7 @@ export class BryntumFileField extends React.Component<BryntumFileFieldProps> {
927
895
  ];
928
896
 
929
897
  static propertyNames = [
930
- 'anchorSize',
931
898
  'content',
932
- 'focusVisible',
933
899
  'html',
934
900
  'input',
935
901
  'parent',