@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/src/BryntumGridBase.tsx
CHANGED
|
@@ -709,7 +709,7 @@ export type BryntumGridBaseProps = {
|
|
|
709
709
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
710
710
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
711
711
|
*/
|
|
712
|
-
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
712
|
+
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
713
713
|
/**
|
|
714
714
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
715
715
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -724,7 +724,7 @@ export type BryntumGridBaseProps = {
|
|
|
724
724
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
725
725
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
726
726
|
*/
|
|
727
|
-
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
727
|
+
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
728
728
|
/**
|
|
729
729
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
730
730
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -732,7 +732,7 @@ export type BryntumGridBaseProps = {
|
|
|
732
732
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
733
733
|
* @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).
|
|
734
734
|
*/
|
|
735
|
-
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
735
|
+
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
736
736
|
/**
|
|
737
737
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
738
738
|
* @param {object} event Event object
|
|
@@ -740,7 +740,7 @@ export type BryntumGridBaseProps = {
|
|
|
740
740
|
* @param {string} event.field The field being changed
|
|
741
741
|
* @param {any} event.value The value being set
|
|
742
742
|
*/
|
|
743
|
-
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) =>
|
|
743
|
+
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
744
744
|
/**
|
|
745
745
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
746
746
|
* @param {object} event Event object
|
|
@@ -756,7 +756,7 @@ export type BryntumGridBaseProps = {
|
|
|
756
756
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
757
757
|
* @param {Event} event.event The browser event.
|
|
758
758
|
*/
|
|
759
|
-
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) =>
|
|
759
|
+
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
760
760
|
/**
|
|
761
761
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
762
762
|
* @param {object} event Event object
|
|
@@ -767,7 +767,7 @@ export type BryntumGridBaseProps = {
|
|
|
767
767
|
* @param {Event} event.event The browser event.
|
|
768
768
|
* @param {string} event.region The region where the column was dropped.
|
|
769
769
|
*/
|
|
770
|
-
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
770
|
+
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
771
771
|
/**
|
|
772
772
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
773
773
|
* `false`.
|
|
@@ -776,7 +776,7 @@ export type BryntumGridBaseProps = {
|
|
|
776
776
|
* @param {Grid.column.Column} event.column The column
|
|
777
777
|
* @param {Event} event.domEvent The browser event
|
|
778
778
|
*/
|
|
779
|
-
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
779
|
+
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
780
780
|
/**
|
|
781
781
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
782
782
|
* @param {object} event Event object
|
|
@@ -796,7 +796,7 @@ export type BryntumGridBaseProps = {
|
|
|
796
796
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
797
797
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
798
798
|
*/
|
|
799
|
-
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
799
|
+
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
800
800
|
/**
|
|
801
801
|
* Fires before an object is destroyed.
|
|
802
802
|
* @param {object} event Event object
|
|
@@ -810,14 +810,14 @@ export type BryntumGridBaseProps = {
|
|
|
810
810
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
811
811
|
* @param {any[][]} event.rows An array of records to export
|
|
812
812
|
*/
|
|
813
|
-
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
813
|
+
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
814
814
|
/**
|
|
815
815
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
816
816
|
* @param {object} event Event object
|
|
817
817
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
818
818
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
819
819
|
*/
|
|
820
|
-
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
820
|
+
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
821
821
|
/**
|
|
822
822
|
* 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.
|
|
823
823
|
* @param {object} event Event object
|
|
@@ -838,7 +838,7 @@ export type BryntumGridBaseProps = {
|
|
|
838
838
|
* @param {object} event Event object
|
|
839
839
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
840
840
|
*/
|
|
841
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
841
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
842
842
|
/**
|
|
843
843
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
844
844
|
* @param {object} event Event object
|
|
@@ -854,7 +854,7 @@ export type BryntumGridBaseProps = {
|
|
|
854
854
|
* @param {object} event Event object
|
|
855
855
|
* @param {PdfExportConfig} event.config Export config
|
|
856
856
|
*/
|
|
857
|
-
onBeforePdfExport? : ((event: { config: PdfExportConfig }) =>
|
|
857
|
+
onBeforePdfExport? : ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
858
858
|
/**
|
|
859
859
|
* Fires before a row is rendered.
|
|
860
860
|
* @param {object} event Event object
|
|
@@ -897,7 +897,7 @@ export type BryntumGridBaseProps = {
|
|
|
897
897
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
898
898
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
899
899
|
*/
|
|
900
|
-
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
900
|
+
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
901
901
|
/**
|
|
902
902
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
903
903
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -918,19 +918,19 @@ export type BryntumGridBaseProps = {
|
|
|
918
918
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
919
919
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
920
920
|
*/
|
|
921
|
-
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
921
|
+
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
922
922
|
/**
|
|
923
923
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
924
924
|
* @param {object} event Event object
|
|
925
925
|
* @param {GridStateInfo} event.state State object config
|
|
926
926
|
*/
|
|
927
|
-
onBeforeStateApply? : ((event: { state: GridStateInfo }) =>
|
|
927
|
+
onBeforeStateApply? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
928
928
|
/**
|
|
929
929
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
930
930
|
* @param {object} event Event object
|
|
931
931
|
* @param {GridStateInfo} event.state State object config
|
|
932
932
|
*/
|
|
933
|
-
onBeforeStateSave? : ((event: { state: GridStateInfo }) =>
|
|
933
|
+
onBeforeStateSave? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
934
934
|
/**
|
|
935
935
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
936
936
|
* Returning `false` from a listener prevents the operation
|
|
@@ -940,7 +940,7 @@ export type BryntumGridBaseProps = {
|
|
|
940
940
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
941
941
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
942
942
|
*/
|
|
943
|
-
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
943
|
+
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
944
944
|
/**
|
|
945
945
|
* Fired before a parent node record toggles its collapsed state.
|
|
946
946
|
* @param {object} event Event object
|
|
@@ -1009,7 +1009,7 @@ export type BryntumGridBaseProps = {
|
|
|
1009
1009
|
* @param {Grid.column.Column} event.column Column
|
|
1010
1010
|
* @param {Core.data.Model} event.record Record
|
|
1011
1011
|
*/
|
|
1012
|
-
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1012
|
+
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
1013
1013
|
/**
|
|
1014
1014
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1015
1015
|
* @param {object} event Event object
|
|
@@ -1136,7 +1136,7 @@ export type BryntumGridBaseProps = {
|
|
|
1136
1136
|
* @param {Event} event.event The browser event.
|
|
1137
1137
|
* @param {string} event.region The region where the column was dropped.
|
|
1138
1138
|
*/
|
|
1139
|
-
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
1139
|
+
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
1140
1140
|
/**
|
|
1141
1141
|
* This event is fired after a resize gesture is completed.
|
|
1142
1142
|
* @param {object} event Event object
|
|
@@ -1276,7 +1276,7 @@ export type BryntumGridBaseProps = {
|
|
|
1276
1276
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1277
1277
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1278
1278
|
*/
|
|
1279
|
-
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1279
|
+
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
1280
1280
|
/**
|
|
1281
1281
|
* Fires on the owning Grid when cell editing is finished
|
|
1282
1282
|
* @param {object} event Event object
|
|
@@ -1324,7 +1324,7 @@ export type BryntumGridBaseProps = {
|
|
|
1324
1324
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1325
1325
|
* @param {MouseEvent,TouchEvent} event.event
|
|
1326
1326
|
*/
|
|
1327
|
-
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
1327
|
+
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
1328
1328
|
/**
|
|
1329
1329
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
1330
1330
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -1391,7 +1391,7 @@ export type BryntumGridBaseProps = {
|
|
|
1391
1391
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
1392
1392
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
1393
1393
|
*/
|
|
1394
|
-
onHeaderClick? : ((event: { domEvent: Event, column: Column }) =>
|
|
1394
|
+
onHeaderClick? : ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
1395
1395
|
/**
|
|
1396
1396
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
1397
1397
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -1402,7 +1402,7 @@ export type BryntumGridBaseProps = {
|
|
|
1402
1402
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1403
1403
|
* @param {Grid.column.Column} event.column Column
|
|
1404
1404
|
*/
|
|
1405
|
-
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
1405
|
+
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
1406
1406
|
/**
|
|
1407
1407
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
1408
1408
|
* @param {object} event Event object
|
|
@@ -1613,7 +1613,7 @@ export type BryntumGridBaseProps = {
|
|
|
1613
1613
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1614
1614
|
* @param {Event} event.domEvent The native DOM event
|
|
1615
1615
|
*/
|
|
1616
|
-
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1616
|
+
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1617
1617
|
/**
|
|
1618
1618
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
1619
1619
|
* @param {object} event Event object
|
|
@@ -1638,7 +1638,7 @@ export type BryntumGridBaseProps = {
|
|
|
1638
1638
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1639
1639
|
* @param {Event} event.domEvent The native DOM event
|
|
1640
1640
|
*/
|
|
1641
|
-
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1641
|
+
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1642
1642
|
/**
|
|
1643
1643
|
* Fires on the owning Grid when editing starts
|
|
1644
1644
|
* @param {object} event Event object
|
|
@@ -441,7 +441,7 @@ export type BryntumGridChartDesignerProps = {
|
|
|
441
441
|
* @param {object} event Event object
|
|
442
442
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
443
443
|
*/
|
|
444
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
444
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
445
445
|
/**
|
|
446
446
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
447
447
|
* @param {object} event Event object
|
|
@@ -603,7 +603,7 @@ export type BryntumGridFieldFilterPickerProps = {
|
|
|
603
603
|
* @param {object} event Event object
|
|
604
604
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
605
605
|
*/
|
|
606
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
606
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
607
607
|
/**
|
|
608
608
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
609
609
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -605,7 +605,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
605
605
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
606
606
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
607
607
|
*/
|
|
608
|
-
onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
608
|
+
onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
609
609
|
/**
|
|
610
610
|
* Fires before an object is destroyed.
|
|
611
611
|
* @param {object} event Event object
|
|
@@ -617,7 +617,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
617
617
|
* @param {object} event Event object
|
|
618
618
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
619
619
|
*/
|
|
620
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
620
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
621
621
|
/**
|
|
622
622
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
623
623
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
package/src/BryntumGroupBar.tsx
CHANGED
|
@@ -554,7 +554,7 @@ export type BryntumGroupBarProps = {
|
|
|
554
554
|
* @param {object} event Event object
|
|
555
555
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
556
556
|
*/
|
|
557
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
557
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
558
558
|
/**
|
|
559
559
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
560
560
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -566,7 +566,7 @@ export type BryntumGroupBarProps = {
|
|
|
566
566
|
* @param {number} event.index List item index
|
|
567
567
|
* @param {Event} event.event Triggering event
|
|
568
568
|
*/
|
|
569
|
-
onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
569
|
+
onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
570
570
|
/**
|
|
571
571
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
572
572
|
* @param {object} event Event object
|
package/src/BryntumTreeCombo.tsx
CHANGED
|
@@ -97,6 +97,15 @@ export type BryntumTreeComboProps = {
|
|
|
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/TreeCombo#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`.
|
|
@@ -800,7 +809,7 @@ export type BryntumTreeComboProps = {
|
|
|
800
809
|
* @param {object} event Event object
|
|
801
810
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
802
811
|
*/
|
|
803
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
812
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
804
813
|
/**
|
|
805
814
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
806
815
|
* @param {object} event Event object
|
|
@@ -961,6 +970,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
|
|
|
961
970
|
'cacheLastResult',
|
|
962
971
|
'caseSensitive',
|
|
963
972
|
'centered',
|
|
973
|
+
'checkValidity',
|
|
964
974
|
'chipView',
|
|
965
975
|
'clearable',
|
|
966
976
|
'clearTextOnPickerHide',
|
package/src/BryntumTreeGrid.tsx
CHANGED
|
@@ -710,7 +710,7 @@ export type BryntumTreeGridProps = {
|
|
|
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/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -725,7 +725,7 @@ export type BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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 BryntumTreeGridProps = {
|
|
|
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
|