@bryntum/grid-angular-thin 7.3.1 → 7.3.3

package/src/lib/bryntum-group-bar.component.ts

@@ -50,6 +50,8 @@ export type BryntumGroupBarProps = {
     /**
      * 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/grid/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/Grid/widget/GroupBar#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -83,9 +85,10 @@ export type BryntumGroupBarProps = {
     catchEventHandlerExceptions ? : boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/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/Grid/widget/GroupBar#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
     /**
      * Configure as `true` to clear selection when clicking on empty space inside the List´s element.
      */
@@ -99,9 +102,11 @@ export type BryntumGroupBarProps = {
     /**
      * If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
      * action means. If not provided, the record representing the chip is removed from the store.
+     * @param {Core.data.Model[]} records Records to be closed
+     * @param {object} options Close options
      * @returns {void}
      */
-    closeHandler ? : string|(() => void)
+    closeHandler ? : string|((records: Model[], options: object) => void)
     /**
      * Custom CSS classes to add to element.
      * May be specified as a space separated string, or as an object in which property names
@@ -183,7 +188,7 @@ export type BryntumGroupBarProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/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/Grid/widget/GroupBar#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -278,10 +283,14 @@ export type BryntumGroupBarProps = {
     ignoreParentReadOnly ? : boolean
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/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/Grid/widget/GroupBar#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/grid/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/Grid/widget/GroupBar#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -442,7 +451,7 @@ export type BryntumGroupBarProps = {
     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
     /**
@@ -694,7 +703,6 @@ export class BryntumGroupBarComponent implements OnInit, OnDestroy {
         'ariaDescription',
         'ariaLabel',
         'bubbleEvents',
-        'centered',
         'closable',
         'closeHandler',
         'color',
@@ -751,6 +759,7 @@ export class BryntumGroupBarComponent implements OnInit, OnDestroy {
         'appendTo',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'clearSelectionOnEmptySpaceClick',
         'cls',
         'collapsibleGroups',
@@ -815,9 +824,8 @@ export class BryntumGroupBarComponent implements OnInit, OnDestroy {
     @Input() ariaDescription              ! : string;
     @Input() ariaLabel                    ! : string;
     @Input() bubbleEvents                 ! : object;
-    @Input() centered                     ! : boolean;
     @Input() closable                     ! : boolean;
-    @Input() closeHandler                 ! : string|(() => void);
+    @Input() closeHandler                 ! : string|((records: Model[], options: object) => void);
     @Input() color                        ! : Color;
     @Input() config                       ! : object;
     @Input() constrainTo                  ! : HTMLElement|Widget|Rectangle;
@@ -871,6 +879,9 @@ export class BryntumGroupBarComponent implements OnInit, OnDestroy {
     @Input() appendTo                        ! : HTMLElement|string;
     @Input() callOnFunctions                 ! : boolean;
     @Input() catchEventHandlerExceptions     ! : boolean;
+    @Input() centered                        ! : boolean|{
+        once?: boolean
+    }|boolean|object;
     @Input() clearSelectionOnEmptySpaceClick ! : boolean;
     @Input() cls                             ! : string|object;
     @Input() collapsibleGroups               ! : boolean;

package/src/lib/bryntum-tree-combo.component.ts

@@ -40,6 +40,8 @@ export type BryntumTreeComboProps = {
     /**
      * 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/grid/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/Grid/widget/TreeCombo#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -99,9 +101,10 @@ export type BryntumTreeComboProps = {
     catchEventHandlerExceptions ? : boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/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/Grid/widget/TreeCombo#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/grid/docs/api/Core/widget/Field#property-isValid)
@@ -237,7 +240,7 @@ export type BryntumTreeComboProps = {
     dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/grid/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/Grid/widget/TreeCombo#config-draggable)
      * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -404,10 +407,14 @@ export type BryntumTreeComboProps = {
     inputWidth ? : string|number
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/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/Grid/widget/TreeCombo#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/grid/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/Grid/widget/TreeCombo#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -668,7 +675,7 @@ export type BryntumTreeComboProps = {
     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
     /**
@@ -989,7 +996,6 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
         'bubbleEvents',
         'cacheLastResult',
         'caseSensitive',
-        'centered',
         'checkValidity',
         'chipView',
         'clearable',
@@ -1087,6 +1093,7 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
         'badge',
         'callOnFunctions',
         'catchEventHandlerExceptions',
+        'centered',
         'cls',
         'column',
         'content',
@@ -1160,7 +1167,6 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
     @Input() bubbleEvents                 ! : object;
     @Input() cacheLastResult              ! : number|string|Duration|DurationConfig;
     @Input() caseSensitive                ! : boolean;
-    @Input() centered                     ! : boolean;
     @Input() checkValidity                ! : ((field: Field) => void)|string;
     @Input() chipView                     ! : ChipViewConfig;
     @Input() clearable                    ! : boolean|FieldTriggerConfig;
@@ -1257,6 +1263,9 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
     @Input() badge                       ! : string;
     @Input() callOnFunctions             ! : boolean;
     @Input() catchEventHandlerExceptions ! : boolean;
+    @Input() centered                    ! : boolean|{
+        once?: boolean
+    }|boolean|object;
     @Input() cls                         ! : string|object;
     @Input() column                      ! : number;
     @Input() dataset                     ! : object|Record<string, string>;

package/src/lib/bryntum-tree-grid.component.ts

@@ -48,6 +48,8 @@ export type BryntumTreeGridProps = {
     /**
      * 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/grid/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/Grid/view/TreeGrid#config-appendTo)
      */
     appendTo ? : HTMLElement|string
     /**
@@ -359,10 +361,14 @@ export type BryntumTreeGridProps = {
     inputFieldAlign ? : 'start'|'end'
     /**
      * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/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/Grid/view/TreeGrid#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/grid/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/Grid/view/TreeGrid#config-insertFirst)
      */
     insertFirst ? : HTMLElement|string
     /**
@@ -375,7 +381,7 @@ export type BryntumTreeGridProps = {
      */
     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/Grid/view/TreeGrid#config-labelWidth)
      */
     labelWidth ? : number|null
@@ -1353,6 +1359,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
         'callOnFunctions',
         'catchEventHandlerExceptions',
         'cellEllipsis',
+        'centered',
         'cls',
         'collapsed',
         'column',
@@ -1564,6 +1571,9 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
     @Input() width                       ! : number|string;
 
     // Properties only
+    @Input() centered        ! : boolean|{
+        once?: boolean
+    };
     @Input() originalStore   ! : Store;
     @Input() parent          ! : Widget;
     @Input() selectedCell    ! : GridLocation|GridLocationConfig;