@bryntum/grid-react-thin 7.2.4 → 7.3.0

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 +4 -4
  2. package/lib/BryntumAIFilterField.d.ts +7 -15
  3. package/lib/BryntumAIFilterField.js +1 -2
  4. package/lib/BryntumAIFilterField.js.map +1 -1
  5. package/lib/BryntumChecklistFilterCombo.d.ts +10 -18
  6. package/lib/BryntumChecklistFilterCombo.js +1 -2
  7. package/lib/BryntumChecklistFilterCombo.js.map +1 -1
  8. package/lib/BryntumGrid.d.ts +22 -33
  9. package/lib/BryntumGrid.js +2 -2
  10. package/lib/BryntumGrid.js.map +1 -1
  11. package/lib/BryntumGridBase.d.ts +22 -33
  12. package/lib/BryntumGridBase.js +2 -2
  13. package/lib/BryntumGridBase.js.map +1 -1
  14. package/lib/BryntumGridChartDesigner.d.ts +6 -14
  15. package/lib/BryntumGridChartDesigner.js +1 -2
  16. package/lib/BryntumGridChartDesigner.js.map +1 -1
  17. package/lib/BryntumGridFieldFilterPicker.d.ts +7 -14
  18. package/lib/BryntumGridFieldFilterPicker.js +2 -5
  19. package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
  20. package/lib/BryntumGridFieldFilterPickerGroup.d.ts +7 -14
  21. package/lib/BryntumGridFieldFilterPickerGroup.js +2 -5
  22. package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
  23. package/lib/BryntumGroupBar.d.ts +6 -14
  24. package/lib/BryntumGroupBar.js +1 -2
  25. package/lib/BryntumGroupBar.js.map +1 -1
  26. package/lib/BryntumTreeCombo.d.ts +10 -18
  27. package/lib/BryntumTreeCombo.js +1 -2
  28. package/lib/BryntumTreeCombo.js.map +1 -1
  29. package/lib/BryntumTreeGrid.d.ts +22 -33
  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 +74 -119
  36. package/src/BryntumChecklistFilterCombo.tsx +91 -150
  37. package/src/BryntumGrid.tsx +204 -291
  38. package/src/BryntumGridBase.tsx +204 -291
  39. package/src/BryntumGridChartDesigner.tsx +59 -95
  40. package/src/BryntumGridFieldFilterPicker.tsx +82 -132
  41. package/src/BryntumGridFieldFilterPickerGroup.tsx +81 -130
  42. package/src/BryntumGroupBar.tsx +65 -105
  43. package/src/BryntumTreeCombo.tsx +92 -152
  44. package/src/BryntumTreeGrid.tsx +204 -291
  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
  /**
@@ -108,8 +100,7 @@ export type BryntumTreeComboProps = {
108
100
  /**
109
101
  * A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
110
102
  * 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)
103
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-chipView)
113
104
  */
114
105
  chipView? : ChipViewConfig
115
106
  /**
@@ -134,15 +125,13 @@ export type BryntumTreeComboProps = {
134
125
  * Custom CSS classes to add to element.
135
126
  * May be specified as a space separated string, or as an object in which property names
136
127
  * 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)
128
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-cls)
139
129
  */
140
130
  cls? : string|object
141
131
  /**
142
132
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
143
133
  * `style` block.
144
- * ...
145
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
134
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-color)
146
135
  */
147
136
  color? : Color
148
137
  /**
@@ -159,15 +148,13 @@ export type BryntumTreeComboProps = {
159
148
  * The configuration for additional items associated to this field. This is typically used to add contextual
160
149
  * fields related to a [checkbox](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
161
150
  * these classes for examples of nested fields.
162
- * ...
163
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-container)
151
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-container)
164
152
  */
165
- container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig|FieldContainer
153
+ container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig
166
154
  /**
167
155
  * The config controls how the value of nested items are handled when a parent container gets or sets its
168
156
  * [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)
157
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-containValues)
171
158
  * @param {Core.widget.Field} field Field instance
172
159
  * @returns {boolean}
173
160
  */
@@ -176,16 +163,14 @@ export type BryntumTreeComboProps = {
176
163
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
177
164
  * May be specified as a space separated string, or as an object in which property names
178
165
  * 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)
166
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-contentElementCls)
181
167
  */
182
168
  contentElementCls? : string|object
183
169
  /**
184
170
  * If configured as `true`, this means that when an unmatched string is typed into the
185
171
  * 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
172
  * 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)
173
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-createOnUnmatched)
189
174
  * @param {string} name Record name
190
175
  * @param {Core.widget.Combo} combo Combo instance
191
176
  * @returns {Core.data.Model} New record
@@ -206,16 +191,15 @@ export type BryntumTreeComboProps = {
206
191
  */
207
192
  defaultBindProperty? : string
208
193
  /**
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)
194
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
195
+ * checks:
196
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-detectCSSCompatibilityIssues)
212
197
  */
213
198
  detectCSSCompatibilityIssues? : boolean
214
199
  /**
215
200
  * 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
201
  * 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)
202
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-disabled)
219
203
  */
220
204
  disabled? : boolean|'inert'
221
205
  /**
@@ -228,26 +212,23 @@ export type BryntumTreeComboProps = {
228
212
  * @param {Core.widget.Combo} combo A reference to this Combo
229
213
  * @returns {string,void}
230
214
  */
231
- displayValueRenderer? : (record: Model|ComboModel, combo: Combo) => string|void
215
+ displayValueRenderer? : (record: Model, combo: Combo) => string|void
232
216
  /**
233
217
  * 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
218
  * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
235
219
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
236
220
  * body. Such widgets are called "edge strips".
237
- * ...
238
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-dock)
221
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-dock)
239
222
  */
240
223
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
241
224
  /**
242
225
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
243
226
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
244
227
  * 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)
228
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
229
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
247
230
  */
248
- draggable? : boolean|{
249
- handleSelector?: string
250
- }
231
+ draggable? : boolean|object
251
232
  /**
252
233
  * User can edit text in text field (otherwise only pick from attached picker)
253
234
  */
@@ -255,21 +236,18 @@ export type BryntumTreeComboProps = {
255
236
  /**
256
237
  * An object specifying attributes to assign to the root element of this widget.
257
238
  * 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)
239
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-elementAttributes)
260
240
  */
261
241
  elementAttributes? : Record<string, string|null>
262
242
  /**
263
243
  * 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)
244
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-emptyText)
266
245
  */
267
246
  emptyText? : string
268
247
  /**
269
248
  * 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
249
  * any filters to the server upon load.
271
- * ...
272
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-encodeFilterParams)
250
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-encodeFilterParams)
273
251
  * @param {object[]} filters filters
274
252
  * @returns {object[]} array of values
275
253
  */
@@ -283,8 +261,7 @@ export type BryntumTreeComboProps = {
283
261
  /**
284
262
  * The name of an operator type as implemented in [operator](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter#config-operator)
285
263
  * 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)
264
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-filterOperator)
288
265
  */
289
266
  filterOperator? : CollectionCompareOperator
290
267
  /**
@@ -325,8 +302,7 @@ export type BryntumTreeComboProps = {
325
302
  hidden? : boolean
326
303
  /**
327
304
  * *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)
305
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hideAnimation)
330
306
  */
331
307
  hideAnimation? : boolean|object
332
308
  /**
@@ -347,8 +323,7 @@ export type BryntumTreeComboProps = {
347
323
  /**
348
324
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
349
325
  * a field's units.
350
- * ...
351
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hint)
326
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hint)
352
327
  * @param {object} data A data object
353
328
  * @param {Core.widget.Field} data.source A reference to the field instance
354
329
  * @param {any} data.value The current value of the field
@@ -359,8 +334,7 @@ export type BryntumTreeComboProps = {
359
334
  * 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
335
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
361
336
  * 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)
337
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-hintHtml)
364
338
  * @param {object} data A data object
365
339
  * @param {Core.widget.Field} data.source A reference to the field instance
366
340
  * @param {any} data.value The current value of the field
@@ -373,23 +347,20 @@ export type BryntumTreeComboProps = {
373
347
  id? : string
374
348
  /**
375
349
  * 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)
350
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ignoreParentReadOnly)
378
351
  */
379
352
  ignoreParentReadOnly? : boolean
380
353
  /**
381
354
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
382
355
  * [hbox](https://bryntum.com/products/grid/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
383
356
  * [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)
357
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inline)
386
358
  */
387
359
  inline? : boolean
388
360
  /**
389
361
  * Configure this as `true` to render the dropdown list as a permanently visible list
390
362
  * 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)
363
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-inlinePicker)
393
364
  */
394
365
  inlinePicker? : boolean
395
366
  /**
@@ -427,30 +398,26 @@ export type BryntumTreeComboProps = {
427
398
  insertFirst? : HTMLElement|string
428
399
  /**
429
400
  * 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)
401
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-items)
432
402
  */
433
403
  items? : object[]|string[]|object
434
404
  /**
435
405
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
436
406
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
437
407
  * 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)
408
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyMap)
440
409
  */
441
410
  keyMap? : Record<string, KeyMapConfig>
442
411
  /**
443
412
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
444
413
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
445
414
  * 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)
415
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeChangeDelay)
448
416
  */
449
417
  keyStrokeChangeDelay? : number
450
418
  /**
451
419
  * 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)
420
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-keyStrokeFilterDelay)
454
421
  */
455
422
  keyStrokeFilterDelay? : number
456
423
  /**
@@ -463,15 +430,15 @@ export type BryntumTreeComboProps = {
463
430
  labelCls? : string|object
464
431
  /**
465
432
  * 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)
433
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labelPosition)
468
434
  */
469
435
  labelPosition? : 'before'|'above'|null
470
436
  /**
471
437
  * The labels to add either before or after the input field.
472
438
  * Each label may have the following properties:
473
- * ...
474
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labels)
439
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-labels)
440
+ * @property {string} html Label text
441
+ * @property {'start','end'} align Which end of the file the label should go
475
442
  */
476
443
  labels? : object[]
477
444
  /**
@@ -484,24 +451,21 @@ export type BryntumTreeComboProps = {
484
451
  listCls? : string
485
452
  /**
486
453
  * The listener set for this object.
487
- * ...
488
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listeners)
454
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listeners)
489
455
  */
490
456
  listeners? : TreeComboListeners
491
457
  /**
492
458
  * 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)
459
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-listItemTpl)
495
460
  * @param {Core.data.Model} record The record representing the item being rendered
496
461
  * @returns {string,void}
497
462
  */
498
- listItemTpl? : (record: Model|ComboModel) => string|void
463
+ listItemTpl? : (record: Model) => string|void
499
464
  /**
500
465
  * A class translations of which are used for translating this entity.
501
466
  * This is often used when translations of an item are defined on its container class.
502
467
  * For example:
503
- * ...
504
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localeClass)
468
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localeClass)
505
469
  */
506
470
  localeClass? : typeof Base
507
471
  /**
@@ -513,8 +477,7 @@ export type BryntumTreeComboProps = {
513
477
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
514
478
  * you could use 'localeKey' meta configuration.
515
479
  * Example:
516
- * ...
517
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localizableProperties)
480
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-localizableProperties)
518
481
  */
519
482
  localizableProperties? : string[]
520
483
  /**
@@ -540,8 +503,7 @@ export type BryntumTreeComboProps = {
540
503
  maxHeight? : string|number
541
504
  /**
542
505
  * *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)
506
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-maximizeOnMobile)
545
507
  */
546
508
  maximizeOnMobile? : number|string
547
509
  /**
@@ -555,8 +517,7 @@ export type BryntumTreeComboProps = {
555
517
  maxWidth? : string|number
556
518
  /**
557
519
  * 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)
520
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-minChars)
560
521
  */
561
522
  minChars? : number
562
523
  /**
@@ -577,16 +538,13 @@ export type BryntumTreeComboProps = {
577
538
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
578
539
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
579
540
  * layout.
580
- * ...
581
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-monitorResize)
541
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-monitorResize)
542
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
582
543
  */
583
- monitorResize? : boolean|{
584
- immediate?: boolean
585
- }
544
+ monitorResize? : boolean|object
586
545
  /**
587
546
  * 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)
547
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-multiSelect)
590
548
  */
591
549
  multiSelect? : boolean
592
550
  /**
@@ -599,8 +557,7 @@ export type BryntumTreeComboProps = {
599
557
  * Name of the field which is used as a key to get/set values from/to the field.
600
558
  * 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
559
  * [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)
560
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-name)
604
561
  */
605
562
  name? : string
606
563
  /**
@@ -611,10 +568,9 @@ export type BryntumTreeComboProps = {
611
568
  /**
612
569
  * Configuration object for the [picker](https://bryntum.com/products/grid/docs/api/Core/widget/List) on initialization. Returns the
613
570
  * [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)
571
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-picker)
616
572
  */
617
- picker? : ListConfig|List
573
+ picker? : ListConfig
618
574
  /**
619
575
  * The name of the element property to which the picker should size and align itself.
620
576
  */
@@ -631,8 +587,7 @@ export type BryntumTreeComboProps = {
631
587
  * 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
588
  * not participate in the standard layout of that widget, and must be positioned relatively to that
633
589
  * 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)
590
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-positioned)
636
591
  */
637
592
  positioned? : boolean
638
593
  /**
@@ -644,22 +599,19 @@ export type BryntumTreeComboProps = {
644
599
  * Optionally a [Filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config object which the combo should use for
645
600
  * filtering using the typed value.
646
601
  * 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)
602
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-primaryFilter)
649
603
  */
650
604
  primaryFilter? : CollectionFilterConfig
651
605
  /**
652
606
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
653
607
  * are unresponsive.
654
- * ...
655
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-readOnly)
608
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-readOnly)
656
609
  */
657
610
  readOnly? : boolean
658
611
  relayStoreEvents? : boolean
659
612
  /**
660
613
  * 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)
614
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rendition)
663
615
  */
664
616
  rendition? : 'outlined'|'filled'|string
665
617
  /**
@@ -678,23 +630,26 @@ export type BryntumTreeComboProps = {
678
630
  * Configure as `true` to have the component display a translucent ripple when its
679
631
  * [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
632
  * 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
- }
633
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ripple)
634
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
635
+ * @property {string} [color] A CSS color name or specification.
636
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
637
+ * @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.
638
+ */
639
+ ripple? : boolean|object
640
+ /**
641
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
642
+ * accidentally applying a role which may interfere with screen readers.
643
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-role)
644
+ */
645
+ role? : string
690
646
  /**
691
647
  * 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
648
  */
693
649
  rootElement? : ShadowRoot|HTMLElement
694
650
  /**
695
651
  * 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)
652
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-rtl)
698
653
  */
699
654
  rtl? : boolean
700
655
  /**
@@ -704,8 +659,7 @@ export type BryntumTreeComboProps = {
704
659
  scrollAction? : 'hide'|'realign'|null
705
660
  /**
706
661
  * *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)
662
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-showAnimation)
709
663
  */
710
664
  showAnimation? : boolean|object
711
665
  /**
@@ -738,8 +692,7 @@ export type BryntumTreeComboProps = {
738
692
  * 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
693
  * [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
694
  * this widget:
741
- * ...
742
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tab)
695
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tab)
743
696
  */
744
697
  tab? : boolean|TabConfig
745
698
  /**
@@ -747,14 +700,12 @@ export type BryntumTreeComboProps = {
747
700
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
748
701
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
749
702
  * to the element programmatically.
750
- * ...
751
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tabIndex)
703
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tabIndex)
752
704
  */
753
705
  tabIndex? : number
754
706
  /**
755
707
  * 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)
708
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-textAlign)
758
709
  */
759
710
  textAlign? : 'left'|'center'|'right'|'start'|'end'
760
711
  /**
@@ -763,30 +714,26 @@ export type BryntumTreeComboProps = {
763
714
  title? : string
764
715
  /**
765
716
  * 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)
717
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-tooltip)
768
718
  */
769
719
  tooltip? : string|TooltipConfig|null
770
720
  /**
771
721
  * 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)
722
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggerAction)
774
723
  */
775
724
  triggerAction? : 'all'|'last'|null
776
725
  /**
777
726
  * The triggers to add either before or after the input field. Each property name is the reference by which
778
727
  * 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)
728
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-triggers)
781
729
  */
782
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
730
+ triggers? : Record<string, FieldTriggerConfig>
783
731
  type? : 'treecombo'
784
732
  /**
785
733
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
786
734
  * as a space separated string, an array of strings, or as an object in which property names with truthy
787
735
  * values are used as the class names.
788
- * ...
789
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ui)
736
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-ui)
790
737
  */
791
738
  ui? : string|object
792
739
  /**
@@ -806,8 +753,7 @@ export type BryntumTreeComboProps = {
806
753
  /**
807
754
  * Field used for item value when populating from store. Setting this to `null` will
808
755
  * 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)
756
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-valueField)
811
757
  */
812
758
  valueField? : string|null
813
759
  /**
@@ -823,14 +769,12 @@ export type BryntumTreeComboProps = {
823
769
  width? : string|number
824
770
  /**
825
771
  * The x position for the widget.
826
- * ...
827
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-x)
772
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-x)
828
773
  */
829
774
  x? : number
830
775
  /**
831
776
  * The y position for the widget.
832
- * ...
833
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-y)
777
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-y)
834
778
  */
835
779
  y? : number
836
780
 
@@ -865,8 +809,7 @@ export type BryntumTreeComboProps = {
865
809
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
866
810
  /**
867
811
  * 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)
812
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-catchAll)
870
813
  * @param {object} event Event object
871
814
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
872
815
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -886,8 +829,7 @@ export type BryntumTreeComboProps = {
886
829
  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
830
  /**
888
831
  * 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)
832
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-clear)
891
833
  * @param {object} event Event object
892
834
  * @param {Core.widget.Field,any} event.source This Field
893
835
  */
@@ -946,8 +888,7 @@ export type BryntumTreeComboProps = {
946
888
  /**
947
889
  * Triggered when a widget which had been in a non-visible state for any reason
948
890
  * achieves visibility.
949
- * ...
950
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-paint)
891
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#event-paint)
951
892
  * @param {object} event Event object
952
893
  * @param {Core.widget.Widget} event.source The widget being painted.
953
894
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -1090,6 +1031,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
1090
1031
  'relayStoreEvents',
1091
1032
  'revertOnEscape',
1092
1033
  'ripple',
1034
+ 'role',
1093
1035
  'rootElement',
1094
1036
  'scrollAction',
1095
1037
  'showAnimation',
@@ -1175,9 +1117,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
1175
1117
  ];
1176
1118
 
1177
1119
  static propertyNames = [
1178
- 'anchorSize',
1179
1120
  'content',
1180
- 'focusVisible',
1181
1121
  'formula',
1182
1122
  'html',
1183
1123
  'input',