@bryntum/grid-react-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 (43) hide show
  1. package/README.md +4 -4
  2. package/lib/BryntumAIFilterField.d.ts +1 -1
  3. package/lib/BryntumAIFilterField.js +1 -1
  4. package/lib/BryntumAIFilterField.js.map +1 -1
  5. package/lib/BryntumChecklistFilterCombo.d.ts +1 -1
  6. package/lib/BryntumChecklistFilterCombo.js +1 -1
  7. package/lib/BryntumChecklistFilterCombo.js.map +1 -1
  8. package/lib/BryntumGrid.js +1 -0
  9. package/lib/BryntumGrid.js.map +1 -1
  10. package/lib/BryntumGridBase.js +1 -0
  11. package/lib/BryntumGridBase.js.map +1 -1
  12. package/lib/BryntumGridChartDesigner.d.ts +1 -1
  13. package/lib/BryntumGridChartDesigner.js +1 -1
  14. package/lib/BryntumGridChartDesigner.js.map +1 -1
  15. package/lib/BryntumGridFieldFilterPicker.d.ts +1 -1
  16. package/lib/BryntumGridFieldFilterPicker.js +1 -1
  17. package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
  18. package/lib/BryntumGridFieldFilterPickerGroup.d.ts +1 -1
  19. package/lib/BryntumGridFieldFilterPickerGroup.js +1 -1
  20. package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
  21. package/lib/BryntumGroupBar.d.ts +2 -2
  22. package/lib/BryntumGroupBar.js +1 -1
  23. package/lib/BryntumGroupBar.js.map +1 -1
  24. package/lib/BryntumTreeCombo.d.ts +1 -1
  25. package/lib/BryntumTreeCombo.js +1 -1
  26. package/lib/BryntumTreeCombo.js.map +1 -1
  27. package/lib/BryntumTreeGrid.js +1 -0
  28. package/lib/BryntumTreeGrid.js.map +1 -1
  29. package/lib/WrapperHelper.js +27 -8
  30. package/lib/WrapperHelper.js.map +1 -1
  31. package/license.pdf +0 -0
  32. package/package.json +1 -1
  33. package/src/BryntumAIFilterField.tsx +12 -5
  34. package/src/BryntumChecklistFilterCombo.tsx +12 -5
  35. package/src/BryntumGrid.tsx +8 -1
  36. package/src/BryntumGridBase.tsx +8 -1
  37. package/src/BryntumGridChartDesigner.tsx +12 -5
  38. package/src/BryntumGridFieldFilterPicker.tsx +13 -6
  39. package/src/BryntumGridFieldFilterPickerGroup.tsx +13 -6
  40. package/src/BryntumGroupBar.tsx +15 -6
  41. package/src/BryntumTreeCombo.tsx +12 -5
  42. package/src/BryntumTreeGrid.tsx +8 -1
  43. package/src/WrapperHelper.tsx +55 -17
@@ -35,6 +35,8 @@ export type BryntumAIFilterFieldProps = {
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/AIFilterField#config-appendTo)
38
40
  */
39
41
  appendTo? : HTMLElement|string
40
42
  /**
@@ -81,9 +83,10 @@ export type BryntumAIFilterFieldProps = {
81
83
  catchEventHandlerExceptions? : boolean
82
84
  /**
83
85
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
84
- * Set to `true` to centre the Widget in browser viewport space.
86
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-centered)
87
+ * @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.
85
88
  */
86
- centered? : boolean
89
+ centered? : boolean|object
87
90
  /**
88
91
  * A function (or the name of a function in the ownership hierarchy) called during field validation
89
92
  * 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)
@@ -185,7 +188,7 @@ export type BryntumAIFilterFieldProps = {
185
188
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
186
189
  /**
187
190
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
188
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
191
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
189
192
  * property which controls when a drag should start.
190
193
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-draggable)
191
194
  * @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 @@ export type BryntumAIFilterFieldProps = {
301
304
  inputWidth? : string|number
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/AIFilterField#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/AIFilterField#config-insertFirst)
308
315
  */
309
316
  insertFirst? : HTMLElement|string
310
317
  /**
@@ -506,7 +513,7 @@ export type BryntumAIFilterFieldProps = {
506
513
  rtl? : boolean
507
514
  /**
508
515
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
509
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
516
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
510
517
  */
511
518
  scrollAction? : 'hide'|'realign'|null
512
519
  /**
@@ -783,7 +790,6 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
783
790
  'autoComplete',
784
791
  'autoSelect',
785
792
  'bubbleEvents',
786
- 'centered',
787
793
  'checkValidity',
788
794
  'clearable',
789
795
  'client',
@@ -855,6 +861,7 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
855
861
  'badge',
856
862
  'callOnFunctions',
857
863
  'catchEventHandlerExceptions',
864
+ 'centered',
858
865
  'cls',
859
866
  'column',
860
867
  'dataset',
@@ -35,6 +35,8 @@ export type BryntumChecklistFilterComboProps = {
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/ChecklistFilterCombo#config-appendTo)
38
40
  */
39
41
  appendTo? : HTMLElement|string
40
42
  /**
@@ -94,9 +96,10 @@ export type BryntumChecklistFilterComboProps = {
94
96
  catchEventHandlerExceptions? : boolean
95
97
  /**
96
98
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
97
- * Set to `true` to centre the Widget in browser viewport space.
99
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-centered)
100
+ * @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.
98
101
  */
99
- centered? : boolean
102
+ centered? : boolean|object
100
103
  /**
101
104
  * A function (or the name of a function in the ownership hierarchy) called during field validation
102
105
  * 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)
@@ -232,7 +235,7 @@ export type BryntumChecklistFilterComboProps = {
232
235
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
233
236
  /**
234
237
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
235
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
238
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
236
239
  * property which controls when a drag should start.
237
240
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-draggable)
238
241
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -399,10 +402,14 @@ export type BryntumChecklistFilterComboProps = {
399
402
  inputWidth? : string|number
400
403
  /**
401
404
  * 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.
405
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
406
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertBefore)
402
407
  */
403
408
  insertBefore? : HTMLElement|string
404
409
  /**
405
410
  * 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.
411
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
412
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-insertFirst)
406
413
  */
407
414
  insertFirst? : HTMLElement|string
408
415
  /**
@@ -664,7 +671,7 @@ export type BryntumChecklistFilterComboProps = {
664
671
  rtl? : boolean
665
672
  /**
666
673
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
667
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
674
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
668
675
  */
669
676
  scrollAction? : 'hide'|'realign'|null
670
677
  /**
@@ -978,7 +985,6 @@ export class BryntumChecklistFilterCombo extends React.Component<BryntumChecklis
978
985
  'bubbleEvents',
979
986
  'cacheLastResult',
980
987
  'caseSensitive',
981
- 'centered',
982
988
  'checkValidity',
983
989
  'chipView',
984
990
  'clearable',
@@ -1076,6 +1082,7 @@ export class BryntumChecklistFilterCombo extends React.Component<BryntumChecklis
1076
1082
  'badge',
1077
1083
  'callOnFunctions',
1078
1084
  'catchEventHandlerExceptions',
1085
+ 'centered',
1079
1086
  'cls',
1080
1087
  'column',
1081
1088
  'dataset',
@@ -43,6 +43,8 @@ export type BryntumGridProps = {
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/view/Grid#config-appendTo)
46
48
  */
47
49
  appendTo? : HTMLElement|string
48
50
  /**
@@ -354,10 +356,14 @@ export type BryntumGridProps = {
354
356
  inputFieldAlign? : 'start'|'end'
355
357
  /**
356
358
  * 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.
359
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
360
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
357
361
  */
358
362
  insertBefore? : HTMLElement|string
359
363
  /**
360
364
  * 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.
365
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
366
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
361
367
  */
362
368
  insertFirst? : HTMLElement|string
363
369
  /**
@@ -370,7 +376,7 @@ export type BryntumGridProps = {
370
376
  */
371
377
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
372
378
  /**
373
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
379
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
374
380
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-labelWidth)
375
381
  */
376
382
  labelWidth? : number|null
@@ -2296,6 +2302,7 @@ export class BryntumGrid extends React.Component<BryntumGridProps> {
2296
2302
  ];
2297
2303
 
2298
2304
  static propertyNames = [
2305
+ 'centered',
2299
2306
  'originalStore',
2300
2307
  'parent',
2301
2308
  'selectedCell',
@@ -43,6 +43,8 @@ export type BryntumGridBaseProps = {
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/view/GridBase#config-appendTo)
46
48
  */
47
49
  appendTo? : HTMLElement|string
48
50
  /**
@@ -354,10 +356,14 @@ export type BryntumGridBaseProps = {
354
356
  inputFieldAlign? : 'start'|'end'
355
357
  /**
356
358
  * 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.
359
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
360
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
357
361
  */
358
362
  insertBefore? : HTMLElement|string
359
363
  /**
360
364
  * 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.
365
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
366
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
361
367
  */
362
368
  insertFirst? : HTMLElement|string
363
369
  /**
@@ -370,7 +376,7 @@ export type BryntumGridBaseProps = {
370
376
  */
371
377
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
372
378
  /**
373
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
379
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
374
380
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelWidth)
375
381
  */
376
382
  labelWidth? : number|null
@@ -2293,6 +2299,7 @@ export class BryntumGridBase extends React.Component<BryntumGridBaseProps> {
2293
2299
  ];
2294
2300
 
2295
2301
  static propertyNames = [
2302
+ 'centered',
2296
2303
  'originalStore',
2297
2304
  'parent',
2298
2305
  'selectedCell',
@@ -35,6 +35,8 @@ export type BryntumGridChartDesignerProps = {
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/GridChartDesigner#config-appendTo)
38
40
  */
39
41
  appendTo? : HTMLElement|string
40
42
  /**
@@ -68,9 +70,10 @@ export type BryntumGridChartDesignerProps = {
68
70
  catchEventHandlerExceptions? : boolean
69
71
  /**
70
72
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
71
- * Set to `true` to centre the Widget in browser viewport space.
73
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-centered)
74
+ * @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.
72
75
  */
73
- centered? : boolean
76
+ centered? : boolean|object
74
77
  /**
75
78
  * Custom CSS classes to add to element.
76
79
  * May be specified as a space separated string, or as an object in which property names
@@ -144,7 +147,7 @@ export type BryntumGridChartDesignerProps = {
144
147
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
145
148
  /**
146
149
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
147
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
150
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
148
151
  * property which controls when a drag should start.
149
152
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-draggable)
150
153
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -212,10 +215,14 @@ export type BryntumGridChartDesignerProps = {
212
215
  ignoreParentReadOnly? : boolean
213
216
  /**
214
217
  * 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.
218
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
219
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
215
220
  */
216
221
  insertBefore? : HTMLElement|string
217
222
  /**
218
223
  * 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.
224
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
225
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
219
226
  */
220
227
  insertFirst? : HTMLElement|string
221
228
  /**
@@ -353,7 +360,7 @@ export type BryntumGridChartDesignerProps = {
353
360
  scrollable? : boolean|ScrollerConfig|Scroller
354
361
  /**
355
362
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
356
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
363
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
357
364
  */
358
365
  scrollAction? : 'hide'|'realign'|null
359
366
  /**
@@ -552,7 +559,6 @@ export class BryntumGridChartDesigner extends React.Component<BryntumGridChartDe
552
559
  'ariaDescription',
553
560
  'ariaLabel',
554
561
  'bubbleEvents',
555
- 'centered',
556
562
  'color',
557
563
  'config',
558
564
  'constrainTo',
@@ -599,6 +605,7 @@ export class BryntumGridChartDesigner extends React.Component<BryntumGridChartDe
599
605
  'appendTo',
600
606
  'callOnFunctions',
601
607
  'catchEventHandlerExceptions',
608
+ 'centered',
602
609
  'cls',
603
610
  'column',
604
611
  'content',
@@ -42,6 +42,8 @@ export type BryntumGridFieldFilterPickerProps = {
42
42
  /**
43
43
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
44
44
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
45
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
46
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
45
47
  */
46
48
  appendTo? : HTMLElement|string
47
49
  /**
@@ -83,9 +85,10 @@ export type BryntumGridFieldFilterPickerProps = {
83
85
  catchEventHandlerExceptions? : boolean
84
86
  /**
85
87
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
86
- * Set to `true` to centre the Widget in browser viewport space.
88
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-centered)
89
+ * @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.
87
90
  */
88
- centered? : boolean
91
+ centered? : boolean|object
89
92
  /**
90
93
  * Custom CSS classes to add to element.
91
94
  * May be specified as a space separated string, or as an object in which property names
@@ -174,7 +177,7 @@ export type BryntumGridFieldFilterPickerProps = {
174
177
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
175
178
  /**
176
179
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
177
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
180
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
178
181
  * property which controls when a drag should start.
179
182
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-draggable)
180
183
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -278,10 +281,14 @@ export type BryntumGridFieldFilterPickerProps = {
278
281
  inputFieldAlign? : 'start'|'end'
279
282
  /**
280
283
  * 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.
284
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
285
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
281
286
  */
282
287
  insertBefore? : HTMLElement|string
283
288
  /**
284
289
  * 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.
290
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
291
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
285
292
  */
286
293
  insertFirst? : HTMLElement|string
287
294
  /**
@@ -307,7 +314,7 @@ export type BryntumGridFieldFilterPickerProps = {
307
314
  */
308
315
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
309
316
  /**
310
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
317
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
311
318
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-labelWidth)
312
319
  */
313
320
  labelWidth? : number|null
@@ -489,7 +496,7 @@ export type BryntumGridFieldFilterPickerProps = {
489
496
  scrollable? : boolean|ScrollerConfig|Scroller
490
497
  /**
491
498
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
492
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
499
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
493
500
  */
494
501
  scrollAction? : 'hide'|'realign'|null
495
502
  /**
@@ -740,7 +747,6 @@ export class BryntumGridFieldFilterPicker extends React.Component<BryntumGridFie
740
747
  'autoUpdateRecord',
741
748
  'border',
742
749
  'bubbleEvents',
743
- 'centered',
744
750
  'color',
745
751
  'config',
746
752
  'constrainTo',
@@ -805,6 +811,7 @@ export class BryntumGridFieldFilterPicker extends React.Component<BryntumGridFie
805
811
  'appendTo',
806
812
  'callOnFunctions',
807
813
  'catchEventHandlerExceptions',
814
+ 'centered',
808
815
  'cls',
809
816
  'column',
810
817
  'content',
@@ -45,6 +45,8 @@ export type BryntumGridFieldFilterPickerGroupProps = {
45
45
  /**
46
46
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
47
47
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
48
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
49
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
48
50
  */
49
51
  appendTo? : HTMLElement|string
50
52
  /**
@@ -102,9 +104,10 @@ export type BryntumGridFieldFilterPickerGroupProps = {
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/GridFieldFilterPickerGroup#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
  * Custom CSS classes to add to element.
110
113
  * May be specified as a space separated string, or as an object in which property names
@@ -193,7 +196,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
193
196
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
194
197
  /**
195
198
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
196
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
199
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
197
200
  * property which controls when a drag should start.
198
201
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-draggable)
199
202
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -293,10 +296,14 @@ export type BryntumGridFieldFilterPickerGroupProps = {
293
296
  inputFieldAlign? : 'start'|'end'
294
297
  /**
295
298
  * 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.
299
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
300
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
296
301
  */
297
302
  insertBefore? : HTMLElement|string
298
303
  /**
299
304
  * 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.
305
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
306
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
300
307
  */
301
308
  insertFirst? : HTMLElement|string
302
309
  /**
@@ -322,7 +329,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
322
329
  */
323
330
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
324
331
  /**
325
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
332
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
326
333
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-labelWidth)
327
334
  */
328
335
  labelWidth? : number|null
@@ -499,7 +506,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
499
506
  scrollable? : boolean|ScrollerConfig|Scroller
500
507
  /**
501
508
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
502
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
509
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
503
510
  */
504
511
  scrollAction? : 'hide'|'realign'|null
505
512
  /**
@@ -757,7 +764,6 @@ export class BryntumGridFieldFilterPickerGroup extends React.Component<BryntumGr
757
764
  'bubbleEvents',
758
765
  'canDeleteFilter',
759
766
  'canManageFilter',
760
- 'centered',
761
767
  'color',
762
768
  'config',
763
769
  'constrainTo',
@@ -818,6 +824,7 @@ export class BryntumGridFieldFilterPickerGroup extends React.Component<BryntumGr
818
824
  'appendTo',
819
825
  'callOnFunctions',
820
826
  'catchEventHandlerExceptions',
827
+ 'centered',
821
828
  'cls',
822
829
  'column',
823
830
  'content',
@@ -45,6 +45,8 @@ export type BryntumGroupBarProps = {
45
45
  /**
46
46
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
47
47
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
48
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
49
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
48
50
  */
49
51
  appendTo? : HTMLElement|string
50
52
  /**
@@ -78,9 +80,10 @@ export type BryntumGroupBarProps = {
78
80
  catchEventHandlerExceptions? : boolean
79
81
  /**
80
82
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
81
- * Set to `true` to centre the Widget in browser viewport space.
83
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-centered)
84
+ * @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.
82
85
  */
83
- centered? : boolean
86
+ centered? : boolean|object
84
87
  /**
85
88
  * Configure as `true` to clear selection when clicking on empty space inside the List´s element.
86
89
  */
@@ -94,9 +97,11 @@ export type BryntumGroupBarProps = {
94
97
  /**
95
98
  * 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"
96
99
  * action means. If not provided, the record representing the chip is removed from the store.
100
+ * @param {Core.data.Model[]} records Records to be closed
101
+ * @param {object} options Close options
97
102
  * @returns {void}
98
103
  */
99
- closeHandler? : string|(() => void)
104
+ closeHandler? : string|((records: Model[], options: object) => void)
100
105
  /**
101
106
  * Custom CSS classes to add to element.
102
107
  * May be specified as a space separated string, or as an object in which property names
@@ -178,7 +183,7 @@ export type BryntumGroupBarProps = {
178
183
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
179
184
  /**
180
185
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
181
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
186
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
182
187
  * property which controls when a drag should start.
183
188
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-draggable)
184
189
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -273,10 +278,14 @@ export type BryntumGroupBarProps = {
273
278
  ignoreParentReadOnly? : boolean
274
279
  /**
275
280
  * 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.
281
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
282
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
276
283
  */
277
284
  insertBefore? : HTMLElement|string
278
285
  /**
279
286
  * 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.
287
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
288
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
280
289
  */
281
290
  insertFirst? : HTMLElement|string
282
291
  /**
@@ -437,7 +446,7 @@ export type BryntumGroupBarProps = {
437
446
  scrollable? : boolean|ScrollerConfig|Scroller
438
447
  /**
439
448
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
440
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
449
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
441
450
  */
442
451
  scrollAction? : 'hide'|'realign'|null
443
452
  /**
@@ -710,7 +719,6 @@ export class BryntumGroupBar extends React.Component<BryntumGroupBarProps> {
710
719
  'ariaDescription',
711
720
  'ariaLabel',
712
721
  'bubbleEvents',
713
- 'centered',
714
722
  'closable',
715
723
  'closeHandler',
716
724
  'color',
@@ -767,6 +775,7 @@ export class BryntumGroupBar extends React.Component<BryntumGroupBarProps> {
767
775
  'appendTo',
768
776
  'callOnFunctions',
769
777
  'catchEventHandlerExceptions',
778
+ 'centered',
770
779
  'clearSelectionOnEmptySpaceClick',
771
780
  'cls',
772
781
  'collapsibleGroups',
@@ -35,6 +35,8 @@ export type BryntumTreeComboProps = {
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/TreeCombo#config-appendTo)
38
40
  */
39
41
  appendTo? : HTMLElement|string
40
42
  /**
@@ -94,9 +96,10 @@ export type BryntumTreeComboProps = {
94
96
  catchEventHandlerExceptions? : boolean
95
97
  /**
96
98
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
97
- * Set to `true` to centre the Widget in browser viewport space.
99
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-centered)
100
+ * @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.
98
101
  */
99
- centered? : boolean
102
+ centered? : boolean|object
100
103
  /**
101
104
  * A function (or the name of a function in the ownership hierarchy) called during field validation
102
105
  * 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)
@@ -232,7 +235,7 @@ export type BryntumTreeComboProps = {
232
235
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
233
236
  /**
234
237
  * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
235
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
238
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
236
239
  * property which controls when a drag should start.
237
240
  * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-draggable)
238
241
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -399,10 +402,14 @@ export type BryntumTreeComboProps = {
399
402
  inputWidth? : string|number
400
403
  /**
401
404
  * 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.
405
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
406
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
402
407
  */
403
408
  insertBefore? : HTMLElement|string
404
409
  /**
405
410
  * 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.
411
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
412
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
406
413
  */
407
414
  insertFirst? : HTMLElement|string
408
415
  /**
@@ -663,7 +670,7 @@ export type BryntumTreeComboProps = {
663
670
  rtl? : boolean
664
671
  /**
665
672
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
666
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
673
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
667
674
  */
668
675
  scrollAction? : 'hide'|'realign'|null
669
676
  /**
@@ -969,7 +976,6 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
969
976
  'bubbleEvents',
970
977
  'cacheLastResult',
971
978
  'caseSensitive',
972
- 'centered',
973
979
  'checkValidity',
974
980
  'chipView',
975
981
  'clearable',
@@ -1067,6 +1073,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
1067
1073
  'badge',
1068
1074
  'callOnFunctions',
1069
1075
  'catchEventHandlerExceptions',
1076
+ 'centered',
1070
1077
  'cls',
1071
1078
  'column',
1072
1079
  'dataset',