@bryntum/grid-react-thin 7.3.0 → 7.3.1
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 +5 -5
- package/lib/BryntumAIFilterField.d.ts +2 -1
- package/lib/BryntumAIFilterField.js +1 -0
- package/lib/BryntumAIFilterField.js.map +1 -1
- package/lib/BryntumChecklistFilterCombo.d.ts +2 -1
- package/lib/BryntumChecklistFilterCombo.js +1 -0
- package/lib/BryntumChecklistFilterCombo.js.map +1 -1
- package/lib/BryntumGrid.d.ts +25 -25
- package/lib/BryntumGridBase.d.ts +25 -25
- package/lib/BryntumGridChartDesigner.d.ts +1 -1
- package/lib/BryntumGridFieldFilterPicker.d.ts +1 -1
- package/lib/BryntumGridFieldFilterPickerGroup.d.ts +2 -2
- package/lib/BryntumGroupBar.d.ts +2 -2
- package/lib/BryntumTreeCombo.d.ts +2 -1
- package/lib/BryntumTreeCombo.js +1 -0
- package/lib/BryntumTreeCombo.js.map +1 -1
- package/lib/BryntumTreeGrid.d.ts +25 -25
- package/package.json +1 -1
- package/src/BryntumAIFilterField.tsx +11 -1
- package/src/BryntumChecklistFilterCombo.tsx +11 -1
- package/src/BryntumGrid.tsx +25 -25
- package/src/BryntumGridBase.tsx +25 -25
- package/src/BryntumGridChartDesigner.tsx +1 -1
- package/src/BryntumGridFieldFilterPicker.tsx +1 -1
- package/src/BryntumGridFieldFilterPickerGroup.tsx +2 -2
- package/src/BryntumGroupBar.tsx +2 -2
- package/src/BryntumTreeCombo.tsx +11 -1
- package/src/BryntumTreeGrid.tsx +25 -25
package/lib/BryntumTreeGrid.d.ts
CHANGED
|
@@ -157,7 +157,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
157
157
|
onBeforeCancelCellEdit?: ((event: {
|
|
158
158
|
source: Grid;
|
|
159
159
|
editorContext: GridLocation;
|
|
160
|
-
}) =>
|
|
160
|
+
}) => boolean | void) | string;
|
|
161
161
|
onBeforeCancelRowEdit?: ((event: {
|
|
162
162
|
grid: Grid;
|
|
163
163
|
editorContext: RowEditorContext;
|
|
@@ -165,16 +165,16 @@ export declare type BryntumTreeGridProps = {
|
|
|
165
165
|
onBeforeCellEditStart?: ((event: {
|
|
166
166
|
source: Grid;
|
|
167
167
|
editorContext: CellEditorContext;
|
|
168
|
-
}) =>
|
|
168
|
+
}) => boolean | void) | string;
|
|
169
169
|
onBeforeCellRangeDelete?: ((event: {
|
|
170
170
|
source: Grid;
|
|
171
171
|
gridSelection: (GridLocation | Model)[];
|
|
172
|
-
}) =>
|
|
172
|
+
}) => boolean | void) | string;
|
|
173
173
|
onBeforeCellRangeEdit?: ((event: {
|
|
174
174
|
record: Model;
|
|
175
175
|
field: string;
|
|
176
176
|
value: any;
|
|
177
|
-
}) =>
|
|
177
|
+
}) => boolean | void) | string;
|
|
178
178
|
onBeforeColumnCollapseToggle?: ((event: {
|
|
179
179
|
source: GridBase;
|
|
180
180
|
column: Column;
|
|
@@ -184,7 +184,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
184
184
|
source: Grid;
|
|
185
185
|
column: Column;
|
|
186
186
|
event: Event;
|
|
187
|
-
}) =>
|
|
187
|
+
}) => boolean | void) | string;
|
|
188
188
|
onBeforeColumnDropFinalize?: ((event: {
|
|
189
189
|
source: Grid;
|
|
190
190
|
column: Column;
|
|
@@ -192,12 +192,12 @@ export declare type BryntumTreeGridProps = {
|
|
|
192
192
|
newParent: Column;
|
|
193
193
|
event: Event;
|
|
194
194
|
region: string;
|
|
195
|
-
}) =>
|
|
195
|
+
}) => boolean | void) | string;
|
|
196
196
|
onBeforeColumnResize?: ((event: {
|
|
197
197
|
source: Grid;
|
|
198
198
|
column: Column;
|
|
199
199
|
domEvent: Event;
|
|
200
|
-
}) =>
|
|
200
|
+
}) => boolean | void) | string;
|
|
201
201
|
onBeforeCopy?: ((event: {
|
|
202
202
|
source: Grid;
|
|
203
203
|
cells: GridLocation[];
|
|
@@ -211,7 +211,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
211
211
|
rows: Model[];
|
|
212
212
|
lineDelimiter: string;
|
|
213
213
|
columnDelimiter: string;
|
|
214
|
-
}) =>
|
|
214
|
+
}) => boolean | void) | string;
|
|
215
215
|
onBeforeDestroy?: ((event: {
|
|
216
216
|
source: Base;
|
|
217
217
|
}) => void) | string;
|
|
@@ -219,11 +219,11 @@ export declare type BryntumTreeGridProps = {
|
|
|
219
219
|
config: ExportConfig;
|
|
220
220
|
columns: XLSColumn[];
|
|
221
221
|
rows: any[];
|
|
222
|
-
}) =>
|
|
222
|
+
}) => boolean | void) | string;
|
|
223
223
|
onBeforeFillHandleDragStart?: ((event: {
|
|
224
224
|
cell: GridLocation;
|
|
225
225
|
domEvent: MouseEvent;
|
|
226
|
-
}) =>
|
|
226
|
+
}) => boolean | void) | string;
|
|
227
227
|
onBeforeFinishCellEdit?: ((event: {
|
|
228
228
|
grid: Grid;
|
|
229
229
|
editorContext: CellEditorContext;
|
|
@@ -234,7 +234,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
234
234
|
}) => Promise<boolean> | boolean | void) | string;
|
|
235
235
|
onBeforeHide?: ((event: {
|
|
236
236
|
source: Widget;
|
|
237
|
-
}) =>
|
|
237
|
+
}) => boolean | void) | string;
|
|
238
238
|
onBeforePaste?: ((event: {
|
|
239
239
|
source: Grid;
|
|
240
240
|
clipboardData: string;
|
|
@@ -244,7 +244,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
244
244
|
}) => Promise<boolean> | boolean | void) | string;
|
|
245
245
|
onBeforePdfExport?: ((event: {
|
|
246
246
|
config: PdfExportConfig;
|
|
247
|
-
}) =>
|
|
247
|
+
}) => boolean | void) | string;
|
|
248
248
|
onBeforeRenderRow?: ((event: {
|
|
249
249
|
source: GridBase;
|
|
250
250
|
row: Row;
|
|
@@ -270,7 +270,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
270
270
|
deselectedCells: GridLocation[];
|
|
271
271
|
selectedCells: GridLocation[];
|
|
272
272
|
cellSelection: GridLocation[];
|
|
273
|
-
}) =>
|
|
273
|
+
}) => boolean | void) | string;
|
|
274
274
|
onBeforeSetRecord?: ((event: {
|
|
275
275
|
source: Container;
|
|
276
276
|
record: Model;
|
|
@@ -281,19 +281,19 @@ export declare type BryntumTreeGridProps = {
|
|
|
281
281
|
onBeforeStartRowEdit?: ((event: {
|
|
282
282
|
source: Grid;
|
|
283
283
|
editorContext: RowEditorContext;
|
|
284
|
-
}) =>
|
|
284
|
+
}) => boolean | void) | string;
|
|
285
285
|
onBeforeStateApply?: ((event: {
|
|
286
286
|
state: GridStateInfo;
|
|
287
|
-
}) =>
|
|
287
|
+
}) => boolean | void) | string;
|
|
288
288
|
onBeforeStateSave?: ((event: {
|
|
289
289
|
state: GridStateInfo;
|
|
290
|
-
}) =>
|
|
290
|
+
}) => boolean | void) | string;
|
|
291
291
|
onBeforeToggleGroup?: ((event: {
|
|
292
292
|
groupRecord: Model;
|
|
293
293
|
groupRecords: Model[];
|
|
294
294
|
collapse: boolean;
|
|
295
295
|
domEvent: Event;
|
|
296
|
-
}) =>
|
|
296
|
+
}) => boolean | void) | string;
|
|
297
297
|
onBeforeToggleNode?: ((event: {
|
|
298
298
|
source: Grid;
|
|
299
299
|
record: Model;
|
|
@@ -338,7 +338,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
338
338
|
items: Record<string, MenuItemEntry>;
|
|
339
339
|
column: Column;
|
|
340
340
|
record: Model;
|
|
341
|
-
}) =>
|
|
341
|
+
}) => boolean | void) | string;
|
|
342
342
|
onCellMenuItem?: ((event: {
|
|
343
343
|
source: Grid;
|
|
344
344
|
menu: Menu;
|
|
@@ -425,7 +425,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
425
425
|
valid: boolean;
|
|
426
426
|
event: Event;
|
|
427
427
|
region: string;
|
|
428
|
-
}) =>
|
|
428
|
+
}) => boolean | void) | string;
|
|
429
429
|
onColumnResize?: ((event: {
|
|
430
430
|
source: Grid;
|
|
431
431
|
column: Column;
|
|
@@ -508,7 +508,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
508
508
|
onFillHandleDragStart?: ((event: {
|
|
509
509
|
cell: GridLocation;
|
|
510
510
|
domEvent: MouseEvent;
|
|
511
|
-
}) =>
|
|
511
|
+
}) => boolean | void) | string;
|
|
512
512
|
onFinishCellEdit?: ((event: {
|
|
513
513
|
grid: Grid;
|
|
514
514
|
editorContext: CellEditorContext;
|
|
@@ -539,7 +539,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
539
539
|
records: Model[];
|
|
540
540
|
};
|
|
541
541
|
event: MouseEvent | TouchEvent;
|
|
542
|
-
}) =>
|
|
542
|
+
}) => boolean | void) | string;
|
|
543
543
|
onGridRowBeforeDropFinalize?: ((event: {
|
|
544
544
|
source: GridBase;
|
|
545
545
|
context: {
|
|
@@ -589,13 +589,13 @@ export declare type BryntumTreeGridProps = {
|
|
|
589
589
|
onHeaderClick?: ((event: {
|
|
590
590
|
domEvent: Event;
|
|
591
591
|
column: Column;
|
|
592
|
-
}) =>
|
|
592
|
+
}) => boolean | void) | string;
|
|
593
593
|
onHeaderMenuBeforeShow?: ((event: {
|
|
594
594
|
source: Grid;
|
|
595
595
|
menu: Menu;
|
|
596
596
|
items: Record<string, MenuItemEntry>;
|
|
597
597
|
column: Column;
|
|
598
|
-
}) =>
|
|
598
|
+
}) => boolean | void) | string;
|
|
599
599
|
onHeaderMenuItem?: ((event: {
|
|
600
600
|
source: Grid;
|
|
601
601
|
menu: Menu;
|
|
@@ -724,7 +724,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
724
724
|
source: Grid;
|
|
725
725
|
subGrid: SubGrid;
|
|
726
726
|
domEvent: Event;
|
|
727
|
-
}) =>
|
|
727
|
+
}) => boolean | void) | string;
|
|
728
728
|
onSplitterDragEnd?: ((event: {
|
|
729
729
|
source: Grid;
|
|
730
730
|
subGrid: SubGrid;
|
|
@@ -739,7 +739,7 @@ export declare type BryntumTreeGridProps = {
|
|
|
739
739
|
source: Grid;
|
|
740
740
|
subGrid: SubGrid;
|
|
741
741
|
domEvent: Event;
|
|
742
|
-
}) =>
|
|
742
|
+
}) => boolean | void) | string;
|
|
743
743
|
onStartCellEdit?: ((event: {
|
|
744
744
|
source: Grid;
|
|
745
745
|
editorContext: CellEditorContext;
|
package/package.json
CHANGED
|
@@ -84,6 +84,15 @@ export type BryntumAIFilterFieldProps = {
|
|
|
84
84
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
85
85
|
*/
|
|
86
86
|
centered? : boolean
|
|
87
|
+
/**
|
|
88
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
89
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
90
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
91
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/AIFilterField#config-checkValidity)
|
|
92
|
+
* @param {Core.widget.Field} field The field being validated
|
|
93
|
+
* @returns {void}
|
|
94
|
+
*/
|
|
95
|
+
checkValidity? : ((field: Field) => void)|string
|
|
87
96
|
/**
|
|
88
97
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
89
98
|
* in the [triggers](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
@@ -627,7 +636,7 @@ export type BryntumAIFilterFieldProps = {
|
|
|
627
636
|
* @param {object} event Event object
|
|
628
637
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
629
638
|
*/
|
|
630
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
639
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
631
640
|
/**
|
|
632
641
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
633
642
|
* @param {object} event Event object
|
|
@@ -775,6 +784,7 @@ export class BryntumAIFilterField extends React.Component<BryntumAIFilterFieldPr
|
|
|
775
784
|
'autoSelect',
|
|
776
785
|
'bubbleEvents',
|
|
777
786
|
'centered',
|
|
787
|
+
'checkValidity',
|
|
778
788
|
'clearable',
|
|
779
789
|
'client',
|
|
780
790
|
'color',
|
|
@@ -97,6 +97,15 @@ export type BryntumChecklistFilterComboProps = {
|
|
|
97
97
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
98
98
|
*/
|
|
99
99
|
centered? : boolean
|
|
100
|
+
/**
|
|
101
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
102
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
103
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
104
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/ChecklistFilterCombo#config-checkValidity)
|
|
105
|
+
* @param {Core.widget.Field} field The field being validated
|
|
106
|
+
* @returns {void}
|
|
107
|
+
*/
|
|
108
|
+
checkValidity? : ((field: Field) => void)|string
|
|
100
109
|
/**
|
|
101
110
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
102
111
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -809,7 +818,7 @@ export type BryntumChecklistFilterComboProps = {
|
|
|
809
818
|
* @param {object} event Event object
|
|
810
819
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
811
820
|
*/
|
|
812
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
821
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
813
822
|
/**
|
|
814
823
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
815
824
|
* @param {object} event Event object
|
|
@@ -970,6 +979,7 @@ export class BryntumChecklistFilterCombo extends React.Component<BryntumChecklis
|
|
|
970
979
|
'cacheLastResult',
|
|
971
980
|
'caseSensitive',
|
|
972
981
|
'centered',
|
|
982
|
+
'checkValidity',
|
|
973
983
|
'chipView',
|
|
974
984
|
'clearable',
|
|
975
985
|
'clearTextOnPickerHide',
|
package/src/BryntumGrid.tsx
CHANGED
|
@@ -710,7 +710,7 @@ export type BryntumGridProps = {
|
|
|
710
710
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
711
711
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
712
712
|
*/
|
|
713
|
-
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
713
|
+
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
714
714
|
/**
|
|
715
715
|
* 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.
|
|
716
716
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -725,7 +725,7 @@ export type BryntumGridProps = {
|
|
|
725
725
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
726
726
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
727
727
|
*/
|
|
728
|
-
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
728
|
+
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
729
729
|
/**
|
|
730
730
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
731
731
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -733,7 +733,7 @@ export type BryntumGridProps = {
|
|
|
733
733
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
734
734
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
735
735
|
*/
|
|
736
|
-
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
736
|
+
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
737
737
|
/**
|
|
738
738
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
739
739
|
* @param {object} event Event object
|
|
@@ -741,7 +741,7 @@ export type BryntumGridProps = {
|
|
|
741
741
|
* @param {string} event.field The field being changed
|
|
742
742
|
* @param {any} event.value The value being set
|
|
743
743
|
*/
|
|
744
|
-
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) =>
|
|
744
|
+
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
745
745
|
/**
|
|
746
746
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
747
747
|
* @param {object} event Event object
|
|
@@ -757,7 +757,7 @@ export type BryntumGridProps = {
|
|
|
757
757
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
758
758
|
* @param {Event} event.event The browser event.
|
|
759
759
|
*/
|
|
760
|
-
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) =>
|
|
760
|
+
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
761
761
|
/**
|
|
762
762
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
763
763
|
* @param {object} event Event object
|
|
@@ -768,7 +768,7 @@ export type BryntumGridProps = {
|
|
|
768
768
|
* @param {Event} event.event The browser event.
|
|
769
769
|
* @param {string} event.region The region where the column was dropped.
|
|
770
770
|
*/
|
|
771
|
-
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
771
|
+
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
772
772
|
/**
|
|
773
773
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
774
774
|
* `false`.
|
|
@@ -777,7 +777,7 @@ export type BryntumGridProps = {
|
|
|
777
777
|
* @param {Grid.column.Column} event.column The column
|
|
778
778
|
* @param {Event} event.domEvent The browser event
|
|
779
779
|
*/
|
|
780
|
-
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
780
|
+
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
781
781
|
/**
|
|
782
782
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
783
783
|
* @param {object} event Event object
|
|
@@ -797,7 +797,7 @@ export type BryntumGridProps = {
|
|
|
797
797
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
798
798
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
799
799
|
*/
|
|
800
|
-
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
800
|
+
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
801
801
|
/**
|
|
802
802
|
* Fires before an object is destroyed.
|
|
803
803
|
* @param {object} event Event object
|
|
@@ -811,14 +811,14 @@ export type BryntumGridProps = {
|
|
|
811
811
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
812
812
|
* @param {any[][]} event.rows An array of records to export
|
|
813
813
|
*/
|
|
814
|
-
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
814
|
+
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
815
815
|
/**
|
|
816
816
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
817
817
|
* @param {object} event Event object
|
|
818
818
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
819
819
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
820
820
|
*/
|
|
821
|
-
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
821
|
+
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
822
822
|
/**
|
|
823
823
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
824
824
|
* @param {object} event Event object
|
|
@@ -839,7 +839,7 @@ export type BryntumGridProps = {
|
|
|
839
839
|
* @param {object} event Event object
|
|
840
840
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
841
841
|
*/
|
|
842
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
842
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
843
843
|
/**
|
|
844
844
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
845
845
|
* @param {object} event Event object
|
|
@@ -855,7 +855,7 @@ export type BryntumGridProps = {
|
|
|
855
855
|
* @param {object} event Event object
|
|
856
856
|
* @param {PdfExportConfig} event.config Export config
|
|
857
857
|
*/
|
|
858
|
-
onBeforePdfExport? : ((event: { config: PdfExportConfig }) =>
|
|
858
|
+
onBeforePdfExport? : ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
859
859
|
/**
|
|
860
860
|
* Fires before a row is rendered.
|
|
861
861
|
* @param {object} event Event object
|
|
@@ -898,7 +898,7 @@ export type BryntumGridProps = {
|
|
|
898
898
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
899
899
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
900
900
|
*/
|
|
901
|
-
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
901
|
+
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
902
902
|
/**
|
|
903
903
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
904
904
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -919,19 +919,19 @@ export type BryntumGridProps = {
|
|
|
919
919
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
920
920
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
921
921
|
*/
|
|
922
|
-
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
922
|
+
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
923
923
|
/**
|
|
924
924
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
925
925
|
* @param {object} event Event object
|
|
926
926
|
* @param {GridStateInfo} event.state State object config
|
|
927
927
|
*/
|
|
928
|
-
onBeforeStateApply? : ((event: { state: GridStateInfo }) =>
|
|
928
|
+
onBeforeStateApply? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
929
929
|
/**
|
|
930
930
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
931
931
|
* @param {object} event Event object
|
|
932
932
|
* @param {GridStateInfo} event.state State object config
|
|
933
933
|
*/
|
|
934
|
-
onBeforeStateSave? : ((event: { state: GridStateInfo }) =>
|
|
934
|
+
onBeforeStateSave? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
935
935
|
/**
|
|
936
936
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
937
937
|
* Returning `false` from a listener prevents the operation
|
|
@@ -941,7 +941,7 @@ export type BryntumGridProps = {
|
|
|
941
941
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
942
942
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
943
943
|
*/
|
|
944
|
-
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
944
|
+
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
945
945
|
/**
|
|
946
946
|
* Fired before a parent node record toggles its collapsed state.
|
|
947
947
|
* @param {object} event Event object
|
|
@@ -1010,7 +1010,7 @@ export type BryntumGridProps = {
|
|
|
1010
1010
|
* @param {Grid.column.Column} event.column Column
|
|
1011
1011
|
* @param {Core.data.Model} event.record Record
|
|
1012
1012
|
*/
|
|
1013
|
-
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1013
|
+
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
1014
1014
|
/**
|
|
1015
1015
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1016
1016
|
* @param {object} event Event object
|
|
@@ -1137,7 +1137,7 @@ export type BryntumGridProps = {
|
|
|
1137
1137
|
* @param {Event} event.event The browser event.
|
|
1138
1138
|
* @param {string} event.region The region where the column was dropped.
|
|
1139
1139
|
*/
|
|
1140
|
-
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
1140
|
+
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
1141
1141
|
/**
|
|
1142
1142
|
* This event is fired after a resize gesture is completed.
|
|
1143
1143
|
* @param {object} event Event object
|
|
@@ -1277,7 +1277,7 @@ export type BryntumGridProps = {
|
|
|
1277
1277
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1278
1278
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1279
1279
|
*/
|
|
1280
|
-
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1280
|
+
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
1281
1281
|
/**
|
|
1282
1282
|
* Fires on the owning Grid when cell editing is finished
|
|
1283
1283
|
* @param {object} event Event object
|
|
@@ -1325,7 +1325,7 @@ export type BryntumGridProps = {
|
|
|
1325
1325
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1326
1326
|
* @param {MouseEvent,TouchEvent} event.event
|
|
1327
1327
|
*/
|
|
1328
|
-
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
1328
|
+
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
1329
1329
|
/**
|
|
1330
1330
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
1331
1331
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -1392,7 +1392,7 @@ export type BryntumGridProps = {
|
|
|
1392
1392
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
1393
1393
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
1394
1394
|
*/
|
|
1395
|
-
onHeaderClick? : ((event: { domEvent: Event, column: Column }) =>
|
|
1395
|
+
onHeaderClick? : ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
1396
1396
|
/**
|
|
1397
1397
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
1398
1398
|
* 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).
|
|
@@ -1403,7 +1403,7 @@ export type BryntumGridProps = {
|
|
|
1403
1403
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1404
1404
|
* @param {Grid.column.Column} event.column Column
|
|
1405
1405
|
*/
|
|
1406
|
-
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
1406
|
+
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
1407
1407
|
/**
|
|
1408
1408
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
1409
1409
|
* @param {object} event Event object
|
|
@@ -1614,7 +1614,7 @@ export type BryntumGridProps = {
|
|
|
1614
1614
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1615
1615
|
* @param {Event} event.domEvent The native DOM event
|
|
1616
1616
|
*/
|
|
1617
|
-
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1617
|
+
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1618
1618
|
/**
|
|
1619
1619
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
1620
1620
|
* @param {object} event Event object
|
|
@@ -1639,7 +1639,7 @@ export type BryntumGridProps = {
|
|
|
1639
1639
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1640
1640
|
* @param {Event} event.domEvent The native DOM event
|
|
1641
1641
|
*/
|
|
1642
|
-
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1642
|
+
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1643
1643
|
/**
|
|
1644
1644
|
* Fires on the owning Grid when editing starts
|
|
1645
1645
|
* @param {object} event Event object
|