@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, Color, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
6
+ import { AlignSpec, Base, Color, DomConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Model, ReactJSX, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
7
7
  import { AIFilterField, AIFilterFieldListeners, GridContainerItemConfig, Grid } from '@bryntum/grid-thin';
8
8
 
9
9
  import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
@@ -13,14 +13,12 @@ export type BryntumAIFilterFieldProps = {
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/AIFilterField#config-adopt)
16
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#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/AIFilterField#config-align)
21
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-align)
24
22
  */
25
23
  align? : AlignSpec|string
26
24
  /**
@@ -42,15 +40,13 @@ export type BryntumAIFilterFieldProps = {
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/AIFilterField#config-ariaDescription)
43
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#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/AIFilterField#config-ariaLabel)
49
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ariaLabel)
54
50
  */
55
51
  ariaLabel? : string
56
52
  /**
@@ -69,21 +65,18 @@ export type BryntumAIFilterFieldProps = {
69
65
  /**
70
66
  * An object where property names with a truthy value indicate which events should bubble up the ownership
71
67
  * hierarchy when triggered.
72
- * ...
73
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-bubbleEvents)
68
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-bubbleEvents)
74
69
  */
75
70
  bubbleEvents? : object
76
71
  /**
77
72
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
78
- * ...
79
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-callOnFunctions)
73
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-callOnFunctions)
80
74
  */
81
75
  callOnFunctions? : boolean
82
76
  /**
83
77
  * By default, if an event handler throws an exception, the error propagates up the stack and the
84
78
  * application state is undefined. Code which follows the event handler will *not* be executed.
85
- * ...
86
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-catchEventHandlerExceptions)
79
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-catchEventHandlerExceptions)
87
80
  */
88
81
  catchEventHandlerExceptions? : boolean
89
82
  /**
@@ -106,15 +99,13 @@ export type BryntumAIFilterFieldProps = {
106
99
  * Custom CSS classes to add to element.
107
100
  * May be specified as a space separated string, or as an object in which property names
108
101
  * with truthy values are used as the class names:
109
- * ...
110
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-cls)
102
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-cls)
111
103
  */
112
104
  cls? : string|object
113
105
  /**
114
106
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
115
107
  * `style` block.
116
- * ...
117
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-color)
108
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-color)
118
109
  */
119
110
  color? : Color
120
111
  /**
@@ -131,15 +122,13 @@ export type BryntumAIFilterFieldProps = {
131
122
  * The configuration for additional items associated to this field. This is typically used to add contextual
132
123
  * fields related to a [checkbox](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
133
124
  * these classes for examples of nested fields.
134
- * ...
135
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-container)
125
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-container)
136
126
  */
137
- container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig|FieldContainer
127
+ container? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig
138
128
  /**
139
129
  * The config controls how the value of nested items are handled when a parent container gets or sets its
140
130
  * [values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
141
- * ...
142
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-containValues)
131
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-containValues)
143
132
  * @param {Core.widget.Field} field Field instance
144
133
  * @returns {boolean}
145
134
  */
@@ -148,8 +137,7 @@ export type BryntumAIFilterFieldProps = {
148
137
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
149
138
  * May be specified as a space separated string, or as an object in which property names
150
139
  * with truthy values are used as the class names:
151
- * ...
152
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-contentElementCls)
140
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-contentElementCls)
153
141
  */
154
142
  contentElementCls? : string|object
155
143
  /**
@@ -167,16 +155,15 @@ export type BryntumAIFilterFieldProps = {
167
155
  */
168
156
  defaultBindProperty? : string
169
157
  /**
170
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
171
- * ...
172
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-detectCSSCompatibilityIssues)
158
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
159
+ * checks:
160
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-detectCSSCompatibilityIssues)
173
161
  */
174
162
  detectCSSCompatibilityIssues? : boolean
175
163
  /**
176
164
  * 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
177
165
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
178
- * ...
179
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-disabled)
166
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-disabled)
180
167
  */
181
168
  disabled? : boolean|'inert'
182
169
  /**
@@ -184,33 +171,28 @@ export type BryntumAIFilterFieldProps = {
184
171
  * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
185
172
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
186
173
  * body. Such widgets are called "edge strips".
187
- * ...
188
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-dock)
174
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-dock)
189
175
  */
190
176
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
191
177
  /**
192
178
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
193
179
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
194
180
  * property which controls when a drag should start.
195
- * ...
196
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
181
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
182
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
197
183
  */
198
- draggable? : boolean|{
199
- handleSelector?: string
200
- }
184
+ draggable? : boolean|object
201
185
  /**
202
186
  * Set to `false` to prevent user from editing the field. For TextFields it is basically the same as setting
203
187
  * [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly), but for PickerFields there is a distinction where it allows you to pick a value
204
188
  * but not to type one in the field.
205
- * ...
206
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-editable)
189
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-editable)
207
190
  */
208
191
  editable? : boolean
209
192
  /**
210
193
  * An object specifying attributes to assign to the root element of this widget.
211
194
  * Set `null` value to attribute to remove it.
212
- * ...
213
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-elementAttributes)
195
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-elementAttributes)
214
196
  */
215
197
  elementAttributes? : Record<string, string|null>
216
198
  extraData? : any
@@ -239,8 +221,7 @@ export type BryntumAIFilterFieldProps = {
239
221
  hidden? : boolean
240
222
  /**
241
223
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
242
- * ...
243
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hideAnimation)
224
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hideAnimation)
244
225
  */
245
226
  hideAnimation? : boolean|object
246
227
  /**
@@ -250,8 +231,7 @@ export type BryntumAIFilterFieldProps = {
250
231
  /**
251
232
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
252
233
  * a field's units.
253
- * ...
254
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hint)
234
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hint)
255
235
  * @param {object} data A data object
256
236
  * @param {Core.widget.Field} data.source A reference to the field instance
257
237
  * @param {any} data.value The current value of the field
@@ -262,8 +242,7 @@ export type BryntumAIFilterFieldProps = {
262
242
  * 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.
263
243
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
264
244
  * encode such data (see [encodeHtml](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
265
- * ...
266
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hintHtml)
245
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-hintHtml)
267
246
  * @param {object} data A data object
268
247
  * @param {Core.widget.Field} data.source A reference to the field instance
269
248
  * @param {any} data.value The current value of the field
@@ -276,16 +255,14 @@ export type BryntumAIFilterFieldProps = {
276
255
  id? : string
277
256
  /**
278
257
  * Determines if the widgets read-only state should be controlled by its parent.
279
- * ...
280
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ignoreParentReadOnly)
258
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ignoreParentReadOnly)
281
259
  */
282
260
  ignoreParentReadOnly? : boolean
283
261
  /**
284
262
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
285
263
  * [hbox](https://bryntum.com/products/grid/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
286
264
  * [container](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-container).
287
- * ...
288
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-inline)
265
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-inline)
289
266
  */
290
267
  inline? : boolean
291
268
  /**
@@ -325,16 +302,14 @@ export type BryntumAIFilterFieldProps = {
325
302
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
326
303
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
327
304
  * are the name of the instance method to call when the keystroke is received.
328
- * ...
329
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyMap)
305
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyMap)
330
306
  */
331
307
  keyMap? : Record<string, KeyMapConfig>
332
308
  /**
333
309
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
334
310
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
335
311
  * immediate feedback, change will still be triggered on blur).
336
- * ...
337
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyStrokeChangeDelay)
312
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-keyStrokeChangeDelay)
338
313
  */
339
314
  keyStrokeChangeDelay? : number
340
315
  /**
@@ -347,15 +322,15 @@ export type BryntumAIFilterFieldProps = {
347
322
  labelCls? : string|object
348
323
  /**
349
324
  * Label position, either 'before' the field or 'above' the field
350
- * ...
351
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-labelPosition)
325
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-labelPosition)
352
326
  */
353
327
  labelPosition? : 'before'|'above'|null
354
328
  /**
355
329
  * The labels to add either before or after the input field.
356
330
  * Each label may have the following properties:
357
- * ...
358
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-labels)
331
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-labels)
332
+ * @property {string} html Label text
333
+ * @property {'start','end'} align Which end of the file the label should go
359
334
  */
360
335
  labels? : object[]
361
336
  /**
@@ -364,16 +339,14 @@ export type BryntumAIFilterFieldProps = {
364
339
  labelWidth? : string|number
365
340
  /**
366
341
  * The listener set for this object.
367
- * ...
368
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-listeners)
342
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-listeners)
369
343
  */
370
344
  listeners? : AIFilterFieldListeners
371
345
  /**
372
346
  * A class translations of which are used for translating this entity.
373
347
  * This is often used when translations of an item are defined on its container class.
374
348
  * For example:
375
- * ...
376
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localeClass)
349
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localeClass)
377
350
  */
378
351
  localeClass? : typeof Base
379
352
  /**
@@ -385,8 +358,7 @@ export type BryntumAIFilterFieldProps = {
385
358
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
386
359
  * you could use 'localeKey' meta configuration.
387
360
  * Example:
388
- * ...
389
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localizableProperties)
361
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-localizableProperties)
390
362
  */
391
363
  localizableProperties? : string[]
392
364
  /**
@@ -412,8 +384,7 @@ export type BryntumAIFilterFieldProps = {
412
384
  maxHeight? : string|number
413
385
  /**
414
386
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
415
- * ...
416
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-maximizeOnMobile)
387
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-maximizeOnMobile)
417
388
  */
418
389
  maximizeOnMobile? : number|string
419
390
  /**
@@ -443,18 +414,15 @@ export type BryntumAIFilterFieldProps = {
443
414
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
444
415
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
445
416
  * layout.
446
- * ...
447
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-monitorResize)
417
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-monitorResize)
418
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
448
419
  */
449
- monitorResize? : boolean|{
450
- immediate?: boolean
451
- }
420
+ monitorResize? : boolean|object
452
421
  /**
453
422
  * Name of the field which is used as a key to get/set values from/to the field.
454
423
  * Used prior to [ref](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
455
424
  * [Container.values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
456
- * ...
457
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-name)
425
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-name)
458
426
  */
459
427
  name? : string
460
428
  /**
@@ -465,8 +433,7 @@ export type BryntumAIFilterFieldProps = {
465
433
  * 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
466
434
  * not participate in the standard layout of that widget, and must be positioned relatively to that
467
435
  * widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
468
- * ...
469
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-positioned)
436
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-positioned)
470
437
  */
471
438
  positioned? : boolean
472
439
  /**
@@ -481,15 +448,13 @@ export type BryntumAIFilterFieldProps = {
481
448
  /**
482
449
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
483
450
  * are unresponsive.
484
- * ...
485
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-readOnly)
451
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-readOnly)
486
452
  */
487
453
  readOnly? : boolean
488
454
  relayStoreEvents? : boolean
489
455
  /**
490
456
  * Predefined style to use for the field. Possible values are:
491
- * ...
492
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rendition)
457
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rendition)
493
458
  */
494
459
  rendition? : 'outlined'|'filled'|string
495
460
  /**
@@ -508,23 +473,26 @@ export type BryntumAIFilterFieldProps = {
508
473
  * Configure as `true` to have the component display a translucent ripple when its
509
474
  * [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
510
475
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
511
- * ...
512
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ripple)
513
- */
514
- ripple? : boolean|{
515
- delegate?: string
516
- color?: string
517
- radius?: number
518
- clip?: string
519
- }
476
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ripple)
477
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
478
+ * @property {string} [color] A CSS color name or specification.
479
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
480
+ * @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.
481
+ */
482
+ ripple? : boolean|object
483
+ /**
484
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
485
+ * accidentally applying a role which may interfere with screen readers.
486
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-role)
487
+ */
488
+ role? : string
520
489
  /**
521
490
  * 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`
522
491
  */
523
492
  rootElement? : ShadowRoot|HTMLElement
524
493
  /**
525
494
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
526
- * ...
527
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rtl)
495
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-rtl)
528
496
  */
529
497
  rtl? : boolean
530
498
  /**
@@ -534,8 +502,7 @@ export type BryntumAIFilterFieldProps = {
534
502
  scrollAction? : 'hide'|'realign'|null
535
503
  /**
536
504
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
537
- * ...
538
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-showAnimation)
505
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-showAnimation)
539
506
  */
540
507
  showAnimation? : boolean|object
541
508
  /**
@@ -564,8 +531,7 @@ export type BryntumAIFilterFieldProps = {
564
531
  * 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
565
532
  * [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
566
533
  * this widget:
567
- * ...
568
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tab)
534
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tab)
569
535
  */
570
536
  tab? : boolean|TabConfig
571
537
  /**
@@ -573,14 +539,12 @@ export type BryntumAIFilterFieldProps = {
573
539
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
574
540
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
575
541
  * to the element programmatically.
576
- * ...
577
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tabIndex)
542
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tabIndex)
578
543
  */
579
544
  tabIndex? : number
580
545
  /**
581
546
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
582
- * ...
583
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-textAlign)
547
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-textAlign)
584
548
  */
585
549
  textAlign? : 'left'|'center'|'right'|'start'|'end'
586
550
  /**
@@ -589,24 +553,21 @@ export type BryntumAIFilterFieldProps = {
589
553
  title? : string
590
554
  /**
591
555
  * Tooltip for the widget, either as a string or as a Tooltip config object.
592
- * ...
593
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tooltip)
556
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-tooltip)
594
557
  */
595
558
  tooltip? : string|TooltipConfig|null
596
559
  /**
597
560
  * The triggers to add either before or after the input field. Each property name is the reference by which
598
561
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
599
- * ...
600
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-triggers)
562
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-triggers)
601
563
  */
602
- triggers? : Record<string, FieldTriggerConfig>|Record<string, Widget>
564
+ triggers? : Record<string, FieldTriggerConfig>
603
565
  type? : 'aifilterfield'
604
566
  /**
605
567
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
606
568
  * as a space separated string, an array of strings, or as an object in which property names with truthy
607
569
  * values are used as the class names.
608
- * ...
609
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ui)
570
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-ui)
610
571
  */
611
572
  ui? : string|object
612
573
  /**
@@ -631,14 +592,12 @@ export type BryntumAIFilterFieldProps = {
631
592
  width? : string|number
632
593
  /**
633
594
  * The x position for the widget.
634
- * ...
635
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-x)
595
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-x)
636
596
  */
637
597
  x? : number
638
598
  /**
639
599
  * The y position for the widget.
640
- * ...
641
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-y)
600
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-y)
642
601
  */
643
602
  y? : number
644
603
 
@@ -677,8 +636,7 @@ export type BryntumAIFilterFieldProps = {
677
636
  onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
678
637
  /**
679
638
  * Fires when any other event is fired from the object.
680
- * ...
681
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-catchAll)
639
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-catchAll)
682
640
  * @param {object} event Event object
683
641
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
684
642
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -698,8 +656,7 @@ export type BryntumAIFilterFieldProps = {
698
656
  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
699
657
  /**
700
658
  * Fired when this field is [cleared](https://bryntum.com/products/grid/docs/api/Core/widget/Field#function-clear).
701
- * ...
702
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-clear)
659
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-clear)
703
660
  * @param {object} event Event object
704
661
  * @param {Core.widget.Field,any} event.source This Field
705
662
  */
@@ -757,8 +714,7 @@ export type BryntumAIFilterFieldProps = {
757
714
  /**
758
715
  * Triggered when a widget which had been in a non-visible state for any reason
759
716
  * achieves visibility.
760
- * ...
761
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-paint)
717
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#event-paint)
762
718
  * @param {object} event Event object
763
719
  * @param {Core.widget.Widget} event.source The widget being painted.
764
720
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -866,6 +822,7 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
866
822
  'relayStoreEvents',
867
823
  'revertOnEscape',
868
824
  'ripple',
825
+ 'role',
869
826
  'rootElement',
870
827
  'scrollAction',
871
828
  'showAnimation',
@@ -943,9 +900,7 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
943
900
  ];
944
901
 
945
902
  static propertyNames = [
946
- 'anchorSize',
947
903
  'content',
948
- 'focusVisible',
949
904
  'formula',
950
905
  'html',
951
906
  'input',