@bryntum/grid-react-thin 7.2.4 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/lib/BryntumAIFilterField.d.ts +7 -15
- package/lib/BryntumAIFilterField.js +1 -2
- package/lib/BryntumAIFilterField.js.map +1 -1
- package/lib/BryntumChecklistFilterCombo.d.ts +10 -18
- package/lib/BryntumChecklistFilterCombo.js +1 -2
- package/lib/BryntumChecklistFilterCombo.js.map +1 -1
- package/lib/BryntumGrid.d.ts +22 -33
- package/lib/BryntumGrid.js +2 -2
- package/lib/BryntumGrid.js.map +1 -1
- package/lib/BryntumGridBase.d.ts +22 -33
- package/lib/BryntumGridBase.js +2 -2
- package/lib/BryntumGridBase.js.map +1 -1
- package/lib/BryntumGridChartDesigner.d.ts +6 -14
- package/lib/BryntumGridChartDesigner.js +1 -2
- package/lib/BryntumGridChartDesigner.js.map +1 -1
- package/lib/BryntumGridFieldFilterPicker.d.ts +7 -14
- package/lib/BryntumGridFieldFilterPicker.js +2 -5
- package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
- package/lib/BryntumGridFieldFilterPickerGroup.d.ts +7 -14
- package/lib/BryntumGridFieldFilterPickerGroup.js +2 -5
- package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
- package/lib/BryntumGroupBar.d.ts +6 -14
- package/lib/BryntumGroupBar.js +1 -2
- package/lib/BryntumGroupBar.js.map +1 -1
- package/lib/BryntumTreeCombo.d.ts +10 -18
- package/lib/BryntumTreeCombo.js +1 -2
- package/lib/BryntumTreeCombo.js.map +1 -1
- package/lib/BryntumTreeGrid.d.ts +22 -33
- package/lib/BryntumTreeGrid.js +2 -2
- package/lib/BryntumTreeGrid.js.map +1 -1
- package/lib/WrapperHelper.js +2 -2
- package/lib/WrapperHelper.js.map +1 -1
- package/package.json +1 -1
- package/src/BryntumAIFilterField.tsx +74 -119
- package/src/BryntumChecklistFilterCombo.tsx +91 -150
- package/src/BryntumGrid.tsx +204 -291
- package/src/BryntumGridBase.tsx +204 -291
- package/src/BryntumGridChartDesigner.tsx +59 -95
- package/src/BryntumGridFieldFilterPicker.tsx +82 -132
- package/src/BryntumGridFieldFilterPickerGroup.tsx +81 -130
- package/src/BryntumGroupBar.tsx +65 -105
- package/src/BryntumTreeCombo.tsx +92 -152
- package/src/BryntumTreeGrid.tsx +204 -291
- package/src/WrapperHelper.tsx +2 -2
package/src/BryntumGroupBar.tsx
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
5
5
|
import React, { RefObject } from 'react';
|
|
6
|
-
import { AlignSpec, Base, Collection, CollectionConfig, Color, DomConfig, KeyMapConfig, List, MaskConfig, Model, ModelConfig, Rectangle, Scroller, ScrollerConfig, Store, StoreConfig, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
6
|
+
import { AlignSpec, Base, Collection, CollectionConfig, Color, DomConfig, KeyMapConfig, List, MaskConfig, Model, ModelConfig, ReactJSX, Rectangle, Scroller, ScrollerConfig, Store, StoreConfig, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
7
7
|
import { GroupBar, GroupBarListeners } from '@bryntum/grid-thin';
|
|
8
8
|
|
|
9
9
|
import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
|
|
@@ -18,14 +18,12 @@ export type BryntumGroupBarProps = {
|
|
|
18
18
|
/**
|
|
19
19
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
20
20
|
* content will be placed inside this element.
|
|
21
|
-
* ...
|
|
22
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-adopt)
|
|
21
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-adopt)
|
|
23
22
|
*/
|
|
24
23
|
adopt? : HTMLElement|string
|
|
25
24
|
/**
|
|
26
25
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
27
|
-
* ...
|
|
28
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-align)
|
|
26
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-align)
|
|
29
27
|
*/
|
|
30
28
|
align? : AlignSpec|string
|
|
31
29
|
/**
|
|
@@ -52,35 +50,30 @@ export type BryntumGroupBarProps = {
|
|
|
52
50
|
/**
|
|
53
51
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
54
52
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
55
|
-
* ...
|
|
56
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ariaDescription)
|
|
53
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ariaDescription)
|
|
57
54
|
*/
|
|
58
55
|
ariaDescription? : string
|
|
59
56
|
/**
|
|
60
57
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
61
58
|
* the `aria-label` attribute.
|
|
62
|
-
* ...
|
|
63
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ariaLabel)
|
|
59
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ariaLabel)
|
|
64
60
|
*/
|
|
65
61
|
ariaLabel? : string
|
|
66
62
|
/**
|
|
67
63
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
68
64
|
* hierarchy when triggered.
|
|
69
|
-
* ...
|
|
70
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-bubbleEvents)
|
|
65
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-bubbleEvents)
|
|
71
66
|
*/
|
|
72
67
|
bubbleEvents? : object
|
|
73
68
|
/**
|
|
74
69
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
75
|
-
* ...
|
|
76
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-callOnFunctions)
|
|
70
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-callOnFunctions)
|
|
77
71
|
*/
|
|
78
72
|
callOnFunctions? : boolean
|
|
79
73
|
/**
|
|
80
74
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
81
75
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
82
|
-
* ...
|
|
83
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-catchEventHandlerExceptions)
|
|
76
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-catchEventHandlerExceptions)
|
|
84
77
|
*/
|
|
85
78
|
catchEventHandlerExceptions? : boolean
|
|
86
79
|
/**
|
|
@@ -93,10 +86,9 @@ export type BryntumGroupBarProps = {
|
|
|
93
86
|
*/
|
|
94
87
|
clearSelectionOnEmptySpaceClick? : boolean
|
|
95
88
|
/**
|
|
96
|
-
* Configure as `true` to display a clickable close icon after the [itemTpl](https://bryntum.com/products/grid/docs/api/Core/widget/
|
|
89
|
+
* Configure as `true` to display a clickable close icon after the [itemTpl](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-itemTpl).
|
|
97
90
|
* When tapped, the configured [closeHandler](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closeHandler) is called passing the associated record.
|
|
98
|
-
* ...
|
|
99
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-closable)
|
|
91
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-closable)
|
|
100
92
|
*/
|
|
101
93
|
closable? : boolean
|
|
102
94
|
/**
|
|
@@ -109,8 +101,7 @@ export type BryntumGroupBarProps = {
|
|
|
109
101
|
* Custom CSS classes to add to element.
|
|
110
102
|
* May be specified as a space separated string, or as an object in which property names
|
|
111
103
|
* with truthy values are used as the class names:
|
|
112
|
-
* ...
|
|
113
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-cls)
|
|
104
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-cls)
|
|
114
105
|
*/
|
|
115
106
|
cls? : string|object
|
|
116
107
|
/**
|
|
@@ -120,8 +111,7 @@ export type BryntumGroupBarProps = {
|
|
|
120
111
|
/**
|
|
121
112
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
122
113
|
* `style` block.
|
|
123
|
-
* ...
|
|
124
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-color)
|
|
114
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-color)
|
|
125
115
|
*/
|
|
126
116
|
color? : Color
|
|
127
117
|
/**
|
|
@@ -145,8 +135,7 @@ export type BryntumGroupBarProps = {
|
|
|
145
135
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
|
|
146
136
|
* May be specified as a space separated string, or as an object in which property names
|
|
147
137
|
* with truthy values are used as the class names:
|
|
148
|
-
* ...
|
|
149
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-contentElementCls)
|
|
138
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-contentElementCls)
|
|
150
139
|
*/
|
|
151
140
|
contentElementCls? : string|object
|
|
152
141
|
/**
|
|
@@ -164,16 +153,15 @@ export type BryntumGroupBarProps = {
|
|
|
164
153
|
*/
|
|
165
154
|
defaultBindProperty? : string
|
|
166
155
|
/**
|
|
167
|
-
* Check for CSS compatibility issues
|
|
168
|
-
*
|
|
169
|
-
* [
|
|
156
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
157
|
+
* checks:
|
|
158
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-detectCSSCompatibilityIssues)
|
|
170
159
|
*/
|
|
171
160
|
detectCSSCompatibilityIssues? : boolean
|
|
172
161
|
/**
|
|
173
162
|
* 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
|
|
174
163
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
175
|
-
* ...
|
|
176
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-disabled)
|
|
164
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-disabled)
|
|
177
165
|
*/
|
|
178
166
|
disabled? : boolean|'inert'
|
|
179
167
|
/**
|
|
@@ -185,25 +173,21 @@ export type BryntumGroupBarProps = {
|
|
|
185
173
|
* [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
186
174
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
187
175
|
* body. Such widgets are called "edge strips".
|
|
188
|
-
* ...
|
|
189
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-dock)
|
|
176
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-dock)
|
|
190
177
|
*/
|
|
191
178
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
192
179
|
/**
|
|
193
180
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
194
181
|
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
195
182
|
* property which controls when a drag should start.
|
|
196
|
-
* ...
|
|
197
|
-
*
|
|
183
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-draggable)
|
|
184
|
+
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
198
185
|
*/
|
|
199
|
-
draggable? : boolean|
|
|
200
|
-
handleSelector?: string
|
|
201
|
-
}
|
|
186
|
+
draggable? : boolean|object
|
|
202
187
|
/**
|
|
203
188
|
* An object specifying attributes to assign to the root element of this widget.
|
|
204
189
|
* Set `null` value to attribute to remove it.
|
|
205
|
-
* ...
|
|
206
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-elementAttributes)
|
|
190
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-elementAttributes)
|
|
207
191
|
*/
|
|
208
192
|
elementAttributes? : Record<string, string|null>
|
|
209
193
|
/**
|
|
@@ -258,25 +242,22 @@ export type BryntumGroupBarProps = {
|
|
|
258
242
|
hidden? : boolean
|
|
259
243
|
/**
|
|
260
244
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
261
|
-
* ...
|
|
262
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-hideAnimation)
|
|
245
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-hideAnimation)
|
|
263
246
|
*/
|
|
264
247
|
hideAnimation? : boolean|object
|
|
265
248
|
/**
|
|
266
249
|
* The HTML to display initially or a function returning the markup (called at widget construction time).
|
|
267
|
-
* ...
|
|
268
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-html)
|
|
250
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-html)
|
|
269
251
|
* @param {Core.widget.Widget} widget The calling Widget
|
|
270
|
-
* @returns {string}
|
|
271
252
|
*/
|
|
272
|
-
html? : string|((widget: Widget) =>
|
|
253
|
+
html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
|
|
273
254
|
/**
|
|
274
255
|
* The CSS class(es) to add when HTML content is being applied to this widget.
|
|
275
256
|
*/
|
|
276
257
|
htmlCls? : string|object
|
|
277
258
|
/**
|
|
278
259
|
* A template function, which, when passed a record, returns the markup which encapsulates a chip's icon to be
|
|
279
|
-
* placed before the [itemTpl](https://bryntum.com/products/grid/docs/api/Core/widget/
|
|
260
|
+
* placed before the [itemTpl](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-itemTpl).
|
|
280
261
|
* @param {Core.data.Model} record The record to provide an icon for
|
|
281
262
|
* @returns {DomConfig,string,void}
|
|
282
263
|
*/
|
|
@@ -287,8 +268,7 @@ export type BryntumGroupBarProps = {
|
|
|
287
268
|
id? : string
|
|
288
269
|
/**
|
|
289
270
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
290
|
-
* ...
|
|
291
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ignoreParentReadOnly)
|
|
271
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ignoreParentReadOnly)
|
|
292
272
|
*/
|
|
293
273
|
ignoreParentReadOnly? : boolean
|
|
294
274
|
/**
|
|
@@ -322,22 +302,19 @@ export type BryntumGroupBarProps = {
|
|
|
322
302
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
323
303
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
324
304
|
* are the name of the instance method to call when the keystroke is received.
|
|
325
|
-
* ...
|
|
326
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-keyMap)
|
|
305
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-keyMap)
|
|
327
306
|
*/
|
|
328
307
|
keyMap? : Record<string, KeyMapConfig>
|
|
329
308
|
/**
|
|
330
309
|
* The listener set for this object.
|
|
331
|
-
* ...
|
|
332
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-listeners)
|
|
310
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-listeners)
|
|
333
311
|
*/
|
|
334
312
|
listeners? : GroupBarListeners
|
|
335
313
|
/**
|
|
336
314
|
* A class translations of which are used for translating this entity.
|
|
337
315
|
* This is often used when translations of an item are defined on its container class.
|
|
338
316
|
* For example:
|
|
339
|
-
* ...
|
|
340
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-localeClass)
|
|
317
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-localeClass)
|
|
341
318
|
*/
|
|
342
319
|
localeClass? : typeof Base
|
|
343
320
|
/**
|
|
@@ -349,8 +326,7 @@ export type BryntumGroupBarProps = {
|
|
|
349
326
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
350
327
|
* you could use 'localeKey' meta configuration.
|
|
351
328
|
* Example:
|
|
352
|
-
* ...
|
|
353
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-localizableProperties)
|
|
329
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-localizableProperties)
|
|
354
330
|
*/
|
|
355
331
|
localizableProperties? : string[]
|
|
356
332
|
/**
|
|
@@ -376,8 +352,7 @@ export type BryntumGroupBarProps = {
|
|
|
376
352
|
maxHeight? : string|number
|
|
377
353
|
/**
|
|
378
354
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
379
|
-
* ...
|
|
380
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-maximizeOnMobile)
|
|
355
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-maximizeOnMobile)
|
|
381
356
|
*/
|
|
382
357
|
maximizeOnMobile? : number|string
|
|
383
358
|
/**
|
|
@@ -399,12 +374,10 @@ export type BryntumGroupBarProps = {
|
|
|
399
374
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
400
375
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
401
376
|
* layout.
|
|
402
|
-
* ...
|
|
403
|
-
*
|
|
377
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-monitorResize)
|
|
378
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
404
379
|
*/
|
|
405
|
-
monitorResize? : boolean|
|
|
406
|
-
immediate?: boolean
|
|
407
|
-
}
|
|
380
|
+
monitorResize? : boolean|object
|
|
408
381
|
/**
|
|
409
382
|
* Configure as `true` to allow multi select and allow clicking and key navigation to select multiple chips.
|
|
410
383
|
*/
|
|
@@ -413,8 +386,7 @@ export type BryntumGroupBarProps = {
|
|
|
413
386
|
* 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
|
|
414
387
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
415
388
|
* widget's [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
|
|
416
|
-
* ...
|
|
417
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-positioned)
|
|
389
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-positioned)
|
|
418
390
|
*/
|
|
419
391
|
positioned? : boolean
|
|
420
392
|
/**
|
|
@@ -425,8 +397,7 @@ export type BryntumGroupBarProps = {
|
|
|
425
397
|
/**
|
|
426
398
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
427
399
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
428
|
-
* ...
|
|
429
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-readOnly)
|
|
400
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-readOnly)
|
|
430
401
|
*/
|
|
431
402
|
readOnly? : boolean
|
|
432
403
|
relayStoreEvents? : boolean
|
|
@@ -434,23 +405,26 @@ export type BryntumGroupBarProps = {
|
|
|
434
405
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
435
406
|
* [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
|
|
436
407
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
437
|
-
* ...
|
|
438
|
-
* [
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
408
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ripple)
|
|
409
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
410
|
+
* @property {string} [color] A CSS color name or specification.
|
|
411
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
412
|
+
* @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.
|
|
413
|
+
*/
|
|
414
|
+
ripple? : boolean|object
|
|
415
|
+
/**
|
|
416
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
417
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
418
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-role)
|
|
419
|
+
*/
|
|
420
|
+
role? : string
|
|
446
421
|
/**
|
|
447
422
|
* 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`
|
|
448
423
|
*/
|
|
449
424
|
rootElement? : ShadowRoot|HTMLElement
|
|
450
425
|
/**
|
|
451
426
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
452
|
-
* ...
|
|
453
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-rtl)
|
|
427
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-rtl)
|
|
454
428
|
*/
|
|
455
429
|
rtl? : boolean
|
|
456
430
|
/**
|
|
@@ -458,8 +432,7 @@ export type BryntumGroupBarProps = {
|
|
|
458
432
|
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
459
433
|
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
460
434
|
* CSS overflow properties thus:
|
|
461
|
-
* ...
|
|
462
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-scrollable)
|
|
435
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-scrollable)
|
|
463
436
|
*/
|
|
464
437
|
scrollable? : boolean|ScrollerConfig|Scroller
|
|
465
438
|
/**
|
|
@@ -475,14 +448,12 @@ export type BryntumGroupBarProps = {
|
|
|
475
448
|
/**
|
|
476
449
|
* A [Collection](https://bryntum.com/products/grid/docs/api/Core/util/Collection), or Collection config object to use to contain this List's selected
|
|
477
450
|
* records.
|
|
478
|
-
* ...
|
|
479
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-selected)
|
|
451
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-selected)
|
|
480
452
|
*/
|
|
481
453
|
selected? : object[]|number[]|string[]|Collection|CollectionConfig|CollectionConfig[]
|
|
482
454
|
/**
|
|
483
455
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-floating).*
|
|
484
|
-
* ...
|
|
485
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-showAnimation)
|
|
456
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-showAnimation)
|
|
486
457
|
*/
|
|
487
458
|
showAnimation? : boolean|object
|
|
488
459
|
/**
|
|
@@ -496,16 +467,14 @@ export type BryntumGroupBarProps = {
|
|
|
496
467
|
/**
|
|
497
468
|
* A [Store](https://bryntum.com/products/grid/docs/api/Core/data/Store) which provides the records which map to List items. Each record is passed through the
|
|
498
469
|
* [itemTpl](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-itemTpl) to produce the DOM structure of the List. May be generated from an array of [items](#Core/widget/List#config-items).
|
|
499
|
-
* ...
|
|
500
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-store)
|
|
470
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-store)
|
|
501
471
|
*/
|
|
502
472
|
store? : object|object[]|StoreConfig|Store|StoreConfig[]
|
|
503
473
|
/**
|
|
504
474
|
* 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
|
|
505
475
|
* [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
|
|
506
476
|
* this widget:
|
|
507
|
-
* ...
|
|
508
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-tab)
|
|
477
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-tab)
|
|
509
478
|
*/
|
|
510
479
|
tab? : boolean|TabConfig
|
|
511
480
|
/**
|
|
@@ -514,8 +483,7 @@ export type BryntumGroupBarProps = {
|
|
|
514
483
|
tag? : string
|
|
515
484
|
/**
|
|
516
485
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
517
|
-
* ...
|
|
518
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-textAlign)
|
|
486
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-textAlign)
|
|
519
487
|
*/
|
|
520
488
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
521
489
|
/**
|
|
@@ -528,8 +496,7 @@ export type BryntumGroupBarProps = {
|
|
|
528
496
|
toggleAllIfCtrlPressed? : boolean
|
|
529
497
|
/**
|
|
530
498
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
531
|
-
* ...
|
|
532
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-tooltip)
|
|
499
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-tooltip)
|
|
533
500
|
*/
|
|
534
501
|
tooltip? : string|TooltipConfig|null
|
|
535
502
|
/**
|
|
@@ -543,16 +510,14 @@ export type BryntumGroupBarProps = {
|
|
|
543
510
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
544
511
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
545
512
|
* values are used as the class names.
|
|
546
|
-
* ...
|
|
547
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ui)
|
|
513
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-ui)
|
|
548
514
|
*/
|
|
549
515
|
ui? : string|object
|
|
550
516
|
/**
|
|
551
517
|
* Controls virtualization of list items using the `IntersectionObserver` API to render items only when
|
|
552
518
|
* scrolled into view. This is only useful for lists with complex markup, for simple lists it likely adds
|
|
553
519
|
* overhead.
|
|
554
|
-
* ...
|
|
555
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-virtualize)
|
|
520
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-virtualize)
|
|
556
521
|
*/
|
|
557
522
|
virtualize? : boolean|number
|
|
558
523
|
/**
|
|
@@ -568,14 +533,12 @@ export type BryntumGroupBarProps = {
|
|
|
568
533
|
width? : string|number
|
|
569
534
|
/**
|
|
570
535
|
* The x position for the widget.
|
|
571
|
-
* ...
|
|
572
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-x)
|
|
536
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-x)
|
|
573
537
|
*/
|
|
574
538
|
x? : number
|
|
575
539
|
/**
|
|
576
540
|
* The y position for the widget.
|
|
577
|
-
* ...
|
|
578
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-y)
|
|
541
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-y)
|
|
579
542
|
*/
|
|
580
543
|
y? : number
|
|
581
544
|
|
|
@@ -612,8 +575,7 @@ export type BryntumGroupBarProps = {
|
|
|
612
575
|
onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
|
|
613
576
|
/**
|
|
614
577
|
* Fires when any other event is fired from the object.
|
|
615
|
-
* ...
|
|
616
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#event-catchAll)
|
|
578
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#event-catchAll)
|
|
617
579
|
* @param {object} event Event object
|
|
618
580
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
619
581
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -675,8 +637,7 @@ export type BryntumGroupBarProps = {
|
|
|
675
637
|
/**
|
|
676
638
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
677
639
|
* achieves visibility.
|
|
678
|
-
* ...
|
|
679
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#event-paint)
|
|
640
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#event-paint)
|
|
680
641
|
* @param {object} event Event object
|
|
681
642
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
682
643
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -784,6 +745,7 @@ export class BryntumGroupBar extends React.Component<BryntumGroupBarProps> {
|
|
|
784
745
|
'preventTooltipOnTouch',
|
|
785
746
|
'relayStoreEvents',
|
|
786
747
|
'ripple',
|
|
748
|
+
'role',
|
|
787
749
|
'rootElement',
|
|
788
750
|
'scrollAction',
|
|
789
751
|
'selectAllItem',
|
|
@@ -864,8 +826,6 @@ export class BryntumGroupBar extends React.Component<BryntumGroupBarProps> {
|
|
|
864
826
|
];
|
|
865
827
|
|
|
866
828
|
static propertyNames = [
|
|
867
|
-
'anchorSize',
|
|
868
|
-
'focusVisible',
|
|
869
829
|
'parent'
|
|
870
830
|
];
|
|
871
831
|
|