@bryntum/calendar-vue-3 7.3.0 → 7.3.2

package/src/components/BryntumFilePickerProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumFilePickerProps = {
     /**
      * 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/calendar/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/calendar/docs/api/Core/widget/FilePicker#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -240,10 +242,14 @@ export declare type BryntumFilePickerProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/FilePicker#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/calendar/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/calendar/docs/api/Core/widget/FilePicker#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumFilterField.vue

@@ -42,6 +42,8 @@ defineProps<{
     /**
      * 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/calendar/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/calendar/docs/api/Core/widget/FilterField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -91,6 +93,15 @@ defineProps<{
      * 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/calendar/docs/api/Core/widget/Field#property-isValid)
+     * evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/FilterField#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -313,10 +324,14 @@ defineProps<{
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/FilterField#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/calendar/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/calendar/docs/api/Core/widget/FilterField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -662,7 +677,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {Core.widget.Widget} params.event.source The widget being hidden.
      */
-    (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {string} e Event name
@@ -835,6 +850,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/components/BryntumFilterFieldProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumFilterFieldProps = {
     /**
      * 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/calendar/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/calendar/docs/api/Core/widget/FilterField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -77,6 +79,15 @@ export declare type BryntumFilterFieldProps = {
      * 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/calendar/docs/api/Core/widget/Field#property-isValid)
+     * evaluation, after the built-in [required](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/FilterField#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/calendar/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -299,10 +310,14 @@ export declare type BryntumFilterFieldProps = {
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/FilterField#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/calendar/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/calendar/docs/api/Core/widget/FilterField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumGrid.vue

@@ -73,6 +73,8 @@ defineProps<{
     /**
      * 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/calendar/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/calendar/docs/api/Grid/view/Grid#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -384,10 +386,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/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/calendar/docs/api/Grid/view/Grid#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/calendar/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/calendar/docs/api/Grid/view/Grid#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -1003,7 +1009,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {Grid.util.GridLocation} params.event.editorContext Editing context
      */
-    (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
     /**
      * 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/calendar/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
@@ -1022,7 +1028,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {CellEditorContext} params.event.editorContext Editing context
      */
-    (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
     /**
      * 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/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
@@ -1032,7 +1038,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {(Grid.util.GridLocation|Core.data.Model)[]} params.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).
      */
-    (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
     /**
      * Fires for each selected record on the owning Grid before editing a range of selected cell values
      * @param {string} e Event name
@@ -1042,7 +1048,7 @@ const emit = defineEmits<{
      * @param {string} params.event.field The field being changed
      * @param {any} params.event.value The value being set
      */
-    (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
     /**
      * This event is triggered before a parent column is collapsed or expanded.
      * @param {string} e Event name
@@ -1062,7 +1068,7 @@ const emit = defineEmits<{
      * @param {Grid.column.Column} params.event.column The dragged column.
      * @param {Event} params.event.event The browser event.
      */
-    (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
     /**
      * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
      * @param {string} e Event name
@@ -1075,7 +1081,7 @@ const emit = defineEmits<{
      * @param {Event} params.event.event The browser event.
      * @param {string} params.event.region The region where the column was dropped.
      */
-    (e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
     /**
      * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
      * `false`.
@@ -1086,7 +1092,7 @@ const emit = defineEmits<{
      * @param {Grid.column.Column} params.event.column The column
      * @param {Event} params.event.domEvent The browser event
      */
-    (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
      * @param {string} e Event name
@@ -1110,7 +1116,7 @@ const emit = defineEmits<{
      * @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
      * @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
      */
-    (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
     /**
      * Fires before an object is destroyed.
      * @param {string} e Event name
@@ -1128,7 +1134,7 @@ const emit = defineEmits<{
      * @param {XLSColumn[]} params.event.columns An array of columns to export
      * @param {any[][]} params.event.rows An array of records to export
      */
-    (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
     /**
      * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
      * @param {string} e Event name
@@ -1137,7 +1143,7 @@ const emit = defineEmits<{
      * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
      * @param {MouseEvent} params.event.domEvent The raw DOM event
      */
-    (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
     /**
      * 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 {string} e Event name
@@ -1164,7 +1170,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {Core.widget.Widget} params.event.source The widget being hidden.
      */
-    (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
      * @param {string} e Event name
@@ -1184,7 +1190,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {PdfExportConfig} params.event.config Export config
      */
-    (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
     /**
      * Fires before a row is rendered.
      * @param {string} e Event name
@@ -1237,7 +1243,7 @@ const emit = defineEmits<{
      * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
      * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
      */
-    (e: 'beforeSelectionChange', params: ((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): Promise<boolean>|boolean|void
+    (e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string): boolean|void
     /**
      * 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)
@@ -1264,7 +1270,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {RowEditorContext} params.event.editorContext Editing context
      */
-    (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
     /**
      * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
      * @param {string} e Event name
@@ -1272,7 +1278,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {GridStateInfo} params.event.state State object config
      */
-    (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
     /**
      * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
      * @param {string} e Event name
@@ -1280,7 +1286,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {GridStateInfo} params.event.state State object config
      */
-    (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
     /**
      * Fired when a group is going to be expanded or collapsed using the UI.
      * Returning `false` from a listener prevents the operation
@@ -1292,7 +1298,7 @@ const emit = defineEmits<{
      * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
      * @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
      */
-    (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fired before a parent node record toggles its collapsed state.
      * @param {string} e Event name
@@ -1375,7 +1381,7 @@ const emit = defineEmits<{
      * @param {Grid.column.Column} params.event.column Column
      * @param {Core.data.Model} params.event.record Record
      */
-    (e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
     /**
      * This event fires on the owning grid when an item is selected in the cell context menu.
      * @param {string} e Event name
@@ -1528,7 +1534,7 @@ const emit = defineEmits<{
      * @param {Event} params.event.event The browser event.
      * @param {string} params.event.region The region where the column was dropped.
      */
-    (e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
     /**
      * This event is fired after a resize gesture is completed.
      * @param {string} e Event name
@@ -1702,7 +1708,7 @@ const emit = defineEmits<{
      * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
      * @param {MouseEvent} params.event.domEvent The raw DOM event
      */
-    (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid when cell editing is finished
      * @param {string} e Event name
@@ -1760,7 +1766,7 @@ const emit = defineEmits<{
      * @param {Core.data.Model[]} params.event.context.records The dragged row records
      * @param {MouseEvent,TouchEvent} params.event.event
      */
-    (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
     /**
      * 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).
@@ -1839,7 +1845,7 @@ const emit = defineEmits<{
      * @param {Event} params.event.domEvent The triggering DOM event.
      * @param {Grid.column.Column} params.event.column The column clicked on.
      */
-    (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
     /**
      * 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/calendar/docs/api/Grid/feature/HeaderMenu#config-processItems).
@@ -1852,7 +1858,7 @@ const emit = defineEmits<{
      * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
      * @param {Grid.column.Column} params.event.column Column
      */
-    (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
     /**
      * This event fires on the owning Grid when an item is selected in the header context menu.
      * @param {string} e Event name
@@ -2113,7 +2119,7 @@ const emit = defineEmits<{
      * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
      * @param {Event} params.event.domEvent The native DOM event
      */
-    (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fired by the Grid after a sub-grid has been resized using the splitter
      * @param {string} e Event name
@@ -2144,7 +2150,7 @@ const emit = defineEmits<{
      * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
      * @param {Event} params.event.domEvent The native DOM event
      */
-    (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid when editing starts
      * @param {string} e Event name

package/src/components/BryntumGridBase.vue

@@ -73,6 +73,8 @@ defineProps<{
     /**
      * 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/calendar/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/calendar/docs/api/Grid/view/GridBase#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -384,10 +386,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/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/calendar/docs/api/Grid/view/GridBase#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/calendar/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/calendar/docs/api/Grid/view/GridBase#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -1002,7 +1008,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {Grid.util.GridLocation} params.event.editorContext Editing context
      */
-    (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCancelCellEdit', params: ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string): boolean|void
     /**
      * 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/calendar/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
@@ -1021,7 +1027,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {CellEditorContext} params.event.editorContext Editing context
      */
-    (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCellEditStart', params: ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string): boolean|void
     /**
      * 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/calendar/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
@@ -1031,7 +1037,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {(Grid.util.GridLocation|Core.data.Model)[]} params.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).
      */
-    (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCellRangeDelete', params: ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string): boolean|void
     /**
      * Fires for each selected record on the owning Grid before editing a range of selected cell values
      * @param {string} e Event name
@@ -1041,7 +1047,7 @@ const emit = defineEmits<{
      * @param {string} params.event.field The field being changed
      * @param {any} params.event.value The value being set
      */
-    (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCellRangeEdit', params: ((event: { record: Model, field: string, value: any }) => boolean|void)|string): boolean|void
     /**
      * This event is triggered before a parent column is collapsed or expanded.
      * @param {string} e Event name
@@ -1061,7 +1067,7 @@ const emit = defineEmits<{
      * @param {Grid.column.Column} params.event.column The dragged column.
      * @param {Event} params.event.event The browser event.
      */
-    (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeColumnDragStart', params: ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string): boolean|void
     /**
      * This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
      * @param {string} e Event name
@@ -1074,7 +1080,7 @@ const emit = defineEmits<{
      * @param {Event} params.event.event The browser event.
      * @param {string} params.event.region The region where the column was dropped.
      */
-    (e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeColumnDropFinalize', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string): boolean|void
     /**
      * This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
      * `false`.
@@ -1085,7 +1091,7 @@ const emit = defineEmits<{
      * @param {Grid.column.Column} params.event.column The column
      * @param {Event} params.event.domEvent The browser event
      */
-    (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeColumnResize', params: ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
      * @param {string} e Event name
@@ -1109,7 +1115,7 @@ const emit = defineEmits<{
      * @param {string} params.event.lineDelimiter The CSV delimiter to separate lines
      * @param {string} params.event.columnDelimiter The CSV delimiter to separate values on one line
      */
-    (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCSVExport', params: ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string): boolean|void
     /**
      * Fires before an object is destroyed.
      * @param {string} e Event name
@@ -1127,7 +1133,7 @@ const emit = defineEmits<{
      * @param {XLSColumn[]} params.event.columns An array of columns to export
      * @param {any[][]} params.event.rows An array of records to export
      */
-    (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeExcelExport', params: ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string): boolean|void
     /**
      * Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
      * @param {string} e Event name
@@ -1136,7 +1142,7 @@ const emit = defineEmits<{
      * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
      * @param {MouseEvent} params.event.domEvent The raw DOM event
      */
-    (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeFillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
     /**
      * 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 {string} e Event name
@@ -1163,7 +1169,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {Core.widget.Widget} params.event.source The widget being hidden.
      */
-    (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
      * @param {string} e Event name
@@ -1183,7 +1189,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {PdfExportConfig} params.event.config Export config
      */
-    (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforePdfExport', params: ((event: { config: PdfExportConfig }) => boolean|void)|string): boolean|void
     /**
      * Fires before a row is rendered.
      * @param {string} e Event name
@@ -1236,7 +1242,7 @@ const emit = defineEmits<{
      * @param {Grid.util.GridLocation[]} params.event.selectedCells The cells to be selected in this operation.
      * @param {Grid.util.GridLocation[]} params.event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
      */
-    (e: 'beforeSelectionChange', params: ((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): Promise<boolean>|boolean|void
+    (e: 'beforeSelectionChange', params: ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string): boolean|void
     /**
      * 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)
@@ -1263,7 +1269,7 @@ const emit = defineEmits<{
      * @param {Grid.view.Grid} params.event.source Owner grid
      * @param {RowEditorContext} params.event.editorContext Editing context
      */
-    (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStartRowEdit', params: ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string): boolean|void
     /**
      * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
      * @param {string} e Event name
@@ -1271,7 +1277,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {GridStateInfo} params.event.state State object config
      */
-    (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStateApply', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
     /**
      * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
      * @param {string} e Event name
@@ -1279,7 +1285,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {GridStateInfo} params.event.state State object config
      */
-    (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStateSave', params: ((event: { state: GridStateInfo }) => boolean|void)|string): boolean|void
     /**
      * Fired when a group is going to be expanded or collapsed using the UI.
      * Returning `false` from a listener prevents the operation
@@ -1291,7 +1297,7 @@ const emit = defineEmits<{
      * @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
      * @param {Event} params.event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
      */
-    (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeToggleGroup', params: ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fired before a parent node record toggles its collapsed state.
      * @param {string} e Event name
@@ -1374,7 +1380,7 @@ const emit = defineEmits<{
      * @param {Grid.column.Column} params.event.column Column
      * @param {Core.data.Model} params.event.record Record
      */
-    (e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'cellMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string): boolean|void
     /**
      * This event fires on the owning grid when an item is selected in the cell context menu.
      * @param {string} e Event name
@@ -1527,7 +1533,7 @@ const emit = defineEmits<{
      * @param {Event} params.event.event The browser event.
      * @param {string} params.event.region The region where the column was dropped.
      */
-    (e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'columnDrop', params: ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string): boolean|void
     /**
      * This event is fired after a resize gesture is completed.
      * @param {string} e Event name
@@ -1701,7 +1707,7 @@ const emit = defineEmits<{
      * @param {Grid.util.GridLocation} params.event.cell Information about the column / record
      * @param {MouseEvent} params.event.domEvent The raw DOM event
      */
-    (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'fillHandleDragStart', params: ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid when cell editing is finished
      * @param {string} e Event name
@@ -1759,7 +1765,7 @@ const emit = defineEmits<{
      * @param {Core.data.Model[]} params.event.context.records The dragged row records
      * @param {MouseEvent,TouchEvent} params.event.event
      */
-    (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'gridRowBeforeDragStart', params: ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string): boolean|void
     /**
      * 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).
@@ -1838,7 +1844,7 @@ const emit = defineEmits<{
      * @param {Event} params.event.domEvent The triggering DOM event.
      * @param {Grid.column.Column} params.event.column The column clicked on.
      */
-    (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'headerClick', params: ((event: { domEvent: Event, column: Column }) => boolean|void)|string): boolean|void
     /**
      * 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/calendar/docs/api/Grid/feature/HeaderMenu#config-processItems).
@@ -1851,7 +1857,7 @@ const emit = defineEmits<{
      * @param {Record<string, MenuItemEntry>} params.event.items Menu item configs
      * @param {Grid.column.Column} params.event.column Column
      */
-    (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'headerMenuBeforeShow', params: ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string): boolean|void
     /**
      * This event fires on the owning Grid when an item is selected in the header context menu.
      * @param {string} e Event name
@@ -2112,7 +2118,7 @@ const emit = defineEmits<{
      * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
      * @param {Event} params.event.domEvent The native DOM event
      */
-    (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'splitterCollapseClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fired by the Grid after a sub-grid has been resized using the splitter
      * @param {string} e Event name
@@ -2143,7 +2149,7 @@ const emit = defineEmits<{
      * @param {Grid.view.SubGrid} params.event.subGrid The subgrid
      * @param {Event} params.event.domEvent The native DOM event
      */
-    (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'splitterExpandClick', params: ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string): boolean|void
     /**
      * Fires on the owning Grid when editing starts
      * @param {string} e Event name