@bryntum/calendar-vue-3 7.3.0 → 7.3.1

package/src/components/BryntumDayResourceView.vue

@@ -469,9 +469,13 @@ defineProps<{
      */
     eventSorter ? : (lhs: EventModel|EventBar, rhs: EventModel|EventBar) => number
     /**
-     * Number of pixels to reduce the height of events by, to leave a gap between them.
+     * The amount of vertical spacing applied to events. May be a single number giving the
+     * bottom spacing in pixels, or an object specifying both top and bottom spacings:
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayResourceView#config-eventSpacing)
+     * @property {number} [top] The top spacing in pixels.
+     * @property {number} [bottom] The bottom spacing in pixels.
      */
-    eventSpacing ? : number
+    eventSpacing ? : number|object
     /**
      * By default, the end date of an all day event is displayed in the UI as
      * the last calendar date on which the event falls. For most end users, this is the
@@ -1249,7 +1253,7 @@ const emit = defineEmits<{
      * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource if the UI includes a resource.
      * @param {CalendarView} params.event.view This view.
      */
-    (e: 'beforeAutoCreate', params: ((event: { domEvent: Event, date: Date, startDate: Date, endDate: Date, resourceRecord: ResourceModel, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeAutoCreate', params: ((event: { domEvent: Event, date: Date, startDate: Date, endDate: Date, resourceRecord: ResourceModel, view: CalendarView }) => boolean|void)|string): boolean|void
     /**
      * Triggered before a view's orientating date changes.
      * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayResourceView#event-beforeChangeDate)
@@ -1259,7 +1263,7 @@ const emit = defineEmits<{
      * @param {Date} params.event.oldDate The current orientating date of this view.
      * @param {Date} params.event.date The new date to which this view is to be orientated.
      */
-    (e: 'beforeChangeDate', params: ((event: { oldDate: Date, date: Date }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeChangeDate', params: ((event: { oldDate: Date, date: Date }) => boolean|void)|string): boolean|void
     /**
      * Fires before an object is destroyed.
      * @param {string} e Event name
@@ -1275,7 +1279,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 new [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
      * @param {string} e Event name
@@ -1311,7 +1315,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
@@ -1319,7 +1323,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/calendar/docs/api/Calendar/widget/DayResourceView#event-catchAll)

package/src/components/BryntumDayResourceViewProps.ts

@@ -455,9 +455,13 @@ export declare type BryntumDayResourceViewProps = {
      */
     eventSorter ? : (lhs: EventModel|EventBar, rhs: EventModel|EventBar) => number
     /**
-     * Number of pixels to reduce the height of events by, to leave a gap between them.
+     * The amount of vertical spacing applied to events. May be a single number giving the
+     * bottom spacing in pixels, or an object specifying both top and bottom spacings:
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayResourceView#config-eventSpacing)
+     * @property {number} [top] The top spacing in pixels.
+     * @property {number} [bottom] The bottom spacing in pixels.
      */
-    eventSpacing ? : number
+    eventSpacing ? : number|object
     /**
      * By default, the end date of an all day event is displayed in the UI as
      * the last calendar date on which the event falls. For most end users, this is the

package/src/components/BryntumDayView.vue

@@ -469,9 +469,13 @@ defineProps<{
      */
     eventSorter ? : (lhs: EventModel|EventBar, rhs: EventModel|EventBar) => number
     /**
-     * Number of pixels to reduce the height of events by, to leave a gap between them.
+     * The amount of vertical spacing applied to events. May be a single number giving the
+     * bottom spacing in pixels, or an object specifying both top and bottom spacings:
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView#config-eventSpacing)
+     * @property {number} [top] The top spacing in pixels.
+     * @property {number} [bottom] The bottom spacing in pixels.
      */
-    eventSpacing ? : number
+    eventSpacing ? : number|object
     /**
      * By default, the end date of an all day event is displayed in the UI as
      * the last calendar date on which the event falls. For most end users, this is the
@@ -1214,7 +1218,7 @@ const emit = defineEmits<{
      * @param {Scheduler.model.ResourceModel} params.event.resourceRecord The resource if the UI includes a resource.
      * @param {CalendarView} params.event.view This view.
      */
-    (e: 'beforeAutoCreate', params: ((event: { domEvent: Event, date: Date, startDate: Date, endDate: Date, resourceRecord: ResourceModel, view: CalendarView }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeAutoCreate', params: ((event: { domEvent: Event, date: Date, startDate: Date, endDate: Date, resourceRecord: ResourceModel, view: CalendarView }) => boolean|void)|string): boolean|void
     /**
      * Triggered before a view's orientating date changes.
      * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView#event-beforeChangeDate)
@@ -1224,7 +1228,7 @@ const emit = defineEmits<{
      * @param {Date} params.event.oldDate The current orientating date of this view.
      * @param {Date} params.event.date The new date to which this view is to be orientated.
      */
-    (e: 'beforeChangeDate', params: ((event: { oldDate: Date, date: Date }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeChangeDate', params: ((event: { oldDate: Date, date: Date }) => boolean|void)|string): boolean|void
     /**
      * Fires before an object is destroyed.
      * @param {string} e Event name
@@ -1240,7 +1244,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 new [responsiveState](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Responsive#config-responsiveState) is applied.
      * @param {string} e Event name
@@ -1276,7 +1280,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
@@ -1284,7 +1288,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/calendar/docs/api/Calendar/widget/DayView#event-catchAll)

package/src/components/BryntumDayViewProps.ts

@@ -455,9 +455,13 @@ export declare type BryntumDayViewProps = {
      */
     eventSorter ? : (lhs: EventModel|EventBar, rhs: EventModel|EventBar) => number
     /**
-     * Number of pixels to reduce the height of events by, to leave a gap between them.
+     * The amount of vertical spacing applied to events. May be a single number giving the
+     * bottom spacing in pixels, or an object specifying both top and bottom spacings:
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/DayView#config-eventSpacing)
+     * @property {number} [top] The top spacing in pixels.
+     * @property {number} [bottom] The bottom spacing in pixels.
      */
-    eventSpacing ? : number
+    eventSpacing ? : number|object
     /**
      * By default, the end date of an all day event is displayed in the UI as
      * the last calendar date on which the event falls. For most end users, this is the

package/src/components/BryntumDemoCodeEditor.vue

@@ -690,7 +690,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)
@@ -716,7 +716,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
@@ -724,7 +724,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/calendar/docs/api/Core/widget/DemoCodeEditor#event-catchAll)

package/src/components/BryntumDisplayField.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/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/DisplayField#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
@@ -628,7 +637,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
@@ -801,6 +810,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/components/BryntumDisplayFieldProps.ts

@@ -77,6 +77,15 @@ export declare type BryntumDisplayFieldProps = {
      * 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/DisplayField#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

package/src/components/BryntumDurationField.vue

@@ -100,6 +100,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/DurationField#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
@@ -676,7 +685,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
@@ -849,6 +858,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'color',
         'config',

package/src/components/BryntumDurationFieldProps.ts

@@ -86,6 +86,15 @@ export declare type BryntumDurationFieldProps = {
      * 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/DurationField#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

package/src/components/BryntumEditor.vue

@@ -607,7 +607,7 @@ const emit = defineEmits<{
      * @param {Event} params.event.event Included if the cancellation was triggered by a DOM event
      * @param {Core.widget.Editor} params.event.source The Editor that triggered the event.
      */
-    (e: 'beforeCancel', params: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeCancel', params: ((event: { oldValue: object, value: object, event: Event, source: Editor }) => boolean|void)|string): boolean|void
     /**
      * Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
      * The completion may be vetoed, in which case, focus is moved back into the editor.
@@ -620,7 +620,7 @@ const emit = defineEmits<{
      * @param {Function} [params.event.finalize] An async function may be injected into this property which performs asynchronous finalization tasks such as complex validation of confirmation. The value `true` or `false` must be returned.
      * @param {object} [params.event.finalize.context] An object describing the editing context upon requested completion of the edit.
      */
-    (e: 'beforeComplete', params: ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeComplete', params: ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => boolean|void)|string): boolean|void
     /**
      * Fires before an object is destroyed.
      * @param {string} e Event name
@@ -636,7 +636,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)
@@ -660,7 +660,7 @@ const emit = defineEmits<{
      * @param {string} e Event name
      * @param {object} params Event parameters
      * @param {object} params.event Event object
-     * @param {HTMLElement} params.event.target The element which the Editor is to overlay to edit its content.
+     * @param {Element} params.event.target The element which the Editor is to overlay to edit its content.
      * @param {Core.data.Model} [params.event.record] The record being edited.
      * @param {string} [params.event.field] The name of the field if a record is being edited.
      * @param {object} params.event.value The value to be edited.
@@ -672,7 +672,7 @@ const emit = defineEmits<{
      * @param {boolean} params.event.matchFont Whether to match the target's font. See [matchFont](https://bryntum.com/products/calendar/docs/api/Core/widget/Editor#config-matchFont)
      * @param {boolean} params.event.focus Whether to focus the editor's field.
      */
-    (e: 'beforeStart', params: ((event: { target: HTMLElement, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStart', params: ((event: { target: Element, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => boolean|void)|string): boolean|void
     /**
      * Edit has been canceled without updating the associated record or element.
      * @param {string} e Event name

package/src/components/BryntumEventColorField.vue

@@ -99,6 +99,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/Scheduler/widget/EventColorField#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
@@ -639,7 +648,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
@@ -813,6 +822,7 @@ const widgetData = {
         'autoSelect',
         'bubbleEvents',
         'centered',
+        'checkValidity',
         'clearable',
         'config',
         'constrainTo',

package/src/components/BryntumEventColorFieldProps.ts

@@ -85,6 +85,15 @@ export declare type BryntumEventColorFieldProps = {
      * 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/Scheduler/widget/EventColorField#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