@bryntum/grid-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 (45) hide show
  1. package/README.md +5 -5
  2. package/lib/BryntumAIFilterField.d.ts +9 -16
  3. package/lib/BryntumAIFilterField.js +2 -2
  4. package/lib/BryntumAIFilterField.js.map +1 -1
  5. package/lib/BryntumChecklistFilterCombo.d.ts +12 -19
  6. package/lib/BryntumChecklistFilterCombo.js +2 -2
  7. package/lib/BryntumChecklistFilterCombo.js.map +1 -1
  8. package/lib/BryntumGrid.d.ts +47 -58
  9. package/lib/BryntumGrid.js +2 -2
  10. package/lib/BryntumGrid.js.map +1 -1
  11. package/lib/BryntumGridBase.d.ts +47 -58
  12. package/lib/BryntumGridBase.js +2 -2
  13. package/lib/BryntumGridBase.js.map +1 -1
  14. package/lib/BryntumGridChartDesigner.d.ts +7 -15
  15. package/lib/BryntumGridChartDesigner.js +1 -2
  16. package/lib/BryntumGridChartDesigner.js.map +1 -1
  17. package/lib/BryntumGridFieldFilterPicker.d.ts +8 -15
  18. package/lib/BryntumGridFieldFilterPicker.js +2 -5
  19. package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
  20. package/lib/BryntumGridFieldFilterPickerGroup.d.ts +9 -16
  21. package/lib/BryntumGridFieldFilterPickerGroup.js +2 -5
  22. package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
  23. package/lib/BryntumGroupBar.d.ts +8 -16
  24. package/lib/BryntumGroupBar.js +1 -2
  25. package/lib/BryntumGroupBar.js.map +1 -1
  26. package/lib/BryntumTreeCombo.d.ts +12 -19
  27. package/lib/BryntumTreeCombo.js +2 -2
  28. package/lib/BryntumTreeCombo.js.map +1 -1
  29. package/lib/BryntumTreeGrid.d.ts +47 -58
  30. package/lib/BryntumTreeGrid.js +2 -2
  31. package/lib/BryntumTreeGrid.js.map +1 -1
  32. package/lib/WrapperHelper.js +2 -2
  33. package/lib/WrapperHelper.js.map +1 -1
  34. package/package.json +1 -1
  35. package/src/BryntumAIFilterField.tsx +85 -120
  36. package/src/BryntumChecklistFilterCombo.tsx +102 -151
  37. package/src/BryntumGrid.tsx +229 -316
  38. package/src/BryntumGridBase.tsx +229 -316
  39. package/src/BryntumGridChartDesigner.tsx +60 -96
  40. package/src/BryntumGridFieldFilterPicker.tsx +83 -133
  41. package/src/BryntumGridFieldFilterPickerGroup.tsx +83 -132
  42. package/src/BryntumGroupBar.tsx +67 -107
  43. package/src/BryntumTreeCombo.tsx +103 -153
  44. package/src/BryntumTreeGrid.tsx +229 -316
  45. package/src/WrapperHelper.tsx +2 -2
@@ -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, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo, ComboModel, DomConfig, Duration, DurationConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, List, ListConfig, MaskConfig, Model, Rectangle, Scroller, Store, StoreConfig, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo, DomConfig, Duration, DurationConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, List, ListConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, Store, StoreConfig, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
7
7
  import { GridContainerItemConfig, TreeCombo, TreeComboListeners } from '@bryntum/grid-thin';
8
8
 
9
9
  import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
@@ -13,14 +13,12 @@ export type BryntumTreeComboProps = {
13
13
  /**
14
14
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
15
15
  * content will be placed inside this element.
16
- * ...
17
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-adopt)
16
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-adopt)
18
17
  */
19
18
  adopt? : HTMLElement|string
20
19
  /**
21
20
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
22
- * ...
23
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-align)
21
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-align)
24
22
  */
25
23
  align? : AlignSpec|string
26
24
  /**
@@ -42,15 +40,13 @@ export type BryntumTreeComboProps = {
42
40
  /**
43
41
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
44
42
  * into an element which will be linked using the `aria-describedby` attribute.
45
- * ...
46
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaDescription)
43
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaDescription)
47
44
  */
48
45
  ariaDescription? : string
49
46
  /**
50
47
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
51
48
  * the `aria-label` attribute.
52
- * ...
53
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaLabel)
49
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ariaLabel)
54
50
  */
55
51
  ariaLabel? : string
56
52
  /**
@@ -73,20 +69,17 @@ export type BryntumTreeComboProps = {
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/Grid/widget/TreeCombo#config-bubbleEvents)
72
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-bubbleEvents)
78
73
  */
79
74
  bubbleEvents? : object
80
75
  /**
81
76
  * Enable caching of the last retrieved result until the timeout is reached.
82
- * ...
83
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cacheLastResult)
77
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cacheLastResult)
84
78
  */
85
79
  cacheLastResult? : number|string|Duration|DurationConfig
86
80
  /**
87
81
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
88
- * ...
89
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-callOnFunctions)
82
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-callOnFunctions)
90
83
  */
91
84
  callOnFunctions? : boolean
92
85
  /**
@@ -96,8 +89,7 @@ export type BryntumTreeComboProps = {
96
89
  /**
97
90
  * By default, if an event handler throws an exception, the error propagates up the stack and the
98
91
  * application state is undefined. Code which follows the event handler will *not* be executed.
99
- * ...
100
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-catchEventHandlerExceptions)
92
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-catchEventHandlerExceptions)
101
93
  */
102
94
  catchEventHandlerExceptions? : boolean
103
95
  /**
@@ -105,11 +97,19 @@ export type BryntumTreeComboProps = {
105
97
  * Set to `true` to centre the Widget in browser viewport space.
106
98
  */
107
99
  centered? : boolean
100
+ /**
101
+ * A function (or the name of a function in the ownership hierarchy) called during field validation
102
+ * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
103
+ * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
104
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
105
+ * @param {Core.widget.Field} field The field being validated
106
+ * @returns {void}
107
+ */
108
+ checkValidity? : ((field: Field) => void)|string
108
109
  /**
109
110
  * A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
110
111
  * selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
111
- * ...
112
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-chipView)
112
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-chipView)
113
113
  */
114
114
  chipView? : ChipViewConfig
115
115
  /**
@@ -134,15 +134,13 @@ export type BryntumTreeComboProps = {
134
134
  * Custom CSS classes to add to element.
135
135
  * May be specified as a space separated string, or as an object in which property names
136
136
  * with truthy values are used as the class names:
137
- * ...
138
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cls)
137
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cls)
139
138
  */
140
139
  cls? : string|object
141
140
  /**
142
141
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
143
142
  * `style` block.
144
- * ...
145
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
143
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
146
144
  */
147
145
  color? : Color
148
146
  /**
@@ -159,15 +157,13 @@ export type BryntumTreeComboProps = {
159
157
  * The configuration for additional items associated to this field. This is typically used to add contextual
160
158
  * fields related to a [checkbox](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
161
159
  * these classes for examples of nested fields.
162
- * ...
163
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-container)
160
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-container)
164
161
  */
165
- container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig|FieldContainer
162
+ container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig
166
163
  /**
167
164
  * The config controls how the value of nested items are handled when a parent container gets or sets its
168
165
  * [values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
169
- * ...
170
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-containValues)
166
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-containValues)
171
167
  * @param {Core.widget.Field} field Field instance
172
168
  * @returns {boolean}
173
169
  */
@@ -176,16 +172,14 @@ export type BryntumTreeComboProps = {
176
172
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
177
173
  * May be specified as a space separated string, or as an object in which property names
178
174
  * with truthy values are used as the class names:
179
- * ...
180
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-contentElementCls)
175
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-contentElementCls)
181
176
  */
182
177
  contentElementCls? : string|object
183
178
  /**
184
179
  * If configured as `true`, this means that when an unmatched string is typed into the
185
180
  * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
186
181
  * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-displayField).
187
- * ...
188
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
182
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
189
183
  * @param {string} name Record name
190
184
  * @param {Core.widget.Combo} combo Combo instance
191
185
  * @returns {Core.data.Model} New record
@@ -206,16 +200,15 @@ export type BryntumTreeComboProps = {
206
200
  */
207
201
  defaultBindProperty? : string
208
202
  /**
209
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
210
- * ...
211
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-detectCSSCompatibilityIssues)
203
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
204
+ * checks:
205
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-detectCSSCompatibilityIssues)
212
206
  */
213
207
  detectCSSCompatibilityIssues? : boolean
214
208
  /**
215
209
  * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
216
210
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
217
- * ...
218
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-disabled)
211
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-disabled)
219
212
  */
220
213
  disabled? : boolean|'inert'
221
214
  /**
@@ -228,26 +221,23 @@ export type BryntumTreeComboProps = {
228
221
  * @param {Core.widget.Combo} combo A reference to this Combo
229
222
  * @returns {string,void}
230
223
  */
231
- displayValueRenderer? : (record: Model|ComboModel, combo: Combo) => string|void
224
+ displayValueRenderer? : (record: Model, combo: Combo) => string|void
232
225
  /**
233
226
  * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/grid/docs/api/Core/widget/Panel)
234
227
  * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
235
228
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
236
229
  * body. Such widgets are called "edge strips".
237
- * ...
238
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-dock)
230
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-dock)
239
231
  */
240
232
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
241
233
  /**
242
234
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
243
235
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
244
236
  * property which controls when a drag should start.
245
- * ...
246
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
237
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
238
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
247
239
  */
248
- draggable? : boolean|{
249
- handleSelector?: string
250
- }
240
+ draggable? : boolean|object
251
241
  /**
252
242
  * User can edit text in text field (otherwise only pick from attached picker)
253
243
  */
@@ -255,21 +245,18 @@ export type BryntumTreeComboProps = {
255
245
  /**
256
246
  * An object specifying attributes to assign to the root element of this widget.
257
247
  * Set `null` value to attribute to remove it.
258
- * ...
259
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-elementAttributes)
248
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-elementAttributes)
260
249
  */
261
250
  elementAttributes? : Record<string, string|null>
262
251
  /**
263
252
  * Text to display in the drop down when there are no items in the underlying store.
264
- * ...
265
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-emptyText)
253
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-emptyText)
266
254
  */
267
255
  emptyText? : string
268
256
  /**
269
257
  * A function which creates an array of values for the [filterParamName](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-filterParamName) to pass
270
258
  * any filters to the server upon load.
271
- * ...
272
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-encodeFilterParams)
259
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-encodeFilterParams)
273
260
  * @param {object[]} filters filters
274
261
  * @returns {object[]} array of values
275
262
  */
@@ -283,8 +270,7 @@ export type BryntumTreeComboProps = {
283
270
  /**
284
271
  * The name of an operator type as implemented in [operator](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter#config-operator)
285
272
  * to use when filtering the dropdown list based upon the typed value.
286
- * ...
287
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-filterOperator)
273
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-filterOperator)
288
274
  */
289
275
  filterOperator? : CollectionCompareOperator
290
276
  /**
@@ -325,8 +311,7 @@ export type BryntumTreeComboProps = {
325
311
  hidden? : boolean
326
312
  /**
327
313
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
328
- * ...
329
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hideAnimation)
314
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hideAnimation)
330
315
  */
331
316
  hideAnimation? : boolean|object
332
317
  /**
@@ -347,8 +332,7 @@ export type BryntumTreeComboProps = {
347
332
  /**
348
333
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
349
334
  * a field's units.
350
- * ...
351
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hint)
335
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hint)
352
336
  * @param {object} data A data object
353
337
  * @param {Core.widget.Field} data.source A reference to the field instance
354
338
  * @param {any} data.value The current value of the field
@@ -359,8 +343,7 @@ export type BryntumTreeComboProps = {
359
343
  * This config is similar to [hint](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-hint) except that this config is used to display HTML content.
360
344
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
361
345
  * encode such data (see [encodeHtml](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
362
- * ...
363
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hintHtml)
346
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hintHtml)
364
347
  * @param {object} data A data object
365
348
  * @param {Core.widget.Field} data.source A reference to the field instance
366
349
  * @param {any} data.value The current value of the field
@@ -373,23 +356,20 @@ export type BryntumTreeComboProps = {
373
356
  id? : string
374
357
  /**
375
358
  * Determines if the widgets read-only state should be controlled by its parent.
376
- * ...
377
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ignoreParentReadOnly)
359
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ignoreParentReadOnly)
378
360
  */
379
361
  ignoreParentReadOnly? : boolean
380
362
  /**
381
363
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
382
364
  * [hbox](https://bryntum.com/products/grid/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
383
365
  * [container](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-container).
384
- * ...
385
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inline)
366
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inline)
386
367
  */
387
368
  inline? : boolean
388
369
  /**
389
370
  * Configure this as `true` to render the dropdown list as a permanently visible list
390
371
  * in the document flow immediately below the input area instead of as a popup.
391
- * ...
392
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inlinePicker)
372
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inlinePicker)
393
373
  */
394
374
  inlinePicker? : boolean
395
375
  /**
@@ -427,30 +407,26 @@ export type BryntumTreeComboProps = {
427
407
  insertFirst? : HTMLElement|string
428
408
  /**
429
409
  * Rows to display in the dropdown (list items).
430
- * ...
431
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-items)
410
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-items)
432
411
  */
433
412
  items? : object[]|string[]|object
434
413
  /**
435
414
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
436
415
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
437
416
  * are the name of the instance method to call when the keystroke is received.
438
- * ...
439
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyMap)
417
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyMap)
440
418
  */
441
419
  keyMap? : Record<string, KeyMapConfig>
442
420
  /**
443
421
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
444
422
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
445
423
  * immediate feedback, change will still be triggered on blur).
446
- * ...
447
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeChangeDelay)
424
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeChangeDelay)
448
425
  */
449
426
  keyStrokeChangeDelay? : number
450
427
  /**
451
428
  * The delay in milliseconds to wait after the last keystroke before filtering the list.
452
- * ...
453
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeFilterDelay)
429
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeFilterDelay)
454
430
  */
455
431
  keyStrokeFilterDelay? : number
456
432
  /**
@@ -463,15 +439,15 @@ export type BryntumTreeComboProps = {
463
439
  labelCls? : string|object
464
440
  /**
465
441
  * Label position, either 'before' the field or 'above' the field
466
- * ...
467
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labelPosition)
442
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labelPosition)
468
443
  */
469
444
  labelPosition? : 'before'|'above'|null
470
445
  /**
471
446
  * The labels to add either before or after the input field.
472
447
  * Each label may have the following properties:
473
- * ...
474
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labels)
448
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labels)
449
+ * @property {string} html Label text
450
+ * @property {'start','end'} align Which end of the file the label should go
475
451
  */
476
452
  labels? : object[]
477
453
  /**
@@ -484,24 +460,21 @@ export type BryntumTreeComboProps = {
484
460
  listCls? : string
485
461
  /**
486
462
  * The listener set for this object.
487
- * ...
488
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listeners)
463
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listeners)
489
464
  */
490
465
  listeners? : TreeComboListeners
491
466
  /**
492
467
  * Template string used to render the list items in the dropdown list
493
- * ...
494
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listItemTpl)
468
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listItemTpl)
495
469
  * @param {Core.data.Model} record The record representing the item being rendered
496
470
  * @returns {string,void}
497
471
  */
498
- listItemTpl? : (record: Model|ComboModel) => string|void
472
+ listItemTpl? : (record: Model) => string|void
499
473
  /**
500
474
  * A class translations of which are used for translating this entity.
501
475
  * This is often used when translations of an item are defined on its container class.
502
476
  * For example:
503
- * ...
504
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localeClass)
477
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localeClass)
505
478
  */
506
479
  localeClass? : typeof Base
507
480
  /**
@@ -513,8 +486,7 @@ export type BryntumTreeComboProps = {
513
486
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
514
487
  * you could use 'localeKey' meta configuration.
515
488
  * Example:
516
- * ...
517
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localizableProperties)
489
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localizableProperties)
518
490
  */
519
491
  localizableProperties? : string[]
520
492
  /**
@@ -540,8 +512,7 @@ export type BryntumTreeComboProps = {
540
512
  maxHeight? : string|number
541
513
  /**
542
514
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
543
- * ...
544
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-maximizeOnMobile)
515
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-maximizeOnMobile)
545
516
  */
546
517
  maximizeOnMobile? : number|string
547
518
  /**
@@ -555,8 +526,7 @@ export type BryntumTreeComboProps = {
555
526
  maxWidth? : string|number
556
527
  /**
557
528
  * The minimum string length to trigger the filtering, only relevant when [editable](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-editable) is `true`.
558
- * ...
559
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-minChars)
529
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-minChars)
560
530
  */
561
531
  minChars? : number
562
532
  /**
@@ -577,16 +547,13 @@ export type BryntumTreeComboProps = {
577
547
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
578
548
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
579
549
  * layout.
580
- * ...
581
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-monitorResize)
550
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-monitorResize)
551
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
582
552
  */
583
- monitorResize? : boolean|{
584
- immediate?: boolean
585
- }
553
+ monitorResize? : boolean|object
586
554
  /**
587
555
  * Set to `true` to allow selection of multiple values from the dropdown list.
588
- * ...
589
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-multiSelect)
556
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-multiSelect)
590
557
  */
591
558
  multiSelect? : boolean
592
559
  /**
@@ -599,8 +566,7 @@ export type BryntumTreeComboProps = {
599
566
  * Name of the field which is used as a key to get/set values from/to the field.
600
567
  * Used prior to [ref](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
601
568
  * [Container.values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
602
- * ...
603
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-name)
569
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-name)
604
570
  */
605
571
  name? : string
606
572
  /**
@@ -611,10 +577,9 @@ export type BryntumTreeComboProps = {
611
577
  /**
612
578
  * Configuration object for the [picker](https://bryntum.com/products/grid/docs/api/Core/widget/List) on initialization. Returns the
613
579
  * [picker](https://bryntum.com/products/grid/docs/api/Core/widget/List) instance at runtime.
614
- * ...
615
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-picker)
580
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-picker)
616
581
  */
617
- picker? : ListConfig|List
582
+ picker? : ListConfig
618
583
  /**
619
584
  * The name of the element property to which the picker should size and align itself.
620
585
  */
@@ -631,8 +596,7 @@ export type BryntumTreeComboProps = {
631
596
  * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement), but must
632
597
  * not participate in the standard layout of that widget, and must be positioned relatively to that
633
598
  * widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
634
- * ...
635
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-positioned)
599
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-positioned)
636
600
  */
637
601
  positioned? : boolean
638
602
  /**
@@ -644,22 +608,19 @@ export type BryntumTreeComboProps = {
644
608
  * Optionally a [Filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config object which the combo should use for
645
609
  * filtering using the typed value.
646
610
  * This may use a `filterBy` property to test its `value` against any field in the passed record.
647
- * ...
648
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-primaryFilter)
611
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-primaryFilter)
649
612
  */
650
613
  primaryFilter? : CollectionFilterConfig
651
614
  /**
652
615
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
653
616
  * are unresponsive.
654
- * ...
655
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-readOnly)
617
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-readOnly)
656
618
  */
657
619
  readOnly? : boolean
658
620
  relayStoreEvents? : boolean
659
621
  /**
660
622
  * Predefined style to use for the field. Possible values are:
661
- * ...
662
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rendition)
623
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rendition)
663
624
  */
664
625
  rendition? : 'outlined'|'filled'|string
665
626
  /**
@@ -678,23 +639,26 @@ export type BryntumTreeComboProps = {
678
639
  * Configure as `true` to have the component display a translucent ripple when its
679
640
  * [focusElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
680
641
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
681
- * ...
682
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ripple)
683
- */
684
- ripple? : boolean|{
685
- delegate?: string
686
- color?: string
687
- radius?: number
688
- clip?: string
689
- }
642
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ripple)
643
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
644
+ * @property {string} [color] A CSS color name or specification.
645
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
646
+ * @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.
647
+ */
648
+ ripple? : boolean|object
649
+ /**
650
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
651
+ * accidentally applying a role which may interfere with screen readers.
652
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-role)
653
+ */
654
+ role? : string
690
655
  /**
691
656
  * 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`
692
657
  */
693
658
  rootElement? : ShadowRoot|HTMLElement
694
659
  /**
695
660
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
696
- * ...
697
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rtl)
661
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rtl)
698
662
  */
699
663
  rtl? : boolean
700
664
  /**
@@ -704,8 +668,7 @@ export type BryntumTreeComboProps = {
704
668
  scrollAction? : 'hide'|'realign'|null
705
669
  /**
706
670
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
707
- * ...
708
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-showAnimation)
671
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-showAnimation)
709
672
  */
710
673
  showAnimation? : boolean|object
711
674
  /**
@@ -738,8 +701,7 @@ export type BryntumTreeComboProps = {
738
701
  * A configuration for the [tab](https://bryntum.com/products/grid/docs/api/Core/widget/Tab) created for this widget when it is placed in a
739
702
  * [TabPanel](https://bryntum.com/products/grid/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
740
703
  * this widget:
741
- * ...
742
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tab)
704
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tab)
743
705
  */
744
706
  tab? : boolean|TabConfig
745
707
  /**
@@ -747,14 +709,12 @@ export type BryntumTreeComboProps = {
747
709
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
748
710
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
749
711
  * to the element programmatically.
750
- * ...
751
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tabIndex)
712
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tabIndex)
752
713
  */
753
714
  tabIndex? : number
754
715
  /**
755
716
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
756
- * ...
757
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-textAlign)
717
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-textAlign)
758
718
  */
759
719
  textAlign? : 'left'|'center'|'right'|'start'|'end'
760
720
  /**
@@ -763,30 +723,26 @@ export type BryntumTreeComboProps = {
763
723
  title? : string
764
724
  /**
765
725
  * Tooltip for the widget, either as a string or as a Tooltip config object.
766
- * ...
767
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tooltip)
726
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tooltip)
768
727
  */
769
728
  tooltip? : string|TooltipConfig|null
770
729
  /**
771
730
  * How to query the store upon click of the expand trigger. Specify one of these values:
772
- * ...
773
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggerAction)
731
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggerAction)
774
732
  */
775
733
  triggerAction? : 'all'|'last'|null
776
734
  /**
777
735
  * The triggers to add either before or after the input field. Each property name is the reference by which
778
736
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
779
- * ...
780
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggers)
737
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggers)
781
738
  */
782
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
739
+ triggers? : Record<string, FieldTriggerConfig>
783
740
  type? : 'treecombo'
784
741
  /**
785
742
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
786
743
  * as a space separated string, an array of strings, or as an object in which property names with truthy
787
744
  * values are used as the class names.
788
- * ...
789
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ui)
745
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ui)
790
746
  */
791
747
  ui? : string|object
792
748
  /**
@@ -806,8 +762,7 @@ export type BryntumTreeComboProps = {
806
762
  /**
807
763
  * Field used for item value when populating from store. Setting this to `null` will
808
764
  * yield the selected record as the Combo's [value](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#property-value).
809
- * ...
810
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-valueField)
765
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-valueField)
811
766
  */
812
767
  valueField? : string|null
813
768
  /**
@@ -823,14 +778,12 @@ export type BryntumTreeComboProps = {
823
778
  width? : string|number
824
779
  /**
825
780
  * The x position for the widget.
826
- * ...
827
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-x)
781
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-x)
828
782
  */
829
783
  x? : number
830
784
  /**
831
785
  * The y position for the widget.
832
- * ...
833
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-y)
786
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-y)
834
787
  */
835
788
  y? : number
836
789
 
@@ -856,7 +809,7 @@ export type BryntumTreeComboProps = {
856
809
  * @param {object} event Event object
857
810
  * @param {Core.widget.Widget} event.source The widget being hidden.
858
811
  */
859
- onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
812
+ onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
860
813
  /**
861
814
  * Triggered before a widget is shown. Return `false` to prevent the action.
862
815
  * @param {object} event Event object
@@ -865,8 +818,7 @@ export type BryntumTreeComboProps = {
865
818
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
866
819
  /**
867
820
  * Fires when any other event is fired from the object.
868
- * ...
869
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-catchAll)
821
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-catchAll)
870
822
  * @param {object} event Event object
871
823
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
872
824
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -886,8 +838,7 @@ export type BryntumTreeComboProps = {
886
838
  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
887
839
  /**
888
840
  * Fired when this field is [cleared](https://bryntum.com/products/grid/docs/api/Core/widget/Field#function-clear).
889
- * ...
890
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-clear)
841
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-clear)
891
842
  * @param {object} event Event object
892
843
  * @param {Core.widget.Field,any} event.source This Field
893
844
  */
@@ -946,8 +897,7 @@ export type BryntumTreeComboProps = {
946
897
  /**
947
898
  * Triggered when a widget which had been in a non-visible state for any reason
948
899
  * achieves visibility.
949
- * ...
950
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-paint)
900
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-paint)
951
901
  * @param {object} event Event object
952
902
  * @param {Core.widget.Widget} event.source The widget being painted.
953
903
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -1020,6 +970,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
1020
970
  'cacheLastResult',
1021
971
  'caseSensitive',
1022
972
  'centered',
973
+ 'checkValidity',
1023
974
  'chipView',
1024
975
  'clearable',
1025
976
  'clearTextOnPickerHide',
@@ -1090,6 +1041,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
1090
1041
  'relayStoreEvents',
1091
1042
  'revertOnEscape',
1092
1043
  'ripple',
1044
+ 'role',
1093
1045
  'rootElement',
1094
1046
  'scrollAction',
1095
1047
  'showAnimation',
@@ -1175,9 +1127,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
1175
1127
  ];
1176
1128
 
1177
1129
  static propertyNames = [
1178
- 'anchorSize',
1179
1130
  'content',
1180
- 'focusVisible',
1181
1131
  'formula',
1182
1132
  'html',
1183
1133
  'input',