@genesislcap/foundation-layout 14.408.0 → 14.409.0

package/docs/api/foundation-layout.layoutcomponentwithstate.applystate.md

@@ -1,52 +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; [LayoutComponentWithState](./foundation-layout.layoutcomponentwithstate.md) &gt; [applyState](./foundation-layout.layoutcomponentwithstate.applystate.md)
-
-## LayoutComponentWithState.applyState() method
-
-Handle any state that has been saved previously for this instance of this component. It is not deterministic to know whether this is called before the component is appended to the DOM.
-
-**Signature:**
-
-```typescript
-applyState(state: T | null): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-state
-
-
-</td><td>
-
-T \| null
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-layout.layoutcomponentwithstate.getcurrentstate.md

@@ -1,17 +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; [LayoutComponentWithState](./foundation-layout.layoutcomponentwithstate.md) &gt; [getCurrentState](./foundation-layout.layoutcomponentwithstate.getcurrentstate.md)
-
-## LayoutComponentWithState.getCurrentState() method
-
-Provide the state you wish to save. It is recommended if the component which implements this interface has not fully initialised at the point this is called that you return `null` as the state, following the pattern of `null` being set as the initial state.
-
-**Signature:**
-
-```typescript
-getCurrentState(): T;
-```
-**Returns:**
-
-T
-

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

@@ -1,105 +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; [LayoutComponentWithState](./foundation-layout.layoutcomponentwithstate.md)
-
-## LayoutComponentWithState interface
-
-Interface to implement on an item which is a component of the layout and you wish to serialise state with. This is saved separately for each instance of the component, which allows you to restore multiple instances of the same component with different state.
-
-**Signature:**
-
-```typescript
-export interface LayoutComponentWithState<T> 
-```
-
-## Remarks
-
-When the layout is saved either via the autosave functionality or manually calling [FoundationLayout.getLayout()](./foundation-layout.foundationlayout.getlayout.md)<!-- -->, all contained components will be requested to provide state if they wish.
-
-Any state which is provided will be saved as part of the layout config and will be passed back to the component when the layout is loaded with [FoundationLayout.loadLayout()](./foundation-layout.foundationlayout.loadlayout.md) (or via autoloading). The state will be applied to the component via `applyState`<!-- -->, this may be before or after the component has been placed on the DOM, so you'll need to handle either scenario. The state is `null` when the instance is first created.
-
-See the written documentation for some error scenarios to consider about when implementing this interface.
-
-## Example 1
-
-
-```
-type ComponentState = {
-  foo: string;
-}
-\@customElement({ name: 'my-component' })
-export class MyComponent extends FASTElement implements LayoutComponentWithState<ComponentState> {
-  \@observable foo: string;
-  private fooCache: ComponentState | null;
-
-  getCurrentState(): ComponentState {
-    if (!this.foo) return null;
-    return {
-      foo: this.foo;
-    }
-  }
-
-  applyState(state: ComponentState | null) {
-    this.fooCache = state;
-  }
-
-  connectedCallback() {
-    // do other required setup
-    if (this.fooCache) {
-      this.foo = this.fooCache.foo;
-    }
-  }
-}
-```
-
-## Example 2
-
-If you are using the autosave functionality you should inform the layout system when you update the state of a component, otherwise the state will only be updated when the user performs an action such as resizing an item. Use the [LayoutReceiveEvents](./foundation-layout.layoutreceiveevents.md) `autosave` event.
-
-```
-// Same component as above
-export class MyComponent extends FASTElement implements LayoutComponentWithState<ComponentState> {
- // can use xChanged pattern as `foo` was declared observable
- fooChanged() {
-   this.$emit(LayoutReceiveEvents.autosave);
- }
-}
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[applyState(state)](./foundation-layout.layoutcomponentwithstate.applystate.md)
-
-
-</td><td>
-
-Handle any state that has been saved previously for this instance of this component. It is not deterministic to know whether this is called before the component is appended to the DOM.
-
-
-</td></tr>
-<tr><td>
-
-[getCurrentState()](./foundation-layout.layoutcomponentwithstate.getcurrentstate.md)
-
-
-</td><td>
-
-Provide the state you wish to save. It is recommended if the component which implements this interface has not fully initialised at the point this is called that you return `null` as the state, following the pattern of `null` being set as the initial state.
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,20 +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; [LayoutEmitEvents](./foundation-layout.layoutemitevents.md)
-
-## LayoutEmitEvents variable
-
-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' <br/> 'itemResized' - emitted when the user drags the divider to resize elements
-
-**Signature:**
-
-```typescript
-LayoutEmitEvents: {
-    readonly firstLoaded: "first-loaded";
-    readonly itemAdded: "item-added";
-    readonly itemRemoved: "item-removed";
-    readonly itemResized: "item-resized";
-}
-```

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

@@ -1,22 +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; [LayoutPopoutConfig](./foundation-layout.layoutpopoutconfig.md)
-
-## LayoutPopoutConfig type
-
-> 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.
-> 
-
-
-**Signature:**
-
-```typescript
-export type LayoutPopoutConfig = {
-    channelName?: string;
-    loadAutomatically?: boolean;
-    popoutDimension?: {
-        width: number;
-        height: number;
-    };
-};
-```

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

@@ -1,18 +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; [LayoutReceiveEvents](./foundation-layout.layoutreceiveevents.md)
-
-## LayoutReceiveEvents variable
-
-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. 'autosave' - emit this from a contained item to hint to the layout system that it should autosave the layout. A contained item should do this if it has just changed some state it would like to persist. See [LayoutComponentWithState](./foundation-layout.layoutcomponentwithstate.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-LayoutReceiveEvents: {
-    readonly changeTitle: "change-title";
-    readonly autosave: "autosave";
-}
-```

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

@@ -1,21 +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; [LayoutReceiveEventsDetail](./foundation-layout.layoutreceiveeventsdetail.md)
-
-## LayoutReceiveEventsDetail type
-
-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. 'autosave' - no other parameters.
-
-**Signature:**
-
-```typescript
-export type LayoutReceiveEventsDetail = {
-    changeTitle: {
-        title: string;
-        mode: 'replace' | 'suffix';
-    };
-    autosave: void;
-};
-```

package/docs/api/foundation-layout.layoutregiontype.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; [LayoutRegionType](./foundation-layout.layoutregiontype.md)
-
-## LayoutRegionType type
-
-Union type describing the three different types of region splits. Set on the `type` attribute on [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-export type LayoutRegionType = (typeof layoutRegionValue)[number];
-```

package/docs/api/foundation-layout.layoutregistrationerror._constructor_.md

@@ -1,48 +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; [LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md) &gt; [(constructor)](./foundation-layout.layoutregistrationerror._constructor_.md)
-
-## LayoutRegistrationError.(constructor)
-
-Constructs a new instance of the `LayoutRegistrationError` class
-
-**Signature:**
-
-```typescript
-constructor(message: string);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,48 +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; [LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md)
-
-## LayoutRegistrationError class
-
-
-**Signature:**
-
-```typescript
-export declare class LayoutRegistrationError extends Error 
-```
-**Extends:** Error
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(message)](./foundation-layout.layoutregistrationerror._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `LayoutRegistrationError` class
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,18 +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; [layoutStyles](./foundation-layout.layoutstyles.md)
-
-## layoutStyles variable
-
-`ElementStyles` which defines the css for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-layoutStyles: import("@microsoft/fast-element").ElementStyles
-```
-
-## Remarks
-
-Can be used in a composition to customise the styles of the layout.
-

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

@@ -1,18 +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; [layoutTemplate](./foundation-layout.layouttemplate.md)
-
-## layoutTemplate variable
-
-`ViewTemplate` which defines the html for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-layoutTemplate: import("@microsoft/fast-element").ViewTemplate<FoundationLayout, any>
-```
-
-## Remarks
-
-Can be used in a composition to customise the styles of the layout.
-

package/docs/api/foundation-layout.layoutusageerror._constructor_.md

@@ -1,48 +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; [LayoutUsageError](./foundation-layout.layoutusageerror.md) &gt; [(constructor)](./foundation-layout.layoutusageerror._constructor_.md)
-
-## LayoutUsageError.(constructor)
-
-Constructs a new instance of the `LayoutUsageError` class
-
-**Signature:**
-
-```typescript
-constructor(message: string);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,48 +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; [LayoutUsageError](./foundation-layout.layoutusageerror.md)
-
-## LayoutUsageError class
-
-
-**Signature:**
-
-```typescript
-export declare class LayoutUsageError extends Error 
-```
-**Extends:** Error
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(message)](./foundation-layout.layoutusageerror._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `LayoutUsageError` class
-
-
-</td></tr>
-</tbody></table>
-