@bryntum/schedulerpro-vue-3 7.3.0 → 7.3.1

package/src/components/BryntumVersionGrid.vue

@@ -1004,7 +1004,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/schedulerpro/docs/api/SchedulerPro/widget/VersionGrid#event-beforeCancelRowEdit)
@@ -1023,7 +1023,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/schedulerpro/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
@@ -1033,7 +1033,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
@@ -1043,7 +1043,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
@@ -1063,7 +1063,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
@@ -1076,7 +1076,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`.
@@ -1087,7 +1087,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
@@ -1111,7 +1111,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
@@ -1129,7 +1129,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
@@ -1138,7 +1138,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
@@ -1165,7 +1165,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
@@ -1185,7 +1185,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
@@ -1238,7 +1238,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)
@@ -1265,7 +1265,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
@@ -1273,7 +1273,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
@@ -1281,7 +1281,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
@@ -1293,7 +1293,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
@@ -1376,7 +1376,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
@@ -1529,7 +1529,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
@@ -1711,7 +1711,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
@@ -1769,7 +1769,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).
@@ -1848,7 +1848,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/schedulerpro/docs/api/Grid/feature/HeaderMenu#config-processItems).
@@ -1861,7 +1861,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
@@ -2130,7 +2130,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
@@ -2161,7 +2161,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/BryntumViewPresetCombo.vue

@@ -81,6 +81,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/schedulerpro/docs/api/Core/widget/Field#property-isValid)
+     * evaluation, after the built-in [required](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/widget/ViewPresetCombo#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * Specify `false` to not clear value typed to a multiselect combo when an item is selected.
      */
@@ -572,7 +581,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
@@ -744,6 +753,7 @@ const widgetData = {
         'bubbleEvents',
         'cacheLastResult',
         'centered',
+        'checkValidity',
         'clearTextOnSelection',
         'clearWhenInputEmpty',
         'client',

package/src/components/BryntumViewPresetComboProps.ts

@@ -67,6 +67,15 @@ export declare type BryntumViewPresetComboProps = {
      * 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/schedulerpro/docs/api/Core/widget/Field#property-isValid)
+     * evaluation, after the built-in [required](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-required) check.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/widget/ViewPresetCombo#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * Specify `false` to not clear value typed to a multiselect combo when an item is selected.
      */

package/src/components/BryntumWidget.vue

@@ -443,7 +443,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

package/src/components/BryntumYearPicker.vue

@@ -673,7 +673,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
     /**
      * 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)
@@ -699,7 +699,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {any} params.event.state State object config
      */
-    (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStateApply', params: ((event: { state: any }) => 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
@@ -707,7 +707,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {any} params.event.state State object config
      */
-    (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
     /**
      * Fires when any other event is fired from the object.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/YearPicker#event-catchAll)