@genesislcap/foundation-layout 9.0.1-alpha-b5c5eb7.0

package/dist/remoteEntry.js

@@ -0,0 +1,2 @@
+var foundationLayout;(()=>{"use strict";var e,t,r,n,o,a,i,l,f,u,s,d,c={451:(e,t,r)=>{var n={"./index":()=>r.e(755).then((()=>()=>r(755)))},o=(e,t)=>(r.R=t,t=r.o(n,e)?n[e]():Promise.resolve().then((()=>{throw new Error('Module "'+e+'" does not exist in container.')})),r.R=void 0,t),a=(e,t)=>{if(r.S){var n=r.S.default,o="default";if(n&&n!==e)throw new Error("Container initialization failed as it has already been initialized with a different share scope");return r.S[o]=e,r.I(o,t)}};r.d(t,{get:()=>o,init:()=>a})}},h={};function p(e){var t=h[e];if(void 0!==t)return t.exports;var r=h[e]={exports:{}},n=!0;try{c[e].call(r.exports,r,r.exports,p),n=!1}finally{n&&delete h[e]}return r.exports}p.m=c,p.c=h,e=[],p.O=(t,r,n,o)=>{if(!r){var a=1/0;for(u=0;u<e.length;u++){for(var[r,n,o]=e[u],i=!0,l=0;l<r.length;l++)(!1&o||a>=o)&&Object.keys(p.O).every((e=>p.O[e](r[l])))?r.splice(l--,1):(i=!1,o<a&&(a=o));if(i){e.splice(u--,1);var f=n();void 0!==f&&(t=f)}}return t}o=o||0;for(var u=e.length;u>0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,n,o]},p.d=(e,t)=>{for(var r in t)p.o(t,r)&&!p.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},p.f={},p.e=e=>Promise.all(Object.keys(p.f).reduce(((t,r)=>(p.f[r](e,t),t)),[])),p.u=e=>(({127:"npm.microsoft",248:"npm.genesis-community",713:"npm.consola"}[e]||e)+"."+e+"."+{127:"00f16f24d8da8fd89263",147:"680b1da1d96051244bd2",191:"106ece7a41ded6731029",248:"9c9900001dbc5ba9c3ed",259:"216fcad43e9a38888e08",415:"094780a1a1162c7e5f1c",459:"c9f0bb440eb1f041c99e",495:"ef332497920c5f8d6592",623:"0e7e8f23454ee96ed9c8",713:"b1e4073e73c71572987a",755:"f93ee58c2b836a669ec4",758:"c3c8911366f8331c70cc"}[e]+".js"),p.miniCssF=e=>{},p.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),t={},r="@genesislcap/foundation-layout:",p.l=(e,n,o,a)=>{if(t[e])t[e].push(n);else{var i,l;if(void 0!==o)for(var f=document.getElementsByTagName("script"),u=0;u<f.length;u++){var s=f[u];if(s.getAttribute("src")==e||s.getAttribute("data-webpack")==r+o){i=s;break}}i||(l=!0,(i=document.createElement("script")).charset="utf-8",i.timeout=120,p.nc&&i.setAttribute("nonce",p.nc),i.setAttribute("data-webpack",r+o),i.src=e),t[e]=[n];var d=(r,n)=>{i.onerror=i.onload=null,clearTimeout(c);var o=t[e];if(delete t[e],i.parentNode&&i.parentNode.removeChild(i),o&&o.forEach((e=>e(n))),r)return r(n)},c=setTimeout(d.bind(null,void 0,{type:"timeout",target:i}),12e4);i.onerror=d.bind(null,i.onerror),i.onload=d.bind(null,i.onload),l&&document.head.appendChild(i)}},p.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},(()=>{p.S={};var e={},t={};p.I=(r,n)=>{n||(n=[]);var o=t[r];if(o||(o=t[r]={}),!(n.indexOf(o)>=0)){if(n.push(o),e[r])return e[r];p.o(p.S,r)||(p.S[r]={});var a=p.S[r],i="@genesislcap/foundation-layout",l=(e,t,r,n)=>{var o=a[e]=a[e]||{},l=o[t];(!l||!l.loaded&&(!n!=!l.eager?n:i>l.from))&&(o[t]={get:r,from:i,eager:!!n})},f=[];if("default"===r)l("@genesis-community/golden-layout","2.9.3",(()=>p.e(248).then((()=>()=>p(192))))),l("@genesislcap/foundation-utils","9.0.0",(()=>Promise.all([p.e(127),p.e(713),p.e(147),p.e(259),p.e(758)]).then((()=>()=>p(259))))),l("@microsoft/fast-element","1.11.0",(()=>p.e(127).then((()=>()=>p(759))))),l("@microsoft/fast-foundation","2.47.0",(()=>Promise.all([p.e(127),p.e(147),p.e(495),p.e(415)]).then((()=>()=>p(916))))),l("tslib","1.14.1",(()=>p.e(127).then((()=>()=>p(160))))),l("tslib","1.14.1",(()=>p.e(127).then((()=>()=>p(726))))),l("tslib","2.5.0",(()=>p.e(191).then((()=>()=>p(191)))));return f.length?e[r]=Promise.all(f).then((()=>e[r]=1)):e[r]=1}}})(),p.p="/",n=e=>{var t=e=>e.split(".").map((e=>+e==e?+e:e)),r=/^([^-+]+)?(?:-([^+]+))?(?:\+(.+))?$/.exec(e),n=r[1]?t(r[1]):[];return r[2]&&(n.length++,n.push.apply(n,t(r[2]))),r[3]&&(n.push([]),n.push.apply(n,t(r[3]))),n},o=(e,t)=>{e=n(e),t=n(t);for(var r=0;;){if(r>=e.length)return r<t.length&&"u"!=(typeof t[r])[0];var o=e[r],a=(typeof o)[0];if(r>=t.length)return"u"==a;var i=t[r],l=(typeof i)[0];if(a!=l)return"o"==a&&"n"==l||"s"==l||"u"==a;if("o"!=a&&"u"!=a&&o!=i)return o<i;r++}},a=(e,t)=>{if(0 in e){t=n(t);var r=e[0],o=r<0;o&&(r=-r-1);for(var i=0,l=1,f=!0;;l++,i++){var u,s,d=l<e.length?(typeof e[l])[0]:"";if(i>=t.length||"o"==(s=(typeof(u=t[i]))[0]))return!f||("u"==d?l>r&&!o:""==d!=o);if("u"==s){if(!f||"u"!=d)return!1}else if(f)if(d==s)if(l<=r){if(u!=e[l])return!1}else{if(o?u>e[l]:u<e[l])return!1;u!=e[l]&&(f=!1)}else if("s"!=d&&"n"!=d){if(o||l<=r)return!1;f=!1,l--}else{if(l<=r||s<d!=o)return!1;f=!1}else"s"!=d&&"n"!=d&&(f=!1,l--)}}var c=[],h=c.pop.bind(c);for(i=1;i<e.length;i++){var p=e[i];c.push(1==p?h()|h():2==p?h()&h():p?a(p,t):!h())}return!!h()},i=(e,t,r)=>{var n=e[t];return(t=Object.keys(n).reduce(((e,t)=>!a(r,t)||e&&!o(e,t)?e:t),0))&&n[t]},l=e=>(e.loaded=1,e.get()),f=(e=>function(t,r,n,o){var a=p.I(t);return a&&a.then?a.then(e.bind(e,t,p.S[t],r,n,o)):e(t,p.S[t],r,n,o)})(((e,t,r,n,o)=>{var a=t&&p.o(t,r)&&i(t,r,n);return a?l(a):o()})),u={},s={147:()=>f("default","@microsoft/fast-element",[1,1,7,0],(()=>p.e(127).then((()=>()=>p(759))))),951:()=>f("default","@microsoft/fast-foundation",[1,2,33,2],(()=>Promise.all([p.e(127),p.e(495),p.e(623)]).then((()=>()=>p(916))))),304:()=>f("default","tslib",[1,2,3,1],(()=>p.e(191).then((()=>()=>p(191))))),495:()=>f("default","tslib",[1,2,3,1],(()=>p.e(127).then((()=>()=>p(726))))),64:()=>f("default","@genesislcap/foundation-utils",[1,9,0,0],(()=>Promise.all([p.e(713),p.e(259)]).then((()=>()=>p(259))))),699:()=>f("default","@genesis-community/golden-layout",[1,2,9,3],(()=>p.e(248).then((()=>()=>p(192)))))},d={147:[147],459:[64,699],495:[495],758:[951,304]},p.f.consumes=(e,t)=>{p.o(d,e)&&d[e].forEach((e=>{if(p.o(u,e))return t.push(u[e]);var r=t=>{u[e]=0,p.m[e]=r=>{delete p.c[e],r.exports=t()}},n=t=>{delete u[e],p.m[e]=r=>{throw delete p.c[e],t}};try{var o=s[e]();o.then?t.push(u[e]=o.then(r).catch(n)):r(o)}catch(e){n(e)}}))},(()=>{var e={302:0,648:0};p.f.j=(t,r)=>{var n=p.o(e,t)?e[t]:void 0;if(0!==n)if(n)r.push(n[2]);else if(/^(147|495|648|758)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>n=e[t]=[r,o]));r.push(n[2]=o);var a=p.p+p.u(t),i=new Error;p.l(a,(r=>{if(p.o(e,t)&&(0!==(n=e[t])&&(e[t]=void 0),n)){var o=r&&("load"===r.type?"missing":r.type),a=r&&r.target&&r.target.src;i.message="Loading chunk "+t+" failed.\n("+o+": "+a+")",i.name="ChunkLoadError",i.type=o,i.request=a,n[1](i)}}),"chunk-"+t,t)}},p.O.j=t=>0===e[t];var t=(t,r)=>{var n,o,[a,i,l]=r,f=0;for(n in i)p.o(i,n)&&(p.m[n]=i[n]);if(l)var u=l(p);for(t&&t(r);f<a.length;f++)o=a[f],p.o(e,o)&&e[o]&&e[o][0](),e[a[f]]=0;return p.O(u)},r=self.webpackChunk_genesislcap_foundation_layout=self.webpackChunk_genesislcap_foundation_layout||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})();var v=p.O(void 0,[648],(()=>p(451)));v=p.O(v),foundationLayout=v})();
+//# sourceMappingURL=foundationLayout.8b94161c9f0d0d475d026a05513893c1.js.map

package/dist/serve.json

@@ -0,0 +1,3 @@
+{
+  "rewrites": [ { "source": "/**", "destination": "/index.html" } ]
+}

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.4"
+    }
+  ]
+}

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [DEFAULT\_RELOAD\_BUFFER](./foundation-layout.default_reload_buffer.md)
+
+## DEFAULT\_RELOAD\_BUFFER variable
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Default time in milliseconds for the layout to buffer calls to reloading the layout while the declarative API is loading.
+
+During the first load of the layout, a loading spinner will be shown.
+
+**Signature:**
+
+```typescript
+DEFAULT_RELOAD_BUFFER = 500
+```

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

@@ -0,0 +1,38 @@
+<!-- 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; [addItem](./foundation-layout.foundationlayout.additem.md)
+
+## FoundationLayout.addItem() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Dynamically add a new item to the layout. The user can move the new plane to whenever they want once it has been added.
+
+**Signature:**
+
+```typescript
+addItem(config: RegisteredElementConfig, placement?: Placement): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  config | [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) | [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) configuration items for the new pane |
+|  placement | [Placement](./foundation-layout.placement.md) | _(Optional)_ where to add the new pane on the layout (defaults to the right hand side) |
+
+**Returns:**
+
+void
+
+## Exceptions
+
+[LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md) if you attempt to add an item before it has been registered
+
+## Remarks
+
+Adding a new item invokes the registration previously made explicitly via [registerItem()](./foundation-layout.foundationlayout.registeritem.md) or implicitly via the html declerative API.
+
+The elements added onto the new pane are copies using `element.cloneNode()` of the original element references used during registration.
+

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

@@ -0,0 +1,16 @@
+<!-- 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; [dragging](./foundation-layout.foundationlayout.dragging.md)
+
+## FoundationLayout.dragging property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Set to true when the user is currently dragging the panes inside of the layout
+
+**Signature:**
+
+```typescript
+dragging: boolean;
+```

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

@@ -0,0 +1,22 @@
+<!-- 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; [getLayout](./foundation-layout.foundationlayout.getlayout.md)
+
+## FoundationLayout.getLayout() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Gets a minified string containing the config describing the current layout of the layout object to later restore in [function](./foundation-layout.foundationlayout.loadlayout.md)
+
+**Signature:**
+
+```typescript
+getLayout(): SerialisedLayout;
+```
+**Returns:**
+
+[SerialisedLayout](./foundation-layout.serialisedlayout.md)
+
+- latest version of [SerialisedLayout](./foundation-layout.serialisedlayout.md) describing the layout
+

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

@@ -0,0 +1,37 @@
+<!-- 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; [layoutRequiredRegistrations](./foundation-layout.foundationlayout.layoutrequiredregistrations.md)
+
+## FoundationLayout.layoutRequiredRegistrations() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Gets all of the required registration function names for a set of config
+
+**Signature:**
+
+```typescript
+static layoutRequiredRegistrations(layout: SerialisedLayout): string[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  layout | [SerialisedLayout](./foundation-layout.serialisedlayout.md) | any version of [SerialisedLayout](./foundation-layout.serialisedlayout.md) object describing the layout |
+
+**Returns:**
+
+string\[\]
+
+string\[\] - an item for each registered element in the config. These must all be added before [function](./foundation-layout.foundationlayout.loadlayout.md)
+
+## Exceptions
+
+- various errors if the layout parameter cannot be parsed
+
+## Remarks
+
+You can use this with [registeredItems](./foundation-layout.foundationlayout.registereditems.md) to work out what items you need to register with [registerItem()](./foundation-layout.foundationlayout.registeritem.md) before loading the layout with [loadLayout()](./foundation-layout.foundationlayout.loadlayout.md)
+

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

@@ -0,0 +1,37 @@
+<!-- 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; [loadLayout](./foundation-layout.foundationlayout.loadlayout.md)
+
+## FoundationLayout.loadLayout() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Restores a layout described in the config from [getLayout()](./foundation-layout.foundationlayout.getlayout.md)
+
+**Signature:**
+
+```typescript
+loadLayout(layout: SerialisedLayout): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  layout | [SerialisedLayout](./foundation-layout.serialisedlayout.md) | any version of [SerialisedLayout](./foundation-layout.serialisedlayout.md) object describing the layout |
+
+**Returns:**
+
+void
+
+## Exceptions
+
+[LayoutUsageError](./foundation-layout.layoutusageerror.md) if you attempt to load a layout with registered items that are not currently registered with the layout system
+
+various errors if the layout string is malformed and cannot be parsed
+
+## Remarks
+
+In order to restore a layout you must have registered all of the required panes with the layout system before restoring it. If you are just setting the layout using the declarative API then all of the same components will be registered. &lt;<!-- -->br/ &gt;<!-- -->If you have added any elements using [FoundationLayout.registerItem()](./foundation-layout.foundationlayout.registeritem.md) then you must ensure all of the same items have been added again. To make tracking what items are registered easier it is recommended in this case you explicitly name your registrations using the `id` parameter available on the [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) and `foundation-layout-item` APIs. <br/> You can use [FoundationLayout.layoutRequiredRegistrations()](./foundation-layout.foundationlayout.layoutrequiredregistrations.md) to check which items are registered in a current layout in order to dynamically add any missing items before you can restore the layout
+

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

@@ -0,0 +1,44 @@
+<!-- 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)
+
+## FoundationLayout class
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Top level web component which is used to initialise a custom layout
+
+**Signature:**
+
+```typescript
+export declare class FoundationLayout extends FoundationElement implements LayoutComponent 
+```
+**Extends:** FoundationElement
+
+**Implements:** LayoutComponent
+
+## Remarks
+
+Can be used in a composition to customise the styles of the layout.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FoundationLayout` class.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [dragging](./foundation-layout.foundationlayout.dragging.md) |  | boolean | **_(BETA)_** Set to true when the user is currently dragging the panes inside of the layout |
+|  [reloadBuffer](./foundation-layout.foundationlayout.reloadbuffer.md) |  | number | **_(BETA)_** Number describing how long to wait in ms before reloading the config when adding items declaratively by the html API. Default 500 (ms). |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [addItem(config, placement)](./foundation-layout.foundationlayout.additem.md) |  | **_(BETA)_** Dynamically add a new item to the layout. The user can move the new plane to whenever they want once it has been added. |
+|  [getLayout()](./foundation-layout.foundationlayout.getlayout.md) |  | **_(BETA)_** Gets a minified string containing the config describing the current layout of the layout object to later restore in [function](./foundation-layout.foundationlayout.loadlayout.md) |
+|  [layoutRequiredRegistrations(layout)](./foundation-layout.foundationlayout.layoutrequiredregistrations.md) | <code>static</code> | **_(BETA)_** Gets all of the required registration function names for a set of config |
+|  [loadLayout(layout)](./foundation-layout.foundationlayout.loadlayout.md) |  | **_(BETA)_** Restores a layout described in the config from [getLayout()](./foundation-layout.foundationlayout.getlayout.md) |
+|  [registeredItems()](./foundation-layout.foundationlayout.registereditems.md) |  | **_(BETA)_** Gets all of the currently registered names |
+|  [registerItem(registration, elements)](./foundation-layout.foundationlayout.registeritem.md) |  | **_(BETA)_** Register a collection of <code>Element</code> and associate them with an <code>ID</code> with the layout system for later use. |
+

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

@@ -0,0 +1,26 @@
+<!-- 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; [registeredItems](./foundation-layout.foundationlayout.registereditems.md)
+
+## FoundationLayout.registeredItems() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Gets all of the currently registered names
+
+**Signature:**
+
+```typescript
+registeredItems(): string[];
+```
+**Returns:**
+
+string\[\]
+
+string\[\] - an item for each registered element currently registered with the layout system
+
+## Remarks
+
+You can use this with [layoutRequiredRegistrations](./foundation-layout.foundationlayout.layoutrequiredregistrations.md) to work out what items you need to register with [registerItem()](./foundation-layout.foundationlayout.registeritem.md) before loading the layout with [loadLayout()](./foundation-layout.foundationlayout.loadlayout.md)
+

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

@@ -0,0 +1,42 @@
+<!-- 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; [registerItem](./foundation-layout.foundationlayout.registeritem.md)
+
+## FoundationLayout.registerItem() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Register a collection of `Element` and associate them with an `ID` with the layout system for later use.
+
+**Signature:**
+
+```typescript
+registerItem(registration: string, elements: Element[]): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  registration | string | string of the registration ID |
+|  elements | Element\[\] | Elements\[\] containing the reference to the elements to register for later usage |
+
+**Returns:**
+
+string
+
+- string defining the name of the registered item with the layout system (config.id if set).
+
+## Exceptions
+
+[LayoutUsageError](./foundation-layout.layoutusageerror.md) if you attempt to add an item before the layout has been initialised.
+
+[LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md) if you attempt to use a `registration` name which is already in use (declarative html API and JavaScript API registrations use the same "pool" of registration names).
+
+## Remarks
+
+You would use this to register elements that you later want to load when using [FoundationLayout.loadLayout()](./foundation-layout.foundationlayout.loadlayout.md)<!-- -->. Use [FoundationLayout.layoutRequiredRegistrations()](./foundation-layout.foundationlayout.layoutrequiredregistrations.md) to see what components need to be registered for a certain config and then register them using this function before calling [FoundationLayout.loadLayout()](./foundation-layout.foundationlayout.loadlayout.md)<!-- -->.
+
+When registering an element it is moved by reference into the internals of the layout, so if you pass elements already in the DOM then they will disappear. If you want to avoid this you can pass copies using `element.cloneNode(true)`<!-- -->.
+

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

@@ -0,0 +1,16 @@
+<!-- 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; [reloadBuffer](./foundation-layout.foundationlayout.reloadbuffer.md)
+
+## FoundationLayout.reloadBuffer property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Number describing how long to wait in ms before reloading the config when adding items declaratively by the html API. Default 500 (ms).
+
+**Signature:**
+
+```typescript
+reloadBuffer: number;
+```

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

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [foundationLayoutComponents](./foundation-layout.foundationlayoutcomponents.md)
+
+## foundationLayoutComponents variable
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Registration object to register the layout with your design system.
+
+**Signature:**
+
+```typescript
+foundationLayoutComponents: {
+    foundationLayout: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
+        baseName: string;
+        styles: import("@microsoft/fast-element").ElementStyles;
+        template: import("@microsoft/fast-element").ViewTemplate<import("./layout-main").FoundationLayout, any>;
+    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
+        baseName: string;
+        styles: import("@microsoft/fast-element").ElementStyles;
+        template: import("@microsoft/fast-element").ViewTemplate<import("./layout-main").FoundationLayout, any>;
+    }, typeof import("./layout-main").FoundationLayout>;
+    foundationLayoutRegion: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
+        baseName: string;
+        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
+    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
+        baseName: string;
+        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
+    }, typeof import("./layout-region").FoundationLayoutRegion>;
+    foundationLayoutItem: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
+        baseName: string;
+        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
+    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
+        baseName: string;
+        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
+    }, typeof import("./layout-item").FoundationLayoutItem>;
+    register(container?: Container, ...rest: any[]): void;
+}
+```
+
+## Remarks
+
+Registers the three layout component types with the design system. You require to use the prefix of the design system with each tag. If you wish to alternate the styles of the layout you only need to compose your own custom version of [FoundationLayout](./foundation-layout.foundationlayout.md) as this contains the styles for the entire layout.
+
+## Example
+
+`<zero-layout></zero-layout>` if you are using the layout with the `zero` design-system.
+

package/docs/api/foundation-layout.foundationlayoutitem.closable.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [closable](./foundation-layout.foundationlayoutitem.closable.md)
+
+## FoundationLayoutItem.closable property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Boolean attribute controls whether the window can be closed in the GUI. Defaults to `false`<!-- -->.
+
+**Signature:**
+
+```typescript
+closable: boolean;
+```

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

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md)
+
+## FoundationLayoutItem class
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+`FoundationLayoutItem` is a custom element that represents an item in the layout.
+
+**Signature:**
+
+```typescript
+export declare class FoundationLayoutItem extends FoundationElement implements LayoutComponent 
+```
+**Extends:** FoundationElement
+
+**Implements:** LayoutComponent
+
+## Remarks
+
+This element is used to wrap html elements and configure their layout settings as part of the layout system.
+
+This is a simple component which is only used to define the layout splits; any JavaScript API interactions or custom styling is used via [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [closable](./foundation-layout.foundationlayoutitem.closable.md) |  | boolean | **_(BETA)_** Boolean attribute controls whether the window can be closed in the GUI. Defaults to <code>false</code>. |
+|  [registration](./foundation-layout.foundationlayoutitem.registration.md) |  | string | **_(BETA)_** Sets the registration name for the item, which can be used later to add the item via the JavaScript API using . |
+|  [size](./foundation-layout.foundationlayoutitem.size.md) |  | string | **_(BETA)_** optional string describing the size of the new item (see the written documentation for more info) |
+|  [title](./foundation-layout.foundationlayoutitem.title.md) |  | string | **_(BETA)_** Sets the title of the item which is displayed on the tab. |
+

package/docs/api/foundation-layout.foundationlayoutitem.registration.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [registration](./foundation-layout.foundationlayoutitem.registration.md)
+
+## FoundationLayoutItem.registration property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Sets the registration name for the item, which can be used later to add the item via the JavaScript API using .
+
+**Signature:**
+
+```typescript
+registration: string;
+```
+
+## Remarks
+
+Items added via the JavaScript API and HTML API share the same pool of registration names. Using a duplicate registration name is a runtime error. This registration name defaults to the number of the window it is. It is highly recommended if you are using the JavaScript API that you set a registration name here manually.
+

package/docs/api/foundation-layout.foundationlayoutitem.size.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [size](./foundation-layout.foundationlayoutitem.size.md)
+
+## FoundationLayoutItem.size property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+optional string describing the size of the new item (see the written documentation for more info)
+
+**Signature:**
+
+```typescript
+size: string;
+```

package/docs/api/foundation-layout.foundationlayoutitem.title.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [title](./foundation-layout.foundationlayoutitem.title.md)
+
+## FoundationLayoutItem.title property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Sets the title of the item which is displayed on the tab.
+
+**Signature:**
+
+```typescript
+title: string;
+```
+
+## Remarks
+
+Defaults to `Item ` + [FoundationLayoutItem.registration](./foundation-layout.foundationlayoutitem.registration.md)
+

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

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)
+
+## FoundationLayoutRegion class
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+`FoundationLayoutRegion` is a custom element that represents a region in the layout.
+
+**Signature:**
+
+```typescript
+export declare class FoundationLayoutRegion extends FoundationElement implements LayoutComponent 
+```
+**Extends:** FoundationElement
+
+**Implements:** LayoutComponent
+
+## Remarks
+
+This element is used to create a region in the layout. It can be used to create a horizontal or vertical split, or a tabbed region.
+
+This is a simple component which is only used to define the layout splits; any JavaScript API interactions or custom styling is used via [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [size](./foundation-layout.foundationlayoutregion.size.md) |  | string | **_(BETA)_** optional string describing the size of the new item (see the written documentation for more info) |
+|  [type](./foundation-layout.foundationlayoutregion.type.md) |  | [LayoutRegionType](./foundation-layout.layoutregiontype.md) | **_(BETA)_** Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to <code>horizontal</code>. |
+

package/docs/api/foundation-layout.foundationlayoutregion.size.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md) &gt; [size](./foundation-layout.foundationlayoutregion.size.md)
+
+## FoundationLayoutRegion.size property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+optional string describing the size of the new item (see the written documentation for more info)
+
+**Signature:**
+
+```typescript
+size: string;
+```

package/docs/api/foundation-layout.foundationlayoutregion.type.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md) &gt; [type](./foundation-layout.foundationlayoutregion.type.md)
+
+## FoundationLayoutRegion.type property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to `horizontal`<!-- -->.
+
+**Signature:**
+
+```typescript
+type: LayoutRegionType;
+```

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [LayoutEmitEvents](./foundation-layout.layoutemitevents.md)
+
+## LayoutEmitEvents variable
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Defines events that the layout system emits
+
+'firstLoaded' - emitted when the layout has finished loading the first time using the declarative API after [DEFAULT\_RELOAD\_BUFFER](./foundation-layout.default_reload_buffer.md) ms. <br/> 'itemAdded' - emitted when an item is added to the layout' <br/> 'itemRemoved' - emitted when an item is removed from the layout'
+
+**Signature:**
+
+```typescript
+LayoutEmitEvents: {
+    readonly firstLoaded: "first-loaded";
+    readonly itemAdded: "item-added";
+    readonly itemRemoved: "item-removed";
+}
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [LayoutReceiveEvents](./foundation-layout.layoutreceiveevents.md)
+
+## LayoutReceiveEvents variable
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Defines events that the layout system listens for
+
+'changeTitle' - emit this from a contained item to update the title of the window that contains it.
+
+**Signature:**
+
+```typescript
+LayoutReceiveEvents: {
+    readonly changeTitle: "change-title";
+}
+```