@bryntum/grid-vue-3-thin 7.3.1 → 7.3.3

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 (64) hide show
  1. package/README.md +4 -4
  2. package/lib/chunks/{C87PnYXS.js → C0JvA2nJ.js} +2 -2
  3. package/lib/chunks/C0JvA2nJ.js.map +1 -0
  4. package/lib/chunks/{CWYhi4DG.js → CY1iE7DM.js} +2 -2
  5. package/lib/chunks/CY1iE7DM.js.map +1 -0
  6. package/lib/chunks/{w2GDktIt.js → Ci62kqiA.js} +2 -1
  7. package/lib/chunks/Ci62kqiA.js.map +1 -0
  8. package/lib/chunks/{Be7ZZzGW.js → DYXBLIYI.js} +9 -8
  9. package/lib/chunks/DYXBLIYI.js.map +1 -0
  10. package/lib/chunks/{C9RmZYoQ.js → DdqL-AKl.js} +2 -2
  11. package/lib/chunks/DdqL-AKl.js.map +1 -0
  12. package/lib/chunks/{Bc2x_WPR.js → DiGTPgG-.js} +2 -1
  13. package/lib/chunks/DiGTPgG-.js.map +1 -0
  14. package/lib/chunks/{CAlh-Y8B.js → DxJ_eGe0.js} +2 -2
  15. package/lib/chunks/DxJ_eGe0.js.map +1 -0
  16. package/lib/chunks/{BpNo5v3W.js → Qh0FUJz3.js} +2 -2
  17. package/lib/chunks/Qh0FUJz3.js.map +1 -0
  18. package/lib/chunks/{DZ2V6NNc.js → kePPbdOW.js} +2 -2
  19. package/lib/chunks/kePPbdOW.js.map +1 -0
  20. package/lib/chunks/{CcfDAcJD.js → rQ3-VslX.js} +2 -2
  21. package/lib/chunks/rQ3-VslX.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/BryntumTreeCombo.js +1 -1
  31. package/lib/components/BryntumTreeGrid.js +1 -1
  32. package/lib/index.js +10 -10
  33. package/license.pdf +0 -0
  34. package/package.json +1 -1
  35. package/src/components/BryntumAIFilterField.vue +12 -5
  36. package/src/components/BryntumAIFilterFieldProps.ts +11 -4
  37. package/src/components/BryntumChecklistFilterCombo.vue +12 -5
  38. package/src/components/BryntumChecklistFilterComboProps.ts +11 -4
  39. package/src/components/BryntumGrid.vue +8 -1
  40. package/src/components/BryntumGridBase.vue +8 -1
  41. package/src/components/BryntumGridBaseProps.ts +7 -1
  42. package/src/components/BryntumGridChartDesigner.vue +12 -5
  43. package/src/components/BryntumGridChartDesignerProps.ts +11 -4
  44. package/src/components/BryntumGridFieldFilterPicker.vue +13 -6
  45. package/src/components/BryntumGridFieldFilterPickerGroup.vue +13 -6
  46. package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +12 -5
  47. package/src/components/BryntumGridFieldFilterPickerProps.ts +12 -5
  48. package/src/components/BryntumGridProps.ts +7 -1
  49. package/src/components/BryntumGroupBar.vue +15 -6
  50. package/src/components/BryntumGroupBarProps.ts +14 -5
  51. package/src/components/BryntumTreeCombo.vue +12 -5
  52. package/src/components/BryntumTreeComboProps.ts +11 -4
  53. package/src/components/BryntumTreeGrid.vue +8 -1
  54. package/src/components/BryntumTreeGridProps.ts +7 -1
  55. package/lib/chunks/Bc2x_WPR.js.map +0 -1
  56. package/lib/chunks/Be7ZZzGW.js.map +0 -1
  57. package/lib/chunks/BpNo5v3W.js.map +0 -1
  58. package/lib/chunks/C87PnYXS.js.map +0 -1
  59. package/lib/chunks/C9RmZYoQ.js.map +0 -1
  60. package/lib/chunks/CAlh-Y8B.js.map +0 -1
  61. package/lib/chunks/CWYhi4DG.js.map +0 -1
  62. package/lib/chunks/CcfDAcJD.js.map +0 -1
  63. package/lib/chunks/DZ2V6NNc.js.map +0 -1
  64. package/lib/chunks/w2GDktIt.js.map +0 -1
@@ -53,6 +53,8 @@ defineProps<{
53
53
  /**
54
54
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
55
55
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
56
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
57
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
56
58
  */
57
59
  appendTo ? : HTMLElement|string
58
60
  /**
@@ -110,9 +112,10 @@ defineProps<{
110
112
  catchEventHandlerExceptions ? : Boolean
111
113
  /**
112
114
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
113
- * Set to `true` to centre the Widget in browser viewport space.
115
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-centered)
116
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
114
117
  */
115
- centered ? : Boolean
118
+ centered ? : Boolean|object
116
119
  /**
117
120
  * Custom CSS classes to add to element.
118
121
  * May be specified as a space separated string, or as an object in which property names
@@ -201,7 +204,7 @@ defineProps<{
201
204
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
202
205
  /**
203
206
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
204
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
207
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
205
208
  * property which controls when a drag should start.
206
209
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-draggable)
207
210
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -301,10 +304,14 @@ defineProps<{
301
304
  inputFieldAlign ? : 'start'|'end'
302
305
  /**
303
306
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
307
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
308
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
304
309
  */
305
310
  insertBefore ? : HTMLElement|string
306
311
  /**
307
312
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
313
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
314
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
308
315
  */
309
316
  insertFirst ? : HTMLElement|string
310
317
  /**
@@ -330,7 +337,7 @@ defineProps<{
330
337
  */
331
338
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
332
339
  /**
333
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
340
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
334
341
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-labelWidth)
335
342
  */
336
343
  labelWidth ? : number|null
@@ -507,7 +514,7 @@ defineProps<{
507
514
  scrollable ? : Boolean|ScrollerConfig|Scroller
508
515
  /**
509
516
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
510
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
517
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
511
518
  */
512
519
  scrollAction ? : 'hide'|'realign'|null
513
520
  /**
@@ -796,7 +803,6 @@ const widgetData = {
796
803
  'bubbleEvents',
797
804
  'canDeleteFilter',
798
805
  'canManageFilter',
799
- 'centered',
800
806
  'color',
801
807
  'config',
802
808
  'constrainTo',
@@ -856,6 +862,7 @@ const widgetData = {
856
862
  'appendTo',
857
863
  'callOnFunctions',
858
864
  'catchEventHandlerExceptions',
865
+ 'centered',
859
866
  'cls',
860
867
  'column',
861
868
  'content',
@@ -38,6 +38,8 @@ export declare type BryntumGridFieldFilterPickerGroupProps = {
38
38
  /**
39
39
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
40
40
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
41
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
41
43
  */
42
44
  appendTo ? : HTMLElement|string
43
45
  /**
@@ -95,9 +97,10 @@ export declare type BryntumGridFieldFilterPickerGroupProps = {
95
97
  catchEventHandlerExceptions ? : Boolean
96
98
  /**
97
99
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
98
- * Set to `true` to centre the Widget in browser viewport space.
100
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-centered)
101
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
99
102
  */
100
- centered ? : Boolean
103
+ centered ? : Boolean|object
101
104
  /**
102
105
  * Custom CSS classes to add to element.
103
106
  * May be specified as a space separated string, or as an object in which property names
@@ -186,7 +189,7 @@ export declare type BryntumGridFieldFilterPickerGroupProps = {
186
189
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
187
190
  /**
188
191
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
189
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
192
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
190
193
  * property which controls when a drag should start.
191
194
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-draggable)
192
195
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -286,10 +289,14 @@ export declare type BryntumGridFieldFilterPickerGroupProps = {
286
289
  inputFieldAlign ? : 'start'|'end'
287
290
  /**
288
291
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
292
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
293
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
289
294
  */
290
295
  insertBefore ? : HTMLElement|string
291
296
  /**
292
297
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
298
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
299
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
293
300
  */
294
301
  insertFirst ? : HTMLElement|string
295
302
  /**
@@ -315,7 +322,7 @@ export declare type BryntumGridFieldFilterPickerGroupProps = {
315
322
  */
316
323
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
317
324
  /**
318
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
325
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
319
326
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-labelWidth)
320
327
  */
321
328
  labelWidth ? : number|null
@@ -492,7 +499,7 @@ export declare type BryntumGridFieldFilterPickerGroupProps = {
492
499
  scrollable ? : Boolean|ScrollerConfig|Scroller
493
500
  /**
494
501
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
495
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
502
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
496
503
  */
497
504
  scrollAction ? : 'hide'|'realign'|null
498
505
  /**
@@ -35,6 +35,8 @@ export declare type BryntumGridFieldFilterPickerProps = {
35
35
  /**
36
36
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
37
37
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
38
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
39
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
38
40
  */
39
41
  appendTo ? : HTMLElement|string
40
42
  /**
@@ -76,9 +78,10 @@ export declare type BryntumGridFieldFilterPickerProps = {
76
78
  catchEventHandlerExceptions ? : Boolean
77
79
  /**
78
80
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
79
- * Set to `true` to centre the Widget in browser viewport space.
81
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-centered)
82
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
80
83
  */
81
- centered ? : Boolean
84
+ centered ? : Boolean|object
82
85
  /**
83
86
  * Custom CSS classes to add to element.
84
87
  * May be specified as a space separated string, or as an object in which property names
@@ -167,7 +170,7 @@ export declare type BryntumGridFieldFilterPickerProps = {
167
170
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
168
171
  /**
169
172
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
170
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
173
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
171
174
  * property which controls when a drag should start.
172
175
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-draggable)
173
176
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -271,10 +274,14 @@ export declare type BryntumGridFieldFilterPickerProps = {
271
274
  inputFieldAlign ? : 'start'|'end'
272
275
  /**
273
276
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
277
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
278
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
274
279
  */
275
280
  insertBefore ? : HTMLElement|string
276
281
  /**
277
282
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
283
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
284
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
278
285
  */
279
286
  insertFirst ? : HTMLElement|string
280
287
  /**
@@ -300,7 +307,7 @@ export declare type BryntumGridFieldFilterPickerProps = {
300
307
  */
301
308
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
302
309
  /**
303
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
310
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
304
311
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-labelWidth)
305
312
  */
306
313
  labelWidth ? : number|null
@@ -482,7 +489,7 @@ export declare type BryntumGridFieldFilterPickerProps = {
482
489
  scrollable ? : Boolean|ScrollerConfig|Scroller
483
490
  /**
484
491
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
485
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
492
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
486
493
  */
487
494
  scrollAction ? : 'hide'|'realign'|null
488
495
  /**
@@ -36,6 +36,8 @@ export declare type BryntumGridProps = {
36
36
  /**
37
37
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
38
38
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
39
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
40
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-appendTo)
39
41
  */
40
42
  appendTo ? : HTMLElement|string
41
43
  /**
@@ -347,10 +349,14 @@ export declare type BryntumGridProps = {
347
349
  inputFieldAlign ? : 'start'|'end'
348
350
  /**
349
351
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
352
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
353
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
350
354
  */
351
355
  insertBefore ? : HTMLElement|string
352
356
  /**
353
357
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
358
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
359
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
354
360
  */
355
361
  insertFirst ? : HTMLElement|string
356
362
  /**
@@ -363,7 +369,7 @@ export declare type BryntumGridProps = {
363
369
  */
364
370
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
365
371
  /**
366
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
372
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
367
373
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-labelWidth)
368
374
  */
369
375
  labelWidth ? : number|null
@@ -53,6 +53,8 @@ defineProps<{
53
53
  /**
54
54
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
55
55
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
56
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
57
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
56
58
  */
57
59
  appendTo ? : HTMLElement|string
58
60
  /**
@@ -86,9 +88,10 @@ defineProps<{
86
88
  catchEventHandlerExceptions ? : Boolean
87
89
  /**
88
90
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
89
- * Set to `true` to centre the Widget in browser viewport space.
91
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-centered)
92
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
90
93
  */
91
- centered ? : Boolean
94
+ centered ? : Boolean|object
92
95
  /**
93
96
  * Configure as `true` to clear selection when clicking on empty space inside the List´s element.
94
97
  */
@@ -102,9 +105,11 @@ defineProps<{
102
105
  /**
103
106
  * If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
104
107
  * action means. If not provided, the record representing the chip is removed from the store.
108
+ * @param {Core.data.Model[]} records Records to be closed
109
+ * @param {object} options Close options
105
110
  * @returns {void}
106
111
  */
107
- closeHandler ? : string|(() => void)
112
+ closeHandler ? : string|((records: Model[], options: object) => void)
108
113
  /**
109
114
  * Custom CSS classes to add to element.
110
115
  * May be specified as a space separated string, or as an object in which property names
@@ -186,7 +191,7 @@ defineProps<{
186
191
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
187
192
  /**
188
193
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
189
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
194
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
190
195
  * property which controls when a drag should start.
191
196
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-draggable)
192
197
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -281,10 +286,14 @@ defineProps<{
281
286
  ignoreParentReadOnly ? : Boolean
282
287
  /**
283
288
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
289
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
290
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
284
291
  */
285
292
  insertBefore ? : HTMLElement|string
286
293
  /**
287
294
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
295
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
296
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
288
297
  */
289
298
  insertFirst ? : HTMLElement|string
290
299
  /**
@@ -445,7 +454,7 @@ defineProps<{
445
454
  scrollable ? : Boolean|ScrollerConfig|Scroller
446
455
  /**
447
456
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
448
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
457
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
449
458
  */
450
459
  scrollAction ? : 'hide'|'realign'|null
451
460
  /**
@@ -751,7 +760,6 @@ const widgetData = {
751
760
  'ariaDescription',
752
761
  'ariaLabel',
753
762
  'bubbleEvents',
754
- 'centered',
755
763
  'closable',
756
764
  'closeHandler',
757
765
  'color',
@@ -807,6 +815,7 @@ const widgetData = {
807
815
  'appendTo',
808
816
  'callOnFunctions',
809
817
  'catchEventHandlerExceptions',
818
+ 'centered',
810
819
  'clearSelectionOnEmptySpaceClick',
811
820
  'cls',
812
821
  'collapsibleGroups',
@@ -38,6 +38,8 @@ export declare type BryntumGroupBarProps = {
38
38
  /**
39
39
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
40
40
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
41
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
42
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
41
43
  */
42
44
  appendTo ? : HTMLElement|string
43
45
  /**
@@ -71,9 +73,10 @@ export declare type BryntumGroupBarProps = {
71
73
  catchEventHandlerExceptions ? : Boolean
72
74
  /**
73
75
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
74
- * Set to `true` to centre the Widget in browser viewport space.
76
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-centered)
77
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
75
78
  */
76
- centered ? : Boolean
79
+ centered ? : Boolean|object
77
80
  /**
78
81
  * Configure as `true` to clear selection when clicking on empty space inside the List´s element.
79
82
  */
@@ -87,9 +90,11 @@ export declare type BryntumGroupBarProps = {
87
90
  /**
88
91
  * If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
89
92
  * action means. If not provided, the record representing the chip is removed from the store.
93
+ * @param {Core.data.Model[]} records Records to be closed
94
+ * @param {object} options Close options
90
95
  * @returns {void}
91
96
  */
92
- closeHandler ? : string|(() => void)
97
+ closeHandler ? : string|((records: Model[], options: object) => void)
93
98
  /**
94
99
  * Custom CSS classes to add to element.
95
100
  * May be specified as a space separated string, or as an object in which property names
@@ -171,7 +176,7 @@ export declare type BryntumGroupBarProps = {
171
176
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
172
177
  /**
173
178
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
174
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
179
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
175
180
  * property which controls when a drag should start.
176
181
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-draggable)
177
182
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -266,10 +271,14 @@ export declare type BryntumGroupBarProps = {
266
271
  ignoreParentReadOnly ? : Boolean
267
272
  /**
268
273
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
274
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
275
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
269
276
  */
270
277
  insertBefore ? : HTMLElement|string
271
278
  /**
272
279
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
280
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
281
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
273
282
  */
274
283
  insertFirst ? : HTMLElement|string
275
284
  /**
@@ -430,7 +439,7 @@ export declare type BryntumGroupBarProps = {
430
439
  scrollable ? : Boolean|ScrollerConfig|Scroller
431
440
  /**
432
441
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
433
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
442
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
434
443
  */
435
444
  scrollAction ? : 'hide'|'realign'|null
436
445
  /**
@@ -43,6 +43,8 @@ defineProps<{
43
43
  /**
44
44
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
45
45
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
46
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
47
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
46
48
  */
47
49
  appendTo ? : HTMLElement|string
48
50
  /**
@@ -102,9 +104,10 @@ defineProps<{
102
104
  catchEventHandlerExceptions ? : Boolean
103
105
  /**
104
106
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
105
- * Set to `true` to centre the Widget in browser viewport space.
107
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-centered)
108
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
106
109
  */
107
- centered ? : Boolean
110
+ centered ? : Boolean|object
108
111
  /**
109
112
  * A function (or the name of a function in the ownership hierarchy) called during field validation
110
113
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
@@ -240,7 +243,7 @@ defineProps<{
240
243
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
241
244
  /**
242
245
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
243
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
246
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
244
247
  * property which controls when a drag should start.
245
248
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
246
249
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -407,10 +410,14 @@ defineProps<{
407
410
  inputWidth ? : string|number
408
411
  /**
409
412
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
413
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
414
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
410
415
  */
411
416
  insertBefore ? : HTMLElement|string
412
417
  /**
413
418
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
419
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
420
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
414
421
  */
415
422
  insertFirst ? : HTMLElement|string
416
423
  /**
@@ -671,7 +678,7 @@ defineProps<{
671
678
  rtl ? : Boolean
672
679
  /**
673
680
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
674
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
681
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
675
682
  */
676
683
  scrollAction ? : 'hide'|'realign'|null
677
684
  /**
@@ -1012,7 +1019,6 @@ const widgetData = {
1012
1019
  'bubbleEvents',
1013
1020
  'cacheLastResult',
1014
1021
  'caseSensitive',
1015
- 'centered',
1016
1022
  'checkValidity',
1017
1023
  'chipView',
1018
1024
  'clearable',
@@ -1109,6 +1115,7 @@ const widgetData = {
1109
1115
  'badge',
1110
1116
  'callOnFunctions',
1111
1117
  'catchEventHandlerExceptions',
1118
+ 'centered',
1112
1119
  'cls',
1113
1120
  'column',
1114
1121
  'dataset',
@@ -28,6 +28,8 @@ export declare type BryntumTreeComboProps = {
28
28
  /**
29
29
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
30
30
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
31
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
32
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
31
33
  */
32
34
  appendTo ? : HTMLElement|string
33
35
  /**
@@ -87,9 +89,10 @@ export declare type BryntumTreeComboProps = {
87
89
  catchEventHandlerExceptions ? : Boolean
88
90
  /**
89
91
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
90
- * Set to `true` to centre the Widget in browser viewport space.
92
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-centered)
93
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
91
94
  */
92
- centered ? : Boolean
95
+ centered ? : Boolean|object
93
96
  /**
94
97
  * A function (or the name of a function in the ownership hierarchy) called during field validation
95
98
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
@@ -225,7 +228,7 @@ export declare type BryntumTreeComboProps = {
225
228
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
226
229
  /**
227
230
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
228
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
231
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
229
232
  * property which controls when a drag should start.
230
233
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
231
234
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -392,10 +395,14 @@ export declare type BryntumTreeComboProps = {
392
395
  inputWidth ? : string|number
393
396
  /**
394
397
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
398
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
399
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
395
400
  */
396
401
  insertBefore ? : HTMLElement|string
397
402
  /**
398
403
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
404
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
405
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
399
406
  */
400
407
  insertFirst ? : HTMLElement|string
401
408
  /**
@@ -656,7 +663,7 @@ export declare type BryntumTreeComboProps = {
656
663
  rtl ? : Boolean
657
664
  /**
658
665
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
659
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
666
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
660
667
  */
661
668
  scrollAction ? : 'hide'|'realign'|null
662
669
  /**
@@ -74,6 +74,8 @@ defineProps<{
74
74
  /**
75
75
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
76
76
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
77
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
78
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
77
79
  */
78
80
  appendTo ? : HTMLElement|string
79
81
  /**
@@ -385,10 +387,14 @@ defineProps<{
385
387
  inputFieldAlign ? : 'start'|'end'
386
388
  /**
387
389
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
390
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
391
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
388
392
  */
389
393
  insertBefore ? : HTMLElement|string
390
394
  /**
391
395
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
396
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
397
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
392
398
  */
393
399
  insertFirst ? : HTMLElement|string
394
400
  /**
@@ -401,7 +407,7 @@ defineProps<{
401
407
  */
402
408
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
403
409
  /**
404
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
410
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
405
411
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelWidth)
406
412
  */
407
413
  labelWidth ? : number|null
@@ -2535,6 +2541,7 @@ const widgetData = {
2535
2541
  'width'
2536
2542
  ],
2537
2543
  propertyNames : [
2544
+ 'centered',
2538
2545
  'originalStore',
2539
2546
  'parent',
2540
2547
  'selectedCell',
@@ -36,6 +36,8 @@ export declare type BryntumTreeGridProps = {
36
36
  /**
37
37
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
38
38
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
39
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
40
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
39
41
  */
40
42
  appendTo ? : HTMLElement|string
41
43
  /**
@@ -347,10 +349,14 @@ export declare type BryntumTreeGridProps = {
347
349
  inputFieldAlign ? : 'start'|'end'
348
350
  /**
349
351
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
352
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
353
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
350
354
  */
351
355
  insertBefore ? : HTMLElement|string
352
356
  /**
353
357
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
358
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
359
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
354
360
  */
355
361
  insertFirst ? : HTMLElement|string
356
362
  /**
@@ -363,7 +369,7 @@ export declare type BryntumTreeGridProps = {
363
369
  */
364
370
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
365
371
  /**
366
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
372
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
367
373
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-labelWidth)
368
374
  */
369
375
  labelWidth ? : number|null