@genesislcap/foundation-layout 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +12 -135
  2. package/package.json +15 -15
  3. package/docs/api/foundation-layout.componentfactory.md +0 -46
  4. package/docs/api/foundation-layout.custombutton.md +0 -21
  5. package/docs/api/foundation-layout.default_reload_buffer.md +0 -15
  6. package/docs/api/foundation-layout.foundationlayout.additem.md +0 -80
  7. package/docs/api/foundation-layout.foundationlayout.autosavekey.md +0 -13
  8. package/docs/api/foundation-layout.foundationlayout.class.md +0 -18
  9. package/docs/api/foundation-layout.foundationlayout.clearautosaveandreverttodefault.md +0 -25
  10. package/docs/api/foundation-layout.foundationlayout.custombuttons.md +0 -18
  11. package/docs/api/foundation-layout.foundationlayout.dimensionsconfig.md +0 -13
  12. package/docs/api/foundation-layout.foundationlayout.dragging.md +0 -13
  13. package/docs/api/foundation-layout.foundationlayout.getlayout.md +0 -23
  14. package/docs/api/foundation-layout.foundationlayout.hasfirstloaded.md +0 -20
  15. package/docs/api/foundation-layout.foundationlayout.layoutrequiredregistrations.md +0 -64
  16. package/docs/api/foundation-layout.foundationlayout.lifecycleupdatetoken.md +0 -18
  17. package/docs/api/foundation-layout.foundationlayout.loadlayout.md +0 -96
  18. package/docs/api/foundation-layout.foundationlayout.md +0 -400
  19. package/docs/api/foundation-layout.foundationlayout.missingitemplaceholder.md +0 -13
  20. package/docs/api/foundation-layout.foundationlayout.popoutconfig.md +0 -16
  21. package/docs/api/foundation-layout.foundationlayout.registereditems.md +0 -23
  22. package/docs/api/foundation-layout.foundationlayout.registeritem.md +0 -108
  23. package/docs/api/foundation-layout.foundationlayout.reloadbuffer.md +0 -13
  24. package/docs/api/foundation-layout.foundationlayout.removeitems.md +0 -76
  25. package/docs/api/foundation-layout.foundationlayout.tryactivatepopoutmode.md +0 -26
  26. package/docs/api/foundation-layout.foundationlayout.tryloadlayoutfromlocalstorage.md +0 -27
  27. package/docs/api/foundation-layout.foundationlayoutcomponents.md +0 -47
  28. package/docs/api/foundation-layout.foundationlayoutitem.closable.md +0 -13
  29. package/docs/api/foundation-layout.foundationlayoutitem.md +0 -126
  30. package/docs/api/foundation-layout.foundationlayoutitem.registration.md +0 -36
  31. package/docs/api/foundation-layout.foundationlayoutitem.size.md +0 -13
  32. package/docs/api/foundation-layout.foundationlayoutitem.title.md +0 -18
  33. package/docs/api/foundation-layout.foundationlayoutregion.md +0 -86
  34. package/docs/api/foundation-layout.foundationlayoutregion.size.md +0 -13
  35. package/docs/api/foundation-layout.foundationlayoutregion.type.md +0 -13
  36. package/docs/api/foundation-layout.getfactory.md +0 -56
  37. package/docs/api/foundation-layout.layout_icons.md +0 -34
  38. package/docs/api/foundation-layout.layout_popout_container_class.md +0 -16
  39. package/docs/api/foundation-layout.layout_popout_control_key.md +0 -16
  40. package/docs/api/foundation-layout.layoutcomponentwithstate.applystate.md +0 -52
  41. package/docs/api/foundation-layout.layoutcomponentwithstate.getcurrentstate.md +0 -17
  42. package/docs/api/foundation-layout.layoutcomponentwithstate.md +0 -105
  43. package/docs/api/foundation-layout.layoutemitevents.md +0 -20
  44. package/docs/api/foundation-layout.layoutpopoutconfig.md +0 -22
  45. package/docs/api/foundation-layout.layoutreceiveevents.md +0 -18
  46. package/docs/api/foundation-layout.layoutreceiveeventsdetail.md +0 -21
  47. package/docs/api/foundation-layout.layoutregiontype.md +0 -13
  48. package/docs/api/foundation-layout.layoutregistrationerror._constructor_.md +0 -48
  49. package/docs/api/foundation-layout.layoutregistrationerror.md +0 -48
  50. package/docs/api/foundation-layout.layoutstyles.md +0 -18
  51. package/docs/api/foundation-layout.layouttemplate.md +0 -18
  52. package/docs/api/foundation-layout.layoutusageerror._constructor_.md +0 -48
  53. package/docs/api/foundation-layout.layoutusageerror.md +0 -48
  54. package/docs/api/foundation-layout.md +0 -373
  55. package/docs/api/foundation-layout.placement.md +0 -25
  56. package/docs/api/foundation-layout.registeredelementconfig.closable.md +0 -11
  57. package/docs/api/foundation-layout.registeredelementconfig.md +0 -136
  58. package/docs/api/foundation-layout.registeredelementconfig.registration.md +0 -11
  59. package/docs/api/foundation-layout.registeredelementconfig.showmaximisebutton.md +0 -11
  60. package/docs/api/foundation-layout.registeredelementconfig.size.md +0 -11
  61. package/docs/api/foundation-layout.registeredelementconfig.title.md +0 -11
  62. package/docs/api/foundation-layout.registerfactory.md +0 -94
  63. package/docs/api/foundation-layout.serialisedlayout.md +0 -26
  64. package/docs/api/foundation-layout.unregisterfactory.md +0 -63
  65. package/docs/api/index.md +0 -30
  66. package/docs/api-report.md.api.md +0 -278
@@ -1,76 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayout](./foundation-layout.foundationlayout.md) &gt; [removeItems](./foundation-layout.foundationlayout.removeitems.md)
4
-
5
- ## FoundationLayout.removeItems() method
6
-
7
- Removes all instances of a specified registered item from the layout.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- removeItems(registration: string, force?: boolean): number;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- registration
36
-
37
-
38
- </td><td>
39
-
40
- string
41
-
42
-
43
- </td><td>
44
-
45
- string of the registration ID
46
-
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- force
52
-
53
-
54
- </td><td>
55
-
56
- boolean
57
-
58
-
59
- </td><td>
60
-
61
- _(Optional)_ if set to true then the item will be removed even if it is not closable. Defaults to false, which is the same behaviour as the close button on the header.
62
-
63
-
64
- </td></tr>
65
- </tbody></table>
66
-
67
- **Returns:**
68
-
69
- number
70
-
71
- number of items removed
72
-
73
- ## Remarks
74
-
75
- Does not remove the registration from the layout system. Has a side affect of setting all tab views to be viewing the first tab in the stack.
76
-
@@ -1,26 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayout](./foundation-layout.foundationlayout.md) &gt; [tryActivatePopoutMode](./foundation-layout.foundationlayout.tryactivatepopoutmode.md)
4
-
5
- ## FoundationLayout.tryActivatePopoutMode() method
6
-
7
- > 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.
8
- >
9
-
10
- 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.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- tryActivatePopoutMode(): boolean;
16
- ```
17
- **Returns:**
18
-
19
- boolean
20
-
21
- ## Remarks
22
-
23
- If you need to call this manually then you should do it as soon as you register all of the required components with [FoundationLayout.registerItem()](./foundation-layout.foundationlayout.registeritem.md)<!-- -->.
24
-
25
- If you set the `LAYOUT_POPOUT_CONTAINER_CLASS` on an element which is a DOM parent of the layout, then if the layout goes into popout mode then it will place itself as the only child for the popout container you set. It is likely you'll want to attach this class to your design system provider.
26
-
@@ -1,27 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayout](./foundation-layout.foundationlayout.md) &gt; [tryLoadLayoutFromLocalStorage](./foundation-layout.foundationlayout.tryloadlayoutfromlocalstorage.md)
4
-
5
- ## FoundationLayout.tryLoadLayoutFromLocalStorage() method
6
-
7
- Try to load a layout from local storage, or return false. Only required if manually calling [FoundationLayout.registerItem()](./foundation-layout.foundationlayout.registeritem.md)
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- tryLoadLayoutFromLocalStorage(): boolean;
13
- ```
14
- **Returns:**
15
-
16
- boolean
17
-
18
- boolean - true if a layout was loaded, false if not
19
-
20
- ## Remarks
21
-
22
- 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.
23
-
24
- 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.
25
-
26
- Will load the layout with `handleMissingItem = 'placeholder` so placeholder text will be shown for any missing items. Loads layout config with the cache disabled (this will likely only be called after the page has refreshed anyway, so there would have been no cached elements to try and recover).
27
-
@@ -1,47 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [foundationLayoutComponents](./foundation-layout.foundationlayoutcomponents.md)
4
-
5
- ## foundationLayoutComponents variable
6
-
7
- Registration object to register the layout with your design system.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- foundationLayoutComponents: {
13
- foundationLayout: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
14
- baseName: string;
15
- styles: import("@microsoft/fast-element").ElementStyles;
16
- template: import("@microsoft/fast-element").ViewTemplate<import("./layout-main").FoundationLayout, any>;
17
- }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
18
- baseName: string;
19
- styles: import("@microsoft/fast-element").ElementStyles;
20
- template: import("@microsoft/fast-element").ViewTemplate<import("./layout-main").FoundationLayout, any>;
21
- }, typeof import("./layout-main").FoundationLayout>;
22
- foundationLayoutRegion: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
23
- baseName: string;
24
- template: import("@microsoft/fast-element").ViewTemplate<any, any>;
25
- }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
26
- baseName: string;
27
- template: import("@microsoft/fast-element").ViewTemplate<any, any>;
28
- }, typeof import("./layout-region").FoundationLayoutRegion>;
29
- foundationLayoutItem: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
30
- baseName: string;
31
- template: import("@microsoft/fast-element").ViewTemplate<any, any>;
32
- }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
33
- baseName: string;
34
- template: import("@microsoft/fast-element").ViewTemplate<any, any>;
35
- }, typeof import("./layout-item").FoundationLayoutItem>;
36
- register(container?: Container, ...rest: any[]): void;
37
- }
38
- ```
39
-
40
- ## Remarks
41
-
42
- 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.
43
-
44
- ## Example
45
-
46
- `<zero-layout></zero-layout>` if you are using the layout with the `zero` design-system.
47
-
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [closable](./foundation-layout.foundationlayoutitem.closable.md)
4
-
5
- ## FoundationLayoutItem.closable property
6
-
7
- Boolean attribute controls whether the window can be closed in the GUI. Defaults to `false`<!-- -->.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- closable: boolean;
13
- ```
@@ -1,126 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md)
4
-
5
- ## FoundationLayoutItem class
6
-
7
- `FoundationLayoutItem` is a custom element that represents an item in the layout.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare class FoundationLayoutItem extends FoundationElement implements LayoutComponent
13
- ```
14
- **Extends:** FoundationElement
15
-
16
- **Implements:** LayoutComponent
17
-
18
- ## Remarks
19
-
20
- This element is used to wrap html elements and configure their layout settings as part of the layout system.
21
-
22
- 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)<!-- -->.
23
-
24
- The item can either use slotted content or a factory function registered via [registerFactory()](./foundation-layout.registerfactory.md)<!-- -->. When a factory is registered with the same name as the registration attribute, it takes precedence over slotted content.
25
-
26
- ## Properties
27
-
28
- <table><thead><tr><th>
29
-
30
- Property
31
-
32
-
33
- </th><th>
34
-
35
- Modifiers
36
-
37
-
38
- </th><th>
39
-
40
- Type
41
-
42
-
43
- </th><th>
44
-
45
- Description
46
-
47
-
48
- </th></tr></thead>
49
- <tbody><tr><td>
50
-
51
- [closable](./foundation-layout.foundationlayoutitem.closable.md)
52
-
53
-
54
- </td><td>
55
-
56
-
57
- </td><td>
58
-
59
- boolean
60
-
61
-
62
- </td><td>
63
-
64
- Boolean attribute controls whether the window can be closed in the GUI. Defaults to `false`<!-- -->.
65
-
66
-
67
- </td></tr>
68
- <tr><td>
69
-
70
- [registration](./foundation-layout.foundationlayoutitem.registration.md)
71
-
72
-
73
- </td><td>
74
-
75
-
76
- </td><td>
77
-
78
- string
79
-
80
-
81
- </td><td>
82
-
83
- Sets the registration name for the item, which can be used later to add the item via the JavaScript API using [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md)<!-- -->.
84
-
85
-
86
- </td></tr>
87
- <tr><td>
88
-
89
- [size](./foundation-layout.foundationlayoutitem.size.md)
90
-
91
-
92
- </td><td>
93
-
94
-
95
- </td><td>
96
-
97
- string
98
-
99
-
100
- </td><td>
101
-
102
- optional string describing the size of the new item (see the written documentation for more info)
103
-
104
-
105
- </td></tr>
106
- <tr><td>
107
-
108
- [title](./foundation-layout.foundationlayoutitem.title.md)
109
-
110
-
111
- </td><td>
112
-
113
-
114
- </td><td>
115
-
116
- string
117
-
118
-
119
- </td><td>
120
-
121
- Sets the title of the item which is displayed on the tab.
122
-
123
-
124
- </td></tr>
125
- </tbody></table>
126
-
@@ -1,36 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [registration](./foundation-layout.foundationlayoutitem.registration.md)
4
-
5
- ## FoundationLayoutItem.registration property
6
-
7
- Sets the registration name for the item, which can be used later to add the item via the JavaScript API using [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md)<!-- -->.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- registration: string;
13
- ```
14
-
15
- ## Remarks
16
-
17
- 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.
18
-
19
- When using the declarative API with framework components, register a factory function via [registerFactory()](./foundation-layout.registerfactory.md) using the same name as this registration attribute.
20
-
21
- ## Example
22
-
23
-
24
- ```typescript
25
- import { registerFactory } from '@genesislcap/foundation-layout';
26
- import { reactFactory } from './utils/react-layout-factory';
27
-
28
- // Register factory with the same name as the registration
29
- registerFactory('my-component', reactFactory(MyComponent));
30
- ```
31
- Then in JSX/HTML:
32
-
33
- ```tsx
34
- <rapid-layout-item registration="my-component" title="My Component" />
35
- ```
36
-
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [size](./foundation-layout.foundationlayoutitem.size.md)
4
-
5
- ## FoundationLayoutItem.size property
6
-
7
- optional string describing the size of the new item (see the written documentation for more info)
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- size: string;
13
- ```
@@ -1,18 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) &gt; [title](./foundation-layout.foundationlayoutitem.title.md)
4
-
5
- ## FoundationLayoutItem.title property
6
-
7
- Sets the title of the item which is displayed on the tab.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- title: string;
13
- ```
14
-
15
- ## Remarks
16
-
17
- Defaults to `Item ` + [FoundationLayoutItem.registration](./foundation-layout.foundationlayoutitem.registration.md)
18
-
@@ -1,86 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)
4
-
5
- ## FoundationLayoutRegion class
6
-
7
- `FoundationLayoutRegion` is a custom element that represents a region in the layout.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare class FoundationLayoutRegion extends FoundationElement implements LayoutComponent
13
- ```
14
- **Extends:** FoundationElement
15
-
16
- **Implements:** LayoutComponent
17
-
18
- ## Remarks
19
-
20
- 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.
21
-
22
- 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)<!-- -->.
23
-
24
- ## Properties
25
-
26
- <table><thead><tr><th>
27
-
28
- Property
29
-
30
-
31
- </th><th>
32
-
33
- Modifiers
34
-
35
-
36
- </th><th>
37
-
38
- Type
39
-
40
-
41
- </th><th>
42
-
43
- Description
44
-
45
-
46
- </th></tr></thead>
47
- <tbody><tr><td>
48
-
49
- [size](./foundation-layout.foundationlayoutregion.size.md)
50
-
51
-
52
- </td><td>
53
-
54
-
55
- </td><td>
56
-
57
- string
58
-
59
-
60
- </td><td>
61
-
62
- optional string describing the size of the new item (see the written documentation for more info)
63
-
64
-
65
- </td></tr>
66
- <tr><td>
67
-
68
- [type](./foundation-layout.foundationlayoutregion.type.md)
69
-
70
-
71
- </td><td>
72
-
73
-
74
- </td><td>
75
-
76
- [LayoutRegionType](./foundation-layout.layoutregiontype.md)
77
-
78
-
79
- </td><td>
80
-
81
- Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to `horizontal`<!-- -->.
82
-
83
-
84
- </td></tr>
85
- </tbody></table>
86
-
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md) &gt; [size](./foundation-layout.foundationlayoutregion.size.md)
4
-
5
- ## FoundationLayoutRegion.size property
6
-
7
- optional string describing the size of the new item (see the written documentation for more info)
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- size: string;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md) &gt; [type](./foundation-layout.foundationlayoutregion.type.md)
4
-
5
- ## FoundationLayoutRegion.type property
6
-
7
- Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to `horizontal`<!-- -->.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- type: LayoutRegionType;
13
- ```
@@ -1,56 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [getFactory](./foundation-layout.getfactory.md)
4
-
5
- ## getFactory() function
6
-
7
- Retrieves a factory function by its key.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare function getFactory(key: string): ComponentFactory | undefined;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- key
36
-
37
-
38
- </td><td>
39
-
40
- string
41
-
42
-
43
- </td><td>
44
-
45
- The unique identifier for the factory.
46
-
47
-
48
- </td></tr>
49
- </tbody></table>
50
-
51
- **Returns:**
52
-
53
- [ComponentFactory](./foundation-layout.componentfactory.md) \| undefined
54
-
55
- The factory function, or undefined if not found.
56
-
@@ -1,34 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [LAYOUT\_ICONS](./foundation-layout.layout_icons.md)
4
-
5
- ## LAYOUT\_ICONS variable
6
-
7
- A collection of SVG icons in base64 format.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- LAYOUT_ICONS: {
13
- readonly renameSVG: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2ZXJzaW9uPSIxLjEiIHdpZHRoPSI0NTAiIGhlaWdodD0iNDUwIiB2aWV3Qm94PSIwIDAgNDUwIDQ1MCIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+PGcgdHJhbnNmb3JtPSJtYXRyaXgoMTguNjEgMCAwIDE4LjYxIDIyMi44MSAyMjIuODEpIiBpZD0iT3V0bGluZSIgID48cGF0aCBzdHlsZT0ic3Ryb2tlOiBub25lOyBzdHJva2Utd2lkdGg6IDE7IHN0cm9rZS1kYXNoYXJyYXk6IG5vbmU7IHN0cm9rZS1saW5lY2FwOiBidXR0OyBzdHJva2UtZGFzaG9mZnNldDogMDsgc3Ryb2tlLWxpbmVqb2luOiBtaXRlcjsgc3Ryb2tlLW1pdGVybGltaXQ6IDQ7IGZpbGw6IHJnYigxMTEsMTI2LDEzNSk7IGZpbGwtcnVsZTogbm9uemVybzsgb3BhY2l0eTogMTsiICB0cmFuc2Zvcm09IiB0cmFuc2xhdGUoLTExLjk2LCAtMTIuMDQpIiBkPSJNIDIyLjg1MyAxLjE0OCBhIDMuNjI2IDMuNjI2IDAgMCAwIC01LjEyNCAwIEwgMS40NjUgMTcuNDEyIEEgNC45NjggNC45NjggMCAwIDAgMCAyMC45NDcgViAyMyBhIDEgMSAwIDAgMCAxIDEgSCAzLjA1MyBhIDQuOTY2IDQuOTY2IDAgMCAwIDMuNTM1IC0xLjQ2NCBMIDIyLjg1MyA2LjI3MSBBIDMuNjI2IDMuNjI2IDAgMCAwIDIyLjg1MyAxLjE0OCBaIE0gNS4xNzQgMjEuMTIyIEEgMy4wMjIgMy4wMjIgMCAwIDEgMy4wNTMgMjIgSCAyIFYgMjAuOTQ3IGEgMi45OCAyLjk4IDAgMCAxIDAuODc5IC0yLjEyMSBMIDE1LjIyMiA2LjQ4MyBsIDIuMyAyLjMgWiBNIDIxLjQzOCA0Ljg1NyBMIDE4LjkzMiA3LjM2NCBsIC0yLjMgLTIuMjk1IGwgMi41MDcgLTIuNTA3IGEgMS42MjMgMS42MjMgMCAxIDEgMi4yOTUgMi4zIFoiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgLz48L2c+PC9zdmc+Cg==";
14
- readonly maximiseSVG: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NDggNTEyIj48IS0tISBGb250IEF3ZXNvbWUgUHJvIDYuMi4wIGJ5IEBmb250YXdlc29tZSAtIGh0dHBzOi8vZm9udGF3ZXNvbWUuY29tIExpY2Vuc2UgLSBodHRwczovL2ZvbnRhd2Vzb21lLmNvbS9saWNlbnNlIChDb21tZXJjaWFsIExpY2Vuc2UpIENvcHlyaWdodCAyMDIyIEZvbnRpY29ucywgSW5jLiAtLT48cGF0aCBkPSJNMTQ0IDMyaC0xMjhDNy4xNTYgMzIgMCAzOS4xNiAwIDQ4djEyOEMwIDE4NC44IDcuMTU2IDE5MiAxNiAxOTJTMzIgMTg0LjggMzIgMTc2VjY0aDExMkMxNTIuOCA2NCAxNjAgNTYuODQgMTYwIDQ4UzE1Mi44IDMyIDE0NCAzMnpNMTQ0IDQ0OEgzMnYtMTEyQzMyIDMyNy4yIDI0Ljg0IDMyMCAxNiAzMjBTMCAzMjcuMiAwIDMzNnYxMjhDMCA0NzIuOCA3LjE1NiA0ODAgMTYgNDgwaDEyOEMxNTIuOCA0ODAgMTYwIDQ3Mi44IDE2MCA0NjRTMTUyLjggNDQ4IDE0NCA0NDh6TTQzMiAzMjBjLTguODQ0IDAtMTYgNy4xNTYtMTYgMTZWNDQ4aC0xMTJjLTguODQ0IDAtMTYgNy4xNTYtMTYgMTZzNy4xNTYgMTYgMTYgMTZoMTI4YzguODQ0IDAgMTYtNy4xNTYgMTYtMTZ2LTEyOEM0NDggMzI3LjIgNDQwLjggMzIwIDQzMiAzMjB6TTQzMiAzMmgtMTI4QzI5NS4yIDMyIDI4OCAzOS4xNiAyODggNDhTMjk1LjIgNjQgMzA0IDY0SDQxNnYxMTJDNDE2IDE4NC44IDQyMy4yIDE5MiA0MzIgMTkyUzQ0OCAxODQuOCA0NDggMTc2di0xMjhDNDQ4IDM5LjE2IDQ0MC44IDMyIDQzMiAzMnoiIGZpbGw9IiM4NzliYTYiLz48L3N2Zz4=";
15
- readonly minimiseSVG: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj48IS0tISBGb250IEF3ZXNvbWUgUHJvIDYuMi4wIGJ5IEBmb250YXdlc29tZSAtIGh0dHBzOi8vZm9udGF3ZXNvbWUuY29tIExpY2Vuc2UgLSBodHRwczovL2ZvbnRhd2Vzb21lLmNvbS9saWNlbnNlIChDb21tZXJjaWFsIExpY2Vuc2UpIENvcHlyaWdodCAyMDIyIEZvbnRpY29ucywgSW5jLiAtLT48cGF0aCBkPSJNMCA0NjRDMCA0NTUuMiA3LjE2NCA0NDggMTYgNDQ4SDQ5NkM1MDQuOCA0NDggNTEyIDQ1NS4yIDUxMiA0NjRDNTEyIDQ3Mi44IDUwNC44IDQ4MCA0OTYgNDgwSDE2QzcuMTY0IDQ4MCAwIDQ3Mi44IDAgNDY0eiIgZmlsbD0iIzg3OWJhNiIvPjwvc3ZnPg==";
16
- readonly closeSVG: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzMjAgNTEyIj48IS0tISBGb250IEF3ZXNvbWUgUHJvIDYuMi4wIGJ5IEBmb250YXdlc29tZSAtIGh0dHBzOi8vZm9udGF3ZXNvbWUuY29tIExpY2Vuc2UgLSBodHRwczovL2ZvbnRhd2Vzb21lLmNvbS9saWNlbnNlIChDb21tZXJjaWFsIExpY2Vuc2UpIENvcHlyaWdodCAyMDIyIEZvbnRpY29ucywgSW5jLiAtLT48cGF0aCBkPSJNMzE1LjMgNDExLjNjLTYuMjUzIDYuMjUzLTE2LjM3IDYuMjUzLTIyLjYzIDBMMTYwIDI3OC42bC0xMzIuNyAxMzIuN2MtNi4yNTMgNi4yNTMtMTYuMzcgNi4yNTMtMjIuNjMgMGMtNi4yNTMtNi4yNTMtNi4yNTMtMTYuMzcgMC0yMi42M0wxMzcuNCAyNTZMNC42OSAxMjMuM2MtNi4yNTMtNi4yNTMtNi4yNTMtMTYuMzcgMC0yMi42M2M2LjI1My02LjI1MyAxNi4zNy02LjI1MyAyMi42MyAwTDE2MCAyMzMuNGwxMzIuNy0xMzIuN2M2LjI1My02LjI1MyAxNi4zNy02LjI1MyAyMi42MyAwYzYuMjUzIDYuMjUzIDYuMjUzIDE2LjM3IDAgMjIuNjNMMTgyLjYgMjU2bDEzMi43IDEzMi43QzMyMS42IDM5NC45IDMyMS42IDQwNS4xIDMxNS4zIDQxMS4zeiIgZmlsbD0iIzg3OWJhNiIvPjwvc3ZnPg==";
17
- readonly tabDropdownSVG: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NDggNTEyIj48IS0tISBGb250IEF3ZXNvbWUgUHJvIDYuMi4wIGJ5IEBmb250YXdlc29tZSAtIGh0dHBzOi8vZm9udGF3ZXNvbWUuY29tIExpY2Vuc2UgLSBodHRwczovL2ZvbnRhd2Vzb21lLmNvbS9saWNlbnNlIChDb21tZXJjaWFsIExpY2Vuc2UpIENvcHlyaWdodCAyMDIyIEZvbnRpY29ucywgSW5jLiAtLT48cGF0aCBkPSJNNC4yNTEgMTgxLjFDNy4zOTIgMTc3LjcgMTEuNjkgMTc1LjEgMTYgMTc1LjFjMy44OTEgMCA3Ljc4MSAxLjQwNiAxMC44NiA0LjI1bDE5Ny4xIDE4MS4xbDE5Ny4xLTE4MS4xYzYuNS02IDE2LjY0LTUuNjI1IDIyLjYxIC45MDYyYzYgNi41IDUuNTk0IDE2LjU5LS44OTA2IDIyLjU5bC0yMDggMTkyYy02LjE1NiA1LjY4OC0xNS41NiA1LjY4OC0yMS43MiAwbC0yMDgtMTkyQy0xLjM0MyAxOTcuNy0xLjc0OSAxODcuNiA0LjI1MSAxODEuMXoiIGZpbGw9IiM4NzliYTYiLz48L3N2Zz4=";
18
- readonly popoutSVG: "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2ZXJzaW9uPSIxLjEiIHdpZHRoPSIxMDAwIiBoZWlnaHQ9IjEwMDAiIHZpZXdCb3g9IjAgMCAxMDAwIDEwMDAiIHhtbDpzcGFjZT0icHJlc2VydmUiPiA8cmVjdCB4PSIwIiB5PSIwIiB3aWR0aD0iMTAwJSIgaGVpZ2h0PSIxMDAlIiBmaWxsPSJyZ2JhKDI1NSwyNTUsMjU1LDApIi8+IDxnIHRyYW5zZm9ybT0ibWF0cml4KDEuNDY5MiAwIDAgMS40NjkyIDQ5OS45OTA2IDQ5OS45OTA2KSIgaWQ9IjE3OTM0MSI+IDxnIHN0eWxlPSIiIHZlY3Rvci1lZmZlY3Q9Im5vbi1zY2FsaW5nLXN0cm9rZSI+IDxnIHRyYW5zZm9ybT0ibWF0cml4KDIyLjIyMjIgMCAwIDIyLjIyMjIgLTQ0LjQ0NDcgNDQuNDQ0MSkiPiA8cGF0aCBzdHlsZT0ic3Ryb2tlOiBub25lOyBzdHJva2Utd2lkdGg6IDE7IHN0cm9rZS1kYXNoYXJyYXk6IG5vbmU7IHN0cm9rZS1saW5lY2FwOiBidXR0OyBzdHJva2UtZGFzaG9mZnNldDogMDsgc3Ryb2tlLWxpbmVqb2luOiBtaXRlcjsgc3Ryb2tlLW1pdGVybGltaXQ6IDQ7IGlzLWN1c3RvbS1mb250OiBub25lOyBmb250LWZpbGUtdXJsOiBub25lOyBmaWxsOiByZ2IoMTA5LDEyNywxMzgpOyBmaWxsLXJ1bGU6IG5vbnplcm87IG9wYWNpdHk6IDE7IiB0cmFuc2Zvcm09IiB0cmFuc2xhdGUoLTE2LCAtMjApIiBkPSJNIDI3IDMzIEggNSBhIDIgMiAwIDAgMSAtMiAtMiBWIDkgQSAyIDIgMCAwIDEgNSA3IEggMTUgViA5IEggNSBWIDMxIEggMjcgViAyMSBoIDIgViAzMSBBIDIgMiAwIDAgMSAyNyAzMyBaIiBzdHJva2UtbGluZWNhcD0icm91bmQiLz4gPC9nPiA8ZyB0cmFuc2Zvcm09Im1hdHJpeCgyMi4yMjIyIDAgMCAyMi4yMjIyIDEzNy42NzEyIC0xMzcuNjcxNSkiPiA8cGF0aCBzdHlsZT0ic3Ryb2tlOiBub25lOyBzdHJva2Utd2lkdGg6IDE7IHN0cm9rZS1kYXNoYXJyYXk6IG5vbmU7IHN0cm9rZS1saW5lY2FwOiBidXR0OyBzdHJva2UtZGFzaG9mZnNldDogMDsgc3Ryb2tlLWxpbmVqb2luOiBtaXRlcjsgc3Ryb2tlLW1pdGVybGltaXQ6IDQ7IGlzLWN1c3RvbS1mb250OiBub25lOyBmb250LWZpbGUtdXJsOiBub25lOyBmaWxsOiByZ2IoMTA5LDEyNywxMzgpOyBmaWxsLXJ1bGU6IG5vbnplcm87IG9wYWNpdHk6IDE7IiB0cmFuc2Zvcm09IiB0cmFuc2xhdGUoLTI0LjE5NTIsIC0xMS44MDQ4KSIgZD0iTSAxOCAzIGEgMSAxIDAgMCAwIDAgMiBIIDI5LjU5IEwgMTUuNzQgMTguODUgYSAxIDEgMCAxIDAgMS40MSAxLjQxIEwgMzEgNi40MSBWIDE4IGEgMSAxIDAgMCAwIDIgMCBWIDMgWiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIi8+IDwvZz4gPGcgdHJhbnNmb3JtPSJtYXRyaXgoMjIuMjIyMiAwIDAgMjIuMjIyMiAtMC4wMDA0IC0wLjAwMDQpIj4gPHJlY3Qgc3R5bGU9InN0cm9rZTogbm9uZTsgc3Ryb2tlLXdpZHRoOiAxOyBzdHJva2UtZGFzaGFycmF5OiBub25lOyBzdHJva2UtbGluZWNhcDogYnV0dDsgc3Ryb2tlLWRhc2hvZmZzZXQ6IDA7IHN0cm9rZS1saW5lam9pbjogbWl0ZXI7IHN0cm9rZS1taXRlcmxpbWl0OiA0OyBpcy1jdXN0b20tZm9udDogbm9uZTsgZm9udC1maWxlLXVybDogbm9uZTsgZmlsbDogcmdiKDAsMCwwKTsgZmlsbC1vcGFjaXR5OiAwOyBmaWxsLXJ1bGU6IG5vbnplcm87IG9wYWNpdHk6IDE7IiB4PSItMTgiIHk9Ii0xOCIgcng9IjAiIHJ5PSIwIiB3aWR0aD0iMzYiIGhlaWdodD0iMzYiLz4gPC9nPiA8L2c+IDwvZz4gPC9zdmc+Cg==";
19
- }
20
- ```
21
-
22
- ## Remarks
23
-
24
- These icons are used by the layout manager for the UI buttons. You can use these as examples for your own custom icons when creating a custom button.
25
-
26
- ## Example
27
-
28
-
29
- ```
30
- export const layoutCustomButtons: CustomButton[] = [
31
- { svg: LAYOUT_ICONS.renameSVG, onClick: (button: HTMLElement, elem: HTMLElement) => {} },
32
- ];
33
- ```
34
-
@@ -1,16 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [LAYOUT\_POPOUT\_CONTAINER\_CLASS](./foundation-layout.layout_popout_container_class.md)
4
-
5
- ## LAYOUT\_POPOUT\_CONTAINER\_CLASS variable
6
-
7
- > 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.
8
- >
9
-
10
- 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.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- LAYOUT_POPOUT_CONTAINER_CLASS = "f-layout-popout"
16
- ```
@@ -1,16 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-layout](./foundation-layout.md) &gt; [LAYOUT\_POPOUT\_CONTROL\_KEY](./foundation-layout.layout_popout_control_key.md)
4
-
5
- ## LAYOUT\_POPOUT\_CONTROL\_KEY variable
6
-
7
- > 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.
8
- >
9
-
10
- Key to be used for controlling popout behaviour
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- LAYOUT_POPOUT_CONTROL_KEY = "f-layout-key"
16
- ```