@bryntum/scheduler-vue-3-thin 7.3.0 → 7.3.2

package/src/components/BryntumTimelineHistogramProps.ts

@@ -52,6 +52,8 @@ export declare type BryntumTimelineHistogramProps = {
     /**
      * 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/scheduler/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/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -581,10 +583,14 @@ export declare type BryntumTimelineHistogramProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/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/scheduler/docs/api/Scheduler/view/TimelineHistogram#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/scheduler/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/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**

package/src/components/BryntumUndoRedo.vue

@@ -43,6 +43,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/scheduler/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/scheduler/docs/api/Scheduler/widget/UndoRedo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -245,10 +247,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/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/scheduler/docs/api/Scheduler/widget/UndoRedo#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/scheduler/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/scheduler/docs/api/Scheduler/widget/UndoRedo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -391,7 +397,7 @@ defineProps<{
      * transaction to track.
      * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-project)
      */
-    project ? : ProjectModel|ProjectModelConfig|object
+    project ? : ProjectModel|ProjectModelConfig|object|null
     /**
      * Whether this widget is read-only.  This is only valid if the widget is an input
      * field, <strong>or contains input fields at any depth</strong>.
@@ -556,42 +562,34 @@ const emit = defineEmits<{
      * Fires before an object is destroyed.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.Base} params.params.event.source The Object that is being destroyed.
+     * @param {object} params.event Event object
+     * @param {Core.Base} params.event.source The Object that is being destroyed.
      */
     (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
     /**
      * Triggered before a widget is hidden. Return `false` to prevent the action.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget being hidden.
+     * @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)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Container} params.params.event.source The container
-     * @param {Core.data.Model} params.params.event.record The record
+     * @param {object} params.event Event object
+     * @param {Core.widget.Container} params.event.source The container
+     * @param {Core.data.Model} params.event.record The record
      */
     (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
     /**
      * Triggered before a widget is shown. Return `false` to prevent the action.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget,any} params.params.event.source The widget being shown
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget,any} params.event.source The widget being shown
      */
     (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
     /**
@@ -599,57 +597,47 @@ const emit = defineEmits<{
      * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#event-catchAll)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
-     * @param {string} params.params.event.event.type The type of the event which is caught by the listener
+     * @param {object} params.event Event object
+     * @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
+     * @param {string} params.event.event.type The type of the event which is caught by the listener
      */
     (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
     /**
      * Fires when an object is destroyed.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.Base} params.params.event.source The Object that is being destroyed.
+     * @param {object} params.event Event object
+     * @param {Core.Base} params.event.source The Object that is being destroyed.
      */
     (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
     /**
      * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-hasChanges) property changes
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Container} params.params.event.source The container.
-     * @param {boolean} params.params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Container} params.event.source The container.
+     * @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
      */
     (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
     /**
      * Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {HTMLElement} params.params.event.element The Widget's element.
+     * @param {object} params.event Event object
+     * @param {HTMLElement} params.event.element The Widget's element.
      */
     (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
     /**
      * Fired when focus enters this Widget.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source This Widget
-     * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
-     * @param {HTMLElement} params.params.event.toElement The element which gained focus.
-     * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
-     * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
-     * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source This Widget
+     * @param {HTMLElement} params.event.fromElement The element which lost focus.
+     * @param {HTMLElement} params.event.toElement The element which gained focus.
+     * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
+     * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
+     * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
      */
     (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
     /**
@@ -658,25 +646,21 @@ const emit = defineEmits<{
      * will not trigger this event. This is when focus exits this widget completely.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source This Widget
-     * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
-     * @param {HTMLElement} params.params.event.toElement The element which gained focus.
-     * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
-     * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
-     * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source This Widget
+     * @param {HTMLElement} params.event.fromElement The element which lost focus.
+     * @param {HTMLElement} params.event.toElement The element which gained focus.
+     * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
+     * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
+     * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
      */
     (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
     /**
      * Triggered after a widget was hidden
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source The widget
      */
     (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
     /**
@@ -685,21 +669,17 @@ const emit = defineEmits<{
      * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#event-paint)
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget being painted.
-     * @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source The widget being painted.
+     * @param {boolean} params.event.firstPaint `true` if this is the first paint.
      */
     (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
     /**
      * Fired when a Widget's read only state is toggled
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {boolean} params.params.event.readOnly Read only or not
+     * @param {object} params.event Event object
+     * @param {boolean} params.event.readOnly Read only or not
      */
     (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
     /**
@@ -711,24 +691,20 @@ const emit = defineEmits<{
      * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source This Widget
-     * @param {number} params.params.event.width The new width
-     * @param {number} params.params.event.height The new height
-     * @param {number} params.params.event.oldWidth The old width
-     * @param {number} params.params.event.oldHeight The old height
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source This Widget
+     * @param {number} params.event.width The new width
+     * @param {number} params.event.height The new height
+     * @param {number} params.event.oldWidth The old width
+     * @param {number} params.event.oldHeight The old height
      */
     (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
     /**
      * Triggered after a widget is shown.
      * @param {string} e Event name
      * @param {object} params Event parameters
-     * @param {string} params.e Event name
-     * @param {object} params.params Event parameters
-     * @param {object} params.params.event Event object
-     * @param {Core.widget.Widget} params.params.event.source The widget
+     * @param {object} params.event Event object
+     * @param {Core.widget.Widget} params.event.source The widget
      */
     (e: 'show', params: ((event: { source: Widget }) => void)|string): void
 }>();

package/src/components/BryntumUndoRedoProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumUndoRedoProps = {
     /**
      * 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/scheduler/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/scheduler/docs/api/Scheduler/widget/UndoRedo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -230,10 +232,14 @@ export declare type BryntumUndoRedoProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/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/scheduler/docs/api/Scheduler/widget/UndoRedo#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/scheduler/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/scheduler/docs/api/Scheduler/widget/UndoRedo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -376,7 +382,7 @@ export declare type BryntumUndoRedoProps = {
      * transaction to track.
      * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-project)
      */
-    project ? : ProjectModel|ProjectModelConfig|object
+    project ? : ProjectModel|ProjectModelConfig|object|null
     /**
      * Whether this widget is read-only.  This is only valid if the widget is an input
      * field, <strong>or contains input fields at any depth</strong>.