@bryntum/calendar-vue-3 7.3.0 → 7.3.2

package/src/components/BryntumViewPresetComboProps.ts

@@ -22,6 +22,8 @@ export declare type BryntumViewPresetComboProps = {
     /**
      * 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/ViewPresetCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -67,6 +69,15 @@ export declare type BryntumViewPresetComboProps = {
      * Set to `true` to centre the Widget in browser viewport space.
      */
     centered ? : Boolean
+    /**
+     * A function (or the name of a function in the ownership hierarchy) called during field validation
+     * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/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/ViewPresetCombo#config-checkValidity)
+     * @param {Core.widget.Field} field The field being validated
+     * @returns {void}
+     */
+    checkValidity ? : ((field: Field) => void)|string
     /**
      * Specify `false` to not clear value typed to a multiselect combo when an item is selected.
      */
@@ -246,10 +257,14 @@ export declare type BryntumViewPresetComboProps = {
     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/ViewPresetCombo#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/ViewPresetCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumWeekView.vue

@@ -83,6 +83,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/WeekView#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -469,9 +471,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/WeekView#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
@@ -606,10 +612,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/WeekView#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/WeekView#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -1214,7 +1224,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/WeekView#event-beforeChangeDate)
@@ -1224,7 +1234,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 +1250,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 +1286,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 +1294,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/WeekView#event-catchAll)

package/src/components/BryntumWeekViewProps.ts

@@ -69,6 +69,8 @@ export declare type BryntumWeekViewProps = {
     /**
      * 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/WeekView#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -455,9 +457,13 @@ export declare type BryntumWeekViewProps = {
      */
     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/WeekView#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
@@ -592,10 +598,14 @@ export declare type BryntumWeekViewProps = {
     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/WeekView#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/WeekView#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumWidget.vue

@@ -42,6 +42,8 @@ defineProps<{
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -213,10 +215,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/Core/widget/Widget#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -443,7 +449,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/BryntumWidgetProps.ts

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

package/src/components/BryntumYearPicker.vue

@@ -42,6 +42,8 @@ defineProps<{
     /**
      * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
      * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-element).
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/YearPicker#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -299,10 +301,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/Core/widget/YearPicker#config-insertBefore)
      */
     insertBefore ? : HTMLElement|string
     /**
      * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
+     * [More...](https://bryntum.com/products/calendar/docs/api/Core/widget/YearPicker#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -673,7 +679,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {Core.widget.Widget} params.event.source The widget being hidden.
      */
-    (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
     /**
      * Fired before this container will load record values into its child fields. This is useful if you
      * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
@@ -699,7 +705,7 @@ const emit = defineEmits<{
      * @param {object} params.event Event object
      * @param {any} params.event.state State object config
      */
-    (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
     /**
      * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
      * @param {string} e Event name
@@ -707,7 +713,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/YearPicker#event-catchAll)

package/src/components/BryntumYearPickerProps.ts

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

package/src/components/BryntumYearPlanner.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/YearPlanner#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -447,10 +449,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/YearPlanner#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/YearPlanner#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -902,7 +908,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/YearPlanner#event-beforeChangeDate)
@@ -912,7 +918,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
@@ -928,7 +934,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)
@@ -954,7 +960,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
@@ -962,7 +968,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/YearPlanner#event-catchAll)

package/src/components/BryntumYearPlannerProps.ts

@@ -51,6 +51,8 @@ export declare type BryntumYearPlannerProps = {
     /**
      * 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/YearPlanner#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -433,10 +435,14 @@ export declare type BryntumYearPlannerProps = {
     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/YearPlanner#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/YearPlanner#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumYearView.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/YearView#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -493,10 +495,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/YearView#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/YearView#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -1004,7 +1010,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/YearView#event-beforeChangeDate)
@@ -1014,7 +1020,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
@@ -1030,7 +1036,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
@@ -1070,7 +1076,7 @@ const emit = defineEmits<{
      * @param {Date} params.event.date The date which has overflowing events
      * @param {Calendar.widget.OverflowPopup} params.event.overflowPopup The overflow `Popup`.
      */
-    (e: 'beforeShowOverflowPopup', params: ((event: { cell: HTMLElement, cellData: DayCell, date: Date, overflowPopup: OverflowPopup }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
+    (e: 'beforeShowOverflowPopup', params: ((event: { cell: HTMLElement, cellData: DayCell, date: Date, overflowPopup: OverflowPopup }) => boolean|void)|string): boolean|void
     /**
      * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
      * @param {string} e Event name
@@ -1078,7 +1084,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
@@ -1086,7 +1092,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/YearView#event-catchAll)

package/src/components/BryntumYearViewProps.ts

@@ -51,6 +51,8 @@ export declare type BryntumYearViewProps = {
     /**
      * 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/YearView#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -479,10 +481,14 @@ export declare type BryntumYearViewProps = {
     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/YearView#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/YearView#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**