@bryntum/schedulerpro-vue-3 7.3.1 → 7.3.3

package/src/components/BryntumBooleanCombo.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/schedulerpro/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/schedulerpro/docs/api/Core/widget/BooleanCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -101,9 +103,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * A function (or the name of a function in the ownership hierarchy) called during field validation
      * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-isValid)
@@ -239,7 +242,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
      * property which controls when a drag should start.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -406,10 +409,14 @@ defineProps<{
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/Core/widget/BooleanCombo#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/schedulerpro/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/schedulerpro/docs/api/Core/widget/BooleanCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -686,7 +693,7 @@ defineProps<{
     rtl ? : Boolean
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**
@@ -1026,7 +1033,6 @@ const widgetData = {
         'bubbleEvents',
         'cacheLastResult',
         'caseSensitive',
-        'centered',
         'checkValidity',
         'chipView',
         'clearable',
@@ -1127,6 +1133,7 @@ const widgetData = {
         'badge',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'dataset',

package/src/components/BryntumBooleanComboProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumBooleanComboProps = {
     /**
      * 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/schedulerpro/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/schedulerpro/docs/api/Core/widget/BooleanCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -87,9 +89,10 @@ export declare type BryntumBooleanComboProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * A function (or the name of a function in the ownership hierarchy) called during field validation
      * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-isValid)
@@ -225,7 +228,7 @@ export declare type BryntumBooleanComboProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
      * property which controls when a drag should start.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -392,10 +395,14 @@ export declare type BryntumBooleanComboProps = {
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/Core/widget/BooleanCombo#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/schedulerpro/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/schedulerpro/docs/api/Core/widget/BooleanCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -672,7 +679,7 @@ export declare type BryntumBooleanComboProps = {
     rtl ? : Boolean
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**

package/src/components/BryntumButton.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/schedulerpro/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/schedulerpro/docs/api/Core/widget/Button#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -83,9 +85,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Button#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * Custom CSS classes to add to element.
      * May be specified as a space separated string, or as an object in which property names
@@ -159,7 +162,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
      * property which controls when a drag should start.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Button#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -235,10 +238,14 @@ defineProps<{
     ignoreParentReadOnly ? : Boolean
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/Core/widget/Button#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/schedulerpro/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/schedulerpro/docs/api/Core/widget/Button#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -408,7 +415,7 @@ defineProps<{
     scrollable ? : Boolean|ScrollerConfig|Scroller
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**
@@ -720,7 +727,6 @@ const widgetData = {
         'ariaDescription',
         'ariaLabel',
         'bubbleEvents',
-        'centered',
         'color',
         'config',
         'constrainTo',
@@ -767,6 +773,7 @@ const widgetData = {
         'behaviorType',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'content',

package/src/components/BryntumButtonGroup.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/schedulerpro/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/schedulerpro/docs/api/Core/widget/ButtonGroup#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -83,9 +85,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * Custom CSS class to add to element.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-cls)
@@ -168,7 +171,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
      * property which controls when a drag should start.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -243,10 +246,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/Core/widget/ButtonGroup#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/schedulerpro/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/schedulerpro/docs/api/Core/widget/ButtonGroup#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -270,7 +277,7 @@ defineProps<{
      */
     labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
     /**
-     * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
+     * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -435,7 +442,7 @@ defineProps<{
     scrollable ? : Boolean|ScrollerConfig|Scroller
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**
@@ -738,7 +745,6 @@ const widgetData = {
         'autoUpdateRecord',
         'border',
         'bubbleEvents',
-        'centered',
         'color',
         'config',
         'constrainTo',
@@ -792,6 +798,7 @@ const widgetData = {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'content',

package/src/components/BryntumButtonGroupProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumButtonGroupProps = {
     /**
      * 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/schedulerpro/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/schedulerpro/docs/api/Core/widget/ButtonGroup#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -69,9 +71,10 @@ export declare type BryntumButtonGroupProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * Custom CSS class to add to element.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-cls)
@@ -154,7 +157,7 @@ export declare type BryntumButtonGroupProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
      * property which controls when a drag should start.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -229,10 +232,14 @@ export declare type BryntumButtonGroupProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/Core/widget/ButtonGroup#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/schedulerpro/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/schedulerpro/docs/api/Core/widget/ButtonGroup#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -256,7 +263,7 @@ export declare type BryntumButtonGroupProps = {
      */
     labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
     /**
-     * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
+     * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ButtonGroup#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -421,7 +428,7 @@ export declare type BryntumButtonGroupProps = {
     scrollable ? : Boolean|ScrollerConfig|Scroller
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**

package/src/components/BryntumButtonProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumButtonProps = {
     /**
      * 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/schedulerpro/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/schedulerpro/docs/api/Core/widget/Button#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -69,9 +71,10 @@ export declare type BryntumButtonProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Button#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * Custom CSS classes to add to element.
      * May be specified as a space separated string, or as an object in which property names
@@ -145,7 +148,7 @@ export declare type BryntumButtonProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
      * property which controls when a drag should start.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Button#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -221,10 +224,14 @@ export declare type BryntumButtonProps = {
     ignoreParentReadOnly ? : Boolean
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/Core/widget/Button#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/schedulerpro/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/schedulerpro/docs/api/Core/widget/Button#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -394,7 +401,7 @@ export declare type BryntumButtonProps = {
     scrollable ? : Boolean|ScrollerConfig|Scroller
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**

package/src/components/BryntumCalendarEditor.vue

@@ -46,6 +46,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/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -113,9 +115,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * Show a tool in the header to close this Popup.
      * The tool is available in the [tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Toolable#property-tools) object
@@ -354,10 +357,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#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/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -383,7 +390,7 @@ defineProps<{
      */
     labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
     /**
-     * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
+     * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -584,7 +591,7 @@ defineProps<{
     scrollable ? : Boolean|ScrollerConfig|Scroller
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**
@@ -952,7 +959,6 @@ const widgetData = {
         'border',
         'bubbleEvents',
         'calendar',
-        'centered',
         'closable',
         'closeAction',
         'closeOnEscape',
@@ -1025,6 +1031,7 @@ const widgetData = {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'collapsed',
         'column',

package/src/components/BryntumCalendarEditorProps.ts

@@ -32,6 +32,8 @@ export declare type BryntumCalendarEditorProps = {
     /**
      * 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/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -99,9 +101,10 @@ export declare type BryntumCalendarEditorProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * Show a tool in the header to close this Popup.
      * The tool is available in the [tools](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Toolable#property-tools) object
@@ -340,10 +343,14 @@ export declare type BryntumCalendarEditorProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#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/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -369,7 +376,7 @@ export declare type BryntumCalendarEditorProps = {
      */
     labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
     /**
-     * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
+     * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/CalendarEditor#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -570,7 +577,7 @@ export declare type BryntumCalendarEditorProps = {
     scrollable ? : Boolean|ScrollerConfig|Scroller
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**

package/src/components/BryntumCalendarField.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/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -112,9 +114,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/CalendarField#config-centered)
+     * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
      */
-    centered ? : Boolean
+    centered ? : Boolean|object
     /**
      * A function (or the name of a function in the ownership hierarchy) called during field validation
      * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-isValid)
@@ -250,7 +253,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
      * property which controls when a drag should start.
      * [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/widget/CalendarField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -417,10 +420,14 @@ defineProps<{
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarField#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/schedulerpro/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/schedulerpro/docs/api/SchedulerPro/widget/CalendarField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -681,7 +688,7 @@ defineProps<{
     rtl ? : Boolean
     /**
      * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
-     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
      */
     scrollAction ? : 'hide'|'realign'|null
     /**
@@ -1024,7 +1031,6 @@ const widgetData = {
         'calendarConsumerRecord',
         'calendarEditor',
         'caseSensitive',
-        'centered',
         'checkValidity',
         'chipView',
         'clearable',
@@ -1121,6 +1127,7 @@ const widgetData = {
         'badge',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'dataset',