@bryntum/grid-vue-3-thin 7.2.3 → 7.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +4 -4
  2. package/lib/chunks/{B5DiBj1m.js → BGeNcVH6.js} +5 -5
  3. package/lib/chunks/BGeNcVH6.js.map +1 -0
  4. package/lib/chunks/{v3MxzI7J.js → Ba35uKyP.js} +3 -3
  5. package/lib/chunks/Ba35uKyP.js.map +1 -0
  6. package/lib/chunks/{MAev_NTD.js → Bc2x_WPR.js} +8 -6
  7. package/lib/chunks/Bc2x_WPR.js.map +1 -0
  8. package/lib/chunks/{C3MmNeeF.js → Be7ZZzGW.js} +14 -12
  9. package/lib/chunks/Be7ZZzGW.js.map +1 -0
  10. package/lib/chunks/{CnbA4JoC.js → BeyOFZne.js} +6 -6
  11. package/lib/chunks/BeyOFZne.js.map +1 -0
  12. package/lib/chunks/{BQkqLHa6.js → BpNo5v3W.js} +9 -10
  13. package/lib/chunks/BpNo5v3W.js.map +1 -0
  14. package/lib/chunks/{Da4PP6A-.js → CAlh-Y8B.js} +3 -3
  15. package/lib/chunks/CAlh-Y8B.js.map +1 -0
  16. package/lib/chunks/{DkzTNiUv.js → CWYhi4DG.js} +8 -9
  17. package/lib/chunks/CWYhi4DG.js.map +1 -0
  18. package/lib/chunks/{D639wy1k.js → CcfDAcJD.js} +9 -9
  19. package/lib/chunks/CcfDAcJD.js.map +1 -0
  20. package/lib/chunks/{C8vFKx3Q.js → w2GDktIt.js} +8 -6
  21. package/lib/chunks/w2GDktIt.js.map +1 -0
  22. package/lib/components/BryntumAIFilterField.js +1 -1
  23. package/lib/components/BryntumChecklistFilterCombo.js +1 -1
  24. package/lib/components/BryntumGrid.js +1 -1
  25. package/lib/components/BryntumGridBase.js +1 -1
  26. package/lib/components/BryntumGridChartDesigner.js +1 -1
  27. package/lib/components/BryntumGridFieldFilterPicker.js +1 -1
  28. package/lib/components/BryntumGridFieldFilterPickerGroup.js +1 -1
  29. package/lib/components/BryntumGroupBar.js +1 -1
  30. package/lib/components/BryntumThemeCombo.js +57 -0
  31. package/lib/components/BryntumThemeCombo.js.map +1 -0
  32. package/lib/components/BryntumTreeCombo.js +1 -1
  33. package/lib/components/BryntumTreeGrid.js +1 -1
  34. package/lib/index.js +10 -10
  35. package/package.json +1 -1
  36. package/src/components/BryntumAIFilterField.vue +73 -118
  37. package/src/components/BryntumAIFilterFieldProps.ts +69 -110
  38. package/src/components/BryntumChecklistFilterCombo.vue +90 -149
  39. package/src/components/BryntumChecklistFilterComboProps.ts +86 -141
  40. package/src/components/BryntumGrid.vue +203 -290
  41. package/src/components/BryntumGridBase.vue +203 -290
  42. package/src/components/BryntumGridBaseProps.ts +186 -261
  43. package/src/components/BryntumGridChartDesigner.vue +58 -94
  44. package/src/components/BryntumGridChartDesignerProps.ts +55 -88
  45. package/src/components/BryntumGridFieldFilterPicker.vue +81 -131
  46. package/src/components/BryntumGridFieldFilterPickerGroup.vue +80 -129
  47. package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +76 -120
  48. package/src/components/BryntumGridFieldFilterPickerProps.ts +77 -122
  49. package/src/components/BryntumGridProps.ts +186 -261
  50. package/src/components/BryntumGroupBar.vue +64 -104
  51. package/src/components/BryntumGroupBarProps.ts +61 -98
  52. package/src/components/BryntumThemeCombo.vue +60 -0
  53. package/src/components/BryntumTreeCombo.vue +91 -151
  54. package/src/components/BryntumTreeComboProps.ts +87 -143
  55. package/src/components/BryntumTreeGrid.vue +203 -290
  56. package/src/components/BryntumTreeGridProps.ts +186 -261
  57. package/lib/chunks/B5DiBj1m.js.map +0 -1
  58. package/lib/chunks/BQkqLHa6.js.map +0 -1
  59. package/lib/chunks/C3MmNeeF.js.map +0 -1
  60. package/lib/chunks/C8vFKx3Q.js.map +0 -1
  61. package/lib/chunks/CnbA4JoC.js.map +0 -1
  62. package/lib/chunks/D639wy1k.js.map +0 -1
  63. package/lib/chunks/Da4PP6A-.js.map +0 -1
  64. package/lib/chunks/DkzTNiUv.js.map +0 -1
  65. package/lib/chunks/MAev_NTD.js.map +0 -1
  66. package/lib/chunks/v3MxzI7J.js.map +0 -1
@@ -33,7 +33,7 @@
33
33
 
34
34
  import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
35
35
 
36
- import type { 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, Widget } from '@bryntum/core-thin';
36
+ import type { 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, Widget } from '@bryntum/core-thin';
37
37
  import type { 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, 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';
38
38
  import { GridBase } from '@bryntum/grid-thin';
39
39
 
@@ -44,8 +44,7 @@ defineProps<{
44
44
  /**
45
45
  * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
46
46
  * content will be placed inside this element.
47
- * ...
48
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-adopt)
47
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-adopt)
49
48
  */
50
49
  adopt ? : HTMLElement|string
51
50
  /**
@@ -80,15 +79,13 @@ defineProps<{
80
79
  /**
81
80
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
82
81
  * into an element which will be linked using the `aria-describedby` attribute.
83
- * ...
84
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaDescription)
82
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaDescription)
85
83
  */
86
84
  ariaDescription ? : string
87
85
  /**
88
86
  * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
89
87
  * the `aria-label` attribute.
90
- * ...
91
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaLabel)
88
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ariaLabel)
92
89
  */
93
90
  ariaLabel ? : string
94
91
  /**
@@ -100,14 +97,12 @@ defineProps<{
100
97
  /**
101
98
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
102
99
  * 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).
103
- * ...
104
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bbar)
100
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bbar)
105
101
  */
106
102
  bbar ? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
107
103
  /**
108
104
  * Custom CSS classes to add to the panel's body element.
109
- * ...
110
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bodyCls)
105
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bodyCls)
111
106
  */
112
107
  bodyCls ? : string|object
113
108
  /**
@@ -117,21 +112,18 @@ defineProps<{
117
112
  /**
118
113
  * An object where property names with a truthy value indicate which events should bubble up the ownership
119
114
  * hierarchy when triggered.
120
- * ...
121
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bubbleEvents)
115
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-bubbleEvents)
122
116
  */
123
117
  bubbleEvents ? : object
124
118
  /**
125
119
  * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
126
- * ...
127
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-callOnFunctions)
120
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-callOnFunctions)
128
121
  */
129
122
  callOnFunctions ? : Boolean
130
123
  /**
131
124
  * By default, if an event handler throws an exception, the error propagates up the stack and the
132
125
  * application state is undefined. Code which follows the event handler will *not* be executed.
133
- * ...
134
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-catchEventHandlerExceptions)
126
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-catchEventHandlerExceptions)
135
127
  */
136
128
  catchEventHandlerExceptions ? : Boolean
137
129
  /**
@@ -144,8 +136,7 @@ defineProps<{
144
136
  * Custom CSS classes to add to element.
145
137
  * May be specified as a space separated string, or as an object in which property names
146
138
  * with truthy values are used as the class names:
147
- * ...
148
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-cls)
139
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-cls)
149
140
  */
150
141
  cls ? : string|object
151
142
  /**
@@ -155,15 +146,13 @@ defineProps<{
155
146
  collapsed ? : Boolean
156
147
  /**
157
148
  * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsed).
158
- * ...
159
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-collapsible)
149
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-collapsible)
160
150
  */
161
151
  collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
162
152
  /**
163
153
  * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
164
154
  * `style` block.
165
- * ...
166
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-color)
155
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-color)
167
156
  */
168
157
  color ? : Color
169
158
  /**
@@ -177,8 +166,7 @@ defineProps<{
177
166
  /**
178
167
  * Accepts column definitions for the grid during initialization. They will be used to create
179
168
  * [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) instances that are added to a [ColumnStore](#Grid/data/ColumnStore).
180
- * ...
181
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-columns)
169
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-columns)
182
170
  */
183
171
  columns ? : ColumnStore|GridColumnConfig[]|ColumnStoreConfig
184
172
  config ? : object
@@ -186,8 +174,7 @@ defineProps<{
186
174
  * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-contentElement).
187
175
  * May be specified as a space separated string, or as an object in which property names
188
176
  * with truthy values are used as the class names:
189
- * ...
190
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-contentElementCls)
177
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-contentElementCls)
191
178
  */
192
179
  contentElementCls ? : string|object
193
180
  /**
@@ -199,8 +186,7 @@ defineProps<{
199
186
  * Convenient shortcut to set data in grids store both during initialization and at runtime. Can also be
200
187
  * used to retrieve data at runtime, although we do recommend interacting with Grids store instead using
201
188
  * the [store](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#property-store) property.
202
- * ...
203
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-data)
189
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-data)
204
190
  */
205
191
  data ? : object[]|Model[]|ModelConfig[]
206
192
  /**
@@ -221,16 +207,15 @@ defineProps<{
221
207
  */
222
208
  destroyStore ? : Boolean
223
209
  /**
224
- * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
225
- * ...
226
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-detectCSSCompatibilityIssues)
210
+ * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
211
+ * checks:
212
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-detectCSSCompatibilityIssues)
227
213
  */
228
214
  detectCSSCompatibilityIssues ? : Boolean
229
215
  /**
230
216
  * 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
231
217
  * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
232
- * ...
233
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-disabled)
218
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-disabled)
234
219
  */
235
220
  disabled ? : Boolean|'inert'
236
221
  /**
@@ -250,43 +235,39 @@ defineProps<{
250
235
  * [strips collection](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
251
236
  * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
252
237
  * body. Such widgets are called "edge strips".
253
- * ...
254
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-dock)
238
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-dock)
255
239
  */
256
240
  dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
257
241
  /**
258
242
  * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
259
- * ...
260
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-drawer)
261
- * @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.
262
- * @param {string,number} size The size of the drawer in its collapsible axis.
263
- * @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.
264
- * @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.
265
- * @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.
266
- * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
267
- * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
268
- * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
269
- */
270
- 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}
243
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-drawer)
244
+ * @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.
245
+ * @param {string,number} [size] The size of the drawer in its collapsible axis.
246
+ * @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.
247
+ * @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.
248
+ * @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.
249
+ * @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
250
+ * @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
251
+ * @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
252
+ */
253
+ 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 }
271
254
  /**
272
255
  * An object specifying attributes to assign to the root element of this widget.
273
256
  * Set `null` value to attribute to remove it.
274
- * ...
275
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-elementAttributes)
257
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-elementAttributes)
276
258
  */
277
259
  elementAttributes ? : Record<string, string|null>
278
260
  /**
279
261
  * 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.
280
262
  * When using multiple Grid regions, provide the `region` property to decide where the text is shown.
281
263
  * By default, it is shown in the first region.
282
- * ...
283
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-emptyText)
264
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-emptyText)
284
265
  */
285
266
  emptyText ? : string|EmptyTextDomConfig
286
267
  /**
287
- * Configure this as `true` to allow elements within cells to be styled as `position: sticky`.
288
- * ...
289
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-enableSticky)
268
+ * Set to `true` to enable the [StickyCells](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells) feature, which pins cell
269
+ * content to the top of the grid while rows scroll off the top but remain visible.
270
+ * @deprecated 7.3.0 Use `features : { stickyCells : true }` instead
290
271
  */
291
272
  enableSticky ? : Boolean
292
273
  /**
@@ -310,8 +291,7 @@ defineProps<{
310
291
  * Use fixed row height. Setting this to `true` will configure the underlying RowManager to use fixed row
311
292
  * height, which sacrifices the ability to use rows with variable height to gain a fraction better
312
293
  * performance.
313
- * ...
314
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fixedRowHeight)
294
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fixedRowHeight)
315
295
  */
316
296
  fixedRowHeight ? : Boolean
317
297
  /**
@@ -325,41 +305,35 @@ defineProps<{
325
305
  /**
326
306
  * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
327
307
  * 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).
328
- * ...
329
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-footer)
308
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-footer)
309
+ * @property {'top','right','bottom','left','start','end'} dock Where to dock
310
+ * @property {string} html Html to populate the footer with
311
+ * @property {string} cls CSS class to add to the footer
330
312
  */
331
- footer ? : {
332
- dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
333
- html?: string
334
- cls?: string
335
- }|string
313
+ footer ? : object|string
336
314
  /**
337
315
  * An object which names formula prefixes which will be applied to all columns configured with
338
316
  * `formula : true`.
339
- * ...
340
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-formulaProviders)
317
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-formulaProviders)
341
318
  */
342
319
  formulaProviders ? : Record<string, FormulaProviderConfig>
343
320
  /**
344
321
  * Refresh entire row when a record changes (`true`) or, if possible, only the cells affected (`false`).
345
- * ...
346
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fullRowRefresh)
322
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-fullRowRefresh)
347
323
  */
348
324
  fullRowRefresh ? : Boolean
349
325
  /**
350
326
  * 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
351
327
  * expected to return the desired height of that records row. If the function returns a falsy value, Grids
352
328
  * configured [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight) is used.
353
- * ...
354
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-getRowHeight)
329
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-getRowHeight)
355
330
  * @param {Core.data.Model} getRowHeight.record Record to determine row height for
356
331
  * @returns {number} Desired row height
357
332
  */
358
- getRowHeight ? : (getRowHeight: { record: Model }) => number
333
+ getRowHeight ? : () => number
359
334
  /**
360
335
  * 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`.
361
- * ...
362
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-header)
336
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-header)
363
337
  */
364
338
  header ? : string|Boolean|PanelHeader
365
339
  /**
@@ -399,16 +373,14 @@ defineProps<{
399
373
  id ? : string
400
374
  /**
401
375
  * Determines if the widgets read-only state should be controlled by its parent.
402
- * ...
403
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ignoreParentReadOnly)
376
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ignoreParentReadOnly)
404
377
  */
405
378
  ignoreParentReadOnly ? : Boolean
406
379
  /**
407
380
  * Convenience setting to align input fields of child widgets. By default, the Field input element is
408
381
  * placed immediately following the `label`. If you prefer to have all input fields aligned to the
409
382
  * right, set this config to `'end'`.
410
- * ...
411
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-inputFieldAlign)
383
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-inputFieldAlign)
412
384
  */
413
385
  inputFieldAlign ? : 'start'|'end'
414
386
  /**
@@ -425,14 +397,17 @@ defineProps<{
425
397
  keyMap ? : Record<string, KeyMapConfig>
426
398
  /**
427
399
  * Convenience setting to use same label placement on all child widgets.
428
- * ...
429
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelPosition)
400
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelPosition)
430
401
  */
431
402
  labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
403
+ /**
404
+ * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
405
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-labelWidth)
406
+ */
407
+ labelWidth ? : number|null
432
408
  /**
433
409
  * The listener set for this object.
434
- * ...
435
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-listeners)
410
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-listeners)
436
411
  */
437
412
  listeners ? : GridBaseListeners
438
413
  /**
@@ -445,15 +420,13 @@ defineProps<{
445
420
  * when data is loading. The message and optional configuration from the
446
421
  * [loadMask](https://bryntum.com/products/grid/docs/api/Core/mixin/LoadMaskable#config-loadMask) config take priority over these options, just as they do
447
422
  * for `maskDefaults`, respectively.
448
- * ...
449
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskDefaults)
423
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskDefaults)
450
424
  */
451
425
  loadMaskDefaults ? : MaskConfig
452
426
  /**
453
427
  * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object to adjust the [maskDefaults](#Core/widget/Widget#config-maskDefaults)
454
428
  * when an error occurs loading data.
455
- * ...
456
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskError)
429
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-loadMaskError)
457
430
  */
458
431
  loadMaskError ? : MaskConfig|Mask|Boolean
459
432
  /**
@@ -491,8 +464,7 @@ defineProps<{
491
464
  /**
492
465
  * Grid's `min-height`. Defaults to `10em` to be sure that the Grid always has a height wherever it is
493
466
  * inserted.
494
- * ...
495
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-minHeight)
467
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-minHeight)
496
468
  */
497
469
  minHeight ? : string|number
498
470
  /**
@@ -507,7 +479,7 @@ defineProps<{
507
479
  /**
508
480
  * Specify plugins (an array of classes) in config
509
481
  */
510
- plugins ? : Function[]
482
+ plugins ? : InstancePlugin[]|InstancePlugin
511
483
  /**
512
484
  * True to preserve focused cell after loading new data
513
485
  */
@@ -529,54 +501,61 @@ defineProps<{
529
501
  preventTooltipOnTouch ? : Boolean
530
502
  /**
531
503
  * Set to `true` to make the grid read-only, by disabling any UIs for modifying data.
532
- * ...
533
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-readOnly)
504
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-readOnly)
534
505
  */
535
506
  readOnly ? : Boolean
536
507
  relayStoreEvents ? : Boolean
537
508
  /**
538
509
  * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
539
510
  * `type`.
540
- * ...
541
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rendition)
511
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rendition)
542
512
  */
543
513
  rendition ? : string|Record<string, string>|null
544
514
  /**
545
515
  * Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
546
516
  * constrain the aspect ratio.
547
- * ...
548
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-resizable)
549
- */
550
- resizable ? : Boolean|{
551
- minWidth?: number
552
- maxWidth?: number
553
- minHeight?: number
554
- maxHeight?: number
555
- handles?: object
556
- }
517
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-resizable)
518
+ * @property {number} [resizable.minWidth] The minimum width of the element.
519
+ * @property {number} [resizable.maxWidth] The maximum width of the element.
520
+ * @property {number} [resizable.minHeight] The minimum height of the element.
521
+ * @property {number} [resizable.maxHeight] The maximum height of the element
522
+ * @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
523
+ * @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
524
+ * @property {boolean} [resizable.handles.top] Resizable from top edge
525
+ * @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
526
+ * @property {boolean} [resizable.handles.end] Resizable from end edge
527
+ * @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
528
+ * @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
529
+ * @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
530
+ * @property {boolean} [resizable.handles.start] Resizable from start edge
531
+ */
532
+ 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 } }
557
533
  /**
558
534
  * Set to `false` to only measure cell contents when double-clicking the edge between column headers.
559
535
  */
560
536
  resizeToFitIncludesHeader ? : Boolean
561
537
  /**
562
538
  * "Break points" for which responsive config to use for columns and css.
563
- * ...
564
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-responsiveLevels)
539
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-responsiveLevels)
565
540
  */
566
541
  responsiveLevels ? : Record<string, number|string|ResponsiveLevelConfig>
567
542
  /**
568
543
  * Configure as `true` to have the component display a translucent ripple when its
569
544
  * [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
570
545
  * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
571
- * ...
572
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ripple)
546
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ripple)
547
+ * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
548
+ * @property {string} [color] A CSS color name or specification.
549
+ * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
550
+ * @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.
551
+ */
552
+ ripple ? : Boolean|object
553
+ /**
554
+ * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
555
+ * accidentally applying a role which may interfere with screen readers.
556
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-role)
573
557
  */
574
- ripple ? : Boolean|{
575
- delegate?: string
576
- color?: string
577
- radius?: number
578
- clip?: string
579
- }
558
+ role ? : string
580
559
  /**
581
560
  * 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`
582
561
  */
@@ -585,8 +564,7 @@ defineProps<{
585
564
  * Row height in pixels. This allows the default height for rows to be controlled. Note that it may be
586
565
  * overridden by specifying a [rowHeight](https://bryntum.com/products/grid/docs/api/Grid/data/GridRowModel#field-rowHeight) on a per record basis, or from
587
566
  * a column [renderer](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-renderer).
588
- * ...
589
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
567
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rowHeight)
590
568
  */
591
569
  rowHeight ? : number
592
570
  /**
@@ -595,15 +573,13 @@ defineProps<{
595
573
  rowLines ? : Boolean
596
574
  /**
597
575
  * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
598
- * ...
599
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rtl)
576
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-rtl)
600
577
  */
601
578
  rtl ? : Boolean
602
579
  /**
603
580
  * 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).
604
581
  * See the [scrollerClass](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollerClass) config option.
605
- * ...
606
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollable)
582
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-scrollable)
607
583
  */
608
584
  scrollable ? : Boolean|ScrollerConfig|Scroller
609
585
  /**
@@ -618,141 +594,122 @@ defineProps<{
618
594
  /**
619
595
  * Selection configuration settings, change these properties to control how selection works and what can be
620
596
  * selected.
621
- * ...
622
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-selectionMode)
597
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-selectionMode)
623
598
  */
624
599
  selectionMode ? : GridSelectionMode
625
600
  /**
626
601
  * Configure as `true` to have the grid show a red "changed" tag in cells whose
627
602
  * field value has changed and not yet been committed.
628
- * ...
629
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-showDirty)
603
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-showDirty)
604
+ * @property {boolean} showDirty.duringEdit Set to `true` to show the red tag while editing a cell
605
+ * @property {boolean} showDirty.newRecord Set to `true` to show the red tag for all the cells of the new record
630
606
  */
631
- showDirty ? : Boolean|{
632
- duringEdit?: Boolean
633
- newRecord?: Boolean
634
- }
607
+ showDirty ? : Boolean|{ duringEdit: Boolean, newRecord: Boolean }
635
608
  /**
636
609
  * Programmatic control over how many columns to span when used in a grid layout.
637
610
  */
638
611
  span ? : number
639
612
  /**
640
613
  * This value can be one of the following:
641
- * ...
642
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateful)
614
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateful)
643
615
  */
644
616
  stateful ? : Boolean|object|string[]
645
617
  /**
646
618
  * The events that, when fired by this component, should trigger it to save its state by calling
647
619
  * [saveState](https://bryntum.com/products/grid/docs/api/Core/mixin/State#function-saveState).
648
- * ...
649
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-statefulEvents)
620
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-statefulEvents)
650
621
  */
651
622
  statefulEvents ? : object|string[]
652
623
  /**
653
624
  * 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
654
625
  * 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)
655
626
  * (if explicitly specified) will be used as the `stateId`.
656
- * ...
657
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateId)
627
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateId)
658
628
  */
659
629
  stateId ? : string
660
630
  /**
661
631
  * 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`
662
632
  * will be saved using the [default state provider](https://bryntum.com/products/grid/docs/api/Core/state/StateProvider#property-instance-static).
663
- * ...
664
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateProvider)
633
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateProvider)
665
634
  */
666
635
  stateProvider ? : StateProvider
667
636
  /**
668
637
  * The properties of this settings object controls how grid is restored from state data.
669
- * ...
670
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateSettings)
638
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-stateSettings)
639
+ * @property {boolean} [restoreUnconfiguredColumns] Determines whether to restore columns from the state that are not explicitly defined in the grid configuration.
671
640
  */
672
- stateSettings ? : {
673
- restoreUnconfiguredColumns?: Boolean
674
- }
641
+ stateSettings ? : object
675
642
  /**
676
643
  * Store that holds records to display in the grid, or a store config object. If the configuration contains
677
644
  * a `readUrl`, an `AjaxStore` will be created.
678
- * ...
679
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-store)
645
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-store)
680
646
  */
681
647
  store ? : Store|StoreConfig|AjaxStore|AjaxStoreConfig
682
648
  /**
683
649
  * An object containing widgets keyed by name. By default (when no `type` is given), strips are
684
650
  * [toolbars](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
685
651
  * the toolbar's [items](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-items).
686
- * ...
687
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-strips)
652
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-strips)
688
653
  */
689
654
  strips ? : Record<string, GridContainerItemConfig>
690
655
  /**
691
656
  * An object containing sub grid configuration objects keyed by a `region` property.
692
657
  * By default, grid has a 'locked' region (if configured with locked columns) and a 'normal' region.
693
658
  * The 'normal' region defaults to use `flex: 1`.
694
- * ...
695
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-subGridConfigs)
659
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-subGridConfigs)
696
660
  */
697
661
  subGridConfigs ? : Record<string, SubGridConfig>
698
662
  /**
699
663
  * A [Mask](https://bryntum.com/products/grid/docs/api/Core/widget/Mask) config object, or a message to be shown when Crud Manager
700
664
  * is persisting changes on the server. Set to `null` to disable default sync mask.
701
- * ...
702
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-syncMask)
665
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-syncMask)
703
666
  */
704
667
  syncMask ? : string|MaskConfig|null
705
668
  /**
706
669
  * 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
707
670
  * [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
708
671
  * this widget:
709
- * ...
710
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tab)
672
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tab)
711
673
  */
712
674
  tab ? : Boolean|TabConfig
713
675
  /**
714
676
  * When this container is used as a tab in a TabPanel, these items are added to the
715
677
  * [TabBar](https://bryntum.com/products/grid/docs/api/Core/widget/TabBar) when this container is the active tab.
716
- * ...
717
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tabBarItems)
678
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tabBarItems)
718
679
  */
719
680
  tabBarItems ? : ToolbarItems[]|Widget[]
720
681
  /**
721
682
  * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/grid/docs/api/Core/widget/Toolbar),
722
683
  * or array of config objects representing the child items of a Toolbar.
723
684
  * This creates a toolbar docked to the top of the panel immediately below the header.
724
- * ...
725
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tbar)
685
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tbar)
726
686
  */
727
687
  tbar ? : (GridContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
728
688
  /**
729
689
  * A title to display in the header or owning TabPanel. Causes creation and docking of a header
730
690
  * to the top if no header is configured.
731
- * ...
732
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-title)
691
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-title)
733
692
  */
734
693
  title ? : string
735
694
  /**
736
695
  * 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
737
696
  * property name is the reference by which an instantiated tool may be retrieved from the live
738
697
  * `[tools](https://bryntum.com/products/grid/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
739
- * ...
740
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tools)
698
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-tools)
741
699
  */
742
700
  tools ? : Record<string, ToolConfig>|null
743
701
  /**
744
702
  * Configure UI transitions for various actions in the grid.
703
+ * @property {boolean} insertRecord Transition record insertions
704
+ * @property {boolean} removeRecord Transition record removals
705
+ * @property {boolean} toggleColumn Transition column visibility changes
706
+ * @property {boolean} expandCollapseColumn Transition parent/group column expand/collapse
707
+ * @property {boolean} toggleRegion Transition region expand/collapse
708
+ * @property {boolean} toggleTreeNode Transition tree node expand/collapse
709
+ * @property {boolean} toggleGroup Transition group expand/collapse
710
+ * @property {boolean} filterRemoval Transition row removals caused by filtering (under specific conditions)
745
711
  */
746
- transition ? : {
747
- insertRecord?: Boolean
748
- removeRecord?: Boolean
749
- toggleColumn?: Boolean
750
- expandCollapseColumn?: Boolean
751
- toggleRegion?: Boolean
752
- toggleTreeNode?: Boolean
753
- toggleGroup?: Boolean
754
- filterRemoval?: Boolean
755
- }
712
+ transition ? : object
756
713
  /**
757
714
  * Animation transition duration in milliseconds.
758
715
  */
@@ -761,8 +718,7 @@ defineProps<{
761
718
  * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
762
719
  * as a space separated string, an array of strings, or as an object in which property names with truthy
763
720
  * values are used as the class names.
764
- * ...
765
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ui)
721
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-ui)
766
722
  */
767
723
  ui ? : 'plain'|'toolbar'|string|object
768
724
  /**
@@ -783,129 +739,117 @@ defineProps<{
783
739
  * agent and see the responses. Which allows the user to use natural language to interact with the Grid in different
784
740
  * ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can
785
741
  * also perform data manipulation operations such as adding, updating, deleting records.
786
- * ...
787
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
742
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/AI)
788
743
  */
789
744
  aiFeature ? : object|Boolean|string|AI|AIConfig
790
745
  /**
791
746
  * AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
792
- * ...
793
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
747
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ai/AIFilter)
794
748
  */
795
749
  aiFilterFeature ? : object|Boolean|string|AIFilter|AIFilterConfig
796
750
  /**
797
751
  * Allows using `[Ctrl/CMD + C]`, `[Ctrl/CMD + X]` and `[Ctrl/CMD + V]` to cut, copy and paste cell or cell ranges. Also
798
752
  * makes cut, copy and paste actions available via the cell context menu.
799
- * ...
800
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
753
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellCopyPaste)
801
754
  */
802
755
  cellCopyPasteFeature ? : object|Boolean|string|CellCopyPaste|CellCopyPasteConfig
803
756
  /**
804
757
  * Adding this feature to the grid and other Bryntum products which are based on the Grid (i.e. Scheduler, SchedulerPro, and Gantt)
805
758
  * enables cell editing. Any subclass of [Field](https://bryntum.com/products/grid/docs/api/Core/widget/Field) can be used
806
759
  * as editor for the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column). The most popular are:
807
- * ...
808
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
760
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit)
809
761
  */
810
762
  cellEditFeature ? : object|Boolean|string|CellEdit|CellEditConfig
811
763
  /**
812
764
  * Right click to display context menu for cells. To invoke the cell menu in a keyboard-accessible manner, use the
813
765
  * <kbd>Space</kbd> key when the cell is focused.
814
- * ...
815
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
766
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellMenu)
816
767
  */
817
768
  cellMenuFeature ? : object|Boolean|string|CellMenu|CellMenuConfig
818
769
  /**
819
770
  * Displays a tooltip when hovering cells.
820
- * ...
821
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
771
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/CellTooltip)
822
772
  */
823
773
  cellTooltipFeature ? : object|Boolean|string|CellTooltip|CellTooltipConfig
824
774
  /**
825
775
  * 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
826
776
  * and updated in realtime as data changes. Supports many common chart types with extensive styling and customization
827
777
  * options.
828
- * ...
829
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
778
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Charts)
830
779
  */
831
780
  chartsFeature ? : object|Boolean|string|Charts|ChartsConfig
832
781
  /**
833
- * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns.
834
- * ...
835
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
782
+ * Enables the [autoWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-autoWidth) config for a grid's columns. When a column
783
+ * has `autoWidth` set, this feature measures the rendered content of all visible cells in that column
784
+ * and adjusts the column width to fit. The measurement is triggered automatically when data changes
785
+ * or rows are rendered.
786
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnAutoWidth)
836
787
  */
837
788
  columnAutoWidthFeature ? : object|Boolean|string|ColumnAutoWidth|ColumnAutoWidthConfig
838
789
  /**
839
790
  * Displays a toolbar while dragging column headers. Drop on a button in the toolbar to activate a certain function,
840
791
  * for example to group by that column. This feature simplifies certain operations on touch devices.
841
- * ...
842
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
792
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnDragToolbar)
843
793
  */
844
794
  columnDragToolbarFeature ? : object|Boolean|string|ColumnDragToolbar|ColumnDragToolbarConfig
845
795
  /**
846
796
  * Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus
847
797
  * by region or tag. Grouped headers are displayed as menu hierarchies.
848
- * ...
849
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
798
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnPicker)
850
799
  */
851
800
  columnPickerFeature ? : object|Boolean|string|ColumnPicker|ColumnPickerConfig
852
801
  /**
853
802
  * Allows user to rename columns by either right-clicking column header or using keyboard shortcuts when column header
854
803
  * is focused.
855
- * ...
856
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
804
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnRename)
857
805
  */
858
806
  columnRenameFeature ? : object|Boolean|string|ColumnRename|ColumnRenameConfig
859
807
  /**
860
- * Allows user to reorder columns by dragging headers. To get notified about column reorder listen to `change` event
861
- * on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
862
- * ...
863
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
808
+ * Allows user to reorder columns by dragging headers. Click and drag a column header to move it to a new position.
809
+ * Visual feedback shows the drop target while dragging. To get notified about column reorder, listen to the
810
+ * `change` event on the [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
811
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnReorder)
864
812
  */
865
813
  columnReorderFeature ? : object|Boolean|string|ColumnReorder|ColumnReorderConfig
866
814
  /**
867
- * Enables user to resize columns by dragging a handle on the right hand side of the header. To get notified about column
868
- * resize listen to `change` event on [columns](https://bryntum.com/products/grid/docs/api/Grid/data/ColumnStore) store.
869
- * ...
870
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
815
+ * Enables user to resize columns by dragging a handle on the right hand side of the header. A drag handle
816
+ * appears when hovering near the right edge of a column header. Dragging it adjusts the column width, respecting
817
+ * any [minWidth](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-minWidth) or [maxWidth](#Grid/column/Column#config-maxWidth) constraints.
818
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/ColumnResize)
871
819
  */
872
820
  columnResizeFeature ? : object|Boolean|string|ColumnResize|ColumnResizeConfig
873
821
  /**
874
822
  * A feature that allows exporting Grid data to Excel or CSV without involving the server. It uses
875
823
  * [TableExporter](https://bryntum.com/products/grid/docs/api/Grid/util/TableExporter) class as data provider, 3rd party provider to generate XLS files, and
876
824
  * [Microsoft XML specification](https://msdn.microsoft.com/en-us/library/office/documentformat.openxml.spreadsheet.aspx).
877
- * ...
878
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
825
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/ExcelExporter)
879
826
  */
880
827
  excelExporterFeature ? : object|Boolean|string|ExcelExporter|ExcelExporterConfig
881
828
  /**
882
- * An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it.
883
- * In the event, you get access to the raw files as strings, that were parsed by calling `readAsBinaryString`.
884
- * ...
885
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
829
+ * An experimental feature that lets users drop files on a Widget. The widget fires a
830
+ * [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
831
+ * files as strings, that were parsed by calling `readAsBinaryString`.
832
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/experimental/FileDrop)
886
833
  */
887
834
  fileDropFeature ? : object|Boolean|string|FileDrop|FileDropConfig
888
835
  /**
889
836
  * This feature adds a fill handle to a Grid range selection, which when dragged, fills the cells being dragged over
890
837
  * with values based on the values in the original selected range. This is similar to functionality normally seen in
891
838
  * various spreadsheet applications.
892
- * ...
893
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
839
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FillHandle)
894
840
  */
895
841
  fillHandleFeature ? : object|Boolean|string|FillHandle|FillHandleConfig
896
842
  /**
897
843
  * Feature that allows filtering of the grid by settings filters on columns. The actual filtering is done by the store.
898
844
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
899
- * ...
900
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
845
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Filter)
901
846
  */
902
847
  filterFeature ? : object|Boolean|string|Filter|FilterConfig
903
848
  /**
904
849
  * Feature that allows filtering of the grid by entering filters on column headers.
905
850
  * The actual filtering is done by the store.
906
851
  * For info on programmatically handling filters, see [StoreFilter](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreFilter).
907
- * ...
908
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
852
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/FilterBar)
909
853
  */
910
854
  filterBarFeature ? : object|Boolean|string|FilterBar|FilterBarConfig
911
855
  /**
@@ -913,141 +857,124 @@ defineProps<{
913
857
  * <kbd>Shift</kbd> + clicking headers, or by using the context menu, or by using two finger tap (one on header,
914
858
  * one anywhere on grid). Use <kbd>Shift</kbd> + <kbd>Alt</kbd> + click, or the context menu, to remove a column
915
859
  * grouper.
916
- * ...
917
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
860
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Group)
918
861
  */
919
862
  groupFeature ? : object|Boolean|string|Group|GroupConfig
920
863
  /**
921
864
  * Displays a summary row as a group footer in a grouped grid. Uses the same configuration options on columns as
922
865
  * [Summary](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary).
923
- * ...
924
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
866
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/GroupSummary)
925
867
  */
926
868
  groupSummaryFeature ? : object|Boolean|string|GroupSummary|GroupSummaryConfig
927
869
  /**
928
870
  * Right click column header or focus it and press SPACE key to show the context menu for headers.
929
- * ...
930
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
871
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu)
931
872
  */
932
873
  headerMenuFeature ? : object|Boolean|string|HeaderMenu|HeaderMenuConfig
933
874
  /**
934
875
  * This feature allows records which satisfy a certain condition to be locked at the top of the grid.
935
- * ...
936
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
876
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/LockRows)
937
877
  */
938
878
  lockRowsFeature ? : object|Boolean|string|LockRows|LockRowsConfig
939
879
  /**
940
880
  * 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
941
881
  * configured to [mergeCells](https://bryntum.com/products/grid/docs/api/Grid/column/Column#config-mergeCells).
942
- * ...
943
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
882
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/MergeCells)
944
883
  */
945
884
  mergeCellsFeature ? : object|Boolean|string|MergeCells|MergeCellsConfig
946
885
  /**
947
886
  * Generates PDF/PNG files from the Grid component.
948
- * ...
949
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
887
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/PdfExport)
950
888
  */
951
889
  pdfExportFeature ? : object|Boolean|string|PdfExport|PdfExportConfig
952
890
  /**
953
891
  * Allows pinning columns to the start or end region of the grid without any additional subGrid configurations.
954
892
  * When pinning to a region that does not yet exist, the feature creates the required subGrid on the fly.
955
- * ...
956
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
893
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/PinColumns)
957
894
  */
958
895
  pinColumnsFeature ? : object|Boolean|string|PinColumns|PinColumnsConfig
959
896
  /**
960
897
  * Allows printing Grid contents using browser print dialog.
961
- * ...
962
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
898
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/export/Print)
963
899
  */
964
900
  printFeature ? : object|Boolean|string|Print|PrintConfig
965
901
  /**
966
902
  * Feature that allows the user to search in a column by focusing a cell and typing. Navigate between hits using the
967
- * keyboard, [f3] or [ctrl]/[cmd] + [g] moves to next, also pressing [shift] moves to previous.
968
- * ...
969
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
903
+ * keyboard, <kbd>f3</kbd> or <kbd>ctrl</kbd>/<kbd>cmd</kbd> + <kbd>g</kbd> moves to next, also pressing
904
+ * <kbd>shift</kbd> moves to previous.
905
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/QuickFind)
970
906
  */
971
907
  quickFindFeature ? : object|Boolean|string|QuickFind|QuickFindConfig
972
908
  /**
973
909
  * Makes the splitter between grid [sections](https://bryntum.com/products/grid/docs/api/Grid/view/SubGrid) draggable, to let users resize, and
974
910
  * collapse/expand the sections.
975
- * ...
976
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
911
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RegionResize)
977
912
  */
978
913
  regionResizeFeature ? : object|Boolean|string|RegionResize|RegionResizeConfig
979
914
  /**
980
915
  * Allow using [Ctrl/CMD + C/X] and [Ctrl/CMD + V] to copy/cut-and-paste rows. Also makes cut, copy and paste actions
981
916
  * available via the cell context menu.
982
- * ...
983
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
917
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowCopyPaste)
984
918
  */
985
919
  rowCopyPasteFeature ? : object|Boolean|string|RowCopyPaste|RowCopyPasteConfig
986
920
  /**
987
921
  * This feature allows editing of entire rows in a grid in a docked panel which by default slides out from the right.
988
- * ...
989
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
922
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowEdit)
990
923
  */
991
924
  rowEditFeature ? : object|Boolean|string|RowEdit|RowEditConfig
992
925
  /**
993
926
  * Enables expanding of Grid rows by either row click or double click, or by adding a separate Grid column which renders
994
927
  * a button that expands or collapses the row.
995
- * ...
996
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
928
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowExpander)
997
929
  */
998
930
  rowExpanderFeature ? : object|Boolean|string|RowExpander|RowExpanderConfig
999
931
  /**
1000
932
  * Allows user to reorder rows by dragging them. To get notified about row reorder listen to `change` event
1001
933
  * on the grid [store](https://bryntum.com/products/grid/docs/api/Core/data/Store).
1002
- * ...
1003
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
934
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowReorder)
1004
935
  */
1005
936
  rowReorderFeature ? : object|Boolean|string|RowReorder|RowReorderConfig
1006
937
  /**
1007
938
  * 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)
1008
939
  * field of the record is updated (when [applyToAllRows](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize#config-applyToAllRows) is `false`).
1009
- * ...
1010
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
940
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/RowResize)
1011
941
  */
1012
942
  rowResizeFeature ? : object|Boolean|string|RowResize|RowResizeConfig
1013
943
  /**
1014
944
  * <div class="external-example vertical" data-file="Grid/feature/Search.js"></div>
1015
- * ...
1016
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
945
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Search)
1017
946
  */
1018
947
  searchFeature ? : object|Boolean|string|Search|SearchConfig
1019
948
  /**
1020
949
  * Allows sorting of grid by clicking (or tapping) headers, also displays which columns grid is sorted by (numbered if
1021
950
  * using multisort). Use modifier keys for multisorting: [Ctrl/CMD + click] to add sorter, [Ctrl/CMD + Alt + click] to remove sorter.
1022
951
  * The actual sorting is done by the store, see [Store.sort()](https://bryntum.com/products/grid/docs/api/Core/data/mixin/StoreSort#function-sort).
1023
- * ...
1024
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
952
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Sort)
1025
953
  */
1026
954
  sortFeature ? : object|Boolean|string|Sort|SortConfig
1027
955
  /**
1028
956
  * This feature allows splitting the Grid into multiple views, either by using the cell context menu, or
1029
957
  * programmatically by calling [split()](https://bryntum.com/products/grid/docs/api/Grid/feature/Split#function-split).
1030
- * ...
1031
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
958
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Split)
1032
959
  */
1033
960
  splitFeature ? : object|Boolean|string|Split|SplitConfig
1034
961
  /**
1035
- * A feature which pins configurable content from a grid row to the top of the grid
1036
- * while the row scrolls off the top but is still visible.
1037
- * ...
1038
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
962
+ * A feature which pins cell content to the top of the grid while the row scrolls off the top but is still visible. Very
963
+ * similar to native `position: sticky`, which because of Grid's multiple-region setup unfortunately cannot be used to
964
+ * achieve the same effect.
965
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/StickyCells)
1039
966
  */
1040
967
  stickyCellsFeature ? : object|Boolean|string|StickyCells|StickyCellsConfig
1041
968
  /**
1042
969
  * Stripes rows by adding alternating CSS classes to all row elements (`b-even` and `b-odd`).
1043
- * ...
1044
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
970
+ * This improves visual readability in data-heavy grids by giving adjacent rows different background colors.
971
+ * Style the striped rows using the `.b-even` and `.b-odd` CSS classes.
972
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Stripe)
1045
973
  */
1046
974
  stripeFeature ? : object|Boolean|string|Stripe|StripeConfig
1047
975
  /**
1048
976
  * Displays a summary row in the grid footer.
1049
- * ...
1050
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
977
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Summary)
1051
978
  */
1052
979
  summaryFeature ? : object|Boolean|string|Summary|SummaryConfig
1053
980
  /**
@@ -1055,15 +982,13 @@ defineProps<{
1055
982
  * 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
1056
983
  * tree renderer that adds padding and icon to give the appearance of a tree. The original renderer is preserved and
1057
984
  * also called.
1058
- * ...
1059
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
985
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/Tree)
1060
986
  */
1061
987
  treeFeature ? : object|Boolean|string|Tree|TreeConfig
1062
988
  /**
1063
989
  * A feature that allows transforming a flat dataset (or the leaves of a hierarchical) into a tree by specifying a
1064
990
  * record field per parent level. Parents are generated based on each leaf's value for those fields.
1065
- * ...
1066
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
991
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/feature/TreeGroup)
1067
992
  */
1068
993
  treeGroupFeature ? : object|Boolean|string|TreeGroup|TreeGroupConfig
1069
994
 
@@ -1083,8 +1008,7 @@ const emit = defineEmits<{
1083
1008
  (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1084
1009
  /**
1085
1010
  * 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.
1086
- * ...
1087
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
1011
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
1088
1012
  * @param {string} e Event name
1089
1013
  * @param {object} params Event parameters
1090
1014
  * @param {string} params.e Event name
@@ -1255,8 +1179,7 @@ const emit = defineEmits<{
1255
1179
  (e: 'beforeFinishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1256
1180
  /**
1257
1181
  * 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.
1258
- * ...
1259
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeFinishRowEdit)
1182
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeFinishRowEdit)
1260
1183
  * @param {string} e Event name
1261
1184
  * @param {object} params Event parameters
1262
1185
  * @param {string} params.e Event name
@@ -1325,8 +1248,7 @@ const emit = defineEmits<{
1325
1248
  (e: 'beforeRenderRows', params: ((event: { source: GridBase }) => void)|string): void
1326
1249
  /**
1327
1250
  * This event fires before row collapse is started.
1328
- * ...
1329
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowCollapse)
1251
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowCollapse)
1330
1252
  * @param {string} e Event name
1331
1253
  * @param {object} params Event parameters
1332
1254
  * @param {string} params.e Event name
@@ -1337,8 +1259,7 @@ const emit = defineEmits<{
1337
1259
  (e: 'beforeRowCollapse', params: ((event: { record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
1338
1260
  /**
1339
1261
  * This event fires before row expand is started.
1340
- * ...
1341
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowExpand)
1262
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeRowExpand)
1342
1263
  * @param {string} e Event name
1343
1264
  * @param {object} params Event parameters
1344
1265
  * @param {string} params.e Event name
@@ -1458,8 +1379,7 @@ const emit = defineEmits<{
1458
1379
  (e: 'cancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation, event: Event }) => void)|string): void
1459
1380
  /**
1460
1381
  * Fires when any other event is fired from the object.
1461
- * ...
1462
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-catchAll)
1382
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-catchAll)
1463
1383
  * @param {string} e Event name
1464
1384
  * @param {object} params Event parameters
1465
1385
  * @param {string} params.e Event name
@@ -1517,8 +1437,7 @@ const emit = defineEmits<{
1517
1437
  /**
1518
1438
  * This event fires on the owning grid before the context menu is shown for a cell.
1519
1439
  * 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).
1520
- * ...
1521
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-cellMenuBeforeShow)
1440
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-cellMenuBeforeShow)
1522
1441
  * @param {string} e Event name
1523
1442
  * @param {object} params Event parameters
1524
1443
  * @param {string} params.e Event name
@@ -1775,8 +1694,7 @@ const emit = defineEmits<{
1775
1694
  (e: 'copy', params: ((event: { source: Grid, cells: GridLocation[], copiedDataString: string, isCut: boolean, entityName: string }) => void)|string): void
1776
1695
  /**
1777
1696
  * Fired when data in the store changes.
1778
- * ...
1779
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
1697
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
1780
1698
  * @param {string} e Event name
1781
1699
  * @param {object} params Event parameters
1782
1700
  * @param {string} params.e Event name
@@ -1932,8 +1850,7 @@ const emit = defineEmits<{
1932
1850
  (e: 'finishCellEdit', params: ((event: { grid: Grid, editorContext: CellEditorContext }) => void)|string): void
1933
1851
  /**
1934
1852
  * 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.
1935
- * ...
1936
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-finishRowEdit)
1853
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-finishRowEdit)
1937
1854
  * @param {string} e Event name
1938
1855
  * @param {object} params Event parameters
1939
1856
  * @param {string} params.e Event name
@@ -2069,8 +1986,7 @@ const emit = defineEmits<{
2069
1986
  (e: 'gridRowDrop', params: ((event: { source: GridBase, context: { valid: boolean, insertBefore: Model, parent: Model, records: Model[], oldPositionContext: RecordPositionContext[] }, event: MouseEvent }) => void)|string): void
2070
1987
  /**
2071
1988
  * Fired when a grid header is clicked on.
2072
- * ...
2073
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerClick)
1989
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerClick)
2074
1990
  * @param {string} e Event name
2075
1991
  * @param {object} params Event parameters
2076
1992
  * @param {string} params.e Event name
@@ -2083,8 +1999,7 @@ const emit = defineEmits<{
2083
1999
  /**
2084
2000
  * This event fires on the owning Grid before the context menu is shown for a header.
2085
2001
  * 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).
2086
- * ...
2087
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerMenuBeforeShow)
2002
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-headerMenuBeforeShow)
2088
2003
  * @param {string} e Event name
2089
2004
  * @param {object} params Event parameters
2090
2005
  * @param {string} params.e Event name
@@ -2179,8 +2094,7 @@ const emit = defineEmits<{
2179
2094
  /**
2180
2095
  * Triggered when a widget which had been in a non-visible state for any reason
2181
2096
  * achieves visibility.
2182
- * ...
2183
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-paint)
2097
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-paint)
2184
2098
  * @param {string} e Event name
2185
2099
  * @param {object} params Event parameters
2186
2100
  * @param {string} params.e Event name
@@ -2211,8 +2125,8 @@ const emit = defineEmits<{
2211
2125
  * @param {string} params.e Event name
2212
2126
  * @param {object} params.params Event parameters
2213
2127
  * @param {object} params.params.event Event object
2214
- * @param {Response} params.params.event.response Optional response, if received
2215
- * @param {Error} params.params.event.error Optional error, if exception occurred
2128
+ * @param {Response} [params.params.event.response] Optional response, if received
2129
+ * @param {Error} [params.params.event.error] Optional error, if exception occurred
2216
2130
  */
2217
2131
  (e: 'pdfExport', params: ((event: { response?: Response, error?: Error }) => void)|string): void
2218
2132
  /**
@@ -2293,8 +2207,7 @@ const emit = defineEmits<{
2293
2207
  (e: 'rowCollapse', params: ((event: { record: Model }) => void)|string): void
2294
2208
  /**
2295
2209
  * This event fires when a row expand has finished expanding.
2296
- * ...
2297
- * [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-rowExpand)
2210
+ * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-rowExpand)
2298
2211
  * @param {string} e Event name
2299
2212
  * @param {object} params Event parameters
2300
2213
  * @param {string} params.e Event name
@@ -2500,7 +2413,7 @@ const emit = defineEmits<{
2500
2413
  * @param {Core.data.Model} params.params.event.groupRecord [DEPRECATED] Use `groupRecords` param instead
2501
2414
  * @param {Core.data.Model[]} params.params.event.groupRecords The group records being toggled
2502
2415
  * @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
2503
- * @param {boolean} params.params.event.allRecords True if this event is part of toggling all groups
2416
+ * @param {boolean} [params.params.event.allRecords] True if this event is part of toggling all groups
2504
2417
  */
2505
2418
  (e: 'toggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, allRecords?: boolean }) => void)|string): void
2506
2419
  /**
@@ -2661,6 +2574,7 @@ const widgetData = {
2661
2574
  'resizeToFitIncludesHeader',
2662
2575
  'responsiveLevels',
2663
2576
  'ripple',
2577
+ 'role',
2664
2578
  'rootElement',
2665
2579
  'scrollerClass',
2666
2580
  'scrollManager',
@@ -2707,6 +2621,7 @@ const widgetData = {
2707
2621
  'insertFirst',
2708
2622
  'keyMap',
2709
2623
  'labelPosition',
2624
+ 'labelWidth',
2710
2625
  'longPressTime',
2711
2626
  'margin',
2712
2627
  'maxHeight',
@@ -2850,8 +2765,6 @@ const widgetData = {
2850
2765
  'width'
2851
2766
  ],
2852
2767
  propertyNames : [
2853
- 'focusVisible',
2854
- 'hasChanges',
2855
2768
  'originalStore',
2856
2769
  'parent',
2857
2770
  'selectedCell',