@bryntum/core-vue-3-thin 7.3.1 → 7.3.3

package/src/components/BryntumMonthPicker.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/core/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/grid/docs/api/Core/widget/MonthPicker#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -94,9 +96,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#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
@@ -192,7 +195,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/MonthPicker#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -299,10 +302,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/MonthPicker#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/core/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/grid/docs/api/Core/widget/MonthPicker#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -328,7 +335,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/grid/docs/api/Core/widget/MonthPicker#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -498,7 +505,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
     /**
@@ -867,7 +874,6 @@ const widgetData = {
         'bodyCls',
         'border',
         'bubbleEvents',
-        'centered',
         'collapsible',
         'color',
         'config',
@@ -930,6 +936,7 @@ const widgetData = {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'collapsed',
         'column',

package/src/components/BryntumMonthPickerProps.ts

@@ -27,6 +27,8 @@ export declare type BryntumMonthPickerProps = {
     /**
      * 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/core/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/grid/docs/api/Core/widget/MonthPicker#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -79,9 +81,10 @@ export declare type BryntumMonthPickerProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#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
@@ -177,7 +180,7 @@ export declare type BryntumMonthPickerProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/MonthPicker#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -284,10 +287,14 @@ export declare type BryntumMonthPickerProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/MonthPicker#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/core/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/grid/docs/api/Core/widget/MonthPicker#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -313,7 +320,7 @@ export declare type BryntumMonthPickerProps = {
      */
     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/grid/docs/api/Core/widget/MonthPicker#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -483,7 +490,7 @@ export declare type BryntumMonthPickerProps = {
     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/BryntumNumberField.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/core/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/grid/docs/api/Core/widget/NumberField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -88,9 +90,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#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
     /**
      * Controls how change events are triggered when stepping the value up or down using either spinners or
      * arrow keys.
@@ -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/core/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/grid/docs/api/Core/widget/NumberField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -318,10 +321,14 @@ defineProps<{
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/NumberField#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/core/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/grid/docs/api/Core/widget/NumberField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -527,7 +534,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
     /**
@@ -849,7 +856,6 @@ const widgetData = {
         'autoComplete',
         'autoSelect',
         'bubbleEvents',
-        'centered',
         'changeOnSpin',
         'checkValidity',
         'clearable',
@@ -922,6 +928,7 @@ const widgetData = {
         'badge',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'dataset',

package/src/components/BryntumNumberFieldProps.ts

@@ -27,6 +27,8 @@ export declare type BryntumNumberFieldProps = {
     /**
      * 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/core/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/grid/docs/api/Core/widget/NumberField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -73,9 +75,10 @@ export declare type BryntumNumberFieldProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#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
     /**
      * Controls how change events are triggered when stepping the value up or down using either spinners or
      * arrow keys.
@@ -178,7 +181,7 @@ export declare type BryntumNumberFieldProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/NumberField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -303,10 +306,14 @@ export declare type BryntumNumberFieldProps = {
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/NumberField#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/core/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/grid/docs/api/Core/widget/NumberField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -512,7 +519,7 @@ export declare type BryntumNumberFieldProps = {
     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/BryntumPagingToolbar.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/core/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/grid/docs/api/Core/widget/PagingToolbar#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -83,9 +85,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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
@@ -171,7 +174,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/PagingToolbar#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -250,10 +253,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/PagingToolbar#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/core/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/grid/docs/api/Core/widget/PagingToolbar#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -279,7 +286,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/grid/docs/api/Core/widget/PagingToolbar#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -453,7 +460,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
     /**
@@ -756,7 +763,6 @@ const widgetData = {
         'autoUpdateRecord',
         'border',
         'bubbleEvents',
-        'centered',
         'color',
         'config',
         'constrainTo',
@@ -811,6 +817,7 @@ const widgetData = {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'content',

package/src/components/BryntumPagingToolbarProps.ts

@@ -27,6 +27,8 @@ export declare type BryntumPagingToolbarProps = {
     /**
      * 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/core/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/grid/docs/api/Core/widget/PagingToolbar#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -68,9 +70,10 @@ export declare type BryntumPagingToolbarProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#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
@@ -156,7 +159,7 @@ export declare type BryntumPagingToolbarProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/PagingToolbar#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 @@ export declare type BryntumPagingToolbarProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/PagingToolbar#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/core/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/grid/docs/api/Core/widget/PagingToolbar#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -264,7 +271,7 @@ export declare type BryntumPagingToolbarProps = {
      */
     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/grid/docs/api/Core/widget/PagingToolbar#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -438,7 +445,7 @@ export declare type BryntumPagingToolbarProps = {
     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/BryntumPanel.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/core/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/grid/docs/api/Core/widget/Panel#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -94,9 +96,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#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
@@ -192,7 +195,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Panel#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -299,10 +302,14 @@ defineProps<{
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Panel#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/core/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/grid/docs/api/Core/widget/Panel#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -328,7 +335,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/grid/docs/api/Core/widget/Panel#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -494,7 +501,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
     /**
@@ -845,7 +852,6 @@ const widgetData = {
         'bodyCls',
         'border',
         'bubbleEvents',
-        'centered',
         'collapsible',
         'color',
         'config',
@@ -908,6 +914,7 @@ const widgetData = {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'collapsed',
         'column',

package/src/components/BryntumPanelProps.ts

@@ -27,6 +27,8 @@ export declare type BryntumPanelProps = {
     /**
      * 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/core/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/grid/docs/api/Core/widget/Panel#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -79,9 +81,10 @@ export declare type BryntumPanelProps = {
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#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
@@ -177,7 +180,7 @@ export declare type BryntumPanelProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Panel#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -284,10 +287,14 @@ export declare type BryntumPanelProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Panel#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/core/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/grid/docs/api/Core/widget/Panel#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -313,7 +320,7 @@ export declare type BryntumPanelProps = {
      */
     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/grid/docs/api/Core/widget/Panel#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -479,7 +486,7 @@ export declare type BryntumPanelProps = {
     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/BryntumPasswordField.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/core/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/grid/docs/api/Core/widget/PasswordField#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -88,9 +90,10 @@ defineProps<{
     catchEventHandlerExceptions ? : Boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * Set to `true` to centre the Widget in browser viewport space.
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#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/core/docs/api/Core/widget/Field#property-isValid)
@@ -187,7 +190,7 @@ defineProps<{
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/PasswordField#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -303,10 +306,14 @@ defineProps<{
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/PasswordField#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/core/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/grid/docs/api/Core/widget/PasswordField#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -491,7 +498,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
     /**
@@ -801,7 +808,6 @@ const widgetData = {
         'autoComplete',
         'autoSelect',
         'bubbleEvents',
-        'centered',
         'checkValidity',
         'clearable',
         'color',
@@ -868,6 +874,7 @@ const widgetData = {
         'badge',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'dataset',