@genesislcap/foundation-layout 14.408.0 → 14.409.0

package/docs/api/foundation-layout.md

@@ -1,373 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md)
-
-## foundation-layout package
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[FoundationLayout](./foundation-layout.foundationlayout.md)
-
-
-</td><td>
-
-Top level web component which is used to initialise a custom layout
-
-
-</td></tr>
-<tr><td>
-
-[FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md)
-
-
-</td><td>
-
-`FoundationLayoutItem` is a custom element that represents an item in the layout.
-
-
-</td></tr>
-<tr><td>
-
-[FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)
-
-
-</td><td>
-
-`FoundationLayoutRegion` is a custom element that represents a region in the layout.
-
-
-</td></tr>
-<tr><td>
-
-[LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LayoutUsageError](./foundation-layout.layoutusageerror.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[getFactory(key)](./foundation-layout.getfactory.md)
-
-
-</td><td>
-
-Retrieves a factory function by its key.
-
-
-</td></tr>
-<tr><td>
-
-[registerFactory(key, factory)](./foundation-layout.registerfactory.md)
-
-
-</td><td>
-
-Registers a factory function with a unique key. This allows framework components to be used in the declarative layout API without needing to pass function references through HTML attributes.
-
-
-</td></tr>
-<tr><td>
-
-[unregisterFactory(key)](./foundation-layout.unregisterfactory.md)
-
-
-</td><td>
-
-Removes a factory from the registry. This is useful for cleanup when a component is unmounted or no longer needed.
-
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Interface
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[LayoutComponentWithState](./foundation-layout.layoutcomponentwithstate.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[RegisteredElementConfig](./foundation-layout.registeredelementconfig.md)
-
-
-</td><td>
-
-The parameters that can be set on a new item when being added by the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[DEFAULT\_RELOAD\_BUFFER](./foundation-layout.default_reload_buffer.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[foundationLayoutComponents](./foundation-layout.foundationlayoutcomponents.md)
-
-
-</td><td>
-
-Registration object to register the layout with your design system.
-
-
-</td></tr>
-<tr><td>
-
-[LAYOUT\_ICONS](./foundation-layout.layout_icons.md)
-
-
-</td><td>
-
-A collection of SVG icons in base64 format.
-
-
-</td></tr>
-<tr><td>
-
-[LAYOUT\_POPOUT\_CONTAINER\_CLASS](./foundation-layout.layout_popout_container_class.md)
-
-
-</td><td>
-
-**_(BETA)_** Put this classname on an element which is a DOM parent of the layout, and if the layout goes into popout mode then it will place itself as the only child for the popout container you set.
-
-
-</td></tr>
-<tr><td>
-
-[LAYOUT\_POPOUT\_CONTROL\_KEY](./foundation-layout.layout_popout_control_key.md)
-
-
-</td><td>
-
-**_(BETA)_** Key to be used for controlling popout behaviour
-
-
-</td></tr>
-<tr><td>
-
-[LayoutEmitEvents](./foundation-layout.layoutemitevents.md)
-
-
-</td><td>
-
-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
-
-
-</td></tr>
-<tr><td>
-
-[LayoutReceiveEvents](./foundation-layout.layoutreceiveevents.md)
-
-
-</td><td>
-
-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)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[layoutStyles](./foundation-layout.layoutstyles.md)
-
-
-</td><td>
-
-`ElementStyles` which defines the css for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[layoutTemplate](./foundation-layout.layouttemplate.md)
-
-
-</td><td>
-
-`ViewTemplate` which defines the html for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ComponentFactory](./foundation-layout.componentfactory.md)
-
-
-</td><td>
-
-Factory function for creating component instances in the layout.
-
-
-</td></tr>
-<tr><td>
-
-[CustomButton](./foundation-layout.custombutton.md)
-
-
-</td><td>
-
-Definition of a custom button which will be added to all layout items.
-
-
-</td></tr>
-<tr><td>
-
-[LayoutPopoutConfig](./foundation-layout.layoutpopoutconfig.md)
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[LayoutReceiveEventsDetail](./foundation-layout.layoutreceiveeventsdetail.md)
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-<tr><td>
-
-[LayoutRegionType](./foundation-layout.layoutregiontype.md)
-
-
-</td><td>
-
-Union type describing the three different types of region splits. Set on the `type` attribute on [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[Placement](./foundation-layout.placement.md)
-
-
-</td><td>
-
-Where to and how to add the new item(s) into the layout when using the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API.
-
-
-</td></tr>
-<tr><td>
-
-[SerialisedLayout](./foundation-layout.serialisedlayout.md)
-
-
-</td><td>
-
-Versioned layout config objects. `v` is the version and `c` contains the layout config.
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,25 +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; [Placement](./foundation-layout.placement.md)
-
-## Placement type
-
-Where to and how to add the new item(s) into the layout when using the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API.
-
-**Signature:**
-
-```typescript
-export type Placement = {
-    area: 'top' | 'left' | 'bottom' | 'right';
-    multiple?: {
-        type: LayoutRegionType;
-        size?: string;
-    };
-};
-```
-**References:** [LayoutRegionType](./foundation-layout.layoutregiontype.md)
-
-## Remarks
-
-`area` dictates what part of the layout the new item(s) will be added to. `multiple` is optional and is defaulted to `type=horizontal` and `size=50%` if not defined. `multiple` config only affects the placement if multiple items are specified to be added. `multiple.type` sets the group type of the new items, whether they are horizontal, vertical, or in tabs. `multiple.size` - optional string describing the size of the new item (see the written documentation for more info). `multiple.size` specifies the size of the new group to be added and then the `size` config of the new items are the sizes relative to this new multiple group. If you only specify one new item then the `size` of that will be used as the size and will override `multiple.size`<!-- -->.
-

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

@@ -1,11 +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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [closable](./foundation-layout.registeredelementconfig.closable.md)
-
-## RegisteredElementConfig.closable property
-
-**Signature:**
-
-```typescript
-closable?: boolean;
-```

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

@@ -1,136 +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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md)
-
-## RegisteredElementConfig interface
-
-The parameters that can be set on a new item when being added by the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API
-
-**Signature:**
-
-```typescript
-export interface RegisteredElementConfig 
-```
-
-## Remarks
-
-`elements` - array of Elements that are the content of the new item `title` - optional string which is used as the new title of the tab (defaults to be the registered name) `closable` - optional boolean which allows the item to be closed with the X button if set and true `size` - optional string describing the size of the new item (see the written documentation for more info) `registration` - optional string configuring the registration ID of the new item (defaults to sequential IDs)
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[closable?](./foundation-layout.registeredelementconfig.closable.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[registration](./foundation-layout.registeredelementconfig.registration.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[showMaximiseButton?](./foundation-layout.registeredelementconfig.showmaximisebutton.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[size?](./foundation-layout.registeredelementconfig.size.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[title?](./foundation-layout.registeredelementconfig.title.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,11 +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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [registration](./foundation-layout.registeredelementconfig.registration.md)
-
-## RegisteredElementConfig.registration property
-
-**Signature:**
-
-```typescript
-registration: string;
-```

package/docs/api/foundation-layout.registeredelementconfig.showmaximisebutton.md

@@ -1,11 +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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [showMaximiseButton](./foundation-layout.registeredelementconfig.showmaximisebutton.md)
-
-## RegisteredElementConfig.showMaximiseButton property
-
-**Signature:**
-
-```typescript
-showMaximiseButton?: boolean;
-```

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

@@ -1,11 +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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [size](./foundation-layout.registeredelementconfig.size.md)
-
-## RegisteredElementConfig.size property
-
-**Signature:**
-
-```typescript
-size?: string;
-```

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

@@ -1,11 +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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [title](./foundation-layout.registeredelementconfig.title.md)
-
-## RegisteredElementConfig.title property
-
-**Signature:**
-
-```typescript
-title?: string;
-```

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

@@ -1,94 +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; [registerFactory](./foundation-layout.registerfactory.md)
-
-## registerFactory() function
-
-Registers a factory function with a unique key. This allows framework components to be used in the declarative layout API without needing to pass function references through HTML attributes.
-
-**Signature:**
-
-```typescript
-export declare function registerFactory(key: string, factory: ComponentFactory): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Unique identifier for the factory. Should be descriptive and unique across the application.
-
-
-</td></tr>
-<tr><td>
-
-factory
-
-
-</td><td>
-
-[ComponentFactory](./foundation-layout.componentfactory.md)
-
-
-</td><td>
-
-The factory function that creates the component.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Exceptions
-
-{<!-- -->Error<!-- -->} If a factory with the same key is already registered.
-
-## Example
-
-
-```typescript
-// React example
-import { registerFactory } from '@genesislcap/foundation-layout';
-import { reactFactory } from './utils/react-layout-factory';
-import { MyComponent } from './components/MyComponent';
-
-registerFactory('my-component', reactFactory(MyComponent, { someProp: 'value' }));
-```
-Then in your JSX:
-
-```tsx
-<rapid-layout-item
-  registration="my-item"
-  title="My Component"
-/>
-```
-