@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, ColorDescriptor, ColorField, ColorFieldListeners, CoreContainerItemConfig, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, ColorDescriptor, ColorField, ColorFieldListeners, CoreContainerItemConfig, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, 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
 
@@ -16,14 +16,12 @@ export type BryntumColorFieldProps = {
16
16
  /**
17
17
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
18
18
  * content will be placed inside this element.
19
- * ...
20
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-adopt)
19
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-adopt)
21
20
  */
22
21
  adopt? : HTMLElement|string
23
22
  /**
24
23
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
25
- * ...
26
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-align)
24
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-align)
27
25
  */
28
26
  align? : AlignSpec|string
29
27
  /**
@@ -45,15 +43,13 @@ export type BryntumColorFieldProps = {
45
43
  /**
46
44
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
47
45
  * into an element which will be linked using the `aria-describedby` attribute.
48
- * ...
49
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ariaDescription)
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ariaDescription)
50
47
  */
51
48
  ariaDescription? : string
52
49
  /**
53
50
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
54
51
  * the `aria-label` attribute.
55
- * ...
56
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ariaLabel)
52
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ariaLabel)
57
53
  */
58
54
  ariaLabel? : string
59
55
  /**
@@ -76,21 +72,18 @@ export type BryntumColorFieldProps = {
76
72
  /**
77
73
  * An object where property names with a truthy value indicate which events should bubble up the ownership
78
74
  * hierarchy when triggered.
79
- * ...
80
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-bubbleEvents)
75
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-bubbleEvents)
81
76
  */
82
77
  bubbleEvents? : object
83
78
  /**
84
79
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
85
- * ...
86
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-callOnFunctions)
80
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-callOnFunctions)
87
81
  */
88
82
  callOnFunctions? : boolean
89
83
  /**
90
84
  * By default, if an event handler throws an exception, the error propagates up the stack and the
91
85
  * application state is undefined. Code which follows the event handler will *not* be executed.
92
- * ...
93
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-catchEventHandlerExceptions)
86
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-catchEventHandlerExceptions)
94
87
  */
95
88
  catchEventHandlerExceptions? : boolean
96
89
  /**
@@ -98,6 +91,15 @@ export type BryntumColorFieldProps = {
98
91
  * Set to `true` to centre the Widget in browser viewport space.
99
92
  */
100
93
  centered? : boolean
94
+ /**
95
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
96
+ * 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)
97
+ * evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
98
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-checkValidity)
99
+ * @param {Core.widget.Field} field The field being validated
100
+ * @returns {void}
101
+ */
102
+ checkValidity? : ((field: Field) => void)|string
101
103
  /**
102
104
  * 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
103
105
  * 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
@@ -108,16 +110,14 @@ export type BryntumColorFieldProps = {
108
110
  * Custom CSS classes to add to element.
109
111
  * May be specified as a space separated string, or as an object in which property names
110
112
  * with truthy values are used as the class names:
111
- * ...
112
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-cls)
113
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-cls)
113
114
  */
114
115
  cls? : string|object
115
116
  /**
116
117
  * The `colors` property can be an array of string CSS colors or of objects with `color`
117
118
  * and `text` properties from which the user can chose from. This will override the
118
119
  * [pickers default colors](https://bryntum.com/products/core/docs/api/Core/widget/ColorPicker#config-colors).
119
- * ...
120
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-colors)
120
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-colors)
121
121
  */
122
122
  colors? : (string|ColorDescriptor)[]
123
123
  /**
@@ -134,15 +134,13 @@ export type BryntumColorFieldProps = {
134
134
  * The configuration for additional items associated to this field. This is typically used to add contextual
135
135
  * fields related to a [checkbox](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
136
136
  * these classes for examples of nested fields.
137
- * ...
138
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-container)
137
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-container)
139
138
  */
140
- container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig|FieldContainer
139
+ container? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|FieldContainerConfig
141
140
  /**
142
141
  * The config controls how the value of nested items are handled when a parent container gets or sets its
143
142
  * [values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
144
- * ...
145
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-containValues)
143
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-containValues)
146
144
  * @param {Core.widget.Field} field Field instance
147
145
  * @returns {boolean}
148
146
  */
@@ -151,8 +149,7 @@ export type BryntumColorFieldProps = {
151
149
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
152
150
  * May be specified as a space separated string, or as an object in which property names
153
151
  * with truthy values are used as the class names:
154
- * ...
155
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-contentElementCls)
152
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-contentElementCls)
156
153
  */
157
154
  contentElementCls? : string|object
158
155
  /**
@@ -170,16 +167,15 @@ export type BryntumColorFieldProps = {
170
167
  */
171
168
  defaultBindProperty? : string
172
169
  /**
173
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
174
- * ...
175
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-detectCSSCompatibilityIssues)
170
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
171
+ * checks:
172
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-detectCSSCompatibilityIssues)
176
173
  */
177
174
  detectCSSCompatibilityIssues? : boolean
178
175
  /**
179
176
  * 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
180
177
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
181
- * ...
182
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-disabled)
178
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-disabled)
183
179
  */
184
180
  disabled? : boolean|'inert'
185
181
  /**
@@ -187,25 +183,21 @@ export type BryntumColorFieldProps = {
187
183
  * [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
188
184
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
189
185
  * body. Such widgets are called "edge strips".
190
- * ...
191
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-dock)
186
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-dock)
192
187
  */
193
188
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
194
189
  /**
195
190
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
196
191
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
197
192
  * property which controls when a drag should start.
198
- * ...
199
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-draggable)
193
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-draggable)
194
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
200
195
  */
201
- draggable? : boolean|{
202
- handleSelector?: string
203
- }
196
+ draggable? : boolean|object
204
197
  /**
205
198
  * An object specifying attributes to assign to the root element of this widget.
206
199
  * Set `null` value to attribute to remove it.
207
- * ...
208
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-elementAttributes)
200
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-elementAttributes)
209
201
  */
210
202
  elementAttributes? : Record<string, string|null>
211
203
  extraData? : any
@@ -234,8 +226,7 @@ export type BryntumColorFieldProps = {
234
226
  hidden? : boolean
235
227
  /**
236
228
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
237
- * ...
238
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-hideAnimation)
229
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-hideAnimation)
239
230
  */
240
231
  hideAnimation? : boolean|object
241
232
  /**
@@ -245,8 +236,7 @@ export type BryntumColorFieldProps = {
245
236
  /**
246
237
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
247
238
  * a field's units.
248
- * ...
249
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-hint)
239
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-hint)
250
240
  * @param {object} data A data object
251
241
  * @param {Core.widget.Field} data.source A reference to the field instance
252
242
  * @param {any} data.value The current value of the field
@@ -257,8 +247,7 @@ export type BryntumColorFieldProps = {
257
247
  * 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.
258
248
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
259
249
  * encode such data (see [encodeHtml](https://bryntum.com/products/core/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
260
- * ...
261
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-hintHtml)
250
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-hintHtml)
262
251
  * @param {object} data A data object
263
252
  * @param {Core.widget.Field} data.source A reference to the field instance
264
253
  * @param {any} data.value The current value of the field
@@ -271,16 +260,14 @@ export type BryntumColorFieldProps = {
271
260
  id? : string
272
261
  /**
273
262
  * Determines if the widgets read-only state should be controlled by its parent.
274
- * ...
275
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ignoreParentReadOnly)
263
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ignoreParentReadOnly)
276
264
  */
277
265
  ignoreParentReadOnly? : boolean
278
266
  /**
279
267
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
280
268
  * [hbox](https://bryntum.com/products/core/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
281
269
  * [container](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-container).
282
- * ...
283
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-inline)
270
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-inline)
284
271
  */
285
272
  inline? : boolean
286
273
  /**
@@ -320,16 +307,14 @@ export type BryntumColorFieldProps = {
320
307
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
321
308
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
322
309
  * are the name of the instance method to call when the keystroke is received.
323
- * ...
324
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-keyMap)
310
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-keyMap)
325
311
  */
326
312
  keyMap? : Record<string, KeyMapConfig>
327
313
  /**
328
314
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
329
315
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
330
316
  * immediate feedback, change will still be triggered on blur).
331
- * ...
332
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-keyStrokeChangeDelay)
317
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-keyStrokeChangeDelay)
333
318
  */
334
319
  keyStrokeChangeDelay? : number
335
320
  /**
@@ -342,15 +327,15 @@ export type BryntumColorFieldProps = {
342
327
  labelCls? : string|object
343
328
  /**
344
329
  * Label position, either 'before' the field or 'above' the field
345
- * ...
346
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-labelPosition)
330
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-labelPosition)
347
331
  */
348
332
  labelPosition? : 'before'|'above'|null
349
333
  /**
350
334
  * The labels to add either before or after the input field.
351
335
  * Each label may have the following properties:
352
- * ...
353
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-labels)
336
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-labels)
337
+ * @property {string} html Label text
338
+ * @property {'start','end'} align Which end of the file the label should go
354
339
  */
355
340
  labels? : object[]
356
341
  /**
@@ -359,16 +344,14 @@ export type BryntumColorFieldProps = {
359
344
  labelWidth? : string|number
360
345
  /**
361
346
  * The listener set for this object.
362
- * ...
363
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-listeners)
347
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-listeners)
364
348
  */
365
349
  listeners? : ColorFieldListeners
366
350
  /**
367
351
  * A class translations of which are used for translating this entity.
368
352
  * This is often used when translations of an item are defined on its container class.
369
353
  * For example:
370
- * ...
371
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-localeClass)
354
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-localeClass)
372
355
  */
373
356
  localeClass? : typeof Base
374
357
  /**
@@ -380,8 +363,7 @@ export type BryntumColorFieldProps = {
380
363
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
381
364
  * you could use 'localeKey' meta configuration.
382
365
  * Example:
383
- * ...
384
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-localizableProperties)
366
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-localizableProperties)
385
367
  */
386
368
  localizableProperties? : string[]
387
369
  /**
@@ -407,8 +389,7 @@ export type BryntumColorFieldProps = {
407
389
  maxHeight? : string|number
408
390
  /**
409
391
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
410
- * ...
411
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-maximizeOnMobile)
392
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-maximizeOnMobile)
412
393
  */
413
394
  maximizeOnMobile? : number|string
414
395
  /**
@@ -438,18 +419,15 @@ export type BryntumColorFieldProps = {
438
419
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
439
420
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
440
421
  * layout.
441
- * ...
442
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-monitorResize)
422
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-monitorResize)
423
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
443
424
  */
444
- monitorResize? : boolean|{
445
- immediate?: boolean
446
- }
425
+ monitorResize? : boolean|object
447
426
  /**
448
427
  * Name of the field which is used as a key to get/set values from/to the field.
449
428
  * Used prior to [ref](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
450
429
  * [Container.values](https://bryntum.com/products/core/docs/api/Core/widget/Container#property-values).
451
- * ...
452
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-name)
430
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-name)
453
431
  */
454
432
  name? : string
455
433
  /**
@@ -464,8 +442,7 @@ export type BryntumColorFieldProps = {
464
442
  * 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
465
443
  * not participate in the standard layout of that widget, and must be positioned relatively to that
466
444
  * widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
467
- * ...
468
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-positioned)
445
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-positioned)
469
446
  */
470
447
  positioned? : boolean
471
448
  /**
@@ -476,15 +453,13 @@ export type BryntumColorFieldProps = {
476
453
  /**
477
454
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
478
455
  * are unresponsive.
479
- * ...
480
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-readOnly)
456
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-readOnly)
481
457
  */
482
458
  readOnly? : boolean
483
459
  relayStoreEvents? : boolean
484
460
  /**
485
461
  * Predefined style to use for the field. Possible values are:
486
- * ...
487
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-rendition)
462
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-rendition)
488
463
  */
489
464
  rendition? : 'outlined'|'filled'|string
490
465
  /**
@@ -503,23 +478,26 @@ export type BryntumColorFieldProps = {
503
478
  * Configure as `true` to have the component display a translucent ripple when its
504
479
  * [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
505
480
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
506
- * ...
507
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ripple)
508
- */
509
- ripple? : boolean|{
510
- delegate?: string
511
- color?: string
512
- radius?: number
513
- clip?: string
514
- }
481
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ripple)
482
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
483
+ * @property {string} [color] A CSS color name or specification.
484
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
485
+ * @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.
486
+ */
487
+ ripple? : boolean|object
488
+ /**
489
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
490
+ * accidentally applying a role which may interfere with screen readers.
491
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-role)
492
+ */
493
+ role? : string
515
494
  /**
516
495
  * 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
496
  */
518
497
  rootElement? : ShadowRoot|HTMLElement
519
498
  /**
520
499
  * 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/grid/docs/api/Core/widget/ColorField#config-rtl)
500
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-rtl)
523
501
  */
524
502
  rtl? : boolean
525
503
  /**
@@ -529,8 +507,7 @@ export type BryntumColorFieldProps = {
529
507
  scrollAction? : 'hide'|'realign'|null
530
508
  /**
531
509
  * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
532
- * ...
533
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-showAnimation)
510
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-showAnimation)
534
511
  */
535
512
  showAnimation? : boolean|object
536
513
  /**
@@ -559,8 +536,7 @@ export type BryntumColorFieldProps = {
559
536
  * 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
560
537
  * [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
561
538
  * this widget:
562
- * ...
563
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-tab)
539
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-tab)
564
540
  */
565
541
  tab? : boolean|TabConfig
566
542
  /**
@@ -568,14 +544,12 @@ export type BryntumColorFieldProps = {
568
544
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
569
545
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
570
546
  * to the element programmatically.
571
- * ...
572
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-tabIndex)
547
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-tabIndex)
573
548
  */
574
549
  tabIndex? : number
575
550
  /**
576
551
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
577
- * ...
578
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-textAlign)
552
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-textAlign)
579
553
  */
580
554
  textAlign? : 'left'|'center'|'right'|'start'|'end'
581
555
  /**
@@ -584,24 +558,21 @@ export type BryntumColorFieldProps = {
584
558
  title? : string
585
559
  /**
586
560
  * Tooltip for the widget, either as a string or as a Tooltip config object.
587
- * ...
588
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-tooltip)
561
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-tooltip)
589
562
  */
590
563
  tooltip? : string|TooltipConfig|null
591
564
  /**
592
565
  * The triggers to add either before or after the input field. Each property name is the reference by which
593
566
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
594
- * ...
595
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-triggers)
567
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-triggers)
596
568
  */
597
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
569
+ triggers? : Record<string, FieldTriggerConfig>
598
570
  type? : 'colorfield'
599
571
  /**
600
572
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
601
573
  * as a space separated string, an array of strings, or as an object in which property names with truthy
602
574
  * values are used as the class names.
603
- * ...
604
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ui)
575
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-ui)
605
576
  */
606
577
  ui? : string|object
607
578
  /**
@@ -626,14 +597,12 @@ export type BryntumColorFieldProps = {
626
597
  width? : string|number
627
598
  /**
628
599
  * The x position for the widget.
629
- * ...
630
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-x)
600
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-x)
631
601
  */
632
602
  x? : number
633
603
  /**
634
604
  * The y position for the widget.
635
- * ...
636
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-y)
605
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-y)
637
606
  */
638
607
  y? : number
639
608
 
@@ -663,7 +632,7 @@ export type BryntumColorFieldProps = {
663
632
  * @param {object} event Event object
664
633
  * @param {Core.widget.Widget} event.source The widget being hidden.
665
634
  */
666
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
635
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
667
636
  /**
668
637
  * Triggered before a widget is shown. Return `false` to prevent the action.
669
638
  * @param {object} event Event object
@@ -672,8 +641,7 @@ export type BryntumColorFieldProps = {
672
641
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
673
642
  /**
674
643
  * Fires when any other event is fired from the object.
675
- * ...
676
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#event-catchAll)
644
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#event-catchAll)
677
645
  * @param {object} event Event object
678
646
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
679
647
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -693,8 +661,7 @@ export type BryntumColorFieldProps = {
693
661
  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
662
  /**
695
663
  * Fired when this field is [cleared](https://bryntum.com/products/core/docs/api/Core/widget/Field#function-clear).
696
- * ...
697
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#event-clear)
664
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#event-clear)
698
665
  * @param {object} event Event object
699
666
  * @param {Core.widget.Field,any} event.source This Field
700
667
  */
@@ -752,8 +719,7 @@ export type BryntumColorFieldProps = {
752
719
  /**
753
720
  * Triggered when a widget which had been in a non-visible state for any reason
754
721
  * achieves visibility.
755
- * ...
756
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#event-paint)
722
+ * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#event-paint)
757
723
  * @param {object} event Event object
758
724
  * @param {Core.widget.Widget} event.source The widget being painted.
759
725
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -815,6 +781,7 @@ export class BryntumColorField extends React.Component<BryntumColorFieldProps> {
815
781
  'autoSelect',
816
782
  'bubbleEvents',
817
783
  'centered',
784
+ 'checkValidity',
818
785
  'clearable',
819
786
  'config',
820
787
  'constrainTo',
@@ -860,6 +827,7 @@ export class BryntumColorField extends React.Component<BryntumColorFieldProps> {
860
827
  'relayStoreEvents',
861
828
  'revertOnEscape',
862
829
  'ripple',
830
+ 'role',
863
831
  'rootElement',
864
832
  'scrollAction',
865
833
  'showAnimation',
@@ -938,10 +906,8 @@ export class BryntumColorField extends React.Component<BryntumColorFieldProps> {
938
906
  ];
939
907
 
940
908
  static propertyNames = [
941
- 'anchorSize',
942
909
  'content',
943
910
  'editable',
944
- 'focusVisible',
945
911
  'formula',
946
912
  'html',
947
913
  'input',