@genesislcap/foundation-layout 10.3.1 → 11.3.1

package/dist/foundation-layout.d.ts

@@ -11,22 +11,22 @@ import { ViewTemplate } from '@microsoft/fast-element';
  * Used to key what type of LayoutComponent an object is
  * @internal
  */
-export declare const componentType: unique symbol;
+declare const componentType: unique symbol;
 
 /** @internal */
-export declare type ComponentTypes = LayoutRegionType | 'root' | 'item';
+declare type ComponentTypes = LayoutRegionType | 'root' | 'item';
 
 /**
  * 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.
- * @beta
+ * @public
  */
 export declare const DEFAULT_RELOAD_BUFFER = 500;
 
 /**
- * @beta
+ * @public
  * Top level web component which is used to initialise a custom layout
  * @remarks
  * Can be used in a composition to customise the styles of the layout.
@@ -41,17 +41,34 @@ export declare class FoundationLayout extends FoundationElement implements Layou
     /**
      * Number describing how long to wait in ms before reloading the config when adding items
      * declaratively by the html API. Default 500 (ms).
-     * @beta
+     * @public
      */
     reloadBuffer: number;
     private reloadPending;
     private registeredComponents;
     /** @internal */
+    private uuid;
+    /** @internal */
+    private session;
+    /**
+     * Attribute which if set will auto save and load the layout as the user changes it.
+     * Omit this attribute to disable this feature.
+     * Set attribute using `auto-save-key`.
+     * @public
+     */
+    autoSaveKey?: string;
+    /**
+     * Function which is used to generate the placeholder text when a layout is loaded
+     * with a missing item.
+     * @public
+     */
+    missingItemPlaceholder: (missingItem: string) => string;
+    /** @internal */
     hasFirstLoaded: boolean;
     /** @internal */
     usingDeclerativeAPI: boolean;
     /**
-     * @beta
+     * @public
      * Set to true when the user is currently dragging the panes inside of the layout
      */
     dragging: boolean;
@@ -69,11 +86,13 @@ export declare class FoundationLayout extends FoundationElement implements Layou
     private onItemAdded;
     /** @internal */
     private onItemRemoved;
+    /** @internal */
+    private onItemResized;
     /**
      * JS API, public
      */
     /**
-     * @beta
+     * @public
      * Gets all of the required registration function names for a set of config
      * @remarks
      * You can use this with {@link FoundationLayout.registeredItems | registeredItems} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()}
@@ -85,7 +104,7 @@ export declare class FoundationLayout extends FoundationElement implements Layou
      */
     static layoutRequiredRegistrations(layout: SerialisedLayout): string[];
     /**
-     * @beta
+     * @public
      * Gets all of the currently registered names
      * @remarks
      * You can use this with {@link FoundationLayout.layoutRequiredRegistrations | layoutRequiredRegistrations} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()}
@@ -95,25 +114,40 @@ export declare class FoundationLayout extends FoundationElement implements Layou
      */
     registeredItems(): string[];
     /**
-     * @beta
+     * @public
      * Gets a minified string containing the config describing the current layout of the layout object to later restore in {@link FoundationLayout.loadLayout | function}
      * @returns - latest version of {@link SerialisedLayout} describing the layout
      */
     getLayout(): SerialisedLayout;
     /**
-     * @beta
+     * Try to load a layout from local storage, or return false. Only required if manually calling {@link FoundationLayout.registerItem}
+     * @remarks
+     * Attempt to load an autosaved layout from local storage, keyed on the `auto-save-key` attribute.
+     * If `auto-save-key` attribute is not set or there is no autosaved layout yet, this will return false. Else, true.
+     *
+     * This function is automatically called when loading the layout via the declarative API so if you're not registering components via
+     * the JavaScript API then you don't need to call this function. If you *are* calling {@link FoundationLayout.registerItem} then you should call this function immediately afterwards.
+     *
+     * Will load the layout with `handleMissingItem = 'placeholder` so placeholder text will be shown for any missing items.
+     * @returns boolean - true if a layout was loaded, false if not
+     * @public
+     */
+    tryLoadLayoutFromLocalStorage(): boolean;
+    /**
+     * @public
      * Restores a layout described in the config from {@link FoundationLayout.getLayout | getLayout()}
      *
      * @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. <br/ >If you have added any elements using {@link FoundationLayout.registerItem} 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 {@link RegisteredElementConfig} and `foundation-layout-item` APIs. <br/> You can use {@link FoundationLayout.layoutRequiredRegistrations} to check which items are registered in a current layout in order to dynamically add any missing items before you can restore the layout
+     * 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. If you have added any elements using {@link FoundationLayout.registerItem} 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 {@link RegisteredElementConfig} and `foundation-layout-item` APIs. You can use {@link FoundationLayout.layoutRequiredRegistrations} to check which items are registered in a current layout in order to dynamically add any missing items before you can restore the layout
      *
      * @param layout - any version of {@link SerialisedLayout} object describing the layout
-     * @throws {@link LayoutUsageError} if you attempt to load a layout with registered items that are not currently registered with the layout system
+     * @param handleMissingItem - what to do if the layout contains items that are not currently registered with the layout system. Defaults to 'error' which will throw an error. If set to 'placeholder' then any missing items will be replaced with a placeholder element. You can control the text of the placeholder element with {@link FoundationLayout.missingItemPlaceholder}.
+     * @throws {@link LayoutUsageError} if you attempt to load a layout with registered items that are not currently registered with the layout system, and handleMissingItem is set to 'error' (default).
      * @throws various errors if the layout string is malformed and cannot be parsed
      */
-    loadLayout(layout: SerialisedLayout): void;
+    loadLayout(layout: SerialisedLayout, handleMissingItem?: 'placeholder' | 'error'): void;
     /**
-     * @beta
+     * @public
      * Dynamically add a new item to the layout. The user can move the new plane to whenever they want once it has been added.
      * @remarks
      * Adding a new item invokes the registration previously made explicitly via {@link FoundationLayout.registerItem | registerItem()} or implicitly via the html declerative API.
@@ -126,7 +160,7 @@ export declare class FoundationLayout extends FoundationElement implements Layou
      */
     addItem(config: RegisteredElementConfig, placement?: Placement): void;
     /**
-     * @beta
+     * @public
      * Register a collection of `Element` and associate them with an `ID` with the layout system for later use.
      * @remarks
      * You would use this to register elements that you later want to load when using {@link FoundationLayout.loadLayout}.
@@ -176,10 +210,31 @@ export declare class FoundationLayout extends FoundationElement implements Layou
     private setupLayoutReceiveEvents;
     /**
      * Saves the stored layout config according to the Golden Layout provider.
-     * Needs to be called when the layout is updated outside of using addItemFromChild.
+     * And caches the layout in local storage if {@link FoundationLayout.autoSaveKey} is set.
      * @internal
      * */
-    private cacheLayout;
+    private cacheAndSaveLayout;
+    /**
+     * Used when we are trying to load a layout with missing registrations and we want to add placeholder items
+     * @remarks
+     * This function will register the items with placeholder text, and set them to be closeable if they were not already
+     * As config is passed by reference it is updated directly
+     * @param config - The layout config to update
+     * @param missingRegisteredItems - The items which were missing from the registrations
+     * @internal
+     */
+    private registerPlaceholdersAndSetClosable;
+    /**
+     * Loads the provided config into Golden Layout and does other setup
+     * @remarks
+     * Loads the config into Golden Layout, and then sets up the event listeners for the layout
+     * When loading the layout the visual configuration is loaded
+     * Event listeners are added to the drag handles to emulate resizing events
+     *
+     * **This is the only function which should call this.layout.loadLayout() directly.**
+     * @internal
+     */
+    private loadGLConfigAndSetup;
 }
 
 /**
@@ -194,7 +249,7 @@ export declare class FoundationLayout extends FoundationElement implements Layou
  * @example
  * `<zero-layout></zero-layout>` if you are using the layout with the `zero` design-system.
  *
- * @beta
+ * @public
  */
 export declare const foundationLayoutComponents: {
     foundationLayout: (overrideDefinition?: OverrideFoundationElementDefinition<    {
@@ -224,7 +279,7 @@ export declare const foundationLayoutComponents: {
 };
 
 /**
- * @beta
+ * @public
  * `FoundationLayoutItem` is a custom element that represents an item in the layout.
  * @remarks
  * This element is used to wrap html elements and configure their layout settings as part of the layout system.
@@ -236,28 +291,28 @@ export declare class FoundationLayoutItem extends FoundationElement implements L
      * Sets the title of the item which is displayed on the tab.
      * @remarks
      * Defaults to `Item ` + {@link FoundationLayoutItem.registration}
-     * @beta
+     * @public
      */
     title: string;
     /**
      * Boolean attribute controls whether the window can be closed in the GUI.
      * Defaults to `false`.
-     * @beta
+     * @public
      */
     closable: boolean;
     /**
      * optional string describing the size of the new item (see the written documentation for more info)
-     * @beta
+     * @public
      */
     size: string;
     /**
-     * Sets the registration name for the item, which can be used later to add the item via the JavaScript API using {@link FoundationLayout.addItem()}.
+     * Sets the registration name for the item, which can be used later to add the item via the JavaScript API using {@link FoundationLayout.addItem}.
      * @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.
-     * @beta
+     * @public
      */
     registration: string;
     /** @internal */
@@ -275,7 +330,7 @@ export declare class FoundationLayoutItem extends FoundationElement implements L
 }
 
 /**
- * @beta
+ * @public
  * `FoundationLayoutRegion` is a custom element that represents a region in the layout.
  * @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.
@@ -285,13 +340,13 @@ export declare class FoundationLayoutItem extends FoundationElement implements L
 export declare class FoundationLayoutRegion extends FoundationElement implements LayoutComponent {
     /**
      * optional string describing the size of the new item (see the written documentation for more info)
-     * @beta
+     * @public
      */
     size: string;
     /**
      * Defines the {@link LayoutRegionType | type} of the region.
      * Defaults to `horizontal`.
-     * @beta
+     * @public
      */
     type: LayoutRegionType;
     /** @internal */
@@ -324,18 +379,8 @@ export declare class FoundationLayoutRegion extends FoundationElement implements
     cacheElementsAndRegister(config: RegistrationConfig): string;
 }
 
-/**
- * Returns an array of values of the array a which are missing in b
- * An empty array is returned if every value of a is in b
- * @internal
- */
-export declare function getMissingArrayItems<T>(a: T[], b: T[]): T[];
-
-/** @internal */
-export declare function getParentLayoutComponent(): FoundationLayout | FoundationLayoutRegion;
-
 /** @internal */
-export declare interface LayoutComponent {
+declare interface LayoutComponent {
     [componentType]: ComponentTypes;
     cacheElementsAndRegister(config: RegistrationConfig): string;
     requestLayoutReload(): void;
@@ -350,19 +395,22 @@ export declare interface LayoutComponent {
  * 'itemAdded' - emitted when an item is added to the layout'
  * <br/>
  * 'itemRemoved' - emitted when an item is removed from the layout'
- * @beta
+ * <br/>
+ * 'itemResized' - emitted when the user drags the divider to resize elements
+ * @public
  */
 export declare const LayoutEmitEvents: {
     readonly firstLoaded: "first-loaded";
     readonly itemAdded: "item-added";
     readonly itemRemoved: "item-removed";
+    readonly itemResized: "item-resized";
 };
 
 /**
  * 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.
- * @beta
+ * @public
  */
 export declare const LayoutReceiveEvents: {
     readonly changeTitle: "change-title";
@@ -372,7 +420,7 @@ export declare const LayoutReceiveEvents: {
  * Defines the shape of the detail that the layout listens works with for events it listens on
  *
  * 'changeTitle' - `title` is the string you want to set. For `mode`: `replace` will set the title to be `title`, `suffix` will append `title` to the end of the existing title.
- * @beta
+ * @public
  */
 export declare type LayoutReceiveEventsDetail = {
     changeTitle: {
@@ -382,17 +430,17 @@ export declare type LayoutReceiveEventsDetail = {
 };
 
 /**
- * @beta
+ * @public
  * Union type describing the three different types of region splits.
  * Set on the `type` attribute on {@link FoundationLayoutRegion}.
  */
 export declare type LayoutRegionType = (typeof layoutRegionValue)[number];
 
 /** @internal */
-export declare const layoutRegionValue: readonly ["horizontal", "vertical", "tabs"];
+declare const layoutRegionValue: readonly ["horizontal", "vertical", "tabs"];
 
 /**
- * @beta
+ * @public
  */
 export declare class LayoutRegistrationError extends Error {
     constructor(message: string);
@@ -402,7 +450,7 @@ export declare class LayoutRegistrationError extends Error {
  * `ElementStyles` which defines the css for {@link FoundationLayout}.
  * @remarks
  * Can be used in a composition to customise the styles of the layout.
- * @beta
+ * @public
  */
 export declare const layoutStyles: ElementStyles;
 
@@ -410,19 +458,19 @@ export declare const layoutStyles: ElementStyles;
  * `ViewTemplate` which defines the html for {@link FoundationLayout}.
  * @remarks
  * Can be used in a composition to customise the styles of the layout.
- * @beta
+ * @public
  */
 export declare const layoutTemplate: ViewTemplate<FoundationLayout, any>;
 
 /**
- * @beta
+ * @public
  */
 export declare class LayoutUsageError extends Error {
     constructor(message: string);
 }
 
 /**
- * @beta
+ * @public
  * Where to add the new item into the layout when using the {@link FoundationLayout.addItem} API
  */
 export declare type Placement = {
@@ -430,7 +478,7 @@ export declare type Placement = {
 };
 
 /**
- * @beta
+ * @public
  * The parameters that can be set on a new item when being added by the {@link FoundationLayout.addItem} API
  *
  * @remarks
@@ -454,7 +502,7 @@ export declare interface RegistrationConfig {
 }
 
 /**
- * @beta
+ * @public
  * Versioned layout config objects. `v` is the version and `c` contains the layout config.
  * @remarks
  * Versioning the layout config in this way allows changes to the config schema while
@@ -469,10 +517,4 @@ export declare type SerialisedLayout = {
     c: ResolvedLayoutConfig;
 };
 
-/**
- * template for the child layout elements
- * @internal
- */
-export declare const wrapperTemplate: ViewTemplate<any, any>;
-
 export { }

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

@@ -4,9 +4,6 @@
 
 ## 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.

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -0,0 +1,13 @@
+<!-- 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; [autoSaveKey](./foundation-layout.foundationlayout.autosavekey.md)
+
+## FoundationLayout.autoSaveKey property
+
+Attribute which if set will auto save and load the layout as the user changes it. Omit this attribute to disable this feature. Set attribute using `auto-save-key`<!-- -->.
+
+**Signature:**
+
+```typescript
+autoSaveKey?: string;
+```

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -4,15 +4,12 @@
 
 ## 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;
+loadLayout(layout: SerialisedLayout, handleMissingItem?: 'placeholder' | 'error'): void;
 ```
 
 ## Parameters
@@ -20,6 +17,7 @@ loadLayout(layout: SerialisedLayout): void;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  layout | [SerialisedLayout](./foundation-layout.serialisedlayout.md) | any version of [SerialisedLayout](./foundation-layout.serialisedlayout.md) object describing the layout |
+|  handleMissingItem | 'placeholder' \| 'error' | _(Optional)_ what to do if the layout contains items that are not currently registered with the layout system. Defaults to 'error' which will throw an error. If set to 'placeholder' then any missing items will be replaced with a placeholder element. You can control the text of the placeholder element with [FoundationLayout.missingItemPlaceholder](./foundation-layout.foundationlayout.missingitemplaceholder.md)<!-- -->. |
 
 **Returns:**
 
@@ -27,11 +25,11 @@ 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
+[LayoutUsageError](./foundation-layout.layoutusageerror.md) if you attempt to load a layout with registered items that are not currently registered with the layout system, and handleMissingItem is set to 'error' (default).
 
 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
+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. 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. 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

@@ -4,9 +4,6 @@
 
 ## 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:**
@@ -28,17 +25,20 @@ The constructor for this class is marked as internal. Third-party code should no
 
 |  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). |
+|  [autoSaveKey?](./foundation-layout.foundationlayout.autosavekey.md) |  | string | _(Optional)_ Attribute which if set will auto save and load the layout as the user changes it. Omit this attribute to disable this feature. Set attribute using <code>auto-save-key</code>. |
+|  [dragging](./foundation-layout.foundationlayout.dragging.md) |  | boolean | Set to true when the user is currently dragging the panes inside of the layout |
+|  [missingItemPlaceholder](./foundation-layout.foundationlayout.missingitemplaceholder.md) |  | (missingItem: string) =&gt; string | Function which is used to generate the placeholder text when a layout is loaded with a missing item. |
+|  [reloadBuffer](./foundation-layout.foundationlayout.reloadbuffer.md) |  | number | 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. |
+|  [addItem(config, placement)](./foundation-layout.foundationlayout.additem.md) |  | 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) |  | 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> | Gets all of the required registration function names for a set of config |
+|  [loadLayout(layout, handleMissingItem)](./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. |
+|  [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.missingitemplaceholder.md

@@ -0,0 +1,13 @@
+<!-- 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; [missingItemPlaceholder](./foundation-layout.foundationlayout.missingitemplaceholder.md)
+
+## FoundationLayout.missingItemPlaceholder property
+
+Function which is used to generate the placeholder text when a layout is loaded with a missing item.
+
+**Signature:**
+
+```typescript
+missingItemPlaceholder: (missingItem: string) => string;
+```

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -0,0 +1,27 @@
+<!-- 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; [tryLoadLayoutFromLocalStorage](./foundation-layout.foundationlayout.tryloadlayoutfromlocalstorage.md)
+
+## FoundationLayout.tryLoadLayoutFromLocalStorage() method
+
+Try to load a layout from local storage, or return false. Only required if manually calling [FoundationLayout.registerItem()](./foundation-layout.foundationlayout.registeritem.md)
+
+**Signature:**
+
+```typescript
+tryLoadLayoutFromLocalStorage(): boolean;
+```
+**Returns:**
+
+boolean
+
+boolean - true if a layout was loaded, false if not
+
+## Remarks
+
+Attempt to load an autosaved layout from local storage, keyed on the `auto-save-key` attribute. If `auto-save-key` attribute is not set or there is no autosaved layout yet, this will return false. Else, true.
+
+This function is automatically called when loading the layout via the declarative API so if you're not registering components via the JavaScript API then you don't need to call this function. If you \*are\* calling [FoundationLayout.registerItem()](./foundation-layout.foundationlayout.registeritem.md) then you should call this function immediately afterwards.
+
+Will load the layout with `handleMissingItem = 'placeholder` so placeholder text will be shown for any missing items.
+

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

@@ -4,9 +4,6 @@
 
 ## 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:**

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

@@ -4,9 +4,6 @@
 
 ## 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:**