@bryntum/schedulerpro-vue-3 7.3.0 → 7.3.1

package/src/components/BryntumSchedulerProProjectModel.vue

@@ -10,7 +10,7 @@
 
 import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
 
-import type { AbstractCrudManager, AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, Base, CalendarManagerStore, CalendarManagerStoreConfig, CalendarModel, CalendarModelConfig, CoreStateTrackingManager, CrudManagerRequestResponse, CrudManagerStoreDescriptor, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, DurationUnit, EventModel, EventModelConfig, EventStore, EventStoreConfig, LazyLoadCrudManagerRequestParams, Model, ModelConfig, ProjectModelListeners, ResourceAllocationInfo, ResourceModel, ResourceModelConfig, ResourceStore, ResourceStoreConfig, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, SchedulerProjectModel, StateTrackingManagerConfig, Store, StoreConfig, TimeRangeStore, TimeSpan, TimeSpanConfig } from '@bryntum/schedulerpro';
+import type { AbstractCrudManager, AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, Base, CalendarManagerStore, CalendarManagerStoreConfig, CalendarModel, CalendarModelConfig, CoreStateTrackingManager, CrudManagerRequestResponse, CrudManagerStoreDescriptor, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, DurationUnit, EventModel, EventModelConfig, EventStore, EventStoreConfig, FetchCredentials, HttpMethod, LazyLoadCrudManagerRequestParams, Model, ModelConfig, ProjectModelListeners, ResourceAllocationInfo, ResourceModel, ResourceModelConfig, ResourceStore, ResourceStoreConfig, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, SchedulerProjectModel, StateTrackingManagerConfig, Store, StoreConfig, TimeRangeStore, TimeSpan, TimeSpanConfig } from '@bryntum/schedulerpro';
 import { ProjectModel } from '@bryntum/schedulerpro';
 
 import { WrapperHelper } from '../helper/WrapperHelper';
@@ -277,12 +277,11 @@ defineProps<{
      * If set to `true`, or a config object, this makes the CrudManager load records only when needed. When a record
      * or a date range that is not already loaded is requested, a load request will be made to the specified URL.
      * More more details about lazy loading, see the [guide](https://bryntum.com/products/schedulerpro/docs/api/Grid/guides/data/lazyloading.md)
-     * @param {object} lazyLoad Lazy load config
-     * @param {number} lazyLoad.chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
+     * @param {number} chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
      * @param {DurationUnit} bufferUnit Used together with bufferAmount to calculate the start and end dates of each load request. The value is added to the current visible start or end date. Defaults to the visible time span length (does not affect ResourceStore).
      * @param {number} bufferAmount See `bufferUnit`
      */
-    lazyLoad ? : Boolean|{ lazyLoad: { chunkSize: number }, bufferUnit: DurationUnit, bufferAmount: number }
+    lazyLoad ? : Boolean|{ chunkSize: number, bufferUnit: DurationUnit, bufferAmount: number }
     /**
      * The listener set for this object.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-listeners)
@@ -549,18 +548,20 @@ defineProps<{
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-transport)
      * @property {object} [transport.load] Load requests configuration:
      * @property {string} [transport.load.url] URL to request for data loading.
-     * @property {string} [transport.load.method] HTTP method to be used for load requests.
+     * @property {HttpMethod} [transport.load.method] HTTP method to be used for load requests.
+     * @property {FetchCredentials} [transport.load.credentials] The request credentials option to use for load requests. Corresponds to the standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials">Fetch API `credentials`</a> option.
      * @property {string} [transport.load.paramName] Name of the parameter that will contain a serialized `load` request. The value is mandatory for requests using `GET` method (default for `load`) so if the value is not provided `data` string is used as default. This value is optional for HTTP methods like `POST` and `PUT`, the request body will be used for data transferring in these cases.
      * @property {object} [transport.load.params] An object containing extra HTTP parameters to pass to the server when sending a `load` request. ```javascript transport : {     load : {         url       : 'http://mycool-server.com/load.php',         // HTTP request parameter used to pass serialized "load"-requests         paramName : 'data',         // pass extra HTTP request parameter         // so resulting URL will look like: http://mycool-server.com/load.php?userId=123456&data=...         params    : {             userId : '123456'         }     },     ... } ```
      * @property {Record<string, string>} [transport.load.headers] An object containing headers to pass to each server request. ```javascript transport : {     load : {         url       : 'http://mycool-server.com/load.php',         // HTTP request parameter used to pass serialized "load"-requests         paramName : 'data',         // specify Content-Type for "load" requests         headers   : {             'Content-Type' : 'application/json'         }     },     ... } ```
      * @property {object} [transport.sync] Sync requests (`sync` in further text) configuration:
      * @property {string} [transport.sync.url] URL to request for `sync`.
-     * @property {string} [transport.sync.method] HTTP request method to be used for `sync`.
+     * @property {HttpMethod} [transport.sync.method] HTTP request method to be used for `sync`.
+     * @property {FetchCredentials} [transport.sync.credentials] The request credentials option to use for sync requests. Corresponds to the standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials">Fetch API `credentials`</a> option.
      * @property {string} [transport.sync.paramName] Name of the parameter in which `sync` data will be transferred. This value is optional for requests using methods like `POST` and `PUT`, the request body will be used for data transferring in this case (default for `sync`). And the value is mandatory for requests using `GET` method (if the value is not provided `data` string will be used as fallback).
      * @property {object} [transport.sync.params] HTTP parameters to pass with an HTTP request handling `sync`. ```javascript transport : {     sync : {         url    : 'http://mycool-server.com/sync.php',         // extra HTTP request parameter         params : {             userId : '123456'         }     },     ... } ```
      * @property {Record<string, string>} [transport.sync.headers] HTTP headers to pass with an HTTP request handling `sync`. ```javascript transport : {     sync : {         url     : 'http://mycool-server.com/sync.php',         // specify Content-Type for "sync" requests         headers : {             'Content-Type' : 'application/json'         }     },     ... } ```
      */
-    transport ? : { load?: { url?: string, method?: string, paramName?: string, params?: object, headers?: Record<string, string> }, sync?: { url?: string, method?: string, paramName?: string, params?: object, headers?: Record<string, string> } }
+    transport ? : { load?: { url?: string, method?: HttpMethod, credentials?: FetchCredentials, paramName?: string, params?: object, headers?: Record<string, string> }, sync?: { url?: string, method?: HttpMethod, credentials?: FetchCredentials, paramName?: string, params?: object, headers?: Record<string, string> } }
     /**
      * By default, the stores of a project use the raw data objects passed to them as the data source for their
      * records if data is loaded remotely (using an `AjaxStore` or a `CrudManager`). For data supplied inline,
@@ -604,7 +605,7 @@ const emit = defineEmits<{
      * @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
      * @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
      */
-    (e: 'beforeLoad', params: ((event: { source: AbstractCrudManager, pack: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeLoad', params: ((event: { source: AbstractCrudManager, pack: object }) => boolean|void)|string): boolean|void
     /**
      * Fires before loaded data get applied to the stores. Return `false` to prevent data applying.
      * This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
@@ -615,7 +616,7 @@ const emit = defineEmits<{
      * @param {object} params.event.response The decoded server response object.
      * @param {object} params.event.options Options provided to the [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
      */
-    (e: 'beforeLoadApply', params: ((event: { source: AbstractCrudManager, response: object, options: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeLoadApply', params: ((event: { source: AbstractCrudManager, response: object, options: object }) => boolean|void)|string): boolean|void
     /**
      * Fires before server response gets applied to the stores. Return `false` to prevent data applying.
      * This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
@@ -626,7 +627,7 @@ const emit = defineEmits<{
      * @param {'sync','load'} params.event.requestType The request type (`sync` or `load`).
      * @param {object} params.event.response The decoded server response object.
      */
-    (e: 'beforeResponseApply', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeResponseApply', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object }) => boolean|void)|string): boolean|void
     /**
      * Fires before a request is sent to the server.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-beforeSend)
@@ -658,7 +659,7 @@ const emit = defineEmits<{
      * @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
      * @param {object} params.event.response The decoded server response object.
      */
-    (e: 'beforeSyncApply', params: ((event: { source: AbstractCrudManager, response: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeSyncApply', params: ((event: { source: AbstractCrudManager, response: object }) => boolean|void)|string): boolean|void
     /**
      * Fires when any other event is fired from the object.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-catchAll)

package/src/components/BryntumSchedulerProProjectModelProps.ts

@@ -1,4 +1,4 @@
-import type { AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, CalendarManagerStore, CalendarManagerStoreConfig, CalendarModel, CalendarModelConfig, CoreStateTrackingManager, CrudManagerRequestResponse, CrudManagerStoreDescriptor, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, DurationUnit, EventModel, EventModelConfig, EventStore, EventStoreConfig, LazyLoadCrudManagerRequestParams, Model, ModelConfig, ProjectModelListeners, ResourceAllocationInfo, ResourceModel, ResourceModelConfig, ResourceStore, ResourceStoreConfig, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, StateTrackingManagerConfig, Store, StoreConfig, TimeRangeStore, TimeSpan, TimeSpanConfig } from '@bryntum/schedulerpro';
+import type { AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, CalendarManagerStore, CalendarManagerStoreConfig, CalendarModel, CalendarModelConfig, CoreStateTrackingManager, CrudManagerRequestResponse, CrudManagerStoreDescriptor, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, DurationUnit, EventModel, EventModelConfig, EventStore, EventStoreConfig, FetchCredentials, HttpMethod, LazyLoadCrudManagerRequestParams, Model, ModelConfig, ProjectModelListeners, ResourceAllocationInfo, ResourceModel, ResourceModelConfig, ResourceStore, ResourceStoreConfig, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, StateTrackingManagerConfig, Store, StoreConfig, TimeRangeStore, TimeSpan, TimeSpanConfig } from '@bryntum/schedulerpro';
 import {  } from '@bryntum/schedulerpro';
 
 export declare type BryntumSchedulerProProjectModelProps = {
@@ -263,12 +263,11 @@ export declare type BryntumSchedulerProProjectModelProps = {
      * If set to `true`, or a config object, this makes the CrudManager load records only when needed. When a record
      * or a date range that is not already loaded is requested, a load request will be made to the specified URL.
      * More more details about lazy loading, see the [guide](https://bryntum.com/products/schedulerpro/docs/api/Grid/guides/data/lazyloading.md)
-     * @param {object} lazyLoad Lazy load config
-     * @param {number} lazyLoad.chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
+     * @param {number} chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
      * @param {DurationUnit} bufferUnit Used together with bufferAmount to calculate the start and end dates of each load request. The value is added to the current visible start or end date. Defaults to the visible time span length (does not affect ResourceStore).
      * @param {number} bufferAmount See `bufferUnit`
      */
-    lazyLoad ? : Boolean|{ lazyLoad: { chunkSize: number }, bufferUnit: DurationUnit, bufferAmount: number }
+    lazyLoad ? : Boolean|{ chunkSize: number, bufferUnit: DurationUnit, bufferAmount: number }
     /**
      * The listener set for this object.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-listeners)
@@ -535,18 +534,20 @@ export declare type BryntumSchedulerProProjectModelProps = {
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-transport)
      * @property {object} [transport.load] Load requests configuration:
      * @property {string} [transport.load.url] URL to request for data loading.
-     * @property {string} [transport.load.method] HTTP method to be used for load requests.
+     * @property {HttpMethod} [transport.load.method] HTTP method to be used for load requests.
+     * @property {FetchCredentials} [transport.load.credentials] The request credentials option to use for load requests. Corresponds to the standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials">Fetch API `credentials`</a> option.
      * @property {string} [transport.load.paramName] Name of the parameter that will contain a serialized `load` request. The value is mandatory for requests using `GET` method (default for `load`) so if the value is not provided `data` string is used as default. This value is optional for HTTP methods like `POST` and `PUT`, the request body will be used for data transferring in these cases.
      * @property {object} [transport.load.params] An object containing extra HTTP parameters to pass to the server when sending a `load` request. ```javascript transport : {     load : {         url       : 'http://mycool-server.com/load.php',         // HTTP request parameter used to pass serialized "load"-requests         paramName : 'data',         // pass extra HTTP request parameter         // so resulting URL will look like: http://mycool-server.com/load.php?userId=123456&data=...         params    : {             userId : '123456'         }     },     ... } ```
      * @property {Record<string, string>} [transport.load.headers] An object containing headers to pass to each server request. ```javascript transport : {     load : {         url       : 'http://mycool-server.com/load.php',         // HTTP request parameter used to pass serialized "load"-requests         paramName : 'data',         // specify Content-Type for "load" requests         headers   : {             'Content-Type' : 'application/json'         }     },     ... } ```
      * @property {object} [transport.sync] Sync requests (`sync` in further text) configuration:
      * @property {string} [transport.sync.url] URL to request for `sync`.
-     * @property {string} [transport.sync.method] HTTP request method to be used for `sync`.
+     * @property {HttpMethod} [transport.sync.method] HTTP request method to be used for `sync`.
+     * @property {FetchCredentials} [transport.sync.credentials] The request credentials option to use for sync requests. Corresponds to the standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials">Fetch API `credentials`</a> option.
      * @property {string} [transport.sync.paramName] Name of the parameter in which `sync` data will be transferred. This value is optional for requests using methods like `POST` and `PUT`, the request body will be used for data transferring in this case (default for `sync`). And the value is mandatory for requests using `GET` method (if the value is not provided `data` string will be used as fallback).
      * @property {object} [transport.sync.params] HTTP parameters to pass with an HTTP request handling `sync`. ```javascript transport : {     sync : {         url    : 'http://mycool-server.com/sync.php',         // extra HTTP request parameter         params : {             userId : '123456'         }     },     ... } ```
      * @property {Record<string, string>} [transport.sync.headers] HTTP headers to pass with an HTTP request handling `sync`. ```javascript transport : {     sync : {         url     : 'http://mycool-server.com/sync.php',         // specify Content-Type for "sync" requests         headers : {             'Content-Type' : 'application/json'         }     },     ... } ```
      */
-    transport ? : { load?: { url?: string, method?: string, paramName?: string, params?: object, headers?: Record<string, string> }, sync?: { url?: string, method?: string, paramName?: string, params?: object, headers?: Record<string, string> } }
+    transport ? : { load?: { url?: string, method?: HttpMethod, credentials?: FetchCredentials, paramName?: string, params?: object, headers?: Record<string, string> }, sync?: { url?: string, method?: HttpMethod, credentials?: FetchCredentials, paramName?: string, params?: object, headers?: Record<string, string> } }
     /**
      * By default, the stores of a project use the raw data objects passed to them as the data source for their
      * records if data is loaded remotely (using an `AjaxStore` or a `CrudManager`). For data supplied inline,

package/src/components/BryntumSchedulerProProps.ts

@@ -938,6 +938,11 @@ export declare type BryntumSchedulerProProps = {
      * A [ProjectModel](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel) instance or a config object. The project holds all SchedulerPro data.
      */
     project ? : ProjectModel|ProjectModelConfig|object
+    /**
+     * The project model class to use when creating the project instance. Override this to use a custom project
+     * model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
+     */
+    projectModelClass ? : typeof ProjectModel
     /**
      * Accepts the following values:
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/view/SchedulerPro#config-projectProgressReporting)

package/src/components/BryntumSchedulerProps.ts

@@ -921,6 +921,11 @@ export declare type BryntumSchedulerProps = {
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/view/Scheduler#config-project)
      */
     project ? : ProjectModel|ProjectModelConfig|object
+    /**
+     * The project model class to use when creating the project instance. Override this to use a custom project
+     * model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
+     */
+    projectModelClass ? : typeof ProjectModel
     /**
      * Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
      * `'month'`, `'week'` and `'day'`.

package/src/components/BryntumSchedulingDirectionPicker.vue

@@ -104,6 +104,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/SchedulerPro/widget/SchedulingDirectionPicker#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/schedulerpro/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
@@ -815,7 +824,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
@@ -1003,6 +1012,7 @@ const widgetData = {
         'cacheLastResult',
         'caseSensitive',
         'centered',
+        'checkValidity',
         'chipView',
         'clearable',
         'clearTextOnPickerHide',

package/src/components/BryntumSchedulingDirectionPickerProps.ts

@@ -90,6 +90,15 @@ export declare type BryntumSchedulingDirectionPickerProps = {
      * 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/SchedulerPro/widget/SchedulingDirectionPicker#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/schedulerpro/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) is `true`.

package/src/components/BryntumSchedulingModePicker.vue

@@ -110,6 +110,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/SchedulerPro/widget/SchedulingModePicker#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/schedulerpro/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
@@ -821,7 +830,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
@@ -1010,6 +1019,7 @@ const widgetData = {
         'cacheLastResult',
         'caseSensitive',
         'centered',
+        'checkValidity',
         'chipView',
         'clearable',
         'clearTextOnPickerHide',

package/src/components/BryntumSchedulingModePickerProps.ts

@@ -96,6 +96,15 @@ export declare type BryntumSchedulingModePickerProps = {
      * 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/SchedulerPro/widget/SchedulingModePicker#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/schedulerpro/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) is `true`.

package/src/components/BryntumSlideToggle.vue

@@ -108,6 +108,15 @@ defineProps<{
      * A value of `undefined` will cause this widget not to include its value when checked.
      */
     checkedValue ? : any
+    /**
+     * 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/Core/widget/SlideToggle#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * Custom CSS classes to add to element.
      * May be specified as a space separated string, or as an object in which property names
@@ -624,7 +633,7 @@ const emit = defineEmits<{
      * @param {boolean} params.event.valid True if this field is in a valid state.
      * @param {Event} params.event.event The triggering DOM event if any
      */
-    (e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeChange', params: ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string): boolean|void
     /**
      * Fires before an object is destroyed.
      * @param {string} e Event name
@@ -640,7 +649,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
@@ -824,6 +833,7 @@ const widgetData = {
         'bubbleEvents',
         'centered',
         'checkedValue',
+        'checkValidity',
         'color',
         'config',
         'constrainTo',

package/src/components/BryntumSlideToggleProps.ts

@@ -94,6 +94,15 @@ export declare type BryntumSlideToggleProps = {
      * A value of `undefined` will cause this widget not to include its value when checked.
      */
     checkedValue ? : any
+    /**
+     * 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/Core/widget/SlideToggle#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * Custom CSS classes to add to element.
      * May be specified as a space separated string, or as an object in which property names

package/src/components/BryntumSlider.vue

@@ -512,7 +512,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/BryntumSplitter.vue

@@ -454,7 +454,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/BryntumStartDateField.vue

@@ -95,6 +95,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/SchedulerPro/widget/StartDateField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -722,7 +731,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
@@ -896,6 +905,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/components/BryntumStartDateFieldProps.ts

@@ -81,6 +81,15 @@ export declare type BryntumStartDateFieldProps = {
      * 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/SchedulerPro/widget/StartDateField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which

package/src/components/BryntumTabPanel.vue

@@ -678,7 +678,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)
@@ -704,7 +704,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
@@ -712,7 +712,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
     /**
      * The active tab is about to be changed. Return `false` to prevent this.
      * @param {string} e Event name
@@ -723,7 +723,7 @@ const emit = defineEmits<{
      * @param {number} params.event.prevActiveIndex The previous active index.
      * @param {Core.widget.Widget} params.event.prevActiveItem The previous active child widget.
      */
-    (e: 'beforeTabChange', params: ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeTabChange', params: ((event: { activeIndex: number, activeItem: Widget, prevActiveIndex: number, prevActiveItem: Widget }) => 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/TabPanel#event-catchAll)

package/src/components/BryntumTextAreaField.vue

@@ -97,6 +97,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/Core/widget/TextAreaField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -635,7 +644,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
@@ -809,6 +818,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/components/BryntumTextAreaFieldProps.ts

@@ -83,6 +83,15 @@ export declare type BryntumTextAreaFieldProps = {
      * 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/Core/widget/TextAreaField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which

package/src/components/BryntumTextAreaPickerField.vue

@@ -95,6 +95,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/Core/widget/TextAreaPickerField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -644,7 +653,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
@@ -818,6 +827,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/components/BryntumTextAreaPickerFieldProps.ts

@@ -81,6 +81,15 @@ export declare type BryntumTextAreaPickerFieldProps = {
      * 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/Core/widget/TextAreaPickerField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which

package/src/components/BryntumTextField.vue

@@ -91,6 +91,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/Core/widget/TextField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
@@ -633,7 +642,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
@@ -806,6 +815,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/components/BryntumTextFieldProps.ts

@@ -77,6 +77,15 @@ export declare type BryntumTextFieldProps = {
      * 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/Core/widget/TextField#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/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
      * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which