@bryntum/grid-vue-3-thin 7.2.3 → 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 (66) hide show
  1. package/README.md +4 -4
  2. package/lib/chunks/{B5DiBj1m.js → BGeNcVH6.js} +5 -5
  3. package/lib/chunks/BGeNcVH6.js.map +1 -0
  4. package/lib/chunks/{v3MxzI7J.js → Ba35uKyP.js} +3 -3
  5. package/lib/chunks/Ba35uKyP.js.map +1 -0
  6. package/lib/chunks/{MAev_NTD.js → Bc2x_WPR.js} +8 -6
  7. package/lib/chunks/Bc2x_WPR.js.map +1 -0
  8. package/lib/chunks/{C3MmNeeF.js → Be7ZZzGW.js} +14 -12
  9. package/lib/chunks/Be7ZZzGW.js.map +1 -0
  10. package/lib/chunks/{CnbA4JoC.js → BeyOFZne.js} +6 -6
  11. package/lib/chunks/BeyOFZne.js.map +1 -0
  12. package/lib/chunks/{BQkqLHa6.js → BpNo5v3W.js} +9 -10
  13. package/lib/chunks/BpNo5v3W.js.map +1 -0
  14. package/lib/chunks/{Da4PP6A-.js → CAlh-Y8B.js} +3 -3
  15. package/lib/chunks/CAlh-Y8B.js.map +1 -0
  16. package/lib/chunks/{DkzTNiUv.js → CWYhi4DG.js} +8 -9
  17. package/lib/chunks/CWYhi4DG.js.map +1 -0
  18. package/lib/chunks/{D639wy1k.js → CcfDAcJD.js} +9 -9
  19. package/lib/chunks/CcfDAcJD.js.map +1 -0
  20. package/lib/chunks/{C8vFKx3Q.js → w2GDktIt.js} +8 -6
  21. package/lib/chunks/w2GDktIt.js.map +1 -0
  22. package/lib/components/BryntumAIFilterField.js +1 -1
  23. package/lib/components/BryntumChecklistFilterCombo.js +1 -1
  24. package/lib/components/BryntumGrid.js +1 -1
  25. package/lib/components/BryntumGridBase.js +1 -1
  26. package/lib/components/BryntumGridChartDesigner.js +1 -1
  27. package/lib/components/BryntumGridFieldFilterPicker.js +1 -1
  28. package/lib/components/BryntumGridFieldFilterPickerGroup.js +1 -1
  29. package/lib/components/BryntumGroupBar.js +1 -1
  30. package/lib/components/BryntumThemeCombo.js +57 -0
  31. package/lib/components/BryntumThemeCombo.js.map +1 -0
  32. package/lib/components/BryntumTreeCombo.js +1 -1
  33. package/lib/components/BryntumTreeGrid.js +1 -1
  34. package/lib/index.js +10 -10
  35. package/package.json +1 -1
  36. package/src/components/BryntumAIFilterField.vue +73 -118
  37. package/src/components/BryntumAIFilterFieldProps.ts +69 -110
  38. package/src/components/BryntumChecklistFilterCombo.vue +90 -149
  39. package/src/components/BryntumChecklistFilterComboProps.ts +86 -141
  40. package/src/components/BryntumGrid.vue +203 -290
  41. package/src/components/BryntumGridBase.vue +203 -290
  42. package/src/components/BryntumGridBaseProps.ts +186 -261
  43. package/src/components/BryntumGridChartDesigner.vue +58 -94
  44. package/src/components/BryntumGridChartDesignerProps.ts +55 -88
  45. package/src/components/BryntumGridFieldFilterPicker.vue +81 -131
  46. package/src/components/BryntumGridFieldFilterPickerGroup.vue +80 -129
  47. package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +76 -120
  48. package/src/components/BryntumGridFieldFilterPickerProps.ts +77 -122
  49. package/src/components/BryntumGridProps.ts +186 -261
  50. package/src/components/BryntumGroupBar.vue +64 -104
  51. package/src/components/BryntumGroupBarProps.ts +61 -98
  52. package/src/components/BryntumThemeCombo.vue +60 -0
  53. package/src/components/BryntumTreeCombo.vue +91 -151
  54. package/src/components/BryntumTreeComboProps.ts +87 -143
  55. package/src/components/BryntumTreeGrid.vue +203 -290
  56. package/src/components/BryntumTreeGridProps.ts +186 -261
  57. package/lib/chunks/B5DiBj1m.js.map +0 -1
  58. package/lib/chunks/BQkqLHa6.js.map +0 -1
  59. package/lib/chunks/C3MmNeeF.js.map +0 -1
  60. package/lib/chunks/C8vFKx3Q.js.map +0 -1
  61. package/lib/chunks/CnbA4JoC.js.map +0 -1
  62. package/lib/chunks/D639wy1k.js.map +0 -1
  63. package/lib/chunks/Da4PP6A-.js.map +0 -1
  64. package/lib/chunks/DkzTNiUv.js.map +0 -1
  65. package/lib/chunks/MAev_NTD.js.map +0 -1
  66. package/lib/chunks/v3MxzI7J.js.map +0 -1
@@ -10,7 +10,7 @@
10
10
 
11
11
  import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
12
12
 
13
- import type { AlignSpec, Base, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo, ComboModel, Duration, DurationConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, List, ListConfig, MaskConfig, Model, Rectangle, Store, StoreConfig, TabConfig, TooltipConfig, Widget } from '@bryntum/core-thin';
13
+ import type { AlignSpec, Base, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo, Duration, DurationConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, ListConfig, MaskConfig, Model, Rectangle, Store, StoreConfig, TabConfig, TooltipConfig, Widget } from '@bryntum/core-thin';
14
14
  import type { ChecklistFilterComboListeners, GridContainerItemConfig } from '@bryntum/grid-thin';
15
15
  import { ChecklistFilterCombo } from '@bryntum/grid-thin';
16
16
 
@@ -21,14 +21,12 @@ defineProps<{
21
21
  /**
22
22
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
23
23
  * content will be placed inside this element.
24
- * ...
25
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-adopt)
24
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-adopt)
26
25
  */
27
26
  adopt ? : HTMLElement|string
28
27
  /**
29
28
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
30
- * ...
31
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-align)
29
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-align)
32
30
  */
33
31
  align ? : AlignSpec|string
34
32
  /**
@@ -50,15 +48,13 @@ defineProps<{
50
48
  /**
51
49
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
52
50
  * into an element which will be linked using the `aria-describedby` attribute.
53
- * ...
54
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ariaDescription)
51
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ariaDescription)
55
52
  */
56
53
  ariaDescription ? : string
57
54
  /**
58
55
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
59
56
  * the `aria-label` attribute.
60
- * ...
61
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ariaLabel)
57
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ariaLabel)
62
58
  */
63
59
  ariaLabel ? : string
64
60
  /**
@@ -81,20 +77,17 @@ defineProps<{
81
77
  /**
82
78
  * An object where property names with a truthy value indicate which events should bubble up the ownership
83
79
  * hierarchy when triggered.
84
- * ...
85
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-bubbleEvents)
80
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-bubbleEvents)
86
81
  */
87
82
  bubbleEvents ? : object
88
83
  /**
89
84
  * Enable caching of the last retrieved result until the timeout is reached.
90
- * ...
91
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-cacheLastResult)
85
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-cacheLastResult)
92
86
  */
93
87
  cacheLastResult ? : number|string|Duration|DurationConfig
94
88
  /**
95
89
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
96
- * ...
97
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-callOnFunctions)
90
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-callOnFunctions)
98
91
  */
99
92
  callOnFunctions ? : Boolean
100
93
  /**
@@ -104,8 +97,7 @@ defineProps<{
104
97
  /**
105
98
  * By default, if an event handler throws an exception, the error propagates up the stack and the
106
99
  * application state is undefined. Code which follows the event handler will *not* be executed.
107
- * ...
108
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-catchEventHandlerExceptions)
100
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-catchEventHandlerExceptions)
109
101
  */
110
102
  catchEventHandlerExceptions ? : Boolean
111
103
  /**
@@ -116,8 +108,7 @@ defineProps<{
116
108
  /**
117
109
  * A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
118
110
  * selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
119
- * ...
120
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-chipView)
111
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-chipView)
121
112
  */
122
113
  chipView ? : ChipViewConfig
123
114
  /**
@@ -142,15 +133,13 @@ defineProps<{
142
133
  * Custom CSS classes to add to element.
143
134
  * May be specified as a space separated string, or as an object in which property names
144
135
  * with truthy values are used as the class names:
145
- * ...
146
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-cls)
136
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-cls)
147
137
  */
148
138
  cls ? : string|object
149
139
  /**
150
140
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
151
141
  * `style` block.
152
- * ...
153
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-color)
142
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-color)
154
143
  */
155
144
  color ? : Color
156
145
  /**
@@ -167,15 +156,13 @@ defineProps<{
167
156
  * The configuration for additional items associated to this field. This is typically used to add contextual
168
157
  * fields related to a [checkbox](https://bryntum.com/products/grid/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
169
158
  * these classes for examples of nested fields.
170
- * ...
171
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-container)
159
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-container)
172
160
  */
173
- container ? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig|FieldContainer
161
+ container ? : Record<string, GridContainerItemConfig>|GridContainerItemConfig[]|FieldContainerConfig
174
162
  /**
175
163
  * The config controls how the value of nested items are handled when a parent container gets or sets its
176
164
  * [values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
177
- * ...
178
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-containValues)
165
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-containValues)
179
166
  * @param {Core.widget.Field} field Field instance
180
167
  * @returns {boolean}
181
168
  */
@@ -184,16 +171,14 @@ defineProps<{
184
171
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
185
172
  * May be specified as a space separated string, or as an object in which property names
186
173
  * with truthy values are used as the class names:
187
- * ...
188
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-contentElementCls)
174
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-contentElementCls)
189
175
  */
190
176
  contentElementCls ? : string|object
191
177
  /**
192
178
  * If configured as `true`, this means that when an unmatched string is typed into the
193
179
  * 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,
194
180
  * 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).
195
- * ...
196
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
181
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-createOnUnmatched)
197
182
  * @param {string} name Record name
198
183
  * @param {Core.widget.Combo} combo Combo instance
199
184
  * @returns {Core.data.Model} New record
@@ -214,16 +199,15 @@ defineProps<{
214
199
  */
215
200
  defaultBindProperty ? : string
216
201
  /**
217
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
218
- * ...
219
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-detectCSSCompatibilityIssues)
202
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
203
+ * checks:
204
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-detectCSSCompatibilityIssues)
220
205
  */
221
206
  detectCSSCompatibilityIssues ? : Boolean
222
207
  /**
223
208
  * 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
224
209
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
225
- * ...
226
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-disabled)
210
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-disabled)
227
211
  */
228
212
  disabled ? : Boolean|'inert'
229
213
  /**
@@ -236,26 +220,23 @@ defineProps<{
236
220
  * @param {Core.widget.Combo} combo A reference to this Combo
237
221
  * @returns {string,void}
238
222
  */
239
- displayValueRenderer ? : (record: Model|ComboModel, combo: Combo) => string|void
223
+ displayValueRenderer ? : (record: Model, combo: Combo) => string|void
240
224
  /**
241
225
  * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/grid/docs/api/Core/widget/Panel)
242
226
  * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
243
227
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
244
228
  * body. Such widgets are called "edge strips".
245
- * ...
246
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-dock)
229
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-dock)
247
230
  */
248
231
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
249
232
  /**
250
233
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
251
234
  * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
252
235
  * property which controls when a drag should start.
253
- * ...
254
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-draggable)
236
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-draggable)
237
+ * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
255
238
  */
256
- draggable ? : Boolean|{
257
- handleSelector?: string
258
- }
239
+ draggable ? : Boolean|object
259
240
  /**
260
241
  * User can edit text in text field (otherwise only pick from attached picker)
261
242
  */
@@ -263,21 +244,18 @@ defineProps<{
263
244
  /**
264
245
  * An object specifying attributes to assign to the root element of this widget.
265
246
  * Set `null` value to attribute to remove it.
266
- * ...
267
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-elementAttributes)
247
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-elementAttributes)
268
248
  */
269
249
  elementAttributes ? : Record<string, string|null>
270
250
  /**
271
251
  * Text to display in the drop down when there are no items in the underlying store.
272
- * ...
273
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-emptyText)
252
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-emptyText)
274
253
  */
275
254
  emptyText ? : string
276
255
  /**
277
256
  * 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
278
257
  * any filters to the server upon load.
279
- * ...
280
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-encodeFilterParams)
258
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-encodeFilterParams)
281
259
  * @param {object[]} filters filters
282
260
  * @returns {object[]} array of values
283
261
  */
@@ -291,8 +269,7 @@ defineProps<{
291
269
  /**
292
270
  * The name of an operator type as implemented in [operator](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter#config-operator)
293
271
  * to use when filtering the dropdown list based upon the typed value.
294
- * ...
295
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-filterOperator)
272
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-filterOperator)
296
273
  */
297
274
  filterOperator ? : CollectionCompareOperator
298
275
  /**
@@ -333,8 +310,7 @@ defineProps<{
333
310
  hidden ? : Boolean
334
311
  /**
335
312
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
336
- * ...
337
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-hideAnimation)
313
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-hideAnimation)
338
314
  */
339
315
  hideAnimation ? : Boolean|object
340
316
  /**
@@ -355,8 +331,7 @@ defineProps<{
355
331
  /**
356
332
  * An optional string to display inside the input field as an overlay. This can be useful for displaying
357
333
  * a field's units.
358
- * ...
359
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-hint)
334
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-hint)
360
335
  * @param {object} data A data object
361
336
  * @param {Core.widget.Field} data.source A reference to the field instance
362
337
  * @param {any} data.value The current value of the field
@@ -367,8 +342,7 @@ defineProps<{
367
342
  * 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.
368
343
  * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
369
344
  * encode such data (see [encodeHtml](https://bryntum.com/products/grid/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
370
- * ...
371
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-hintHtml)
345
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-hintHtml)
372
346
  * @param {object} data A data object
373
347
  * @param {Core.widget.Field} data.source A reference to the field instance
374
348
  * @param {any} data.value The current value of the field
@@ -381,23 +355,20 @@ defineProps<{
381
355
  id ? : string
382
356
  /**
383
357
  * Determines if the widgets read-only state should be controlled by its parent.
384
- * ...
385
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ignoreParentReadOnly)
358
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ignoreParentReadOnly)
386
359
  */
387
360
  ignoreParentReadOnly ? : Boolean
388
361
  /**
389
362
  * Set this config to `true` to always display items horizontally along with this field. This assigns an
390
363
  * [hbox](https://bryntum.com/products/grid/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
391
364
  * [container](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-container).
392
- * ...
393
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-inline)
365
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-inline)
394
366
  */
395
367
  inline ? : Boolean
396
368
  /**
397
369
  * Configure this as `true` to render the dropdown list as a permanently visible list
398
370
  * in the document flow immediately below the input area instead of as a popup.
399
- * ...
400
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-inlinePicker)
371
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-inlinePicker)
401
372
  */
402
373
  inlinePicker ? : Boolean
403
374
  /**
@@ -435,30 +406,26 @@ defineProps<{
435
406
  insertFirst ? : HTMLElement|string
436
407
  /**
437
408
  * Rows to display in the dropdown (list items).
438
- * ...
439
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-items)
409
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-items)
440
410
  */
441
411
  items ? : object[]|string[]|object
442
412
  /**
443
413
  * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
444
414
  * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
445
415
  * are the name of the instance method to call when the keystroke is received.
446
- * ...
447
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-keyMap)
416
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-keyMap)
448
417
  */
449
418
  keyMap ? : Record<string, KeyMapConfig>
450
419
  /**
451
420
  * The delay in milliseconds to wait after the last keystroke before triggering a change event.
452
421
  * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
453
422
  * immediate feedback, change will still be triggered on blur).
454
- * ...
455
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-keyStrokeChangeDelay)
423
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-keyStrokeChangeDelay)
456
424
  */
457
425
  keyStrokeChangeDelay ? : number
458
426
  /**
459
427
  * The delay in milliseconds to wait after the last keystroke before filtering the list.
460
- * ...
461
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-keyStrokeFilterDelay)
428
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-keyStrokeFilterDelay)
462
429
  */
463
430
  keyStrokeFilterDelay ? : number
464
431
  /**
@@ -471,15 +438,15 @@ defineProps<{
471
438
  labelCls ? : string|object
472
439
  /**
473
440
  * Label position, either 'before' the field or 'above' the field
474
- * ...
475
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-labelPosition)
441
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-labelPosition)
476
442
  */
477
443
  labelPosition ? : 'before'|'above'|null
478
444
  /**
479
445
  * The labels to add either before or after the input field.
480
446
  * Each label may have the following properties:
481
- * ...
482
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-labels)
447
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-labels)
448
+ * @property {string} html Label text
449
+ * @property {'start','end'} align Which end of the file the label should go
483
450
  */
484
451
  labels ? : object[]
485
452
  /**
@@ -492,8 +459,7 @@ defineProps<{
492
459
  listCls ? : string
493
460
  /**
494
461
  * The listener set for this object.
495
- * ...
496
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-listeners)
462
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-listeners)
497
463
  */
498
464
  listeners ? : ChecklistFilterComboListeners
499
465
  /**
@@ -504,18 +470,16 @@ defineProps<{
504
470
  listItemPillTpl ? : (record: Model) => string
505
471
  /**
506
472
  * Template string used to render the list items in the dropdown list
507
- * ...
508
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-listItemTpl)
473
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-listItemTpl)
509
474
  * @param {Core.data.Model} record The record representing the item being rendered
510
475
  * @returns {string,void}
511
476
  */
512
- listItemTpl ? : (record: Model|ComboModel) => string|void
477
+ listItemTpl ? : (record: Model) => string|void
513
478
  /**
514
479
  * A class translations of which are used for translating this entity.
515
480
  * This is often used when translations of an item are defined on its container class.
516
481
  * For example:
517
- * ...
518
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-localeClass)
482
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-localeClass)
519
483
  */
520
484
  localeClass ? : typeof Base
521
485
  /**
@@ -527,8 +491,7 @@ defineProps<{
527
491
  * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
528
492
  * you could use 'localeKey' meta configuration.
529
493
  * Example:
530
- * ...
531
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-localizableProperties)
494
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-localizableProperties)
532
495
  */
533
496
  localizableProperties ? : string[]
534
497
  /**
@@ -554,8 +517,7 @@ defineProps<{
554
517
  maxHeight ? : string|number
555
518
  /**
556
519
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
557
- * ...
558
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-maximizeOnMobile)
520
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-maximizeOnMobile)
559
521
  */
560
522
  maximizeOnMobile ? : number|string
561
523
  /**
@@ -569,8 +531,7 @@ defineProps<{
569
531
  maxWidth ? : string|number
570
532
  /**
571
533
  * 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`.
572
- * ...
573
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-minChars)
534
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-minChars)
574
535
  */
575
536
  minChars ? : number
576
537
  /**
@@ -591,12 +552,10 @@ defineProps<{
591
552
  * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
592
553
  * is used to monitor this element for size changes caused by either style manipulation, or by CSS
593
554
  * layout.
594
- * ...
595
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-monitorResize)
555
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-monitorResize)
556
+ * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
596
557
  */
597
- monitorResize ? : Boolean|{
598
- immediate?: Boolean
599
- }
558
+ monitorResize ? : Boolean|object
600
559
  /**
601
560
  * A key value which, when typed in a [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) Combo, selects the
602
561
  * currently active item in the picker, and clears the input field ready for another
@@ -607,8 +566,7 @@ defineProps<{
607
566
  * Name of the field which is used as a key to get/set values from/to the field.
608
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
609
568
  * [Container.values](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-values).
610
- * ...
611
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-name)
569
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-name)
612
570
  */
613
571
  name ? : string
614
572
  /**
@@ -619,10 +577,9 @@ defineProps<{
619
577
  /**
620
578
  * Configuration object for the [picker](https://bryntum.com/products/grid/docs/api/Core/widget/List) on initialization. Returns the
621
579
  * [picker](https://bryntum.com/products/grid/docs/api/Core/widget/List) instance at runtime.
622
- * ...
623
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-picker)
580
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-picker)
624
581
  */
625
- picker ? : ListConfig|List
582
+ picker ? : ListConfig
626
583
  /**
627
584
  * The name of the element property to which the picker should size and align itself.
628
585
  */
@@ -639,8 +596,7 @@ defineProps<{
639
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
640
597
  * not participate in the standard layout of that widget, and must be positioned relatively to that
641
598
  * widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
642
- * ...
643
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-positioned)
599
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-positioned)
644
600
  */
645
601
  positioned ? : Boolean
646
602
  /**
@@ -652,22 +608,19 @@ defineProps<{
652
608
  * Optionally a [Filter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) config object which the combo should use for
653
609
  * filtering using the typed value.
654
610
  * This may use a `filterBy` property to test its `value` against any field in the passed record.
655
- * ...
656
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-primaryFilter)
611
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-primaryFilter)
657
612
  */
658
613
  primaryFilter ? : CollectionFilterConfig
659
614
  /**
660
615
  * Makes the field unmodifiable by user action. The input area is not editable, and triggers
661
616
  * are unresponsive.
662
- * ...
663
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-readOnly)
617
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-readOnly)
664
618
  */
665
619
  readOnly ? : Boolean
666
620
  relayStoreEvents ? : Boolean
667
621
  /**
668
622
  * Predefined style to use for the field. Possible values are:
669
- * ...
670
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-rendition)
623
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-rendition)
671
624
  */
672
625
  rendition ? : 'outlined'|'filled'|string
673
626
  /**
@@ -686,23 +639,26 @@ defineProps<{
686
639
  * Configure as `true` to have the component display a translucent ripple when its
687
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
688
641
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
689
- * ...
690
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ripple)
642
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#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.
691
647
  */
692
- ripple ? : Boolean|{
693
- delegate?: string
694
- color?: string
695
- radius?: number
696
- clip?: string
697
- }
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/ChecklistFilterCombo#config-role)
653
+ */
654
+ role ? : string
698
655
  /**
699
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`
700
657
  */
701
658
  rootElement ? : ShadowRoot|HTMLElement
702
659
  /**
703
660
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
704
- * ...
705
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-rtl)
661
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-rtl)
706
662
  */
707
663
  rtl ? : Boolean
708
664
  /**
@@ -716,8 +672,7 @@ defineProps<{
716
672
  searchText ? : string
717
673
  /**
718
674
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
719
- * ...
720
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-showAnimation)
675
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-showAnimation)
721
676
  */
722
677
  showAnimation ? : Boolean|object
723
678
  /**
@@ -755,8 +710,7 @@ defineProps<{
755
710
  * 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
756
711
  * [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
757
712
  * this widget:
758
- * ...
759
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-tab)
713
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-tab)
760
714
  */
761
715
  tab ? : Boolean|TabConfig
762
716
  /**
@@ -764,14 +718,12 @@ defineProps<{
764
718
  * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
765
719
  * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
766
720
  * to the element programmatically.
767
- * ...
768
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-tabIndex)
721
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-tabIndex)
769
722
  */
770
723
  tabIndex ? : number
771
724
  /**
772
725
  * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
773
- * ...
774
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-textAlign)
726
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-textAlign)
775
727
  */
776
728
  textAlign ? : 'left'|'center'|'right'|'start'|'end'
777
729
  /**
@@ -780,30 +732,26 @@ defineProps<{
780
732
  title ? : string
781
733
  /**
782
734
  * Tooltip for the widget, either as a string or as a Tooltip config object.
783
- * ...
784
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-tooltip)
735
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-tooltip)
785
736
  */
786
737
  tooltip ? : string|TooltipConfig|null
787
738
  /**
788
739
  * How to query the store upon click of the expand trigger. Specify one of these values:
789
- * ...
790
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-triggerAction)
740
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-triggerAction)
791
741
  */
792
742
  triggerAction ? : 'all'|'last'|null
793
743
  /**
794
744
  * The triggers to add either before or after the input field. Each property name is the reference by which
795
745
  * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
796
- * ...
797
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-triggers)
746
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-triggers)
798
747
  */
799
- triggers ? : Record<string, FieldTriggerConfig>|Record<string, Widget>
748
+ triggers ? : Record<string, FieldTriggerConfig>
800
749
  type ? : 'checklistfiltercombo'
801
750
  /**
802
751
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
803
752
  * as a space separated string, an array of strings, or as an object in which property names with truthy
804
753
  * values are used as the class names.
805
- * ...
806
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ui)
754
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-ui)
807
755
  */
808
756
  ui ? : string|object
809
757
  /**
@@ -822,8 +770,7 @@ defineProps<{
822
770
  /**
823
771
  * Field used for item value when populating from store. Setting this to `null` will
824
772
  * yield the selected record as the Combo's [value](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#property-value).
825
- * ...
826
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-valueField)
773
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-valueField)
827
774
  */
828
775
  valueField ? : string|null
829
776
  /**
@@ -839,14 +786,12 @@ defineProps<{
839
786
  width ? : string|number
840
787
  /**
841
788
  * The x position for the widget.
842
- * ...
843
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-x)
789
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-x)
844
790
  */
845
791
  x ? : number
846
792
  /**
847
793
  * The y position for the widget.
848
- * ...
849
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-y)
794
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-y)
850
795
  */
851
796
  y ? : number
852
797
 
@@ -899,8 +844,7 @@ const emit = defineEmits<{
899
844
  (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
900
845
  /**
901
846
  * Fires when any other event is fired from the object.
902
- * ...
903
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-catchAll)
847
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-catchAll)
904
848
  * @param {string} e Event name
905
849
  * @param {object} params Event parameters
906
850
  * @param {string} params.e Event name
@@ -928,8 +872,7 @@ const emit = defineEmits<{
928
872
  (e: 'change', params: ((event: { source: Field|any, value: string|number|boolean|any, oldValue: string|number|boolean|any, valid: boolean, event: Event, userAction: boolean, checked: boolean }) => void)|string): void
929
873
  /**
930
874
  * Fired when this field is [cleared](https://bryntum.com/products/grid/docs/api/Core/widget/Field#function-clear).
931
- * ...
932
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-clear)
875
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-clear)
933
876
  * @param {string} e Event name
934
877
  * @param {object} params Event parameters
935
878
  * @param {string} params.e Event name
@@ -1016,8 +959,7 @@ const emit = defineEmits<{
1016
959
  /**
1017
960
  * Triggered when a widget which had been in a non-visible state for any reason
1018
961
  * achieves visibility.
1019
- * ...
1020
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-paint)
962
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#event-paint)
1021
963
  * @param {string} e Event name
1022
964
  * @param {object} params Event parameters
1023
965
  * @param {string} params.e Event name
@@ -1179,6 +1121,7 @@ const widgetData = {
1179
1121
  'relayStoreEvents',
1180
1122
  'revertOnEscape',
1181
1123
  'ripple',
1124
+ 'role',
1182
1125
  'rootElement',
1183
1126
  'scrollAction',
1184
1127
  'showAnimation',
@@ -1264,9 +1207,7 @@ const widgetData = {
1264
1207
  'y'
1265
1208
  ],
1266
1209
  propertyNames : [
1267
- 'anchorSize',
1268
1210
  'content',
1269
- 'focusVisible',
1270
1211
  'formula',
1271
1212
  'html',
1272
1213
  'input',