@bryntum/grid-react-thin 7.3.0 → 7.3.2

package/src/BryntumGroupBar.tsx

@@ -45,6 +45,8 @@ export type BryntumGroupBarProps = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-appendTo)
      */
     appendTo? : HTMLElement|string
     /**
@@ -94,9 +96,11 @@ export type BryntumGroupBarProps = {
     /**
      * If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
      * action means. If not provided, the record representing the chip is removed from the store.
+     * @param {Core.data.Model[]} records Records to be closed
+     * @param {object} options Close options
      * @returns {void}
      */
-    closeHandler? : string|(() => void)
+    closeHandler? : string|((records: Model[], options: object) => void)
     /**
      * Custom CSS classes to add to element.
      * May be specified as a space separated string, or as an object in which property names
@@ -273,10 +277,14 @@ export type BryntumGroupBarProps = {
     ignoreParentReadOnly? : boolean
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
      */
     insertBefore? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertFirst)
      */
     insertFirst? : HTMLElement|string
     /**
@@ -554,7 +562,7 @@ export type BryntumGroupBarProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * User going to activate an item in the list either by pointer or keyboard.
      * The active record, list item index, and the triggering event are passed.
@@ -566,7 +574,7 @@ export type BryntumGroupBarProps = {
      * @param {number} event.index List item index
      * @param {Event} event.event Triggering event
      */
-    onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => Promise<boolean>|boolean|void)|string
+    onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {object} event Event object

package/src/BryntumTreeCombo.tsx

@@ -35,6 +35,8 @@ export type BryntumTreeComboProps = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
      */
     appendTo? : HTMLElement|string
     /**
@@ -97,6 +99,15 @@ export type BryntumTreeComboProps = {
      * Set to `true` to centre the Widget in browser viewport space.
      */
     centered? : boolean
+    /**
+     * A function (or the name of a function in the ownership hierarchy) called during field validation
+     * 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)
+     * evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity? : ((field: Field) => void)|string
     /**
      * A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
@@ -390,10 +401,14 @@ export type BryntumTreeComboProps = {
     inputWidth? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
      */
     insertBefore? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
      */
     insertFirst? : HTMLElement|string
     /**
@@ -800,7 +815,7 @@ export type BryntumTreeComboProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {object} event Event object
@@ -961,6 +976,7 @@ export class BryntumTreeCombo extends React.Component<BryntumTreeComboProps> {
         'cacheLastResult',
         'caseSensitive',
         'centered',
+        'checkValidity',
         'chipView',
         'clearable',
         'clearTextOnPickerHide',

package/src/BryntumTreeGrid.tsx

@@ -43,6 +43,8 @@ export type BryntumTreeGridProps = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
      */
     appendTo? : HTMLElement|string
     /**
@@ -354,10 +356,14 @@ export type BryntumTreeGridProps = {
     inputFieldAlign? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
      */
     insertBefore? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
      */
     insertFirst? : HTMLElement|string
     /**
@@ -710,7 +716,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.view.Grid} event.source Owner grid
      * @param {Grid.util.GridLocation} event.editorContext Editing context
      */
-    onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string
+    onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
     /**
      * 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.
      * [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
@@ -725,7 +731,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.view.Grid} event.source Owner grid
      * @param {CellEditorContext} event.editorContext Editing context
      */
-    onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string
+    onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
     /**
      * Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
      * 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 +739,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.view.Grid} event.source Owner grid
      * @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).
      */
-    onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string
+    onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
     /**
      * Fires for each selected record on the owning Grid before editing a range of selected cell values
      * @param {object} event Event object
@@ -741,7 +747,7 @@ export type BryntumTreeGridProps = {
      * @param {string} event.field The field being changed
      * @param {any} event.value The value being set
      */
-    onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
+    onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => boolean|void)|string
     /**
      * This event is triggered before a parent column is collapsed or expanded.
      * @param {object} event Event object
@@ -757,7 +763,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.column.Column} event.column The dragged column.
      * @param {Event} event.event The browser event.
      */
-    onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string
+    onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
     /**
      * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
      * @param {object} event Event object
@@ -768,7 +774,7 @@ export type BryntumTreeGridProps = {
      * @param {Event} event.event The browser event.
      * @param {string} event.region The region where the column was dropped.
      */
-    onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
+    onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
     /**
      * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
      * `false`.
@@ -777,7 +783,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.column.Column} event.column The column
      * @param {Event} event.domEvent The browser event
      */
-    onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string
+    onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
     /**
      * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
      * @param {object} event Event object
@@ -797,7 +803,7 @@ export type BryntumTreeGridProps = {
      * @param {string} event.lineDelimiter The CSV delimiter to separate lines
      * @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
      */
-    onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string
+    onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
     /**
      * Fires before an object is destroyed.
      * @param {object} event Event object
@@ -811,14 +817,14 @@ export type BryntumTreeGridProps = {
      * @param {XLSColumn[]} event.columns An array of columns to export
      * @param {any[][]} event.rows An array of records to export
      */
-    onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string
+    onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
     /**
      * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
      * @param {object} event Event object
      * @param {Grid.util.GridLocation} event.cell Information about the column / record
      * @param {MouseEvent} event.domEvent The raw DOM event
      */
-    onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
+    onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
     /**
      * 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.
      * @param {object} event Event object
@@ -839,7 +845,7 @@ export type BryntumTreeGridProps = {
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being hidden.
      */
-    onBeforeHide? : ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string
+    onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
     /**
      * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
      * @param {object} event Event object
@@ -855,7 +861,7 @@ export type BryntumTreeGridProps = {
      * @param {object} event Event object
      * @param {PdfExportConfig} event.config Export config
      */
-    onBeforePdfExport? : ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
+    onBeforePdfExport? : ((event: { config: PdfExportConfig }) => boolean|void)|string
     /**
      * Fires before a row is rendered.
      * @param {object} event Event object
@@ -898,7 +904,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
      * @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
      */
-    onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => Promise<boolean>|boolean|void)|string
+    onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
     /**
      * Fired before this container will load record values into its child fields. This is useful if you
      * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -919,19 +925,19 @@ export type BryntumTreeGridProps = {
      * @param {Grid.view.Grid} event.source Owner grid
      * @param {RowEditorContext} event.editorContext Editing context
      */
-    onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string
+    onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
     /**
      * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
      * @param {object} event Event object
      * @param {GridStateInfo} event.state State object config
      */
-    onBeforeStateApply? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
+    onBeforeStateApply? : ((event: { state: GridStateInfo }) => boolean|void)|string
     /**
      * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
      * @param {object} event Event object
      * @param {GridStateInfo} event.state State object config
      */
-    onBeforeStateSave? : ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string
+    onBeforeStateSave? : ((event: { state: GridStateInfo }) => boolean|void)|string
     /**
      * Fired when a group is going to be expanded or collapsed using the UI.
      * Returning `false` from a listener prevents the operation
@@ -941,7 +947,7 @@ export type BryntumTreeGridProps = {
      * @param {boolean} event.collapse Collapsed (true) or expanded (false)
      * @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
      */
-    onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
+    onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
     /**
      * Fired before a parent node record toggles its collapsed state.
      * @param {object} event Event object
@@ -1010,7 +1016,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.column.Column} event.column Column
      * @param {Core.data.Model} event.record Record
      */
-    onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string
+    onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
     /**
      * This event fires on the owning grid when an item is selected in the cell context menu.
      * @param {object} event Event object
@@ -1137,7 +1143,7 @@ export type BryntumTreeGridProps = {
      * @param {Event} event.event The browser event.
      * @param {string} event.region The region where the column was dropped.
      */
-    onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string
+    onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
     /**
      * This event is fired after a resize gesture is completed.
      * @param {object} event Event object
@@ -1277,7 +1283,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.util.GridLocation} event.cell Information about the column / record
      * @param {MouseEvent} event.domEvent The raw DOM event
      */
-    onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string
+    onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
     /**
      * Fires on the owning Grid when cell editing is finished
      * @param {object} event Event object
@@ -1325,7 +1331,7 @@ export type BryntumTreeGridProps = {
      * @param {Core.data.Model[]} event.context.records The dragged row records
      * @param {MouseEvent,TouchEvent} event.event
      */
-    onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string
+    onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
     /**
      * Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
      * Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
@@ -1392,7 +1398,7 @@ export type BryntumTreeGridProps = {
      * @param {Event} event.domEvent The triggering DOM event.
      * @param {Grid.column.Column} event.column The column clicked on.
      */
-    onHeaderClick? : ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string
+    onHeaderClick? : ((event: { domEvent: Event, column: Column }) => boolean|void)|string
     /**
      * This event fires on the owning Grid before the context menu is shown for a header.
      * 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 +1409,7 @@ export type BryntumTreeGridProps = {
      * @param {Record<string, MenuItemEntry>} event.items Menu item configs
      * @param {Grid.column.Column} event.column Column
      */
-    onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string
+    onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
     /**
      * This event fires on the owning Grid when an item is selected in the header context menu.
      * @param {object} event Event object
@@ -1614,7 +1620,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.view.SubGrid} event.subGrid The subgrid
      * @param {Event} event.domEvent The native DOM event
      */
-    onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
+    onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
     /**
      * Fired by the Grid after a sub-grid has been resized using the splitter
      * @param {object} event Event object
@@ -1639,7 +1645,7 @@ export type BryntumTreeGridProps = {
      * @param {Grid.view.SubGrid} event.subGrid The subgrid
      * @param {Event} event.domEvent The native DOM event
      */
-    onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string
+    onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
     /**
      * Fires on the owning Grid when editing starts
      * @param {object} event Event object