@bryntum/schedulerpro-vue-3 7.3.1 → 7.3.3

package/src/components/BryntumSliderProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumSliderProps = {
     /**
      * 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/Slider#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -61,9 +63,10 @@ export declare type BryntumSliderProps = {
     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/Slider#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
@@ -137,7 +140,7 @@ export declare type BryntumSliderProps = {
     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/Slider#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -199,10 +202,14 @@ export declare type BryntumSliderProps = {
     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/Slider#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/Slider#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -365,7 +372,7 @@ export declare type BryntumSliderProps = {
     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/BryntumSplitter.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/Splitter#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -75,9 +77,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/Splitter#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
@@ -151,7 +154,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/Splitter#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -213,10 +216,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/Splitter#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/Splitter#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -359,7 +366,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
     /**
@@ -609,7 +616,6 @@ const widgetData = {
         'ariaDescription',
         'ariaLabel',
         'bubbleEvents',
-        'centered',
         'color',
         'config',
         'constrainTo',
@@ -655,6 +661,7 @@ const widgetData = {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'content',

package/src/components/BryntumSplitterProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumSplitterProps = {
     /**
      * 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/Splitter#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -61,9 +63,10 @@ export declare type BryntumSplitterProps = {
     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/Splitter#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
@@ -137,7 +140,7 @@ export declare type BryntumSplitterProps = {
     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/Splitter#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -199,10 +202,14 @@ export declare type BryntumSplitterProps = {
     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/Splitter#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/Splitter#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -345,7 +352,7 @@ export declare type BryntumSplitterProps = {
     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/BryntumStartDateField.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/StartDateField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -92,9 +94,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/StartDateField#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)
@@ -191,7 +194,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/StartDateField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -312,10 +315,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/StartDateField#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/StartDateField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -512,7 +519,7 @@ defineProps<{
     /**
      * Project model calendar of which should be used by the field.
      */
-    project ? : ProjectModel|object
+    project ? : ProjectModel|object|null
     /**
      * Makes the field unmodifiable by user action. The input area is not editable, and triggers
      * are unresponsive.
@@ -565,7 +572,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
     /**
@@ -904,7 +911,6 @@ const widgetData = {
         'autoExpand',
         'autoSelect',
         'bubbleEvents',
-        'centered',
         'checkValidity',
         'clearable',
         'color',
@@ -984,6 +990,7 @@ const widgetData = {
         'badge',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'dataset',

package/src/components/BryntumStartDateFieldProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumStartDateFieldProps = {
     /**
      * 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/StartDateField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -78,9 +80,10 @@ export declare type BryntumStartDateFieldProps = {
     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/StartDateField#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)
@@ -177,7 +180,7 @@ export declare type BryntumStartDateFieldProps = {
     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/StartDateField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -298,10 +301,14 @@ export declare type BryntumStartDateFieldProps = {
     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/StartDateField#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/StartDateField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -498,7 +505,7 @@ export declare type BryntumStartDateFieldProps = {
     /**
      * Project model calendar of which should be used by the field.
      */
-    project ? : ProjectModel|object
+    project ? : ProjectModel|object|null
     /**
      * Makes the field unmodifiable by user action. The input area is not editable, and triggers
      * are unresponsive.
@@ -551,7 +558,7 @@ export declare type BryntumStartDateFieldProps = {
     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/BryntumTabPanel.vue

@@ -50,6 +50,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/TabPanel#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -106,9 +108,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/TabPanel#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
@@ -204,7 +207,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/TabPanel#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -311,10 +314,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/TabPanel#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/TabPanel#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -340,7 +347,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/TabPanel#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -506,7 +513,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
     /**
@@ -894,7 +901,6 @@ const widgetData = {
         'bodyCls',
         'border',
         'bubbleEvents',
-        'centered',
         'collapsible',
         'color',
         'config',
@@ -961,6 +967,7 @@ const widgetData = {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'collapsed',
         'column',

package/src/components/BryntumTabPanelProps.ts

@@ -36,6 +36,8 @@ export declare type BryntumTabPanelProps = {
     /**
      * 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/TabPanel#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -92,9 +94,10 @@ export declare type BryntumTabPanelProps = {
     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/TabPanel#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
@@ -190,7 +193,7 @@ export declare type BryntumTabPanelProps = {
     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/TabPanel#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -297,10 +300,14 @@ export declare type BryntumTabPanelProps = {
     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/TabPanel#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/TabPanel#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -326,7 +333,7 @@ export declare type BryntumTabPanelProps = {
      */
     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/TabPanel#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -492,7 +499,7 @@ export declare type BryntumTabPanelProps = {
     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/BryntumTextAreaField.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/TextAreaField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -94,9 +96,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/TextAreaField#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)
@@ -193,7 +196,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/TextAreaField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -309,10 +312,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/TextAreaField#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/TextAreaField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -506,7 +513,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
     /**
@@ -817,7 +824,6 @@ const widgetData = {
         'autoHeight',
         'autoSelect',
         'bubbleEvents',
-        'centered',
         'checkValidity',
         'clearable',
         'color',
@@ -885,6 +891,7 @@ const widgetData = {
         'badge',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'dataset',

package/src/components/BryntumTextAreaFieldProps.ts

@@ -28,6 +28,8 @@ export declare type BryntumTextAreaFieldProps = {
     /**
      * 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/TextAreaField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -80,9 +82,10 @@ export declare type BryntumTextAreaFieldProps = {
     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/TextAreaField#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)
@@ -179,7 +182,7 @@ export declare type BryntumTextAreaFieldProps = {
     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/TextAreaField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -295,10 +298,14 @@ export declare type BryntumTextAreaFieldProps = {
     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/TextAreaField#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/TextAreaField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -492,7 +499,7 @@ export declare type BryntumTextAreaFieldProps = {
     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
     /**