@genesislcap/foundation-layout 14.408.0 → 14.409.0

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

@@ -1,96 +0,0 @@
-<!-- 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
-
-Restores a layout described in the config from [getLayout()](./foundation-layout.foundationlayout.getlayout.md)
-
-**Signature:**
-
-```typescript
-loadLayout(layout: SerialisedLayout, handleMissingItem?: 'placeholder' | 'error', disableCache?: boolean): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-layout
-
-
-</td><td>
-
-[SerialisedLayout](./foundation-layout.serialisedlayout.md)
-
-
-</td><td>
-
-any version of [SerialisedLayout](./foundation-layout.serialisedlayout.md) object describing the layout
-
-
-</td></tr>
-<tr><td>
-
-handleMissingItem
-
-
-</td><td>
-
-'placeholder' \| 'error'
-
-
-</td><td>
-
-_(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)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-disableCache
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ if set to true then the layout will give you a new instance of every item, even if it has a currently cached item to use. Using this will not stop you from saving and loading state via the [LayoutComponentWithState](./foundation-layout.layoutcomponentwithstate.md) interface. Defaults to false.
-
-
-</td></tr>
-</tbody></table>
-
-**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, 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. 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

@@ -1,400 +0,0 @@
-<!-- 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
-
-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
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[autoSaveKey?](./foundation-layout.foundationlayout.autosavekey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(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 `auto-save-key`<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[class](./foundation-layout.foundationlayout.class.md)
-
-
-</td><td>
-
-
-</td><td>
-
-"FoundationLayoutMain"
-
-
-</td><td>
-
-Identifier constant token.
-
-
-</td></tr>
-<tr><td>
-
-[customButtons](./foundation-layout.foundationlayout.custombuttons.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[CustomButton](./foundation-layout.custombutton.md)<!-- -->\[\]
-
-
-</td><td>
-
-Set custom button definition on this property to add them to the layout header controls
-
-
-</td></tr>
-<tr><td>
-
-[dimensionsConfig?](./foundation-layout.foundationlayout.dimensionsconfig.md)
-
-
-</td><td>
-
-
-</td><td>
-
-LayoutConfig.Dimensions
-
-
-</td><td>
-
-_(Optional)_ Apply dimensions config to the layout, such as setting the size of the drag handles.
-
-
-</td></tr>
-<tr><td>
-
-[dragging](./foundation-layout.foundationlayout.dragging.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Set to true when the user is currently dragging the panes inside of the layout
-
-
-</td></tr>
-<tr><td>
-
-[hasFirstLoaded](./foundation-layout.foundationlayout.hasfirstloaded.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Boolean signifies whether the layout has loaded for the first time or not.
-
-
-</td></tr>
-<tr><td>
-
-[lifecycleUpdateToken](./foundation-layout.foundationlayout.lifecycleupdatetoken.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string \| undefined
-
-
-</td><td>
-
-Used to calculate whether a layout item should run its lifecycle methods or not
-
-
-</td></tr>
-<tr><td>
-
-[missingItemPlaceholder](./foundation-layout.foundationlayout.missingitemplaceholder.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(missingItem: string) =&gt; string
-
-
-</td><td>
-
-Function which is used to generate the placeholder text when a layout is loaded with a missing item.
-
-
-</td></tr>
-<tr><td>
-
-[popoutConfig](./foundation-layout.foundationlayout.popoutconfig.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[LayoutPopoutConfig](./foundation-layout.layoutpopoutconfig.md) \| undefined
-
-
-</td><td>
-
-**_(BETA)_** Controls whether popout functionality is enabled on the layout. Defaults to disabled. Pass an empty object `{}` to use default configurations, or a [LayoutPopoutConfig](./foundation-layout.layoutpopoutconfig.md) object to further customise.
-
-
-</td></tr>
-<tr><td>
-
-[reloadBuffer](./foundation-layout.foundationlayout.reloadbuffer.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Number describing how long to wait in ms before reloading the config when adding items declaratively by the html API. Default 500 (ms).
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[addItem(config, placement)](./foundation-layout.foundationlayout.additem.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Dynamically add a new item to the layout. The user can move the new plane to whenever they want once it has been added.
-
-
-</td></tr>
-<tr><td>
-
-[clearAutosaveAndRevertToDefault()](./foundation-layout.foundationlayout.clearautosaveandreverttodefault.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Clears the autosaved layout from local storage and reverts to the default layout
-
-
-</td></tr>
-<tr><td>
-
-[getLayout()](./foundation-layout.foundationlayout.getlayout.md)
-
-
-</td><td>
-
-
-</td><td>
-
-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)
-
-
-</td></tr>
-<tr><td>
-
-[layoutRequiredRegistrations(layout)](./foundation-layout.foundationlayout.layoutrequiredregistrations.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Gets all of the required element registry function names for a set of config
-
-
-</td></tr>
-<tr><td>
-
-[loadLayout(layout, handleMissingItem, disableCache)](./foundation-layout.foundationlayout.loadlayout.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Restores a layout described in the config from [getLayout()](./foundation-layout.foundationlayout.getlayout.md)
-
-
-</td></tr>
-<tr><td>
-
-[registeredItems()](./foundation-layout.foundationlayout.registereditems.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Gets all of the currently registered names
-
-
-</td></tr>
-<tr><td>
-
-[registerItem(registration, elementsOrFactory)](./foundation-layout.foundationlayout.registeritem.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Register a collection of `Element` or a factory function and associate them with an `ID` with the layout system for later use.
-
-
-</td></tr>
-<tr><td>
-
-[removeItems(registration, force)](./foundation-layout.foundationlayout.removeitems.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Removes all instances of a specified registered item from the layout.
-
-
-</td></tr>
-<tr><td>
-
-[tryActivatePopoutMode()](./foundation-layout.foundationlayout.tryactivatepopoutmode.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(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.
-
-
-</td></tr>
-<tr><td>
-
-[tryLoadLayoutFromLocalStorage()](./foundation-layout.foundationlayout.tryloadlayoutfromlocalstorage.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Try to load a layout from local storage, or return false. Only required if manually calling [FoundationLayout.registerItem()](./foundation-layout.foundationlayout.registeritem.md)
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,13 +0,0 @@
-<!-- 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.popoutconfig.md

@@ -1,16 +0,0 @@
-<!-- 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; [popoutConfig](./foundation-layout.foundationlayout.popoutconfig.md)
-
-## FoundationLayout.popoutConfig property
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Controls whether popout functionality is enabled on the layout. Defaults to disabled. Pass an empty object `{}` to use default configurations, or a [LayoutPopoutConfig](./foundation-layout.layoutpopoutconfig.md) object to further customise.
-
-**Signature:**
-
-```typescript
-popoutConfig: LayoutPopoutConfig | undefined;
-```

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

@@ -1,23 +0,0 @@
-<!-- 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
-
-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

@@ -1,108 +0,0 @@
-<!-- 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
-
-Register a collection of `Element` or a factory function and associate them with an `ID` with the layout system for later use.
-
-**Signature:**
-
-```typescript
-registerItem(registration: string, elementsOrFactory: Element[] | ComponentFactory): string;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-registration
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-string of the registration ID
-
-
-</td></tr>
-<tr><td>
-
-elementsOrFactory
-
-
-</td><td>
-
-Element\[\] \| [ComponentFactory](./foundation-layout.componentfactory.md)
-
-
-</td><td>
-
-Either Elements\[\] containing the reference to the elements to register, or a ComponentFactory function
-
-
-</td></tr>
-</tbody></table>
-
-**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 can register either an array of elements or a factory function.
-
-\*\*Element registration\*\*: 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)`<!-- -->.
-
-\*\*Factory registration\*\*: This is the recommended approach for framework-rendered components (React, Angular, Vue, etc.) because it allows each layout instance to create a fresh component rather than cloning existing DOM elements (which loses event listeners and framework bindings). The factory function will be called each time a new instance of the component is needed. It receives a container element and should render the component into it. Optionally, it can return a cleanup function that will be called when the component is removed from the layout.
-
-## Example 1
-
-Element registration:
-
-```typescript
-const div = document.createElement('div');
-div.innerHTML = '<h1>Hello</h1>';
-layout.registerItem('my-element', [div]);
-```
-
-## Example 2
-
-Factory registration (React):
-
-```typescript
-layout.registerItem('text-field', (container) => {
-  const root = createRoot(container);
-  root.render(<TextFieldComponent />);
-  return () => root.unmount();
-});
-```
-

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

@@ -1,13 +0,0 @@
-<!-- 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
-
-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;
-```