@genesislcap/foundation-layout 9.0.1-alpha-b5c5eb7.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 (156) hide show
  1. package/README.md +916 -0
  2. package/dist/1.0.0.remoteEntry.js +1 -0
  3. package/dist/191.191.106ece7a41ded6731029.js +2 -0
  4. package/dist/191.9a61143c2afb6057ad1bae886d5d1a6e.js.map +1 -0
  5. package/dist/259.09c601e5288d875caab4df1e2354c0ea.js.map +1 -0
  6. package/dist/259.259.216fcad43e9a38888e08.js +2 -0
  7. package/dist/415.415.094780a1a1162c7e5f1c.js +3 -0
  8. package/dist/415.415.094780a1a1162c7e5f1c.js.LICENSE.txt +4 -0
  9. package/dist/415.fcfb4f02eaecbfa31fc322639f244245.js.map +1 -0
  10. package/dist/459.459.c9f0bb440eb1f041c99e.js +515 -0
  11. package/dist/459.cb5f5b49b4e8881992c420f3b1ca863d.js.map +1 -0
  12. package/dist/623.623.0e7e8f23454ee96ed9c8.js +3 -0
  13. package/dist/623.623.0e7e8f23454ee96ed9c8.js.LICENSE.txt +4 -0
  14. package/dist/623.e8f211473f9034c4157d362efb017821.js.map +1 -0
  15. package/dist/755.718e14af7194fb741f98580b24b2bb8f.js.map +1 -0
  16. package/dist/755.755.f93ee58c2b836a669ec4.js +2 -0
  17. package/dist/dashboard.json +1 -0
  18. package/dist/dts/index.d.ts +3 -0
  19. package/dist/dts/index.d.ts.map +1 -0
  20. package/dist/dts/index.federated.d.ts +1 -0
  21. package/dist/dts/index.federated.d.ts.map +1 -0
  22. package/dist/dts/main/index.d.ts +6 -0
  23. package/dist/dts/main/index.d.ts.map +1 -0
  24. package/dist/dts/main/layout-components.d.ts +42 -0
  25. package/dist/dts/main/layout-components.d.ts.map +1 -0
  26. package/dist/dts/main/layout-item.d.ts +70 -0
  27. package/dist/dts/main/layout-item.d.ts.map +1 -0
  28. package/dist/dts/main/layout-main.d.ts +186 -0
  29. package/dist/dts/main/layout-main.d.ts.map +1 -0
  30. package/dist/dts/main/layout-region.d.ts +70 -0
  31. package/dist/dts/main/layout-region.d.ts.map +1 -0
  32. package/dist/dts/styles/constants.d.ts +7 -0
  33. package/dist/dts/styles/constants.d.ts.map +1 -0
  34. package/dist/dts/styles/dragging.styles.d.ts +7 -0
  35. package/dist/dts/styles/dragging.styles.d.ts.map +1 -0
  36. package/dist/dts/styles/index.d.ts +4 -0
  37. package/dist/dts/styles/index.d.ts.map +1 -0
  38. package/dist/dts/styles/layout.styles.d.ts +8 -0
  39. package/dist/dts/styles/layout.styles.d.ts.map +1 -0
  40. package/dist/dts/utils/constants.d.ts +14 -0
  41. package/dist/dts/utils/constants.d.ts.map +1 -0
  42. package/dist/dts/utils/error.d.ts +13 -0
  43. package/dist/dts/utils/error.d.ts.map +1 -0
  44. package/dist/dts/utils/events.d.ts +38 -0
  45. package/dist/dts/utils/events.d.ts.map +1 -0
  46. package/dist/dts/utils/index.d.ts +7 -0
  47. package/dist/dts/utils/index.d.ts.map +1 -0
  48. package/dist/dts/utils/logger.d.ts +2 -0
  49. package/dist/dts/utils/logger.d.ts.map +1 -0
  50. package/dist/dts/utils/misc.d.ts +10 -0
  51. package/dist/dts/utils/misc.d.ts.map +1 -0
  52. package/dist/dts/utils/templates.d.ts +6 -0
  53. package/dist/dts/utils/templates.d.ts.map +1 -0
  54. package/dist/dts/utils/types.d.ts +63 -0
  55. package/dist/dts/utils/types.d.ts.map +1 -0
  56. package/dist/esm/index.federated.js +2 -0
  57. package/dist/esm/index.federated.js.map +1 -0
  58. package/dist/esm/index.js +3 -0
  59. package/dist/esm/index.js.map +1 -0
  60. package/dist/esm/main/index.js +6 -0
  61. package/dist/esm/main/index.js.map +1 -0
  62. package/dist/esm/main/layout-components.js +36 -0
  63. package/dist/esm/main/layout-components.js.map +1 -0
  64. package/dist/esm/main/layout-item.js +86 -0
  65. package/dist/esm/main/layout-item.js.map +1 -0
  66. package/dist/esm/main/layout-main.js +391 -0
  67. package/dist/esm/main/layout-main.js.map +1 -0
  68. package/dist/esm/main/layout-region.js +98 -0
  69. package/dist/esm/main/layout-region.js.map +1 -0
  70. package/dist/esm/main/main.css +17 -0
  71. package/dist/esm/styles/constants.js +16 -0
  72. package/dist/esm/styles/constants.js.map +1 -0
  73. package/dist/esm/styles/dragging.styles.js +116 -0
  74. package/dist/esm/styles/dragging.styles.js.map +1 -0
  75. package/dist/esm/styles/index.js +4 -0
  76. package/dist/esm/styles/index.js.map +1 -0
  77. package/dist/esm/styles/layout.styles.js +530 -0
  78. package/dist/esm/styles/layout.styles.js.map +1 -0
  79. package/dist/esm/utils/constants.js +14 -0
  80. package/dist/esm/utils/constants.js.map +1 -0
  81. package/dist/esm/utils/error.js +17 -0
  82. package/dist/esm/utils/error.js.map +1 -0
  83. package/dist/esm/utils/events.js +26 -0
  84. package/dist/esm/utils/events.js.map +1 -0
  85. package/dist/esm/utils/index.js +7 -0
  86. package/dist/esm/utils/index.js.map +1 -0
  87. package/dist/esm/utils/logger.js +3 -0
  88. package/dist/esm/utils/logger.js.map +1 -0
  89. package/dist/esm/utils/misc.js +24 -0
  90. package/dist/esm/utils/misc.js.map +1 -0
  91. package/dist/esm/utils/templates.js +11 -0
  92. package/dist/esm/utils/templates.js.map +1 -0
  93. package/dist/esm/utils/types.js +4 -0
  94. package/dist/esm/utils/types.js.map +1 -0
  95. package/dist/favicon.ico +0 -0
  96. package/dist/foundation-layout.api.json +1574 -0
  97. package/dist/foundation-layout.d.ts +478 -0
  98. package/dist/foundationLayout.8b94161c9f0d0d475d026a05513893c1.js.map +1 -0
  99. package/dist/index.ejs +23 -0
  100. package/dist/index.html +15 -0
  101. package/dist/info.ejs +13 -0
  102. package/dist/main.40c13c1585eb6fa5761a17ab29a7851e.js.map +1 -0
  103. package/dist/main.94f8a6853d484ec34632.js +2 -0
  104. package/dist/npm.consola.713.b1e4073e73c71572987a.js +2 -0
  105. package/dist/npm.consola.a0d3324d3e61dcc430c3029da5f4dcc7.js.map +1 -0
  106. package/dist/npm.genesis-community.248.9c9900001dbc5ba9c3ed.js +2 -0
  107. package/dist/npm.genesis-community.2e0cc159dabe113d6fb29bb505c1a0d4.js.map +1 -0
  108. package/dist/npm.microsoft.127.00f16f24d8da8fd89263.js +1469 -0
  109. package/dist/npm.microsoft.127.00f16f24d8da8fd89263.js.LICENSE.txt +14 -0
  110. package/dist/npm.microsoft.be43958facd28231e770c1307660f64d.js.map +1 -0
  111. package/dist/remoteEntry.js +2 -0
  112. package/dist/serve.json +3 -0
  113. package/dist/tsdoc-metadata.json +11 -0
  114. package/docs/.gitattributes +2 -0
  115. package/docs/api/foundation-layout.default_reload_buffer.md +18 -0
  116. package/docs/api/foundation-layout.foundationlayout.additem.md +38 -0
  117. package/docs/api/foundation-layout.foundationlayout.dragging.md +16 -0
  118. package/docs/api/foundation-layout.foundationlayout.getlayout.md +22 -0
  119. package/docs/api/foundation-layout.foundationlayout.layoutrequiredregistrations.md +37 -0
  120. package/docs/api/foundation-layout.foundationlayout.loadlayout.md +37 -0
  121. package/docs/api/foundation-layout.foundationlayout.md +44 -0
  122. package/docs/api/foundation-layout.foundationlayout.registereditems.md +26 -0
  123. package/docs/api/foundation-layout.foundationlayout.registeritem.md +42 -0
  124. package/docs/api/foundation-layout.foundationlayout.reloadbuffer.md +16 -0
  125. package/docs/api/foundation-layout.foundationlayoutcomponents.md +50 -0
  126. package/docs/api/foundation-layout.foundationlayoutitem.closable.md +16 -0
  127. package/docs/api/foundation-layout.foundationlayoutitem.md +35 -0
  128. package/docs/api/foundation-layout.foundationlayoutitem.registration.md +21 -0
  129. package/docs/api/foundation-layout.foundationlayoutitem.size.md +16 -0
  130. package/docs/api/foundation-layout.foundationlayoutitem.title.md +21 -0
  131. package/docs/api/foundation-layout.foundationlayoutregion.md +33 -0
  132. package/docs/api/foundation-layout.foundationlayoutregion.size.md +16 -0
  133. package/docs/api/foundation-layout.foundationlayoutregion.type.md +16 -0
  134. package/docs/api/foundation-layout.layoutemitevents.md +22 -0
  135. package/docs/api/foundation-layout.layoutreceiveevents.md +20 -0
  136. package/docs/api/foundation-layout.layoutreceiveeventsdetail.md +23 -0
  137. package/docs/api/foundation-layout.layoutregiontype.md +16 -0
  138. package/docs/api/foundation-layout.layoutregistrationerror._constructor_.md +23 -0
  139. package/docs/api/foundation-layout.layoutregistrationerror.md +23 -0
  140. package/docs/api/foundation-layout.layoutstyles.md +21 -0
  141. package/docs/api/foundation-layout.layouttemplate.md +21 -0
  142. package/docs/api/foundation-layout.layoutusageerror._constructor_.md +23 -0
  143. package/docs/api/foundation-layout.layoutusageerror.md +23 -0
  144. package/docs/api/foundation-layout.md +42 -0
  145. package/docs/api/foundation-layout.placement.md +18 -0
  146. package/docs/api/foundation-layout.registeredelementconfig.closable.md +14 -0
  147. package/docs/api/foundation-layout.registeredelementconfig.md +30 -0
  148. package/docs/api/foundation-layout.registeredelementconfig.registration.md +14 -0
  149. package/docs/api/foundation-layout.registeredelementconfig.size.md +14 -0
  150. package/docs/api/foundation-layout.registeredelementconfig.title.md +14 -0
  151. package/docs/api/foundation-layout.serialisedlayout.md +26 -0
  152. package/docs/api/index.md +12 -0
  153. package/docs/api-report.md +235 -0
  154. package/docs/img/foundation-layout-example.png +0 -0
  155. package/license.txt +46 -0
  156. package/package.json +80 -0
@@ -0,0 +1,23 @@
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; [LayoutReceiveEventsDetail](./foundation-layout.layoutreceiveeventsdetail.md)
4
+
5
+ ## LayoutReceiveEventsDetail type
6
+
7
+ > 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.
8
+ >
9
+
10
+ Defines the shape of the detail that the layout listens works with for events it listens on
11
+
12
+ '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.
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ export type LayoutReceiveEventsDetail = {
18
+ changeTitle: {
19
+ title: string;
20
+ mode: 'replace' | 'suffix';
21
+ };
22
+ };
23
+ ```
@@ -0,0 +1,16 @@
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; [LayoutRegionType](./foundation-layout.layoutregiontype.md)
4
+
5
+ ## LayoutRegionType type
6
+
7
+ > 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.
8
+ >
9
+
10
+ Union type describing the three different types of region splits. Set on the `type` attribute on [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)<!-- -->.
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export type LayoutRegionType = (typeof layoutRegionValue)[number];
16
+ ```
@@ -0,0 +1,23 @@
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; [LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md) &gt; [(constructor)](./foundation-layout.layoutregistrationerror._constructor_.md)
4
+
5
+ ## LayoutRegistrationError.(constructor)
6
+
7
+ > 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.
8
+ >
9
+
10
+ Constructs a new instance of the `LayoutRegistrationError` class
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ constructor(message: string);
16
+ ```
17
+
18
+ ## Parameters
19
+
20
+ | Parameter | Type | Description |
21
+ | --- | --- | --- |
22
+ | message | string | |
23
+
@@ -0,0 +1,23 @@
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; [LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md)
4
+
5
+ ## LayoutRegistrationError class
6
+
7
+ > 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.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export declare class LayoutRegistrationError extends Error
15
+ ```
16
+ **Extends:** Error
17
+
18
+ ## Constructors
19
+
20
+ | Constructor | Modifiers | Description |
21
+ | --- | --- | --- |
22
+ | [(constructor)(message)](./foundation-layout.layoutregistrationerror._constructor_.md) | | **_(BETA)_** Constructs a new instance of the <code>LayoutRegistrationError</code> class |
23
+
@@ -0,0 +1,21 @@
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; [layoutStyles](./foundation-layout.layoutstyles.md)
4
+
5
+ ## layoutStyles variable
6
+
7
+ > 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.
8
+ >
9
+
10
+ `ElementStyles` which defines the css for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ layoutStyles: import("@microsoft/fast-element").ElementStyles
16
+ ```
17
+
18
+ ## Remarks
19
+
20
+ Can be used in a composition to customise the styles of the layout.
21
+
@@ -0,0 +1,21 @@
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; [layoutTemplate](./foundation-layout.layouttemplate.md)
4
+
5
+ ## layoutTemplate variable
6
+
7
+ > 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.
8
+ >
9
+
10
+ `ViewTemplate` which defines the html for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ layoutTemplate: import("@microsoft/fast-element").ViewTemplate<FoundationLayout, any>
16
+ ```
17
+
18
+ ## Remarks
19
+
20
+ Can be used in a composition to customise the styles of the layout.
21
+
@@ -0,0 +1,23 @@
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; [LayoutUsageError](./foundation-layout.layoutusageerror.md) &gt; [(constructor)](./foundation-layout.layoutusageerror._constructor_.md)
4
+
5
+ ## LayoutUsageError.(constructor)
6
+
7
+ > 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.
8
+ >
9
+
10
+ Constructs a new instance of the `LayoutUsageError` class
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ constructor(message: string);
16
+ ```
17
+
18
+ ## Parameters
19
+
20
+ | Parameter | Type | Description |
21
+ | --- | --- | --- |
22
+ | message | string | |
23
+
@@ -0,0 +1,23 @@
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; [LayoutUsageError](./foundation-layout.layoutusageerror.md)
4
+
5
+ ## LayoutUsageError class
6
+
7
+ > 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.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export declare class LayoutUsageError extends Error
15
+ ```
16
+ **Extends:** Error
17
+
18
+ ## Constructors
19
+
20
+ | Constructor | Modifiers | Description |
21
+ | --- | --- | --- |
22
+ | [(constructor)(message)](./foundation-layout.layoutusageerror._constructor_.md) | | **_(BETA)_** Constructs a new instance of the <code>LayoutUsageError</code> class |
23
+
@@ -0,0 +1,42 @@
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)
4
+
5
+ ## foundation-layout package
6
+
7
+ ## Classes
8
+
9
+ | Class | Description |
10
+ | --- | --- |
11
+ | [FoundationLayout](./foundation-layout.foundationlayout.md) | **_(BETA)_** Top level web component which is used to initialise a custom layout |
12
+ | [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) | **_(BETA)_** <code>FoundationLayoutItem</code> is a custom element that represents an item in the layout. |
13
+ | [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md) | **_(BETA)_** <code>FoundationLayoutRegion</code> is a custom element that represents a region in the layout. |
14
+ | [LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md) | **_(BETA)_** |
15
+ | [LayoutUsageError](./foundation-layout.layoutusageerror.md) | **_(BETA)_** |
16
+
17
+ ## Interfaces
18
+
19
+ | Interface | Description |
20
+ | --- | --- |
21
+ | [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) | **_(BETA)_** The parameters that can be set on a new item when being added by the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API |
22
+
23
+ ## Variables
24
+
25
+ | Variable | Description |
26
+ | --- | --- |
27
+ | [DEFAULT\_RELOAD\_BUFFER](./foundation-layout.default_reload_buffer.md) | <p>**_(BETA)_** Default time in milliseconds for the layout to buffer calls to reloading the layout while the declarative API is loading.</p><p>During the first load of the layout, a loading spinner will be shown.</p> |
28
+ | [foundationLayoutComponents](./foundation-layout.foundationlayoutcomponents.md) | **_(BETA)_** Registration object to register the layout with your design system. |
29
+ | [LayoutEmitEvents](./foundation-layout.layoutemitevents.md) | <p>**_(BETA)_** Defines events that the layout system emits</p><p>'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'</p> |
30
+ | [LayoutReceiveEvents](./foundation-layout.layoutreceiveevents.md) | <p>**_(BETA)_** Defines events that the layout system listens for</p><p>'changeTitle' - emit this from a contained item to update the title of the window that contains it.</p> |
31
+ | [layoutStyles](./foundation-layout.layoutstyles.md) | **_(BETA)_** <code>ElementStyles</code> which defines the css for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->. |
32
+ | [layoutTemplate](./foundation-layout.layouttemplate.md) | **_(BETA)_** <code>ViewTemplate</code> which defines the html for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->. |
33
+
34
+ ## Type Aliases
35
+
36
+ | Type Alias | Description |
37
+ | --- | --- |
38
+ | [LayoutReceiveEventsDetail](./foundation-layout.layoutreceiveeventsdetail.md) | <p>**_(BETA)_** Defines the shape of the detail that the layout listens works with for events it listens on</p><p>'changeTitle' - <code>title</code> is the string you want to set. For <code>mode</code>: <code>replace</code> will set the title to be <code>title</code>, <code>suffix</code> will append <code>title</code> to the end of the existing title.</p> |
39
+ | [LayoutRegionType](./foundation-layout.layoutregiontype.md) | **_(BETA)_** Union type describing the three different types of region splits. Set on the <code>type</code> attribute on [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)<!-- -->. |
40
+ | [Placement](./foundation-layout.placement.md) | **_(BETA)_** Where to add the new item into the layout when using the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API |
41
+ | [SerialisedLayout](./foundation-layout.serialisedlayout.md) | **_(BETA)_** Versioned layout config objects. <code>v</code> is the version and <code>c</code> contains the layout config. |
42
+
@@ -0,0 +1,18 @@
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; [Placement](./foundation-layout.placement.md)
4
+
5
+ ## Placement type
6
+
7
+ > 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.
8
+ >
9
+
10
+ Where to add the new item into the layout when using the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export type Placement = {
16
+ area: 'top' | 'left' | 'bottom' | 'right';
17
+ };
18
+ ```
@@ -0,0 +1,14 @@
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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [closable](./foundation-layout.registeredelementconfig.closable.md)
4
+
5
+ ## RegisteredElementConfig.closable property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ closable?: boolean;
14
+ ```
@@ -0,0 +1,30 @@
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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md)
4
+
5
+ ## RegisteredElementConfig interface
6
+
7
+ > 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.
8
+ >
9
+
10
+ The parameters that can be set on a new item when being added by the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export interface RegisteredElementConfig
16
+ ```
17
+
18
+ ## Remarks
19
+
20
+ `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)
21
+
22
+ ## Properties
23
+
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [closable?](./foundation-layout.registeredelementconfig.closable.md) | | boolean | **_(BETA)_** _(Optional)_ |
27
+ | [registration](./foundation-layout.registeredelementconfig.registration.md) | | string | **_(BETA)_** |
28
+ | [size?](./foundation-layout.registeredelementconfig.size.md) | | string | **_(BETA)_** _(Optional)_ |
29
+ | [title?](./foundation-layout.registeredelementconfig.title.md) | | string | **_(BETA)_** _(Optional)_ |
30
+
@@ -0,0 +1,14 @@
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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [registration](./foundation-layout.registeredelementconfig.registration.md)
4
+
5
+ ## RegisteredElementConfig.registration property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ registration: string;
14
+ ```
@@ -0,0 +1,14 @@
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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [size](./foundation-layout.registeredelementconfig.size.md)
4
+
5
+ ## RegisteredElementConfig.size property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ size?: string;
14
+ ```
@@ -0,0 +1,14 @@
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; [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) &gt; [title](./foundation-layout.registeredelementconfig.title.md)
4
+
5
+ ## RegisteredElementConfig.title property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ title?: string;
14
+ ```
@@ -0,0 +1,26 @@
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; [SerialisedLayout](./foundation-layout.serialisedlayout.md)
4
+
5
+ ## SerialisedLayout type
6
+
7
+ > 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.
8
+ >
9
+
10
+ Versioned layout config objects. `v` is the version and `c` contains the layout config.
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export type SerialisedLayout = {
16
+ v: '1';
17
+ c: ResolvedLayoutConfig;
18
+ };
19
+ ```
20
+
21
+ ## Remarks
22
+
23
+ Versioning the layout config in this way allows changes to the config schema while remaining backwards compatible with any existing client/user configurations. When loading an older version of the configurations the version can be used to lookup and apply transformer functions to get the newest version of the config from it.
24
+
25
+ As more versions of configurations are added this type will have extra union types as part of SerialisedLayout.
26
+
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md)
4
+
5
+ ## API Reference
6
+
7
+ ## Packages
8
+
9
+ | Package | Description |
10
+ | --- | --- |
11
+ | [@genesislcap/foundation-layout](./foundation-layout.md) | |
12
+
@@ -0,0 +1,235 @@
1
+ ## API Report File for "@genesislcap/foundation-layout"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import type { Container } from '@microsoft/fast-foundation';
8
+ import { ElementStyles } from '@microsoft/fast-element';
9
+ import { FoundationElement } from '@microsoft/fast-foundation';
10
+ import { FoundationElementRegistry } from '@microsoft/fast-foundation';
11
+ import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
12
+ import { ResolvedLayoutConfig } from '@genesis-community/golden-layout';
13
+ import { RootItemConfig } from '@genesis-community/golden-layout';
14
+ import { ViewTemplate } from '@microsoft/fast-element';
15
+
16
+ // Warning: (ae-internal-missing-underscore) The name "componentType" should be prefixed with an underscore because the declaration is marked as @internal
17
+ //
18
+ // @internal
19
+ export const componentType: unique symbol;
20
+
21
+ // Warning: (ae-internal-missing-underscore) The name "ComponentTypes" should be prefixed with an underscore because the declaration is marked as @internal
22
+ //
23
+ // @internal (undocumented)
24
+ export type ComponentTypes = LayoutRegionType | 'root' | 'item';
25
+
26
+ // @beta
27
+ export const DEFAULT_RELOAD_BUFFER = 500;
28
+
29
+ // Warning: (ae-incompatible-release-tags) The symbol "FoundationLayout" is marked as @beta, but its signature references "LayoutComponent" which is marked as @internal
30
+ //
31
+ // @beta
32
+ export class FoundationLayout extends FoundationElement implements LayoutComponent {
33
+ // @internal (undocumented)
34
+ [componentType]: "root";
35
+ // @internal
36
+ constructor();
37
+ addItem(config: RegisteredElementConfig, placement?: Placement): void;
38
+ // @internal
39
+ addItemFromChild<T extends RootItemConfig>(item: T): T;
40
+ // @internal
41
+ cacheElementsAndRegister({ elements, id }: RegistrationConfig): string;
42
+ // @internal (undocumented)
43
+ connectedCallback(): void;
44
+ // @internal (undocumented)
45
+ disconnectedCallback(): void;
46
+ dragging: boolean;
47
+ getLayout(): SerialisedLayout;
48
+ // @internal (undocumented)
49
+ hasFirstLoaded: boolean;
50
+ // @internal (undocumented)
51
+ layoutElement: HTMLElement;
52
+ static layoutRequiredRegistrations(layout: SerialisedLayout): string[];
53
+ loadLayout(layout: SerialisedLayout): void;
54
+ registeredItems(): string[];
55
+ registerItem(registration: string, elements: Element[]): string;
56
+ reloadBuffer: number;
57
+ // @internal
58
+ requestLayoutReload(): void;
59
+ // @internal (undocumented)
60
+ usingDeclerativeAPI: boolean;
61
+ }
62
+
63
+ // @beta
64
+ export const foundationLayoutComponents: {
65
+ foundationLayout: (overrideDefinition?: OverrideFoundationElementDefinition< {
66
+ baseName: string;
67
+ styles: ElementStyles;
68
+ template: ViewTemplate<FoundationLayout, any>;
69
+ }>) => FoundationElementRegistry< {
70
+ baseName: string;
71
+ styles: ElementStyles;
72
+ template: ViewTemplate<FoundationLayout, any>;
73
+ }, FoundationLayout>;
74
+ foundationLayoutRegion: (overrideDefinition?: OverrideFoundationElementDefinition< {
75
+ baseName: string;
76
+ template: ViewTemplate<any, any>;
77
+ }>) => FoundationElementRegistry< {
78
+ baseName: string;
79
+ template: ViewTemplate<any, any>;
80
+ }, FoundationLayoutRegion>;
81
+ foundationLayoutItem: (overrideDefinition?: OverrideFoundationElementDefinition< {
82
+ baseName: string;
83
+ template: ViewTemplate<any, any>;
84
+ }>) => FoundationElementRegistry< {
85
+ baseName: string;
86
+ template: ViewTemplate<any, any>;
87
+ }, FoundationLayoutItem>;
88
+ register(container?: Container, ...rest: any[]): void;
89
+ };
90
+
91
+ // Warning: (ae-incompatible-release-tags) The symbol "FoundationLayoutItem" is marked as @beta, but its signature references "LayoutComponent" which is marked as @internal
92
+ //
93
+ // @beta
94
+ export class FoundationLayoutItem extends FoundationElement implements LayoutComponent {
95
+ // @internal (undocumented)
96
+ [componentType]: "item";
97
+ // @internal (undocumented)
98
+ cacheElementsAndRegister(config: RegistrationConfig): string;
99
+ closable: boolean;
100
+ // @internal (undocumented)
101
+ connectedCallback(): void;
102
+ registration: string;
103
+ // @internal (undocumented)
104
+ requestLayoutReload(): void;
105
+ size: string;
106
+ title: string;
107
+ }
108
+
109
+ // Warning: (ae-incompatible-release-tags) The symbol "FoundationLayoutRegion" is marked as @beta, but its signature references "LayoutComponent" which is marked as @internal
110
+ //
111
+ // @beta
112
+ export class FoundationLayoutRegion extends FoundationElement implements LayoutComponent {
113
+ // @internal (undocumented)
114
+ [componentType]: LayoutRegionType;
115
+ // @internal (undocumented)
116
+ addItemFromChild<T extends RootItemConfig>(item: T): T;
117
+ // @internal (undocumented)
118
+ cacheElementsAndRegister(config: RegistrationConfig): string;
119
+ // @internal (undocumented)
120
+ connectedCallback(): void;
121
+ // @internal (undocumented)
122
+ requestLayoutReload(): void;
123
+ size: string;
124
+ type: LayoutRegionType;
125
+ }
126
+
127
+ // Warning: (ae-internal-missing-underscore) The name "getMissingArrayItems" should be prefixed with an underscore because the declaration is marked as @internal
128
+ //
129
+ // @internal
130
+ export function getMissingArrayItems<T>(a: T[], b: T[]): T[];
131
+
132
+ // Warning: (ae-internal-missing-underscore) The name "getParentLayoutComponent" should be prefixed with an underscore because the declaration is marked as @internal
133
+ //
134
+ // @internal (undocumented)
135
+ export function getParentLayoutComponent(): FoundationLayout | FoundationLayoutRegion;
136
+
137
+ // Warning: (ae-internal-missing-underscore) The name "LayoutComponent" should be prefixed with an underscore because the declaration is marked as @internal
138
+ //
139
+ // @internal (undocumented)
140
+ export interface LayoutComponent {
141
+ // (undocumented)
142
+ [componentType]: ComponentTypes;
143
+ // (undocumented)
144
+ cacheElementsAndRegister(config: RegistrationConfig): string;
145
+ // (undocumented)
146
+ requestLayoutReload(): void;
147
+ }
148
+
149
+ // @beta
150
+ export const LayoutEmitEvents: {
151
+ readonly firstLoaded: "first-loaded";
152
+ readonly itemAdded: "item-added";
153
+ readonly itemRemoved: "item-removed";
154
+ };
155
+
156
+ // @beta
157
+ export const LayoutReceiveEvents: {
158
+ readonly changeTitle: "change-title";
159
+ };
160
+
161
+ // @beta
162
+ export type LayoutReceiveEventsDetail = {
163
+ changeTitle: {
164
+ title: string;
165
+ mode: 'replace' | 'suffix';
166
+ };
167
+ };
168
+
169
+ // Warning: (ae-incompatible-release-tags) The symbol "LayoutRegionType" is marked as @beta, but its signature references "layoutRegionValue" which is marked as @internal
170
+ //
171
+ // @beta
172
+ export type LayoutRegionType = (typeof layoutRegionValue)[number];
173
+
174
+ // Warning: (ae-internal-missing-underscore) The name "layoutRegionValue" should be prefixed with an underscore because the declaration is marked as @internal
175
+ //
176
+ // @internal (undocumented)
177
+ export const layoutRegionValue: readonly ["horizontal", "vertical", "tabs"];
178
+
179
+ // @beta (undocumented)
180
+ export class LayoutRegistrationError extends Error {
181
+ constructor(message: string);
182
+ }
183
+
184
+ // @beta
185
+ export const layoutStyles: ElementStyles;
186
+
187
+ // @beta
188
+ export const layoutTemplate: ViewTemplate<FoundationLayout, any>;
189
+
190
+ // @beta (undocumented)
191
+ export class LayoutUsageError extends Error {
192
+ constructor(message: string);
193
+ }
194
+
195
+ // @beta
196
+ export type Placement = {
197
+ area: 'top' | 'left' | 'bottom' | 'right';
198
+ };
199
+
200
+ // @beta
201
+ export interface RegisteredElementConfig {
202
+ // (undocumented)
203
+ closable?: boolean;
204
+ // (undocumented)
205
+ registration: string;
206
+ // (undocumented)
207
+ size?: string;
208
+ // (undocumented)
209
+ title?: string;
210
+ }
211
+
212
+ // Warning: (ae-internal-missing-underscore) The name "RegistrationConfig" should be prefixed with an underscore because the declaration is marked as @internal
213
+ //
214
+ // @internal (undocumented)
215
+ export interface RegistrationConfig {
216
+ // (undocumented)
217
+ elements: Element[];
218
+ // (undocumented)
219
+ id?: string;
220
+ }
221
+
222
+ // @beta
223
+ export type SerialisedLayout = {
224
+ v: '1';
225
+ c: ResolvedLayoutConfig;
226
+ };
227
+
228
+ // Warning: (ae-internal-missing-underscore) The name "wrapperTemplate" should be prefixed with an underscore because the declaration is marked as @internal
229
+ //
230
+ // @internal
231
+ export const wrapperTemplate: ViewTemplate<any, any>;
232
+
233
+ // (No @packageDocumentation comment for this package)
234
+
235
+ ```