@bryntum/grid-trial 7.1.1 → 7.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +265 -19
- package/fluent2-dark.css +1 -1
- package/fluent2-light.css +1 -1
- package/grid.css +2 -2
- package/grid.d.ts +125 -48
- package/grid.lwc.module.d.ts +1 -1
- package/grid.lwc.module.js +2 -2
- package/grid.module.d.ts +1 -1
- package/grid.module.js +44 -44
- package/grid.thin.d.ts +59 -37
- package/grid.umd.d.ts +1 -1
- package/grid.umd.js +46 -46
- package/grid.wc.module.d.ts +1 -1
- package/grid.wc.module.js +44 -44
- package/high-contrast-dark.css +1 -1
- package/high-contrast-light.css +1 -1
- package/material3-dark.css +1 -1
- package/material3-light.css +1 -1
- package/package.json +2 -2
- package/postinstall.js +4 -4
- package/stockholm-dark.css +1 -1
- package/stockholm-light.css +1 -1
- package/svalbard-dark.css +1 -1
- package/svalbard-light.css +1 -1
- package/visby-dark.css +1 -1
- package/visby-light.css +1 -1
package/grid.thin.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/*!
|
|
2
2
|
*
|
|
3
|
-
* Bryntum Grid 7.1.
|
|
3
|
+
* Bryntum Grid 7.1.2 (TRIAL VERSION)
|
|
4
4
|
*
|
|
5
5
|
* Copyright(c) 2026 Bryntum AB
|
|
6
6
|
* https://bryntum.com/contact
|
|
@@ -349,10 +349,16 @@ type ActionConfig = {
|
|
|
349
349
|
*/
|
|
350
350
|
cls?: string
|
|
351
351
|
/**
|
|
352
|
-
* A text to use for the action element
|
|
353
|
-
* action
|
|
352
|
+
* A text to use for the action element's `aria-label` value. If not provided, the
|
|
353
|
+
* action's `tooltip` will be used as the `aria-label` (if present).
|
|
354
354
|
*/
|
|
355
355
|
ariaLabel?: string
|
|
356
|
+
/**
|
|
357
|
+
* A value to use for the action element's `aria-haspopup` attribute.
|
|
358
|
+
* Set to indicate that the action triggers a popup. This helps assistive technologies inform users that activating
|
|
359
|
+
* the action will display a popup element.
|
|
360
|
+
*/
|
|
361
|
+
ariaHasPopup?: 'true'|'false'|'menu'|'listbox'|'tree'|'grid'|'dialog'|boolean
|
|
356
362
|
/**
|
|
357
363
|
* Tooltip text, or a config object which can reconfigure the shared
|
|
358
364
|
* tooltip by setting boolean, numeric and string config values, or a function to return the tooltip text, passed the
|
|
@@ -612,7 +618,7 @@ type EmptyTextDomConfig = DomConfig & {
|
|
|
612
618
|
/**
|
|
613
619
|
* The grid region to add the empty text to
|
|
614
620
|
*/
|
|
615
|
-
region?: string
|
|
621
|
+
region?: 'locked'|'normal'|string
|
|
616
622
|
}
|
|
617
623
|
|
|
618
624
|
type GridScrollOptions = {
|
|
@@ -3281,7 +3287,7 @@ type CheckColumnConfig = {
|
|
|
3281
3287
|
*/
|
|
3282
3288
|
cellMenuItems?: Record<string, MenuItemEntry>
|
|
3283
3289
|
/**
|
|
3284
|
-
* The `aria-label`
|
|
3290
|
+
* The `aria-label` used for the default checkbox widget in this column’s cells.
|
|
3285
3291
|
*/
|
|
3286
3292
|
checkAriaLabel?: string
|
|
3287
3293
|
/**
|
|
@@ -3840,7 +3846,7 @@ export class CheckColumn extends WidgetColumn {
|
|
|
3840
3846
|
*/
|
|
3841
3847
|
static readonly isCheckColumn: boolean
|
|
3842
3848
|
/**
|
|
3843
|
-
* The `aria-label`
|
|
3849
|
+
* The `aria-label` used for the default checkbox widget in this column’s cells.
|
|
3844
3850
|
*/
|
|
3845
3851
|
checkAriaLabel: string
|
|
3846
3852
|
/**
|
|
@@ -12077,7 +12083,8 @@ type TimeColumnConfig = {
|
|
|
12077
12083
|
*/
|
|
12078
12084
|
flex?: number|string
|
|
12079
12085
|
/**
|
|
12080
|
-
* Time format
|
|
12086
|
+
* Time format for time displayed in cell and editor
|
|
12087
|
+
* (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
|
|
12081
12088
|
*/
|
|
12082
12089
|
format?: string
|
|
12083
12090
|
/**
|
|
@@ -12474,7 +12481,8 @@ export class TimeColumn extends Column {
|
|
|
12474
12481
|
*/
|
|
12475
12482
|
static readonly isTimeColumn: boolean
|
|
12476
12483
|
/**
|
|
12477
|
-
* Time format
|
|
12484
|
+
* Time format for time displayed in cell and editor
|
|
12485
|
+
* (see [format](https://bryntum.com/products/grid/docs/api/Core/helper/DateHelper#function-format-static) for formatting options)
|
|
12478
12486
|
*/
|
|
12479
12487
|
format: string
|
|
12480
12488
|
/**
|
|
@@ -14732,7 +14740,9 @@ type ColumnStoreConfig = {
|
|
|
14732
14740
|
*/
|
|
14733
14741
|
pageStartParamName?: string
|
|
14734
14742
|
/**
|
|
14735
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
14743
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
14744
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
14745
|
+
* that changes a node's parent.
|
|
14736
14746
|
*/
|
|
14737
14747
|
reapplyFilterOnAdd?: boolean
|
|
14738
14748
|
/**
|
|
@@ -27389,9 +27399,9 @@ export class PdfExport extends InstancePlugin {
|
|
|
27389
27399
|
/**
|
|
27390
27400
|
* Starts the export process. Accepts a config object which overrides any default configs.
|
|
27391
27401
|
* <strong>NOTE</strong>. Component should not be interacted with when export is in progress
|
|
27392
|
-
* @param {
|
|
27402
|
+
* @param {PdfExportConfig} config
|
|
27393
27403
|
*/
|
|
27394
|
-
export(config:
|
|
27404
|
+
export(config: PdfExportConfig): Promise<any>;
|
|
27395
27405
|
/**
|
|
27396
27406
|
* This method accepts all stylesheets (link and style tags) which are supposed to be put on the page. Use
|
|
27397
27407
|
* this hook method to filter or modify them.
|
|
@@ -27803,9 +27813,9 @@ export class Print extends PdfExport {
|
|
|
27803
27813
|
/**
|
|
27804
27814
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
27805
27815
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
27806
|
-
* @param {
|
|
27816
|
+
* @param {PrintConfig} config
|
|
27807
27817
|
*/
|
|
27808
|
-
print(config:
|
|
27818
|
+
print(config: PrintConfig): Promise<any>;
|
|
27809
27819
|
/**
|
|
27810
27820
|
* Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
|
|
27811
27821
|
*/
|
|
@@ -29155,9 +29165,9 @@ export class PrintMixinClass {
|
|
|
29155
29165
|
/**
|
|
29156
29166
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
29157
29167
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
29158
|
-
* @param {
|
|
29168
|
+
* @param {PrintConfig} config
|
|
29159
29169
|
*/
|
|
29160
|
-
print(config:
|
|
29170
|
+
print(config: PrintConfig): Promise<any>;
|
|
29161
29171
|
/**
|
|
29162
29172
|
* Shows the [print dialog](https://bryntum.com/products/grid/docs/api/Grid/view/export/ExportDialog)
|
|
29163
29173
|
*/
|
|
@@ -29345,6 +29355,10 @@ export class GridLocation {
|
|
|
29345
29355
|
* The cell DOM element which this `GridLocation` references.
|
|
29346
29356
|
*/
|
|
29347
29357
|
readonly cell: HTMLElement
|
|
29358
|
+
/**
|
|
29359
|
+
* Yields the [Column](https://bryntum.com/products/grid/docs/api/Grid/column/Column) of this location.
|
|
29360
|
+
*/
|
|
29361
|
+
readonly column: Column
|
|
29348
29362
|
/**
|
|
29349
29363
|
* Yields the column index of this location.
|
|
29350
29364
|
*/
|
|
@@ -29353,6 +29367,10 @@ export class GridLocation {
|
|
|
29353
29367
|
* This property is `true` if the focus is inside the cell, not *on* the cell.
|
|
29354
29368
|
*/
|
|
29355
29369
|
readonly containsFocus: boolean
|
|
29370
|
+
/**
|
|
29371
|
+
* The grid which this `GridLocation` references.
|
|
29372
|
+
*/
|
|
29373
|
+
readonly grid: Grid
|
|
29356
29374
|
/**
|
|
29357
29375
|
* This property is `true` if the focus target is not the cell itself.
|
|
29358
29376
|
*/
|
|
@@ -29369,6 +29387,10 @@ export class GridLocation {
|
|
|
29369
29387
|
* Yields `true` if the cell and row are selectable.
|
|
29370
29388
|
*/
|
|
29371
29389
|
readonly isSelectable: boolean
|
|
29390
|
+
/**
|
|
29391
|
+
* Yields the [Model](https://bryntum.com/products/grid/docs/api/Core/data/Model) of this location, or `null` if the location is a column header.
|
|
29392
|
+
*/
|
|
29393
|
+
readonly record: Model
|
|
29372
29394
|
/**
|
|
29373
29395
|
* Yields the row index of this location.
|
|
29374
29396
|
*/
|
|
@@ -29607,9 +29629,9 @@ type GridListenersTypes = {
|
|
|
29607
29629
|
/**
|
|
29608
29630
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
29609
29631
|
* @param {object} event Event object
|
|
29610
|
-
* @param {
|
|
29632
|
+
* @param {PdfExportConfig} event.config Export config
|
|
29611
29633
|
*/
|
|
29612
|
-
beforePdfExport: (event: { config:
|
|
29634
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
29613
29635
|
/**
|
|
29614
29636
|
* Fires before a row is rendered.
|
|
29615
29637
|
* @param {object} event Event object
|
|
@@ -30610,9 +30632,9 @@ type GridListeners = {
|
|
|
30610
30632
|
/**
|
|
30611
30633
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
30612
30634
|
* @param {object} event Event object
|
|
30613
|
-
* @param {
|
|
30635
|
+
* @param {PdfExportConfig} event.config Export config
|
|
30614
30636
|
*/
|
|
30615
|
-
beforePdfExport?: ((event: { config:
|
|
30637
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
30616
30638
|
/**
|
|
30617
30639
|
* Fires before a row is rendered.
|
|
30618
30640
|
* @param {object} event Event object
|
|
@@ -32448,9 +32470,9 @@ type GridConfig = {
|
|
|
32448
32470
|
/**
|
|
32449
32471
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
32450
32472
|
* @param {object} event Event object
|
|
32451
|
-
* @param {
|
|
32473
|
+
* @param {PdfExportConfig} event.config Export config
|
|
32452
32474
|
*/
|
|
32453
|
-
onBeforePdfExport?: ((event: { config:
|
|
32475
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
32454
32476
|
/**
|
|
32455
32477
|
* Fires before a row is rendered.
|
|
32456
32478
|
* @param {object} event Event object
|
|
@@ -33670,9 +33692,9 @@ type GridBaseListenersTypes = {
|
|
|
33670
33692
|
/**
|
|
33671
33693
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
33672
33694
|
* @param {object} event Event object
|
|
33673
|
-
* @param {
|
|
33695
|
+
* @param {PdfExportConfig} event.config Export config
|
|
33674
33696
|
*/
|
|
33675
|
-
beforePdfExport: (event: { config:
|
|
33697
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
33676
33698
|
/**
|
|
33677
33699
|
* Fires before a row is rendered.
|
|
33678
33700
|
* @param {object} event Event object
|
|
@@ -34673,9 +34695,9 @@ type GridBaseListeners = {
|
|
|
34673
34695
|
/**
|
|
34674
34696
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
34675
34697
|
* @param {object} event Event object
|
|
34676
|
-
* @param {
|
|
34698
|
+
* @param {PdfExportConfig} event.config Export config
|
|
34677
34699
|
*/
|
|
34678
|
-
beforePdfExport?: ((event: { config:
|
|
34700
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
34679
34701
|
/**
|
|
34680
34702
|
* Fires before a row is rendered.
|
|
34681
34703
|
* @param {object} event Event object
|
|
@@ -36510,9 +36532,9 @@ type GridBaseConfig = {
|
|
|
36510
36532
|
/**
|
|
36511
36533
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
36512
36534
|
* @param {object} event Event object
|
|
36513
|
-
* @param {
|
|
36535
|
+
* @param {PdfExportConfig} event.config Export config
|
|
36514
36536
|
*/
|
|
36515
|
-
onBeforePdfExport?: ((event: { config:
|
|
36537
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
36516
36538
|
/**
|
|
36517
36539
|
* Fires before a row is rendered.
|
|
36518
36540
|
* @param {object} event Event object
|
|
@@ -37836,9 +37858,9 @@ export class GridBase extends Panel {
|
|
|
37836
37858
|
/**
|
|
37837
37859
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
37838
37860
|
* @param {object} event Event object
|
|
37839
|
-
* @param {
|
|
37861
|
+
* @param {PdfExportConfig} event.config Export config
|
|
37840
37862
|
*/
|
|
37841
|
-
onBeforePdfExport: ((event: { config:
|
|
37863
|
+
onBeforePdfExport: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
37842
37864
|
/**
|
|
37843
37865
|
* Fires before a row is rendered.
|
|
37844
37866
|
* @param {object} event Event object
|
|
@@ -38841,9 +38863,9 @@ export class GridBase extends Panel {
|
|
|
38841
38863
|
/**
|
|
38842
38864
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
38843
38865
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
38844
|
-
* @param {
|
|
38866
|
+
* @param {PrintConfig} config
|
|
38845
38867
|
*/
|
|
38846
|
-
print(config:
|
|
38868
|
+
print(config: PrintConfig): Promise<any>;
|
|
38847
38869
|
/**
|
|
38848
38870
|
* Triggers a render of all the cells in a column.
|
|
38849
38871
|
* @param {Grid.column.Column,Grid.column.Column[]} column
|
|
@@ -40145,9 +40167,9 @@ type TreeGridListenersTypes = {
|
|
|
40145
40167
|
/**
|
|
40146
40168
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
40147
40169
|
* @param {object} event Event object
|
|
40148
|
-
* @param {
|
|
40170
|
+
* @param {PdfExportConfig} event.config Export config
|
|
40149
40171
|
*/
|
|
40150
|
-
beforePdfExport: (event: { config:
|
|
40172
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
40151
40173
|
/**
|
|
40152
40174
|
* Fires before a row is rendered.
|
|
40153
40175
|
* @param {object} event Event object
|
|
@@ -41148,9 +41170,9 @@ type TreeGridListeners = {
|
|
|
41148
41170
|
/**
|
|
41149
41171
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
41150
41172
|
* @param {object} event Event object
|
|
41151
|
-
* @param {
|
|
41173
|
+
* @param {PdfExportConfig} event.config Export config
|
|
41152
41174
|
*/
|
|
41153
|
-
beforePdfExport?: ((event: { config:
|
|
41175
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
41154
41176
|
/**
|
|
41155
41177
|
* Fires before a row is rendered.
|
|
41156
41178
|
* @param {object} event Event object
|
|
@@ -42986,9 +43008,9 @@ type TreeGridConfig = {
|
|
|
42986
43008
|
/**
|
|
42987
43009
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
42988
43010
|
* @param {object} event Event object
|
|
42989
|
-
* @param {
|
|
43011
|
+
* @param {PdfExportConfig} event.config Export config
|
|
42990
43012
|
*/
|
|
42991
|
-
onBeforePdfExport?: ((event: { config:
|
|
43013
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
42992
43014
|
/**
|
|
42993
43015
|
* Fires before a row is rendered.
|
|
42994
43016
|
* @param {object} event Event object
|