@genesislcap/foundation-layout 14.126.0 → 14.127.0

package/README.md

@@ -169,6 +169,10 @@ This API enables you to register an item at runtime, but it will not be displaye
 
 Add an item or items that have previously been registered with the layout.
 
+#### [Remove Items](./docs/api/foundation-layout.foundationlayout.removeitems.md)
+
+Dynamically remove items from the layout. See linked API for side effects and options.
+
 #### [Layout Required Registrations](./docs/api/foundation-layout.foundationlayout.layoutrequiredregistrations.md)
 
 Static function to read a layout config. It returns a list of all the required registrations required to load it in the layout system. [See this example](#loading-serialised-layouts).

package/dist/custom-elements.json

@@ -693,6 +693,33 @@
               ],
               "privacy": "public"
             },
+            {
+              "kind": "method",
+              "name": "removeItems",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "string of the registration ID"
+                },
+                {
+                  "name": "force",
+                  "default": "false",
+                  "type": {
+                    "text": "boolean"
+                  },
+                  "description": "if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header."
+                }
+              ],
+              "privacy": "public"
+            },
             {
               "kind": "method",
               "name": "registerItem",

package/dist/dts/main/layout-main.d.ts

@@ -212,6 +212,17 @@ export declare class FoundationLayout extends FoundationElement implements Layou
      * @throws {@link LayoutRegistrationError} if you attempt to add an item before it has been registered
      */
     addItem(config: RegisteredElementConfig | RegisteredElementConfig[], placement?: Placement): void;
+    /**
+     * @public
+     * Removes all instances of a specified registered item from the layout.
+     * @param registration - string of the registration ID
+     * @param force - if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header.
+     * @returns number of items removed
+     * @remarks
+     * Does not remove the registration from the layout system.
+     * Has a side affect of setting all tab views to be viewing the first tab in the stack.
+     */
+    removeItems(registration: string, force?: boolean): number;
     /**
      * @public
      * Register a collection of `Element` and associate them with an `ID` with the layout system for later use.
@@ -272,6 +283,10 @@ export declare class FoundationLayout extends FoundationElement implements Layou
      * Saves the stored layout config according to the Golden Layout provider.
      * And caches the layout in local storage if {@link FoundationLayout.autoSaveKey} is set.
      * @internal
+     * @remarks
+     * This will also normalise the config. E.g. over time when adding and deleting items from
+     * the layout, the layout config can become deeply nested but only have one item in it.
+     * `fromResolved()` function will remove all of the unnecessary nesting.
      * */
     private cacheAndSaveLayout;
     /**

package/dist/dts/main/layout-main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"layout-main.d.ts","sourceRoot":"","sources":["../../../src/main/layout-main.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,YAAY,EAEZ,cAAc,EAGf,MAAM,kCAAkC,CAAC;AAI1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAEL,eAAe,EAGf,SAAS,EACT,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EAKb,YAAY,EAQb,MAAM,WAAW,CAAC;AAKnB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAiBzC;;;;;;;;;;;GAWG;AACH,qBAAa,gBAAiB,SAAQ,iBAAkB,YAAW,eAAe;;IAChF,OAAO,CAAC,MAAM,CAAe;IAC7B,gBAAgB;IAChB,aAAa,EAAE,WAAW,CAAC;IAC3B,OAAO,CAAC,YAAY,CAAqC;IAEzD,gBAAgB;IAChB,CAAC,aAAa,CAAC,SAAmB;IAElC;;;;OAIG;IACmC,YAAY,EAAE,MAAM,CAAyB;IACnF,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,oBAAoB,CAAK;IAEjC,gBAAgB;IACV,OAAO,CAAC,IAAI,CAAO;IAEzB,gBAAgB;IACP,OAAO,CAAC,OAAO,CAAU;IAClC;;;;;OAKG;IACmC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC3D;;;;OAIG;IACS,sBAAsB,gBAAiB,MAAM,YAC2B;IAEpF;;;OAGG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;IAE3C;;;;;;;;;;OAUG;IACS,cAAc,UAAS;IACnC,gBAAgB;IACJ,mBAAmB,UAAS;IAExC;;;;;OAKG;IACH,aAAa,EAAE,YAAY,EAAE,CAAM;IAEnC;;;OAGG;IACS,QAAQ,EAAE,OAAO,CAAS;IAEtC;;;;;OAKG;IACI,KAAK,yBAAmC;IAE/C;;;;;;;OAOG;IACI,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAa;IAE5D;;;;OAIG;IACmC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAa;IACnF,OAAO,CAAC,SAAS,CAAS;IAE1B,gBAAgB;;IAahB,gBAAgB;IAChB,iBAAiB,IAAI,IAAI;IA8BzB,gBAAgB;IAChB,oBAAoB,IAAI,IAAI;IAY5B,gBAAgB;IAChB,OAAO,CAAC,WAAW;IAInB,gBAAgB;IAChB,OAAO,CAAC,UAAU;IAMlB,gBAAgB;IAChB,OAAO,CAAC,eAAe;IAKvB,gBAAgB;IAChB,OAAO,CAAC,gBAAgB;IAIxB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAOzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAKzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAIzB,gBAAgB;IAChB,OAAO,CAAC,kBAAkB;IAI1B,gBAAgB;IAChB,OAAO,CAAC,kBAAkB;IAI1B;;OAEG;IAEH;;;;;;;;;;OAUG;IACH,MAAM,CAAC,2BAA2B,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,EAAE;IActE;;;;;;;;OAQG;IACH,eAAe,IAAI,MAAM,EAAE;IAI3B;;;;;;OAMG;IACH,SAAS,IAAI,gBAAgB;IAiB7B;;;;;;;;;;OAUG;IACH,qBAAqB,IAAI,OAAO;IAwChC;;;;;;;;;;;;;OAaG;IACH,6BAA6B,IAAI,OAAO;IAcxC;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,MAAM,EAAE,gBAAgB,EACxB,iBAAiB,GAAE,aAAa,GAAG,OAAiB,EACpD,YAAY,GAAE,OAAe;IAoC/B;;;;;;;;;;;OAWG;IACH,OAAO,CACL,MAAM,EAAE,uBAAuB,GAAG,uBAAuB,EAAE,EAC3D,SAAS,GAAE,SAAmC;IA+DhD;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM;IAW/D;;OAEG;IAEH;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,mBAAmB,IAAI,IAAI;IAmB3B;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC;IAetD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,kBAAkB,GAAG,MAAM;IAuEtE;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAehC;;;;SAIK;IACL,OAAO,CAAC,kBAAkB;IAY1B;;;;;;;;OAQG;IACH,OAAO,CAAC,kCAAkC;IA4B1C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,oBAAoB;IAW5B;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;IAU3B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAM3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAWpC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;CAyBhC;AAMD;;;;;GAKG;AACH,eAAO,MAAM,cAAc,uEAK1B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;2BAI3B,CAAC"}
+{"version":3,"file":"layout-main.d.ts","sourceRoot":"","sources":["../../../src/main/layout-main.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,YAAY,EAEZ,cAAc,EAGf,MAAM,kCAAkC,CAAC;AAI1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAEL,eAAe,EAGf,SAAS,EACT,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EAKb,YAAY,EAQb,MAAM,WAAW,CAAC;AAKnB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAiBzC;;;;;;;;;;;GAWG;AACH,qBAAa,gBAAiB,SAAQ,iBAAkB,YAAW,eAAe;;IAChF,OAAO,CAAC,MAAM,CAAe;IAC7B,gBAAgB;IAChB,aAAa,EAAE,WAAW,CAAC;IAC3B,OAAO,CAAC,YAAY,CAAqC;IAEzD,gBAAgB;IAChB,CAAC,aAAa,CAAC,SAAmB;IAElC;;;;OAIG;IACmC,YAAY,EAAE,MAAM,CAAyB;IACnF,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,oBAAoB,CAAK;IAEjC,gBAAgB;IACV,OAAO,CAAC,IAAI,CAAO;IAEzB,gBAAgB;IACP,OAAO,CAAC,OAAO,CAAU;IAClC;;;;;OAKG;IACmC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC3D;;;;OAIG;IACS,sBAAsB,gBAAiB,MAAM,YAC2B;IAEpF;;;OAGG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;IAE3C;;;;;;;;;;OAUG;IACS,cAAc,UAAS;IACnC,gBAAgB;IACJ,mBAAmB,UAAS;IAExC;;;;;OAKG;IACH,aAAa,EAAE,YAAY,EAAE,CAAM;IAEnC;;;OAGG;IACS,QAAQ,EAAE,OAAO,CAAS;IAEtC;;;;;OAKG;IACI,KAAK,yBAAmC;IAE/C;;;;;;;OAOG;IACI,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAa;IAE5D;;;;OAIG;IACmC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAa;IACnF,OAAO,CAAC,SAAS,CAAS;IAE1B,gBAAgB;;IAahB,gBAAgB;IAChB,iBAAiB,IAAI,IAAI;IA8BzB,gBAAgB;IAChB,oBAAoB,IAAI,IAAI;IAY5B,gBAAgB;IAChB,OAAO,CAAC,WAAW;IAInB,gBAAgB;IAChB,OAAO,CAAC,UAAU;IAMlB,gBAAgB;IAChB,OAAO,CAAC,eAAe;IAKvB,gBAAgB;IAChB,OAAO,CAAC,gBAAgB;IAIxB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAOzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAKzB,gBAAgB;IAChB,OAAO,CAAC,iBAAiB;IAIzB,gBAAgB;IAChB,OAAO,CAAC,kBAAkB;IAI1B,gBAAgB;IAChB,OAAO,CAAC,kBAAkB;IAI1B;;OAEG;IAEH;;;;;;;;;;OAUG;IACH,MAAM,CAAC,2BAA2B,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,EAAE;IActE;;;;;;;;OAQG;IACH,eAAe,IAAI,MAAM,EAAE;IAI3B;;;;;;OAMG;IACH,SAAS,IAAI,gBAAgB;IAiB7B;;;;;;;;;;OAUG;IACH,qBAAqB,IAAI,OAAO;IAwChC;;;;;;;;;;;;;OAaG;IACH,6BAA6B,IAAI,OAAO;IAcxC;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,MAAM,EAAE,gBAAgB,EACxB,iBAAiB,GAAE,aAAa,GAAG,OAAiB,EACpD,YAAY,GAAE,OAAe;IAoC/B;;;;;;;;;;;OAWG;IACH,OAAO,CACL,MAAM,EAAE,uBAAuB,GAAG,uBAAuB,EAAE,EAC3D,SAAS,GAAE,SAAmC;IA+DhD;;;;;;;;;OASG;IACH,WAAW,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,GAAE,OAAe,GAAG,MAAM;IAgDjE;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM;IAW/D;;OAEG;IAEH;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,mBAAmB,IAAI,IAAI;IAmB3B;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC;IAetD;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,kBAAkB,GAAG,MAAM;IAuEtE;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAehC;;;;;;;;SAQK;IACL,OAAO,CAAC,kBAAkB;IAY1B;;;;;;;;OAQG;IACH,OAAO,CAAC,kCAAkC;IA4B1C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;IAU3B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAM3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAWpC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;CAyBhC;AAMD;;;;;GAKG;AACH,eAAO,MAAM,cAAc,uEAK1B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;2BAI3B,CAAC"}

package/dist/esm/main/layout-main.js

@@ -436,6 +436,61 @@ export class FoundationLayout extends FoundationElement {
         this.loadGLConfigAndSetup(this.layoutConfig);
         this.onPostItemAdded();
     }
+    /**
+     * @public
+     * Removes all instances of a specified registered item from the layout.
+     * @param registration - string of the registration ID
+     * @param force - if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header.
+     * @returns number of items removed
+     * @remarks
+     * Does not remove the registration from the layout system.
+     * Has a side affect of setting all tab views to be viewing the first tab in the stack.
+     */
+    removeItems(registration, force = false) {
+        let removedCount = 0;
+        const countDeletion = () => ((removedCount += 1), true);
+        const closeableCheck = (c) => force || c.isClosable;
+        // Remove an item when it matches the registration and is valid closable,
+        // or when it is now an empty container (because we just removed all items from it)
+        const predicate = (c) => {
+            var _b;
+            return !(((_b = c.content) === null || _b === void 0 ? void 0 : _b.length) === 0 ||
+                (c.type === 'component' &&
+                    c.componentType === registration &&
+                    closeableCheck(c) &&
+                    countDeletion()));
+        };
+        const removeItemFromNode = (node) => {
+            var _b, _c;
+            const recurse = (_node) => {
+                var _b, _c;
+                if (_node.type === 'component')
+                    return;
+                (_b = _node.content) === null || _b === void 0 ? void 0 : _b.forEach(recurse);
+                _node.content = (_c = _node.content) === null || _c === void 0 ? void 0 : _c.filter(predicate);
+                // activeItemIndex tracks which tab you have open in a stack and
+                // will potentially become out of bounds if we remove an item. Deleting it
+                // is safe and just sets you back to the 1st tab, but UX could be improved
+                // with proper tracking of the value
+                if (_node.type === 'stack')
+                    delete _node.activeItemIndex;
+            };
+            (_b = node === null || node === void 0 ? void 0 : node.content) === null || _b === void 0 ? void 0 : _b.forEach(recurse);
+            if (node.type === 'stack')
+                delete node.activeItemIndex;
+            return (_c = node === null || node === void 0 ? void 0 : node.content) === null || _c === void 0 ? void 0 : _c.filter(predicate);
+        };
+        const content = removeItemFromNode(this.layoutConfig.root);
+        if (removedCount === 0)
+            return 0;
+        this.layoutConfig = Object.assign(Object.assign({}, this.layoutConfig), { root: content.length > 0
+                ? Object.assign(Object.assign({}, this.layoutConfig.root), { content })
+                : undefined });
+        this.updateLifecycleToken();
+        this.loadGLConfigAndSetup(this.layoutConfig);
+        this.onPostItemRemoved();
+        return removedCount;
+    }
     /**
      * @public
      * Register a collection of `Element` and associate them with an `ID` with the layout system for later use.
@@ -601,6 +656,10 @@ export class FoundationLayout extends FoundationElement {
      * Saves the stored layout config according to the Golden Layout provider.
      * And caches the layout in local storage if {@link FoundationLayout.autoSaveKey} is set.
      * @internal
+     * @remarks
+     * This will also normalise the config. E.g. over time when adding and deleting items from
+     * the layout, the layout config can become deeply nested but only have one item in it.
+     * `fromResolved()` function will remove all of the unnecessary nesting.
      * */
     cacheAndSaveLayout() {
         this.layoutConfig = LayoutConfig.fromResolved(this.layout.saveLayout());

package/dist/foundation-layout.api.json

@@ -936,6 +936,70 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#removeItems:member(1)",
+              "docComment": "/**\n * Removes all instances of a specified registered item from the layout.\n *\n * @remarks\n *\n * Does not remove the registration from the layout system. Has a side affect of setting all tab views to be viewing the first tab in the stack.\n *\n * @param registration - string of the registration ID\n *\n * @param force - if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header.\n *\n * @returns number of items removed\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "removeItems(registration: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", force?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "registration",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "force",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "removeItems"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#tryActivatePopoutMode:member(1)",

package/dist/foundation-layout.d.ts

@@ -248,6 +248,17 @@ export declare class FoundationLayout extends FoundationElement implements Layou
      * @throws {@link LayoutRegistrationError} if you attempt to add an item before it has been registered
      */
     addItem(config: RegisteredElementConfig | RegisteredElementConfig[], placement?: Placement): void;
+    /**
+     * @public
+     * Removes all instances of a specified registered item from the layout.
+     * @param registration - string of the registration ID
+     * @param force - if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header.
+     * @returns number of items removed
+     * @remarks
+     * Does not remove the registration from the layout system.
+     * Has a side affect of setting all tab views to be viewing the first tab in the stack.
+     */
+    removeItems(registration: string, force?: boolean): number;
     /**
      * @public
      * Register a collection of `Element` and associate them with an `ID` with the layout system for later use.
@@ -308,6 +319,10 @@ export declare class FoundationLayout extends FoundationElement implements Layou
      * Saves the stored layout config according to the Golden Layout provider.
      * And caches the layout in local storage if {@link FoundationLayout.autoSaveKey} is set.
      * @internal
+     * @remarks
+     * This will also normalise the config. E.g. over time when adding and deleting items from
+     * the layout, the layout config can become deeply nested but only have one item in it.
+     * `fromResolved()` function will remove all of the unnecessary nesting.
      * */
     private cacheAndSaveLayout;
     /**

package/docs/api/foundation-layout.foundationlayout.md

@@ -46,6 +46,7 @@ The constructor for this class is marked as internal. Third-party code should no
 |  [loadLayout(layout, handleMissingItem, disableCache)](./foundation-layout.foundationlayout.loadlayout.md) |  | Restores a layout described in the config from [getLayout()](./foundation-layout.foundationlayout.getlayout.md) |
 |  [registeredItems()](./foundation-layout.foundationlayout.registereditems.md) |  | Gets all of the currently registered names |
 |  [registerItem(registration, elements)](./foundation-layout.foundationlayout.registeritem.md) |  | Register a collection of <code>Element</code> and associate them with an <code>ID</code> with the layout system for later use. |
+|  [removeItems(registration, force)](./foundation-layout.foundationlayout.removeitems.md) |  | Removes all instances of a specified registered item from the layout. |
 |  [tryActivatePopoutMode()](./foundation-layout.foundationlayout.tryactivatepopoutmode.md) |  | **_(BETA)_** If in a popout window from the dynamic layout, this function will run the flow to put the component in popout mode. This function is automatically called if using the declarative HTML API, but if only using the JavaScript API then you will need to call this function manually. |
 |  [tryLoadLayoutFromLocalStorage()](./foundation-layout.foundationlayout.tryloadlayoutfromlocalstorage.md) |  | Try to load a layout from local storage, or return false. Only required if manually calling [FoundationLayout.registerItem()](./foundation-layout.foundationlayout.registeritem.md) |
 

package/docs/api/foundation-layout.foundationlayout.removeitems.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayout](./foundation-layout.foundationlayout.md) &gt; [removeItems](./foundation-layout.foundationlayout.removeitems.md)
+
+## FoundationLayout.removeItems() method
+
+Removes all instances of a specified registered item from the layout.
+
+**Signature:**
+
+```typescript
+removeItems(registration: string, force?: boolean): number;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  registration | string | string of the registration ID |
+|  force | boolean | _(Optional)_ if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header. |
+
+**Returns:**
+
+number
+
+number of items removed
+
+## Remarks
+
+Does not remove the registration from the layout system. Has a side affect of setting all tab views to be viewing the first tab in the stack.
+

package/docs/api-report.md

@@ -58,6 +58,7 @@ export class FoundationLayout extends FoundationElement implements LayoutCompone
     registeredItems(): string[];
     registerItem(registration: string, elements: Element[]): string;
     reloadBuffer: number;
+    removeItems(registration: string, force?: boolean): number;
     // @internal
     requestLayoutReload(): void;
     // @beta

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-layout",
   "description": "Genesis Foundation UI App Layout",
-  "version": "14.126.0",
+  "version": "14.127.0",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/foundation-layout.d.ts",
@@ -27,18 +27,18 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.126.0",
-    "@genesislcap/genx": "14.126.0",
+    "@genesislcap/foundation-testing": "14.127.0",
+    "@genesislcap/genx": "14.127.0",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
     "@genesis-community/golden-layout": "^2.11.0",
-    "@genesislcap/foundation-comms": "14.126.0",
-    "@genesislcap/foundation-logger": "14.126.0",
-    "@genesislcap/foundation-utils": "14.126.0",
-    "@microsoft/fast-components": "^2.21.3",
-    "@microsoft/fast-element": "^1.7.0",
-    "@microsoft/fast-foundation": "^2.33.2",
+    "@genesislcap/foundation-comms": "14.127.0",
+    "@genesislcap/foundation-logger": "14.127.0",
+    "@genesislcap/foundation-utils": "14.127.0",
+    "@microsoft/fast-components": "^2.30.6",
+    "@microsoft/fast-element": "^1.12.0",
+    "@microsoft/fast-foundation": "^2.49.4",
     "tslib": "^2.3.1"
   },
   "repository": {
@@ -50,5 +50,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "726c78d9ec85c2d1b308d070eb090db8b68e421d"
+  "gitHead": "9dab321ca616a32643b29abc699626e973a3ac8f"
 }