@bryntum/calendar-vue-3 7.3.0 → 7.3.2

package/src/components/BryntumResourceCombo.vue

@@ -42,6 +42,8 @@ defineProps<{
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -104,6 +106,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/ResourceCombo#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/calendar/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
@@ -397,10 +408,14 @@ defineProps<{
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceCombo#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -819,7 +834,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
@@ -1007,6 +1022,7 @@ const widgetData = {
         'cacheLastResult',
         'caseSensitive',
         'centered',
+        'checkValidity',
         'chipView',
         'clearable',
         'clearTextOnPickerHide',

package/src/components/BryntumResourceComboProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumResourceComboProps = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -90,6 +92,15 @@ export declare type BryntumResourceComboProps = {
      * 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/ResourceCombo#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/calendar/docs/api/Core/widget/ChipView) to display the
      * selected value set when [multiSelect](https://bryntum.com/products/calendar/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
@@ -383,10 +394,14 @@ export declare type BryntumResourceComboProps = {
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceCombo#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumResourceFilter.vue

@@ -52,6 +52,8 @@ defineProps<{
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceFilter#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -273,10 +275,14 @@ defineProps<{
     ignoreParentReadOnly ? : Boolean
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceFilter#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceFilter#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -572,7 +578,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
     /**
      * User going to activate an item in the list either by pointer or keyboard.
      * The active record, list item index, and the triggering event are passed.
@@ -586,7 +592,7 @@ const emit = defineEmits<{
      * @param {number} params.event.index List item index
      * @param {Event} params.event.event Triggering event
      */
-    (e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => 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/BryntumResourceFilterProps.ts

@@ -38,6 +38,8 @@ export declare type BryntumResourceFilterProps = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceFilter#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -259,10 +261,14 @@ export declare type BryntumResourceFilterProps = {
     ignoreParentReadOnly ? : Boolean
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceFilter#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Scheduler/widget/ResourceFilter#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumResourceView.vue

@@ -65,6 +65,8 @@ defineProps<{
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -444,10 +446,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -952,7 +958,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/ResourceView#event-beforeChangeDate)
@@ -962,7 +968,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
@@ -978,7 +984,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
@@ -1014,7 +1020,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
@@ -1022,7 +1028,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/ResourceView#event-catchAll)

package/src/components/BryntumResourceViewProps.ts

@@ -51,6 +51,8 @@ export declare type BryntumResourceViewProps = {
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -430,10 +432,14 @@ export declare type BryntumResourceViewProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Calendar/widget/ResourceView#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**