@bryntum/grid-react-thin 7.2.4 → 7.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +4 -4
  2. package/lib/BryntumAIFilterField.d.ts +7 -15
  3. package/lib/BryntumAIFilterField.js +1 -2
  4. package/lib/BryntumAIFilterField.js.map +1 -1
  5. package/lib/BryntumChecklistFilterCombo.d.ts +10 -18
  6. package/lib/BryntumChecklistFilterCombo.js +1 -2
  7. package/lib/BryntumChecklistFilterCombo.js.map +1 -1
  8. package/lib/BryntumGrid.d.ts +22 -33
  9. package/lib/BryntumGrid.js +2 -2
  10. package/lib/BryntumGrid.js.map +1 -1
  11. package/lib/BryntumGridBase.d.ts +22 -33
  12. package/lib/BryntumGridBase.js +2 -2
  13. package/lib/BryntumGridBase.js.map +1 -1
  14. package/lib/BryntumGridChartDesigner.d.ts +6 -14
  15. package/lib/BryntumGridChartDesigner.js +1 -2
  16. package/lib/BryntumGridChartDesigner.js.map +1 -1
  17. package/lib/BryntumGridFieldFilterPicker.d.ts +7 -14
  18. package/lib/BryntumGridFieldFilterPicker.js +2 -5
  19. package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
  20. package/lib/BryntumGridFieldFilterPickerGroup.d.ts +7 -14
  21. package/lib/BryntumGridFieldFilterPickerGroup.js +2 -5
  22. package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
  23. package/lib/BryntumGroupBar.d.ts +6 -14
  24. package/lib/BryntumGroupBar.js +1 -2
  25. package/lib/BryntumGroupBar.js.map +1 -1
  26. package/lib/BryntumTreeCombo.d.ts +10 -18
  27. package/lib/BryntumTreeCombo.js +1 -2
  28. package/lib/BryntumTreeCombo.js.map +1 -1
  29. package/lib/BryntumTreeGrid.d.ts +22 -33
  30. package/lib/BryntumTreeGrid.js +2 -2
  31. package/lib/BryntumTreeGrid.js.map +1 -1
  32. package/lib/WrapperHelper.js +2 -2
  33. package/lib/WrapperHelper.js.map +1 -1
  34. package/package.json +1 -1
  35. package/src/BryntumAIFilterField.tsx +74 -119
  36. package/src/BryntumChecklistFilterCombo.tsx +91 -150
  37. package/src/BryntumGrid.tsx +204 -291
  38. package/src/BryntumGridBase.tsx +204 -291
  39. package/src/BryntumGridChartDesigner.tsx +59 -95
  40. package/src/BryntumGridFieldFilterPicker.tsx +82 -132
  41. package/src/BryntumGridFieldFilterPickerGroup.tsx +81 -130
  42. package/src/BryntumGroupBar.tsx +65 -105
  43. package/src/BryntumTreeCombo.tsx +92 -152
  44. package/src/BryntumTreeGrid.tsx +204 -291
  45. package/src/WrapperHelper.tsx +2 -2
@@ -3,7 +3,7 @@
3
3
  */
4
4
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
5
5
  import React, { RefObject } from 'react';
6
- import { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomConfig, FormulaProviderConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
6
+ import { AjaxStore, AjaxStoreConfig, Base, Color, Container, DomConfig, FormulaProviderConfig, InstancePlugin, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, StateProvider, Store, StoreConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Widget } from '@bryntum/core-thin';
7
7
  import { AI, AIConfig, AIFilter, AIFilterConfig, CellCopyPaste, CellCopyPasteConfig, CellEdit, CellEditConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, GridContainerItemConfig, EmptyTextDomConfig, ExcelExporter, ExcelExporterConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, Grid, GridBase, GridBaseListeners, GridColumnConfig, GridLocation, GridLocationConfig, GridSelectionMode, GridStateInfo, Group, GroupConfig, GroupSummary, GroupSummaryConfig, HeaderMenu, HeaderMenuConfig, LockRows, LockRowsConfig, MergeCells, MergeCellsConfig, PdfExport, PdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, Print, PrintConfig, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, RowReorder, RowReorderConfig, RowResize, RowResizeConfig, Search, SearchConfig, Sort, SortConfig, Split, SplitConfig, StickyCells, StickyCellsConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, Summary, SummaryConfig, Tree, TreeConfig, TreeGroup, TreeGroupConfig, XLSColumn } from '@bryntum/grid-thin';
8
8
 
9
9
  import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
@@ -13,8 +13,7 @@ export type BryntumGridBaseProps = {
13
13
  /**
14
14
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
15
15
  * content will be placed inside this element.
16
- * ...
17
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-adopt)
16
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-adopt)
18
17
  */
19
18
  adopt? : HTMLElement|string
20
19
  /**
@@ -49,15 +48,13 @@ export type BryntumGridBaseProps = {
49
48
  /**
50
49
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
51
50
  * into an element which will be linked using the `aria-describedby` attribute.
52
- * ...
53
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaDescription)
51
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaDescription)
54
52
  */
55
53
  ariaDescription? : string
56
54
  /**
57
55
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
58
56
  * the `aria-label` attribute.
59
- * ...
60
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaLabel)
57
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaLabel)
61
58
  */
62
59
  ariaLabel? : string
63
60
  /**
@@ -69,14 +66,12 @@ export type BryntumGridBaseProps = {
69
66
  /**
70
67
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
71
68
  * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips).
72
- * ...
73
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bbar)
69
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bbar)
74
70
  */
75
71
  bbar? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
76
72
  /**
77
73
  * Custom CSS classes to add to the panel's body element.
78
- * ...
79
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bodyCls)
74
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bodyCls)
80
75
  */
81
76
  bodyCls? : string|object
82
77
  /**
@@ -86,21 +81,18 @@ export type BryntumGridBaseProps = {
86
81
  /**
87
82
  * An object where property names with a truthy value indicate which events should bubble up the ownership
88
83
  * hierarchy when triggered.
89
- * ...
90
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bubbleEvents)
84
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bubbleEvents)
91
85
  */
92
86
  bubbleEvents? : object
93
87
  /**
94
88
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
95
- * ...
96
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-callOnFunctions)
89
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-callOnFunctions)
97
90
  */
98
91
  callOnFunctions? : boolean
99
92
  /**
100
93
  * By default, if an event handler throws an exception, the error propagates up the stack and the
101
94
  * application state is undefined. Code which follows the event handler will *not* be executed.
102
- * ...
103
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-catchEventHandlerExceptions)
95
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-catchEventHandlerExceptions)
104
96
  */
105
97
  catchEventHandlerExceptions? : boolean
106
98
  /**
@@ -113,8 +105,7 @@ export type BryntumGridBaseProps = {
113
105
  * Custom CSS classes to add to element.
114
106
  * May be specified as a space separated string, or as an object in which property names
115
107
  * with truthy values are used as the class names:
116
- * ...
117
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-cls)
108
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-cls)
118
109
  */
119
110
  cls? : string|object
120
111
  /**
@@ -124,15 +115,13 @@ export type BryntumGridBaseProps = {
124
115
  collapsed? : boolean
125
116
  /**
126
117
  * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsed).
127
- * ...
128
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-collapsible)
118
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-collapsible)
129
119
  */
130
120
  collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
131
121
  /**
132
122
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
133
123
  * `style` block.
134
- * ...
135
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-color)
124
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-color)
136
125
  */
137
126
  color? : Color
138
127
  /**
@@ -146,8 +135,7 @@ export type BryntumGridBaseProps = {
146
135
  /**
147
136
  * Accepts column definitions for the grid during initialization. They will be used to create
148
137
  * [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
149
- * ...
150
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-columns)
138
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-columns)
151
139
  */
152
140
  columns? : ColumnStore|GridColumnConfig[]|ColumnStoreConfig
153
141
  config? : object
@@ -155,8 +143,7 @@ export type BryntumGridBaseProps = {
155
143
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
156
144
  * May be specified as a space separated string, or as an object in which property names
157
145
  * with truthy values are used as the class names:
158
- * ...
159
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-contentElementCls)
146
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-contentElementCls)
160
147
  */
161
148
  contentElementCls? : string|object
162
149
  /**
@@ -168,8 +155,7 @@ export type BryntumGridBaseProps = {
168
155
  * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
169
156
  * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
170
157
  * the [store](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#property-store) property.
171
- * ...
172
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-data)
158
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-data)
173
159
  */
174
160
  data? : object[]|Model[]|ModelConfig[]
175
161
  /**
@@ -190,16 +176,15 @@ export type BryntumGridBaseProps = {
190
176
  */
191
177
  destroyStore? : boolean
192
178
  /**
193
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
194
- * ...
195
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-detectCSSCompatibilityIssues)
179
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
180
+ * checks:
181
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-detectCSSCompatibilityIssues)
196
182
  */
197
183
  detectCSSCompatibilityIssues? : boolean
198
184
  /**
199
185
  * 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
200
186
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
201
- * ...
202
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-disabled)
187
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-disabled)
203
188
  */
204
189
  disabled? : boolean|'inert'
205
190
  /**
@@ -219,43 +204,39 @@ export type BryntumGridBaseProps = {
219
204
  * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
220
205
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
221
206
  * body. Such widgets are called "edge strips".
222
- * ...
223
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-dock)
207
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-dock)
224
208
  */
225
209
  dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
226
210
  /**
227
211
  * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
228
- * ...
229
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-drawer)
230
- * @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
231
- * @param {string,number} size The size of the drawer in its collapsible axis.
232
- * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
233
- * @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
234
- * @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
235
- * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
236
- * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
237
- * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
238
- */
239
- drawer? : boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose: { mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number}
212
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-drawer)
213
+ * @param {'start','left','end','right','top','bottom'} [side] The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
214
+ * @param {string,number} [size] The size of the drawer in its collapsible axis.
215
+ * @param {boolean} [inline] If using the [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
216
+ * @param {boolean,object} [autoClose] Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
217
+ * @param {boolean,string} [autoClose.mousedown] If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
218
+ * @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
219
+ * @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
220
+ * @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
221
+ */
222
+ drawer? : boolean|{ side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose?: boolean|{ mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number }
240
223
  /**
241
224
  * An object specifying attributes to assign to the root element of this widget.
242
225
  * Set `null` value to attribute to remove it.
243
- * ...
244
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-elementAttributes)
226
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-elementAttributes)
245
227
  */
246
228
  elementAttributes? : Record<string, string|null>
247
229
  /**
248
230
  * Text or HTML, or a [EmptyTextDomConfig](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#typedef-EmptyTextDomConfig) block to display when there is no data to display in the grid.
249
231
  * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
250
232
  * By default, it is shown in the first region.
251
- * ...
252
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-emptyText)
233
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-emptyText)
253
234
  */
254
235
  emptyText? : string|EmptyTextDomConfig
255
236
  /**
256
- * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
257
- * ...
258
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-enableSticky)
237
+ * Set to `true` to enable the [StickyCells](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells) feature, which pins cell
238
+ * content to the top of the grid while rows scroll off the top but remain visible.
239
+ * @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
259
240
  */
260
241
  enableSticky? : boolean
261
242
  /**
@@ -279,8 +260,7 @@ export type BryntumGridBaseProps = {
279
260
  * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
280
261
  * height, which sacrifices the ability to use rows with variable height to gain a fraction better
281
262
  * performance.
282
- * ...
283
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fixedRowHeight)
263
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fixedRowHeight)
284
264
  */
285
265
  fixedRowHeight? : boolean
286
266
  /**
@@ -294,41 +274,35 @@ export type BryntumGridBaseProps = {
294
274
  /**
295
275
  * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
296
276
  * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips).
297
- * ...
298
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-footer)
277
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-footer)
278
+ * @property {'top','right','bottom','left','start','end'} dock Where to dock
279
+ * @property {string} html Html to populate the footer with
280
+ * @property {string} cls CSS class to add to the footer
299
281
  */
300
- footer? : {
301
- dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
302
- html?: string
303
- cls?: string
304
- }|string
282
+ footer? : object|string
305
283
  /**
306
284
  * An object which names formula prefixes which will be applied to all columns configured with
307
285
  * `formula : true`.
308
- * ...
309
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-formulaProviders)
286
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-formulaProviders)
310
287
  */
311
288
  formulaProviders? : Record<string, FormulaProviderConfig>
312
289
  /**
313
290
  * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
314
- * ...
315
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fullRowRefresh)
291
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fullRowRefresh)
316
292
  */
317
293
  fullRowRefresh? : boolean
318
294
  /**
319
295
  * A function called for each row to determine its height. It is passed a [record](https://bryntum.com/products/grid/docs/api/Core/data/Model) and
320
296
  * expected to return the desired height of that records row. If the function returns a falsy value, Grids
321
297
  * configured [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight) is used.
322
- * ...
323
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-getRowHeight)
298
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-getRowHeight)
324
299
  * @param {Core.data.Model} getRowHeight.record Record to determine row height for
325
300
  * @returns {number} Desired row height
326
301
  */
327
- getRowHeight? : (getRowHeight: { record: Model }) => number
302
+ getRowHeight? : () => number
328
303
  /**
329
304
  * A config [object](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
330
- * ...
331
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-header)
305
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-header)
332
306
  */
333
307
  header? : string|boolean|PanelHeader
334
308
  /**
@@ -368,16 +342,14 @@ export type BryntumGridBaseProps = {
368
342
  id? : string
369
343
  /**
370
344
  * Determines if the widgets read-only state should be controlled by its parent.
371
- * ...
372
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ignoreParentReadOnly)
345
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ignoreParentReadOnly)
373
346
  */
374
347
  ignoreParentReadOnly? : boolean
375
348
  /**
376
349
  * Convenience setting to align input fields of child widgets. By default, the Field input element is
377
350
  * placed immediately following the `label`. If you prefer to have all input fields aligned to the
378
351
  * right, set this config to `'end'`.
379
- * ...
380
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-inputFieldAlign)
352
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-inputFieldAlign)
381
353
  */
382
354
  inputFieldAlign? : 'start'|'end'
383
355
  /**
@@ -394,14 +366,17 @@ export type BryntumGridBaseProps = {
394
366
  keyMap? : Record<string, KeyMapConfig>
395
367
  /**
396
368
  * Convenience setting to use same label placement on all child widgets.
397
- * ...
398
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelPosition)
369
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelPosition)
399
370
  */
400
371
  labelPosition? : 'before'|'above'|'align-before'|'auto'|null
372
+ /**
373
+ * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
374
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelWidth)
375
+ */
376
+ labelWidth? : number|null
401
377
  /**
402
378
  * The listener set for this object.
403
- * ...
404
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-listeners)
379
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-listeners)
405
380
  */
406
381
  listeners? : GridBaseListeners
407
382
  /**
@@ -414,15 +389,13 @@ export type BryntumGridBaseProps = {
414
389
  * when data is loading. The message and optional configuration from the
415
390
  * [loadMask](https://bryntum.com/products/grid/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
416
391
  * for `maskDefaults`, respectively.
417
- * ...
418
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskDefaults)
392
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskDefaults)
419
393
  */
420
394
  loadMaskDefaults? : MaskConfig
421
395
  /**
422
396
  * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
423
397
  * when an error occurs loading data.
424
- * ...
425
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskError)
398
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskError)
426
399
  */
427
400
  loadMaskError? : MaskConfig|Mask|boolean
428
401
  /**
@@ -460,8 +433,7 @@ export type BryntumGridBaseProps = {
460
433
  /**
461
434
  * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
462
435
  * inserted.
463
- * ...
464
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-minHeight)
436
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-minHeight)
465
437
  */
466
438
  minHeight? : string|number
467
439
  /**
@@ -476,7 +448,7 @@ export type BryntumGridBaseProps = {
476
448
  /**
477
449
  * Specify plugins (an array of classes) in config
478
450
  */
479
- plugins? : Function[]
451
+ plugins? : InstancePlugin[]|InstancePlugin
480
452
  /**
481
453
  * True to preserve focused cell after loading new data
482
454
  */
@@ -498,54 +470,61 @@ export type BryntumGridBaseProps = {
498
470
  preventTooltipOnTouch? : boolean
499
471
  /**
500
472
  * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
501
- * ...
502
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-readOnly)
473
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-readOnly)
503
474
  */
504
475
  readOnly? : boolean
505
476
  relayStoreEvents? : boolean
506
477
  /**
507
478
  * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
508
479
  * `type`.
509
- * ...
510
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rendition)
480
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rendition)
511
481
  */
512
482
  rendition? : string|Record<string, string>|null
513
483
  /**
514
484
  * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
515
485
  * constrain the aspect ratio.
516
- * ...
517
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-resizable)
518
- */
519
- resizable? : boolean|{
520
- minWidth?: number
521
- maxWidth?: number
522
- minHeight?: number
523
- maxHeight?: number
524
- handles?: object
525
- }
486
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-resizable)
487
+ * @property {number} [resizable.minWidth] The minimum width of the element.
488
+ * @property {number} [resizable.maxWidth] The maximum width of the element.
489
+ * @property {number} [resizable.minHeight] The minimum height of the element.
490
+ * @property {number} [resizable.maxHeight] The maximum height of the element
491
+ * @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
492
+ * @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
493
+ * @property {boolean} [resizable.handles.top] Resizable from top edge
494
+ * @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
495
+ * @property {boolean} [resizable.handles.end] Resizable from end edge
496
+ * @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
497
+ * @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
498
+ * @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
499
+ * @property {boolean} [resizable.handles.start] Resizable from start edge
500
+ */
501
+ resizable? : boolean|{ minWidth?: number, maxWidth?: number, minHeight?: number, maxHeight?: number, handles?: { topStart?: boolean, top?: boolean, topEnd?: boolean, end?: boolean, bottomEnd?: boolean, bottom?: boolean, bottomStart?: boolean, start?: boolean } }
526
502
  /**
527
503
  * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
528
504
  */
529
505
  resizeToFitIncludesHeader? : boolean
530
506
  /**
531
507
  * "Break points" for which responsive config to use for columns and css.
532
- * ...
533
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-responsiveLevels)
508
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-responsiveLevels)
534
509
  */
535
510
  responsiveLevels? : Record<string, number|string|ResponsiveLevelConfig>
536
511
  /**
537
512
  * Configure as `true` to have the component display a translucent ripple when its
538
513
  * [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
539
514
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
540
- * ...
541
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ripple)
542
- */
543
- ripple? : boolean|{
544
- delegate?: string
545
- color?: string
546
- radius?: number
547
- clip?: string
548
- }
515
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ripple)
516
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
517
+ * @property {string} [color] A CSS color name or specification.
518
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
519
+ * @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.
520
+ */
521
+ ripple? : boolean|object
522
+ /**
523
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
524
+ * accidentally applying a role which may interfere with screen readers.
525
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-role)
526
+ */
527
+ role? : string
549
528
  /**
550
529
  * 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`
551
530
  */
@@ -554,8 +533,7 @@ export type BryntumGridBaseProps = {
554
533
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
555
534
  * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
556
535
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
557
- * ...
558
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
536
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
559
537
  */
560
538
  rowHeight? : number
561
539
  /**
@@ -564,15 +542,13 @@ export type BryntumGridBaseProps = {
564
542
  rowLines? : boolean
565
543
  /**
566
544
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
567
- * ...
568
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rtl)
545
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rtl)
569
546
  */
570
547
  rtl? : boolean
571
548
  /**
572
549
  * Configures whether the grid is scrollable in the `Y` axis. This is used to configure a [Scroller](https://bryntum.com/products/grid/docs/api/Core/helper/util/Scroller).
573
550
  * See the [scrollerClass](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
574
- * ...
575
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollable)
551
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollable)
576
552
  */
577
553
  scrollable? : boolean|ScrollerConfig|Scroller
578
554
  /**
@@ -587,141 +563,122 @@ export type BryntumGridBaseProps = {
587
563
  /**
588
564
  * Selection configuration settings, change these properties to control how selection works and what can be
589
565
  * selected.
590
- * ...
591
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-selectionMode)
566
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-selectionMode)
592
567
  */
593
568
  selectionMode? : GridSelectionMode
594
569
  /**
595
570
  * Configure as `true` to have the grid show a red "changed" tag in cells whose
596
571
  * field value has changed and not yet been committed.
597
- * ...
598
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-showDirty)
572
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-showDirty)
573
+ * @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
574
+ * @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
599
575
  */
600
- showDirty? : boolean|{
601
- duringEdit?: boolean
602
- newRecord?: boolean
603
- }
576
+ showDirty? : boolean|{ duringEdit: boolean, newRecord: boolean }
604
577
  /**
605
578
  * Programmatic control over how many columns to span when used in a grid layout.
606
579
  */
607
580
  span? : number
608
581
  /**
609
582
  * This value can be one of the following:
610
- * ...
611
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateful)
583
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateful)
612
584
  */
613
585
  stateful? : boolean|object|string[]
614
586
  /**
615
587
  * The events that, when fired by this component, should trigger it to save its state by calling
616
588
  * [saveState](https://bryntum.com/products/grid/docs/api/Core/mixin/State#function-saveState).
617
- * ...
618
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-statefulEvents)
589
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-statefulEvents)
619
590
  */
620
591
  statefulEvents? : object|string[]
621
592
  /**
622
593
  * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateProvider). If this config is
623
594
  * not assigned, and [stateful](https://bryntum.com/products/grid/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
624
595
  * (if explicitly specified) will be used as the `stateId`.
625
- * ...
626
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateId)
596
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateId)
627
597
  */
628
598
  stateId? : string
629
599
  /**
630
600
  * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/grid/docs/api/Core/mixin/State#property-state). By default, `state`
631
601
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
632
- * ...
633
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateProvider)
602
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateProvider)
634
603
  */
635
604
  stateProvider? : StateProvider
636
605
  /**
637
606
  * The properties of this settings object controls how grid is restored from state data.
638
- * ...
639
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateSettings)
607
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateSettings)
608
+ * @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
640
609
  */
641
- stateSettings? : {
642
- restoreUnconfiguredColumns?: boolean
643
- }
610
+ stateSettings? : object
644
611
  /**
645
612
  * Store that holds records to display in the grid, or a store config object. If the configuration contains
646
613
  * a `readUrl`, an `AjaxStore` will be created.
647
- * ...
648
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-store)
614
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-store)
649
615
  */
650
616
  store? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
651
617
  /**
652
618
  * An object containing widgets keyed by name. By default (when no `type` is given), strips are
653
619
  * [toolbars](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
654
620
  * the toolbar's [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-items).
655
- * ...
656
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-strips)
621
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-strips)
657
622
  */
658
623
  strips? : Record<string, GridContainerItemConfig>
659
624
  /**
660
625
  * An object containing sub grid configuration objects keyed by a `region` property.
661
626
  * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
662
627
  * The 'normal' region defaults to use `flex: 1`.
663
- * ...
664
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-subGridConfigs)
628
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-subGridConfigs)
665
629
  */
666
630
  subGridConfigs? : Record<string, SubGridConfig>
667
631
  /**
668
632
  * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
669
633
  * is persisting changes on the server. Set to `null` to disable default sync mask.
670
- * ...
671
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-syncMask)
634
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-syncMask)
672
635
  */
673
636
  syncMask? : string|MaskConfig|null
674
637
  /**
675
638
  * 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
676
639
  * [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
677
640
  * this widget:
678
- * ...
679
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tab)
641
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tab)
680
642
  */
681
643
  tab? : boolean|TabConfig
682
644
  /**
683
645
  * When this container is used as a tab in a TabPanel, these items are added to the
684
646
  * [TabBar](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar) when this container is the active tab.
685
- * ...
686
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tabBarItems)
647
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tabBarItems)
687
648
  */
688
649
  tabBarItems? : ToolbarItems[]|Widget[]
689
650
  /**
690
651
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
691
652
  * or array of config objects representing the child items of a Toolbar.
692
653
  * This creates a toolbar docked to the top of the panel immediately below the header.
693
- * ...
694
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tbar)
654
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tbar)
695
655
  */
696
656
  tbar? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
697
657
  /**
698
658
  * A title to display in the header or owning TabPanel. Causes creation and docking of a header
699
659
  * to the top if no header is configured.
700
- * ...
701
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-title)
660
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-title)
702
661
  */
703
662
  title? : string
704
663
  /**
705
664
  * The [tools](https://bryntum.com/products/grid/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
706
665
  * property name is the reference by which an instantiated tool may be retrieved from the live
707
666
  * `[tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
708
- * ...
709
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tools)
667
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tools)
710
668
  */
711
669
  tools? : Record<string, ToolConfig>|null
712
670
  /**
713
671
  * Configure UI transitions for various actions in the grid.
672
+ * @property {boolean} insertRecord Transition record insertions
673
+ * @property {boolean} removeRecord Transition record removals
674
+ * @property {boolean} toggleColumn Transition column visibility changes
675
+ * @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
676
+ * @property {boolean} toggleRegion Transition region expand/collapse
677
+ * @property {boolean} toggleTreeNode Transition tree node expand/collapse
678
+ * @property {boolean} toggleGroup Transition group expand/collapse
679
+ * @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
714
680
  */
715
- transition? : {
716
- insertRecord?: boolean
717
- removeRecord?: boolean
718
- toggleColumn?: boolean
719
- expandCollapseColumn?: boolean
720
- toggleRegion?: boolean
721
- toggleTreeNode?: boolean
722
- toggleGroup?: boolean
723
- filterRemoval?: boolean
724
- }
681
+ transition? : object
725
682
  /**
726
683
  * Animation transition duration in milliseconds.
727
684
  */
@@ -730,8 +687,7 @@ export type BryntumGridBaseProps = {
730
687
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
731
688
  * as a space separated string, an array of strings, or as an object in which property names with truthy
732
689
  * values are used as the class names.
733
- * ...
734
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ui)
690
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ui)
735
691
  */
736
692
  ui? : 'plain'|'toolbar'|string|object
737
693
  /**
@@ -756,8 +712,7 @@ export type BryntumGridBaseProps = {
756
712
  onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
757
713
  /**
758
714
  * Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
759
- * ...
760
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
715
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
761
716
  * @param {object} event Event object
762
717
  * @param {Grid.view.Grid} event.grid Target grid
763
718
  * @param {RowEditorContext} event.editorContext Editing context
@@ -872,8 +827,7 @@ export type BryntumGridBaseProps = {
872
827
  onBeforeFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
873
828
  /**
874
829
  * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
875
- * ...
876
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeFinishRowEdit)
830
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeFinishRowEdit)
877
831
  * @param {object} event Event object
878
832
  * @param {Grid.view.Grid} event.grid Target grid
879
833
  * @param {RowEditorContext} event.editorContext Editing context
@@ -918,16 +872,14 @@ export type BryntumGridBaseProps = {
918
872
  onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
919
873
  /**
920
874
  * This event fires before row collapse is started.
921
- * ...
922
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowCollapse)
875
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowCollapse)
923
876
  * @param {object} event Event object
924
877
  * @param {Core.data.Model} event.record Record
925
878
  */
926
879
  onBeforeRowCollapse? : ((event: { record: Model }) => Promise<boolean>|boolean|void)|string
927
880
  /**
928
881
  * This event fires before row expand is started.
929
- * ...
930
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowExpand)
882
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowExpand)
931
883
  * @param {object} event Event object
932
884
  * @param {Core.data.Model} event.record Record
933
885
  */
@@ -1007,8 +959,7 @@ export type BryntumGridBaseProps = {
1007
959
  onCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string
1008
960
  /**
1009
961
  * Fires when any other event is fired from the object.
1010
- * ...
1011
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-catchAll)
962
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-catchAll)
1012
963
  * @param {object} event Event object
1013
964
  * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
1014
965
  * @param {string} event.event.type The type of the event which is caught by the listener
@@ -1050,8 +1001,7 @@ export type BryntumGridBaseProps = {
1050
1001
  /**
1051
1002
  * This event fires on the owning grid before the context menu is shown for a cell.
1052
1003
  * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu#config-processItems).
1053
- * ...
1054
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-cellMenuBeforeShow)
1004
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-cellMenuBeforeShow)
1055
1005
  * @param {object} event Event object
1056
1006
  * @param {Grid.view.Grid} event.source The grid
1057
1007
  * @param {Core.widget.Menu} event.menu The menu
@@ -1232,8 +1182,7 @@ export type BryntumGridBaseProps = {
1232
1182
  onCopy? : ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string
1233
1183
  /**
1234
1184
  * Fired when data in the store changes.
1235
- * ...
1236
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
1185
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
1237
1186
  * @param {object} event Event object
1238
1187
  * @param {Grid.view.GridBase} event.source Owning grid
1239
1188
  * @param {Core.data.Store} event.store The originating store
@@ -1337,8 +1286,7 @@ export type BryntumGridBaseProps = {
1337
1286
  onFinishCellEdit? : ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string
1338
1287
  /**
1339
1288
  * Fires on the owning Grid before the row editing is finished, return false to signal that the value is invalid and editing should not be finalized.
1340
- * ...
1341
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-finishRowEdit)
1289
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-finishRowEdit)
1342
1290
  * @param {object} event Event object
1343
1291
  * @param {Grid.view.Grid} event.grid Target grid
1344
1292
  * @param {RowEditorContext} event.editorContext Editing context
@@ -1438,8 +1386,7 @@ export type BryntumGridBaseProps = {
1438
1386
  onGridRowDrop? : ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string
1439
1387
  /**
1440
1388
  * Fired when a grid header is clicked on.
1441
- * ...
1442
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerClick)
1389
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerClick)
1443
1390
  * @param {object} event Event object
1444
1391
  * @param {Event} event.domEvent The triggering DOM event.
1445
1392
  * @param {Grid.column.Column} event.column The column clicked on.
@@ -1448,8 +1395,7 @@ export type BryntumGridBaseProps = {
1448
1395
  /**
1449
1396
  * This event fires on the owning Grid before the context menu is shown for a header.
1450
1397
  * Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
1451
- * ...
1452
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerMenuBeforeShow)
1398
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerMenuBeforeShow)
1453
1399
  * @param {object} event Event object
1454
1400
  * @param {Grid.view.Grid} event.source The grid
1455
1401
  * @param {Core.widget.Menu} event.menu The menu
@@ -1512,8 +1458,7 @@ export type BryntumGridBaseProps = {
1512
1458
  /**
1513
1459
  * Triggered when a widget which had been in a non-visible state for any reason
1514
1460
  * achieves visibility.
1515
- * ...
1516
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-paint)
1461
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-paint)
1517
1462
  * @param {object} event Event object
1518
1463
  * @param {Core.widget.Widget} event.source The widget being painted.
1519
1464
  * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -1532,8 +1477,8 @@ export type BryntumGridBaseProps = {
1532
1477
  /**
1533
1478
  * Fires on the owning Grid when export has finished
1534
1479
  * @param {object} event Event object
1535
- * @param {Response} event.response Optional response, if received
1536
- * @param {Error} event.error Optional error, if exception occurred
1480
+ * @param {Response} [event.response] Optional response, if received
1481
+ * @param {Error} [event.error] Optional error, if exception occurred
1537
1482
  */
1538
1483
  onPdfExport? : ((event: { response?: Response, error?: Error }) => void)|string
1539
1484
  /**
@@ -1590,8 +1535,7 @@ export type BryntumGridBaseProps = {
1590
1535
  onRowCollapse? : ((event: { record: Model }) => void)|string
1591
1536
  /**
1592
1537
  * This event fires when a row expand has finished expanding.
1593
- * ...
1594
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-rowExpand)
1538
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-rowExpand)
1595
1539
  * @param {object} event Event object
1596
1540
  * @param {Core.data.Model} event.record Record
1597
1541
  * @param {object} event.expandedElements An object with the Grid region name as property and the expanded body element as value
@@ -1729,7 +1673,7 @@ export type BryntumGridBaseProps = {
1729
1673
  * @param {Core.data.Model} event.groupRecord [DEPRECATED] Use `groupRecords` param instead
1730
1674
  * @param {Core.data.Model[]} event.groupRecords The group records being toggled
1731
1675
  * @param {boolean} event.collapse Collapsed (true) or expanded (false)
1732
- * @param {boolean} event.allRecords True if this event is part of toggling all groups
1676
+ * @param {boolean} [event.allRecords] True if this event is part of toggling all groups
1733
1677
  */
1734
1678
  onToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string
1735
1679
  /**
@@ -1771,129 +1715,117 @@ export type BryntumGridBaseProps = {
1771
1715
  * agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
1772
1716
  * ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
1773
1717
  * also perform data manipulation operations such as adding, updating, deleting records.
1774
- * ...
1775
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
1718
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
1776
1719
  */
1777
1720
  aiFeature? : object|boolean|string|AI|AIConfig
1778
1721
  /**
1779
1722
  * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
1780
- * ...
1781
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
1723
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
1782
1724
  */
1783
1725
  aiFilterFeature? : object|boolean|string|AIFilter|AIFilterConfig
1784
1726
  /**
1785
1727
  * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
1786
1728
  * makes cut, copy and paste actions available via the cell context menu.
1787
- * ...
1788
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
1729
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
1789
1730
  */
1790
1731
  cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
1791
1732
  /**
1792
1733
  * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
1793
1734
  * enables cell editing. Any subclass of [Field](https://bryntum.com/products/grid/docs/api/Core/widget/Field) can be used
1794
1735
  * as editor for the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column). The most popular are:
1795
- * ...
1796
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
1736
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
1797
1737
  */
1798
1738
  cellEditFeature? : object|boolean|string|CellEdit|CellEditConfig
1799
1739
  /**
1800
1740
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
1801
1741
  * <kbd>Space</kbd> key when the cell is focused.
1802
- * ...
1803
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
1742
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
1804
1743
  */
1805
1744
  cellMenuFeature? : object|boolean|string|CellMenu|CellMenuConfig
1806
1745
  /**
1807
1746
  * Displays a tooltip when hovering cells.
1808
- * ...
1809
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
1747
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
1810
1748
  */
1811
1749
  cellTooltipFeature? : object|boolean|string|CellTooltip|CellTooltipConfig
1812
1750
  /**
1813
1751
  * Adds interactive charting to a Grid. [Charts](https://bryntum.com/products/grid/docs/api/Chart/widget/Chart) can be created from a selection of Grid data
1814
1752
  * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
1815
1753
  * options.
1816
- * ...
1817
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
1754
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
1818
1755
  */
1819
1756
  chartsFeature? : object|boolean|string|Charts|ChartsConfig
1820
1757
  /**
1821
- * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
1822
- * ...
1823
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
1758
+ * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
1759
+ * has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
1760
+ * and adjusts the column width to fit. The measurement is triggered automatically when data changes
1761
+ * or rows are rendered.
1762
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
1824
1763
  */
1825
1764
  columnAutoWidthFeature? : object|boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
1826
1765
  /**
1827
1766
  * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
1828
1767
  * for example to group by that column. This feature simplifies certain operations on touch devices.
1829
- * ...
1830
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
1768
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
1831
1769
  */
1832
1770
  columnDragToolbarFeature? : object|boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
1833
1771
  /**
1834
1772
  * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
1835
1773
  * by region or tag. Grouped headers are displayed as menu hierarchies.
1836
- * ...
1837
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
1774
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
1838
1775
  */
1839
1776
  columnPickerFeature? : object|boolean|string|ColumnPicker|ColumnPickerConfig
1840
1777
  /**
1841
1778
  * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
1842
1779
  * is focused.
1843
- * ...
1844
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
1780
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
1845
1781
  */
1846
1782
  columnRenameFeature? : object|boolean|string|ColumnRename|ColumnRenameConfig
1847
1783
  /**
1848
- * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
1849
- * on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
1850
- * ...
1851
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
1784
+ * Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
1785
+ * Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
1786
+ * `change` event on the [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
1787
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
1852
1788
  */
1853
1789
  columnReorderFeature? : object|boolean|string|ColumnReorder|ColumnReorderConfig
1854
1790
  /**
1855
- * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
1856
- * resize listen to `change` event on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
1857
- * ...
1858
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
1791
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
1792
+ * appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
1793
+ * any [minWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
1794
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
1859
1795
  */
1860
1796
  columnResizeFeature? : object|boolean|string|ColumnResize|ColumnResizeConfig
1861
1797
  /**
1862
1798
  * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
1863
1799
  * [TableExporter](https://bryntum.com/products/grid/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
1864
1800
  * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
1865
- * ...
1866
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
1801
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
1867
1802
  */
1868
1803
  excelExporterFeature? : object|boolean|string|ExcelExporter|ExcelExporterConfig
1869
1804
  /**
1870
- * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
1871
- * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
1872
- * ...
1873
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
1805
+ * An experimental feature that lets users drop files on a Widget. The widget fires a
1806
+ * [fileDrop](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop#event-fileDrop) event when a file is dropped onto it. In the event, you get access to the raw
1807
+ * files as strings, that were parsed by calling `readAsBinaryString`.
1808
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
1874
1809
  */
1875
1810
  fileDropFeature? : object|boolean|string|FileDrop|FileDropConfig
1876
1811
  /**
1877
1812
  * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
1878
1813
  * with values based on the values in the original selected range. This is similar to functionality normally seen in
1879
1814
  * various spreadsheet applications.
1880
- * ...
1881
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
1815
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
1882
1816
  */
1883
1817
  fillHandleFeature? : object|boolean|string|FillHandle|FillHandleConfig
1884
1818
  /**
1885
1819
  * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
1886
1820
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
1887
- * ...
1888
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
1821
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
1889
1822
  */
1890
1823
  filterFeature? : object|boolean|string|Filter|FilterConfig
1891
1824
  /**
1892
1825
  * Feature that allows filtering of the grid by entering filters on column headers.
1893
1826
  * The actual filtering is done by the store.
1894
1827
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
1895
- * ...
1896
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
1828
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
1897
1829
  */
1898
1830
  filterBarFeature? : object|boolean|string|FilterBar|FilterBarConfig
1899
1831
  /**
@@ -1901,141 +1833,124 @@ export type BryntumGridBaseProps = {
1901
1833
  * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
1902
1834
  * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
1903
1835
  * grouper.
1904
- * ...
1905
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
1836
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
1906
1837
  */
1907
1838
  groupFeature? : object|boolean|string|Group|GroupConfig
1908
1839
  /**
1909
1840
  * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
1910
1841
  * [Summary](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary).
1911
- * ...
1912
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
1842
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
1913
1843
  */
1914
1844
  groupSummaryFeature? : object|boolean|string|GroupSummary|GroupSummaryConfig
1915
1845
  /**
1916
1846
  * Right click column header or focus it and press SPACE key to show the context menu for headers.
1917
- * ...
1918
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
1847
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
1919
1848
  */
1920
1849
  headerMenuFeature? : object|boolean|string|HeaderMenu|HeaderMenuConfig
1921
1850
  /**
1922
1851
  * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
1923
- * ...
1924
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
1852
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
1925
1853
  */
1926
1854
  lockRowsFeature? : object|boolean|string|LockRows|LockRowsConfig
1927
1855
  /**
1928
1856
  * This feature merges cells that have the same value in sorted (or [optionally](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells#config-sortedOnly) any) columns
1929
1857
  * configured to [mergeCells](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-mergeCells).
1930
- * ...
1931
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
1858
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
1932
1859
  */
1933
1860
  mergeCellsFeature? : object|boolean|string|MergeCells|MergeCellsConfig
1934
1861
  /**
1935
1862
  * Generates PDF/PNG files from the Grid component.
1936
- * ...
1937
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
1863
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
1938
1864
  */
1939
1865
  pdfExportFeature? : object|boolean|string|PdfExport|PdfExportConfig
1940
1866
  /**
1941
1867
  * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
1942
1868
  * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
1943
- * ...
1944
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
1869
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
1945
1870
  */
1946
1871
  pinColumnsFeature? : object|boolean|string|PinColumns|PinColumnsConfig
1947
1872
  /**
1948
1873
  * Allows printing Grid contents using browser print dialog.
1949
- * ...
1950
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
1874
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
1951
1875
  */
1952
1876
  printFeature? : object|boolean|string|Print|PrintConfig
1953
1877
  /**
1954
1878
  * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
1955
- * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
1956
- * ...
1957
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
1879
+ * keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
1880
+ * <kbd>shift</kbd> moves to previous.
1881
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
1958
1882
  */
1959
1883
  quickFindFeature? : object|boolean|string|QuickFind|QuickFindConfig
1960
1884
  /**
1961
1885
  * Makes the splitter between grid [sections](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
1962
1886
  * collapse/expand the sections.
1963
- * ...
1964
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
1887
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
1965
1888
  */
1966
1889
  regionResizeFeature? : object|boolean|string|RegionResize|RegionResizeConfig
1967
1890
  /**
1968
1891
  * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
1969
1892
  * available via the cell context menu.
1970
- * ...
1971
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
1893
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
1972
1894
  */
1973
1895
  rowCopyPasteFeature? : object|boolean|string|RowCopyPaste|RowCopyPasteConfig
1974
1896
  /**
1975
1897
  * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
1976
- * ...
1977
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
1898
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
1978
1899
  */
1979
1900
  rowEditFeature? : object|boolean|string|RowEdit|RowEditConfig
1980
1901
  /**
1981
1902
  * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
1982
1903
  * a button that expands or collapses the row.
1983
- * ...
1984
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
1904
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
1985
1905
  */
1986
1906
  rowExpanderFeature? : object|boolean|string|RowExpander|RowExpanderConfig
1987
1907
  /**
1988
1908
  * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
1989
1909
  * on the grid [store](https://bryntum.com/products/grid/docs/api/Core/data/Store).
1990
- * ...
1991
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
1910
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
1992
1911
  */
1993
1912
  rowReorderFeature? : object|boolean|string|RowReorder|RowReorderConfig
1994
1913
  /**
1995
1914
  * Enables user to change row height by dragging the bottom row border. After a resize operation, the [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight)
1996
1915
  * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1997
- * ...
1998
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
1916
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
1999
1917
  */
2000
1918
  rowResizeFeature? : object|boolean|string|RowResize|RowResizeConfig
2001
1919
  /**
2002
1920
  * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
2003
- * ...
2004
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
1921
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
2005
1922
  */
2006
1923
  searchFeature? : object|boolean|string|Search|SearchConfig
2007
1924
  /**
2008
1925
  * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
2009
1926
  * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
2010
1927
  * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreSort#function-sort).
2011
- * ...
2012
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
1928
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
2013
1929
  */
2014
1930
  sortFeature? : object|boolean|string|Sort|SortConfig
2015
1931
  /**
2016
1932
  * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
2017
1933
  * programmatically by calling [split()](https://bryntum.com/products/grid/docs/api/Grid/feature/Split#function-split).
2018
- * ...
2019
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
1934
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
2020
1935
  */
2021
1936
  splitFeature? : object|boolean|string|Split|SplitConfig
2022
1937
  /**
2023
- * A feature which pins configurable content from a grid row to the top of the grid
2024
- * while the row scrolls off the top but is still visible.
2025
- * ...
2026
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
1938
+ * A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
1939
+ * similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
1940
+ * achieve the same effect.
1941
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
2027
1942
  */
2028
1943
  stickyCellsFeature? : object|boolean|string|StickyCells|StickyCellsConfig
2029
1944
  /**
2030
1945
  * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
2031
- * ...
2032
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
1946
+ * This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
1947
+ * Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
1948
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
2033
1949
  */
2034
1950
  stripeFeature? : object|boolean|string|Stripe|StripeConfig
2035
1951
  /**
2036
1952
  * Displays a summary row in the grid footer.
2037
- * ...
2038
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
1953
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
2039
1954
  */
2040
1955
  summaryFeature? : object|boolean|string|Summary|SummaryConfig
2041
1956
  /**
@@ -2043,15 +1958,13 @@ export type BryntumGridBaseProps = {
2043
1958
  * exactly one [TreeColumn](https://bryntum.com/products/grid/docs/api/Grid/column/TreeColumn) among grids columns. That column will have its renderer replaced with a
2044
1959
  * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
2045
1960
  * also called.
2046
- * ...
2047
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
1961
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
2048
1962
  */
2049
1963
  treeFeature? : object|boolean|string|Tree|TreeConfig
2050
1964
  /**
2051
1965
  * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
2052
1966
  * record field per parent level. Parents are generated based on each leaf's value for those fields.
2053
- * ...
2054
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
1967
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
2055
1968
  */
2056
1969
  treeGroupFeature? : object|boolean|string|TreeGroup|TreeGroupConfig
2057
1970
 
@@ -2187,6 +2100,7 @@ export class BryntumGridBase extends React.Component<BryntumGridBaseProps> {
2187
2100
  'resizeToFitIncludesHeader',
2188
2101
  'responsiveLevels',
2189
2102
  'ripple',
2103
+ 'role',
2190
2104
  'rootElement',
2191
2105
  'scrollerClass',
2192
2106
  'scrollManager',
@@ -2234,6 +2148,7 @@ export class BryntumGridBase extends React.Component<BryntumGridBaseProps> {
2234
2148
  'insertFirst',
2235
2149
  'keyMap',
2236
2150
  'labelPosition',
2151
+ 'labelWidth',
2237
2152
  'longPressTime',
2238
2153
  'margin',
2239
2154
  'maxHeight',
@@ -2378,8 +2293,6 @@ export class BryntumGridBase extends React.Component<BryntumGridBaseProps> {
2378
2293
  ];
2379
2294
 
2380
2295
  static propertyNames = [
2381
- 'focusVisible',
2382
- 'hasChanges',
2383
2296
  'originalStore',
2384
2297
  'parent',
2385
2298
  'selectedCell',