@genesislcap/foundation-layout 10.3.1 → 11.3.1

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 (142) hide show
  1. package/README.md +98 -30
  2. package/dist/dts/index.d.ts +1 -1
  3. package/dist/dts/index.d.ts.map +1 -1
  4. package/dist/dts/main/index.d.ts +0 -1
  5. package/dist/dts/main/index.d.ts.map +1 -1
  6. package/dist/dts/main/layout-components.d.ts +1 -1
  7. package/dist/dts/main/layout-item.d.ts +7 -7
  8. package/dist/dts/main/layout-item.d.ts.map +1 -1
  9. package/dist/dts/main/layout-main.d.ts +71 -16
  10. package/dist/dts/main/layout-main.d.ts.map +1 -1
  11. package/dist/dts/main/layout-region.d.ts +4 -4
  12. package/dist/dts/main/layout-region.d.ts.map +1 -1
  13. package/dist/dts/styles/layout.styles.d.ts +1 -1
  14. package/dist/dts/utils/constants.d.ts +6 -1
  15. package/dist/dts/utils/constants.d.ts.map +1 -1
  16. package/dist/dts/utils/error.d.ts +2 -2
  17. package/dist/dts/utils/events.d.ts +6 -3
  18. package/dist/dts/utils/events.d.ts.map +1 -1
  19. package/dist/dts/utils/index.d.ts +1 -0
  20. package/dist/dts/utils/index.d.ts.map +1 -1
  21. package/dist/dts/utils/logger.d.ts.map +1 -1
  22. package/dist/dts/utils/types.d.ts +8 -4
  23. package/dist/dts/utils/types.d.ts.map +1 -1
  24. package/dist/esm/index.federated.js +0 -1
  25. package/dist/esm/index.js +1 -2
  26. package/dist/esm/main/index.js +0 -2
  27. package/dist/esm/main/layout-components.js +2 -3
  28. package/dist/esm/main/layout-item.js +3 -4
  29. package/dist/esm/main/layout-main.js +148 -39
  30. package/dist/esm/main/layout-region.js +3 -4
  31. package/dist/esm/styles/constants.js +0 -1
  32. package/dist/esm/styles/dragging.styles.js +0 -1
  33. package/dist/esm/styles/index.js +0 -1
  34. package/dist/esm/styles/layout.styles.js +1 -2
  35. package/dist/esm/utils/constants.js +6 -2
  36. package/dist/esm/utils/error.js +2 -3
  37. package/dist/esm/utils/events.js +5 -3
  38. package/dist/esm/utils/index.js +1 -1
  39. package/dist/esm/utils/logger.js +0 -1
  40. package/dist/esm/utils/misc.js +0 -1
  41. package/dist/esm/utils/templates.js +0 -1
  42. package/dist/esm/utils/types.js +0 -1
  43. package/dist/foundation-layout.api.json +180 -73
  44. package/dist/foundation-layout.d.ts +98 -56
  45. package/docs/api/foundation-layout.default_reload_buffer.md +0 -3
  46. package/docs/api/foundation-layout.foundationlayout.additem.md +0 -3
  47. package/docs/api/foundation-layout.foundationlayout.autosavekey.md +13 -0
  48. package/docs/api/foundation-layout.foundationlayout.dragging.md +0 -3
  49. package/docs/api/foundation-layout.foundationlayout.getlayout.md +0 -3
  50. package/docs/api/foundation-layout.foundationlayout.layoutrequiredregistrations.md +0 -3
  51. package/docs/api/foundation-layout.foundationlayout.loadlayout.md +4 -6
  52. package/docs/api/foundation-layout.foundationlayout.md +11 -11
  53. package/docs/api/foundation-layout.foundationlayout.missingitemplaceholder.md +13 -0
  54. package/docs/api/foundation-layout.foundationlayout.registereditems.md +0 -3
  55. package/docs/api/foundation-layout.foundationlayout.registeritem.md +0 -3
  56. package/docs/api/foundation-layout.foundationlayout.reloadbuffer.md +0 -3
  57. package/docs/api/foundation-layout.foundationlayout.tryloadlayoutfromlocalstorage.md +27 -0
  58. package/docs/api/foundation-layout.foundationlayoutcomponents.md +0 -3
  59. package/docs/api/foundation-layout.foundationlayoutitem.closable.md +0 -3
  60. package/docs/api/foundation-layout.foundationlayoutitem.md +4 -7
  61. package/docs/api/foundation-layout.foundationlayoutitem.registration.md +1 -4
  62. package/docs/api/foundation-layout.foundationlayoutitem.size.md +0 -3
  63. package/docs/api/foundation-layout.foundationlayoutitem.title.md +0 -3
  64. package/docs/api/foundation-layout.foundationlayoutregion.md +2 -5
  65. package/docs/api/foundation-layout.foundationlayoutregion.size.md +0 -3
  66. package/docs/api/foundation-layout.foundationlayoutregion.type.md +0 -3
  67. package/docs/api/foundation-layout.layoutemitevents.md +2 -4
  68. package/docs/api/foundation-layout.layoutreceiveevents.md +0 -3
  69. package/docs/api/foundation-layout.layoutreceiveeventsdetail.md +0 -3
  70. package/docs/api/foundation-layout.layoutregiontype.md +0 -3
  71. package/docs/api/foundation-layout.layoutregistrationerror._constructor_.md +0 -3
  72. package/docs/api/foundation-layout.layoutregistrationerror.md +1 -4
  73. package/docs/api/foundation-layout.layoutstyles.md +0 -3
  74. package/docs/api/foundation-layout.layouttemplate.md +0 -3
  75. package/docs/api/foundation-layout.layoutusageerror._constructor_.md +0 -3
  76. package/docs/api/foundation-layout.layoutusageerror.md +1 -4
  77. package/docs/api/foundation-layout.md +16 -16
  78. package/docs/api/foundation-layout.placement.md +0 -3
  79. package/docs/api/foundation-layout.registeredelementconfig.closable.md +0 -3
  80. package/docs/api/foundation-layout.registeredelementconfig.md +4 -7
  81. package/docs/api/foundation-layout.registeredelementconfig.registration.md +0 -3
  82. package/docs/api/foundation-layout.registeredelementconfig.size.md +0 -3
  83. package/docs/api/foundation-layout.registeredelementconfig.title.md +0 -3
  84. package/docs/api/foundation-layout.serialisedlayout.md +0 -3
  85. package/docs/api-report.md +23 -65
  86. package/docs/img/foundation-layout-example.png +0 -0
  87. package/jsdom.setup.ts +1 -0
  88. package/package.json +22 -8
  89. package/playwright.config.ts +23 -0
  90. package/test/unit/setupRegisterForTests.ts +30 -0
  91. package/test/unit/test.ts +1 -0
  92. package/dist/1.0.0.remoteEntry.js +0 -1
  93. package/dist/191.191.106ece7a41ded6731029.js +0 -2
  94. package/dist/191.9a61143c2afb6057ad1bae886d5d1a6e.js.map +0 -1
  95. package/dist/259.09c601e5288d875caab4df1e2354c0ea.js.map +0 -1
  96. package/dist/259.259.216fcad43e9a38888e08.js +0 -2
  97. package/dist/415.415.094780a1a1162c7e5f1c.js +0 -3
  98. package/dist/415.415.094780a1a1162c7e5f1c.js.LICENSE.txt +0 -4
  99. package/dist/415.fcfb4f02eaecbfa31fc322639f244245.js.map +0 -1
  100. package/dist/459.459.6afc33f49546607f9227.js +0 -515
  101. package/dist/459.57760bcb7fc239af5b5953687ad192ff.js.map +0 -1
  102. package/dist/623.623.0e7e8f23454ee96ed9c8.js +0 -3
  103. package/dist/623.623.0e7e8f23454ee96ed9c8.js.LICENSE.txt +0 -4
  104. package/dist/623.e8f211473f9034c4157d362efb017821.js.map +0 -1
  105. package/dist/755.718e14af7194fb741f98580b24b2bb8f.js.map +0 -1
  106. package/dist/755.755.f93ee58c2b836a669ec4.js +0 -2
  107. package/dist/dashboard.json +0 -1
  108. package/dist/esm/index.federated.js.map +0 -1
  109. package/dist/esm/index.js.map +0 -1
  110. package/dist/esm/main/index.js.map +0 -1
  111. package/dist/esm/main/layout-components.js.map +0 -1
  112. package/dist/esm/main/layout-item.js.map +0 -1
  113. package/dist/esm/main/layout-main.js.map +0 -1
  114. package/dist/esm/main/layout-region.js.map +0 -1
  115. package/dist/esm/styles/constants.js.map +0 -1
  116. package/dist/esm/styles/dragging.styles.js.map +0 -1
  117. package/dist/esm/styles/index.js.map +0 -1
  118. package/dist/esm/styles/layout.styles.js.map +0 -1
  119. package/dist/esm/utils/constants.js.map +0 -1
  120. package/dist/esm/utils/error.js.map +0 -1
  121. package/dist/esm/utils/events.js.map +0 -1
  122. package/dist/esm/utils/index.js.map +0 -1
  123. package/dist/esm/utils/logger.js.map +0 -1
  124. package/dist/esm/utils/misc.js.map +0 -1
  125. package/dist/esm/utils/templates.js.map +0 -1
  126. package/dist/esm/utils/types.js.map +0 -1
  127. package/dist/favicon.ico +0 -0
  128. package/dist/foundationLayout.3cfa4a65fd1f4b6b3ab7671e3356db59.js.map +0 -1
  129. package/dist/index.ejs +0 -23
  130. package/dist/index.html +0 -15
  131. package/dist/info.ejs +0 -13
  132. package/dist/main.b0ddbf415137dc7a9e92.js +0 -2
  133. package/dist/main.f141788ee57f3820f1f4f0fc27368847.js.map +0 -1
  134. package/dist/npm.consola.713.b1e4073e73c71572987a.js +0 -2
  135. package/dist/npm.consola.a0d3324d3e61dcc430c3029da5f4dcc7.js.map +0 -1
  136. package/dist/npm.genesis-community.248.9c9900001dbc5ba9c3ed.js +0 -2
  137. package/dist/npm.genesis-community.2e0cc159dabe113d6fb29bb505c1a0d4.js.map +0 -1
  138. package/dist/npm.microsoft.127.00f16f24d8da8fd89263.js +0 -1469
  139. package/dist/npm.microsoft.127.00f16f24d8da8fd89263.js.LICENSE.txt +0 -14
  140. package/dist/npm.microsoft.be43958facd28231e770c1307660f64d.js.map +0 -1
  141. package/dist/remoteEntry.js +0 -2
  142. package/dist/serve.json +0 -3
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## FoundationLayoutItem class
6
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
7
  `FoundationLayoutItem` is a custom element that represents an item in the layout.
11
8
 
12
9
  **Signature:**
@@ -28,8 +25,8 @@ This is a simple component which is only used to define the layout splits; any J
28
25
 
29
26
  | Property | Modifiers | Type | Description |
30
27
  | --- | --- | --- | --- |
31
- | [closable](./foundation-layout.foundationlayoutitem.closable.md) | | boolean | **_(BETA)_** Boolean attribute controls whether the window can be closed in the GUI. Defaults to <code>false</code>. |
32
- | [registration](./foundation-layout.foundationlayoutitem.registration.md) | | string | **_(BETA)_** Sets the registration name for the item, which can be used later to add the item via the JavaScript API using . |
33
- | [size](./foundation-layout.foundationlayoutitem.size.md) | | string | **_(BETA)_** optional string describing the size of the new item (see the written documentation for more info) |
34
- | [title](./foundation-layout.foundationlayoutitem.title.md) | | string | **_(BETA)_** Sets the title of the item which is displayed on the tab. |
28
+ | [closable](./foundation-layout.foundationlayoutitem.closable.md) | | boolean | Boolean attribute controls whether the window can be closed in the GUI. Defaults to <code>false</code>. |
29
+ | [registration](./foundation-layout.foundationlayoutitem.registration.md) | | string | 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)<!-- -->. |
30
+ | [size](./foundation-layout.foundationlayoutitem.size.md) | | string | optional string describing the size of the new item (see the written documentation for more info) |
31
+ | [title](./foundation-layout.foundationlayoutitem.title.md) | | string | Sets the title of the item which is displayed on the tab. |
35
32
 
@@ -4,10 +4,7 @@
4
4
 
5
5
  ## FoundationLayoutItem.registration property
6
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
- Sets the registration name for the item, which can be used later to add the item via the JavaScript API using .
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)<!-- -->.
11
8
 
12
9
  **Signature:**
13
10
 
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## FoundationLayoutItem.size property
6
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
7
  optional string describing the size of the new item (see the written documentation for more info)
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## FoundationLayoutItem.title property
6
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
7
  Sets the title of the item which is displayed on the tab.
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## FoundationLayoutRegion class
6
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
7
  `FoundationLayoutRegion` is a custom element that represents a region in the layout.
11
8
 
12
9
  **Signature:**
@@ -28,6 +25,6 @@ This is a simple component which is only used to define the layout splits; any J
28
25
 
29
26
  | Property | Modifiers | Type | Description |
30
27
  | --- | --- | --- | --- |
31
- | [size](./foundation-layout.foundationlayoutregion.size.md) | | string | **_(BETA)_** optional string describing the size of the new item (see the written documentation for more info) |
32
- | [type](./foundation-layout.foundationlayoutregion.type.md) | | [LayoutRegionType](./foundation-layout.layoutregiontype.md) | **_(BETA)_** Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to <code>horizontal</code>. |
28
+ | [size](./foundation-layout.foundationlayoutregion.size.md) | | string | optional string describing the size of the new item (see the written documentation for more info) |
29
+ | [type](./foundation-layout.foundationlayoutregion.type.md) | | [LayoutRegionType](./foundation-layout.layoutregiontype.md) | Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to <code>horizontal</code>. |
33
30
 
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## FoundationLayoutRegion.size property
6
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
7
  optional string describing the size of the new item (see the written documentation for more info)
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## FoundationLayoutRegion.type property
6
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
7
  Defines the [type](./foundation-layout.layoutregiontype.md) of the region. Defaults to `horizontal`<!-- -->.
11
8
 
12
9
  **Signature:**
@@ -4,12 +4,9 @@
4
4
 
5
5
  ## LayoutEmitEvents variable
6
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
7
  Defines events that the layout system emits
11
8
 
12
- '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'
9
+ '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
13
10
 
14
11
  **Signature:**
15
12
 
@@ -18,5 +15,6 @@ LayoutEmitEvents: {
18
15
  readonly firstLoaded: "first-loaded";
19
16
  readonly itemAdded: "item-added";
20
17
  readonly itemRemoved: "item-removed";
18
+ readonly itemResized: "item-resized";
21
19
  }
22
20
  ```
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## LayoutReceiveEvents variable
6
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
7
  Defines events that the layout system listens for
11
8
 
12
9
  'changeTitle' - emit this from a contained item to update the title of the window that contains it.
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## LayoutReceiveEventsDetail type
6
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
7
  Defines the shape of the detail that the layout listens works with for events it listens on
11
8
 
12
9
  '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.
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## LayoutRegionType type
6
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
7
  Union type describing the three different types of region splits. Set on the `type` attribute on [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md)<!-- -->.
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## LayoutRegistrationError.(constructor)
6
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
7
  Constructs a new instance of the `LayoutRegistrationError` class
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## LayoutRegistrationError class
6
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
7
 
11
8
  **Signature:**
12
9
 
@@ -19,5 +16,5 @@ export declare class LayoutRegistrationError extends Error
19
16
 
20
17
  | Constructor | Modifiers | Description |
21
18
  | --- | --- | --- |
22
- | [(constructor)(message)](./foundation-layout.layoutregistrationerror._constructor_.md) | | **_(BETA)_** Constructs a new instance of the <code>LayoutRegistrationError</code> class |
19
+ | [(constructor)(message)](./foundation-layout.layoutregistrationerror._constructor_.md) | | Constructs a new instance of the <code>LayoutRegistrationError</code> class |
23
20
 
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## layoutStyles variable
6
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
7
  `ElementStyles` which defines the css for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## layoutTemplate variable
6
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
7
  `ViewTemplate` which defines the html for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->.
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## LayoutUsageError.(constructor)
6
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
7
  Constructs a new instance of the `LayoutUsageError` class
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## LayoutUsageError class
6
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
7
 
11
8
  **Signature:**
12
9
 
@@ -19,5 +16,5 @@ export declare class LayoutUsageError extends Error
19
16
 
20
17
  | Constructor | Modifiers | Description |
21
18
  | --- | --- | --- |
22
- | [(constructor)(message)](./foundation-layout.layoutusageerror._constructor_.md) | | **_(BETA)_** Constructs a new instance of the <code>LayoutUsageError</code> class |
19
+ | [(constructor)(message)](./foundation-layout.layoutusageerror._constructor_.md) | | Constructs a new instance of the <code>LayoutUsageError</code> class |
23
20
 
@@ -8,35 +8,35 @@
8
8
 
9
9
  | Class | Description |
10
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)_** |
11
+ | [FoundationLayout](./foundation-layout.foundationlayout.md) | Top level web component which is used to initialise a custom layout |
12
+ | [FoundationLayoutItem](./foundation-layout.foundationlayoutitem.md) | <code>FoundationLayoutItem</code> is a custom element that represents an item in the layout. |
13
+ | [FoundationLayoutRegion](./foundation-layout.foundationlayoutregion.md) | <code>FoundationLayoutRegion</code> is a custom element that represents a region in the layout. |
14
+ | [LayoutRegistrationError](./foundation-layout.layoutregistrationerror.md) | |
15
+ | [LayoutUsageError](./foundation-layout.layoutusageerror.md) | |
16
16
 
17
17
  ## Interfaces
18
18
 
19
19
  | Interface | Description |
20
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 |
21
+ | [RegisteredElementConfig](./foundation-layout.registeredelementconfig.md) | The parameters that can be set on a new item when being added by the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API |
22
22
 
23
23
  ## Variables
24
24
 
25
25
  | Variable | Description |
26
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)<!-- -->. |
27
+ | [DEFAULT\_RELOAD\_BUFFER](./foundation-layout.default_reload_buffer.md) | <p>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) | Registration object to register the layout with your design system. |
29
+ | [LayoutEmitEvents](./foundation-layout.layoutemitevents.md) | <p>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' <br/> 'itemResized' - emitted when the user drags the divider to resize elements</p> |
30
+ | [LayoutReceiveEvents](./foundation-layout.layoutreceiveevents.md) | <p>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) | <code>ElementStyles</code> which defines the css for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->. |
32
+ | [layoutTemplate](./foundation-layout.layouttemplate.md) | <code>ViewTemplate</code> which defines the html for [FoundationLayout](./foundation-layout.foundationlayout.md)<!-- -->. |
33
33
 
34
34
  ## Type Aliases
35
35
 
36
36
  | Type Alias | Description |
37
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. |
38
+ | [LayoutReceiveEventsDetail](./foundation-layout.layoutreceiveeventsdetail.md) | <p>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) | 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) | 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) | Versioned layout config objects. <code>v</code> is the version and <code>c</code> contains the layout config. |
42
42
 
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## Placement type
6
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
7
  Where to add the new item into the layout when using the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API
11
8
 
12
9
  **Signature:**
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## RegisteredElementConfig.closable property
6
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
7
  **Signature:**
11
8
 
12
9
  ```typescript
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## RegisteredElementConfig interface
6
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
7
  The parameters that can be set on a new item when being added by the [FoundationLayout.addItem()](./foundation-layout.foundationlayout.additem.md) API
11
8
 
12
9
  **Signature:**
@@ -23,8 +20,8 @@ export interface RegisteredElementConfig
23
20
 
24
21
  | Property | Modifiers | Type | Description |
25
22
  | --- | --- | --- | --- |
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)_ |
23
+ | [closable?](./foundation-layout.registeredelementconfig.closable.md) | | boolean | _(Optional)_ |
24
+ | [registration](./foundation-layout.registeredelementconfig.registration.md) | | string | |
25
+ | [size?](./foundation-layout.registeredelementconfig.size.md) | | string | _(Optional)_ |
26
+ | [title?](./foundation-layout.registeredelementconfig.title.md) | | string | _(Optional)_ |
30
27
 
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## RegisteredElementConfig.registration property
6
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
7
  **Signature:**
11
8
 
12
9
  ```typescript
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## RegisteredElementConfig.size property
6
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
7
  **Signature:**
11
8
 
12
9
  ```typescript
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## RegisteredElementConfig.title property
6
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
7
  **Signature:**
11
8
 
12
9
  ```typescript
@@ -4,9 +4,6 @@
4
4
 
5
5
  ## SerialisedLayout type
6
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
7
  Versioned layout config objects. `v` is the version and `c` contains the layout config.
11
8
 
12
9
  **Signature:**
@@ -13,22 +13,12 @@ import { ResolvedLayoutConfig } from '@genesis-community/golden-layout';
13
13
  import { RootItemConfig } from '@genesis-community/golden-layout';
14
14
  import { ViewTemplate } from '@microsoft/fast-element';
15
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
16
+ // @public
27
17
  export const DEFAULT_RELOAD_BUFFER = 500;
28
18
 
29
- // Warning: (ae-incompatible-release-tags) The symbol "FoundationLayout" is marked as @beta, but its signature references "LayoutComponent" which is marked as @internal
19
+ // Warning: (ae-forgotten-export) The symbol "LayoutComponent" needs to be exported by the entry point index.d.ts
30
20
  //
31
- // @beta
21
+ // @public
32
22
  export class FoundationLayout extends FoundationElement implements LayoutComponent {
33
23
  // @internal (undocumented)
34
24
  [componentType]: "root";
@@ -37,6 +27,7 @@ export class FoundationLayout extends FoundationElement implements LayoutCompone
37
27
  addItem(config: RegisteredElementConfig, placement?: Placement): void;
38
28
  // @internal
39
29
  addItemFromChild<T extends RootItemConfig>(item: T): T;
30
+ autoSaveKey?: string;
40
31
  // @internal
41
32
  cacheElementsAndRegister({ elements, id }: RegistrationConfig): string;
42
33
  // @internal (undocumented)
@@ -50,17 +41,19 @@ export class FoundationLayout extends FoundationElement implements LayoutCompone
50
41
  // @internal (undocumented)
51
42
  layoutElement: HTMLElement;
52
43
  static layoutRequiredRegistrations(layout: SerialisedLayout): string[];
53
- loadLayout(layout: SerialisedLayout): void;
44
+ loadLayout(layout: SerialisedLayout, handleMissingItem?: 'placeholder' | 'error'): void;
45
+ missingItemPlaceholder: (missingItem: string) => string;
54
46
  registeredItems(): string[];
55
47
  registerItem(registration: string, elements: Element[]): string;
56
48
  reloadBuffer: number;
57
49
  // @internal
58
50
  requestLayoutReload(): void;
51
+ tryLoadLayoutFromLocalStorage(): boolean;
59
52
  // @internal (undocumented)
60
53
  usingDeclerativeAPI: boolean;
61
54
  }
62
55
 
63
- // @beta
56
+ // @public
64
57
  export const foundationLayoutComponents: {
65
58
  foundationLayout: (overrideDefinition?: OverrideFoundationElementDefinition< {
66
59
  baseName: string;
@@ -88,9 +81,7 @@ export const foundationLayoutComponents: {
88
81
  register(container?: Container, ...rest: any[]): void;
89
82
  };
90
83
 
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
84
+ // @public
94
85
  export class FoundationLayoutItem extends FoundationElement implements LayoutComponent {
95
86
  // @internal (undocumented)
96
87
  [componentType]: "item";
@@ -106,9 +97,7 @@ export class FoundationLayoutItem extends FoundationElement implements LayoutCom
106
97
  title: string;
107
98
  }
108
99
 
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
100
+ // @public
112
101
  export class FoundationLayoutRegion extends FoundationElement implements LayoutComponent {
113
102
  // @internal (undocumented)
114
103
  [componentType]: LayoutRegionType;
@@ -124,41 +113,20 @@ export class FoundationLayoutRegion extends FoundationElement implements LayoutC
124
113
  type: LayoutRegionType;
125
114
  }
126
115
 
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
116
+ // @public
150
117
  export const LayoutEmitEvents: {
151
118
  readonly firstLoaded: "first-loaded";
152
119
  readonly itemAdded: "item-added";
153
120
  readonly itemRemoved: "item-removed";
121
+ readonly itemResized: "item-resized";
154
122
  };
155
123
 
156
- // @beta
124
+ // @public
157
125
  export const LayoutReceiveEvents: {
158
126
  readonly changeTitle: "change-title";
159
127
  };
160
128
 
161
- // @beta
129
+ // @public
162
130
  export type LayoutReceiveEventsDetail = {
163
131
  changeTitle: {
164
132
  title: string;
@@ -166,38 +134,33 @@ export type LayoutReceiveEventsDetail = {
166
134
  };
167
135
  };
168
136
 
169
- // Warning: (ae-incompatible-release-tags) The symbol "LayoutRegionType" is marked as @beta, but its signature references "layoutRegionValue" which is marked as @internal
137
+ // Warning: (ae-forgotten-export) The symbol "layoutRegionValue" needs to be exported by the entry point index.d.ts
170
138
  //
171
- // @beta
139
+ // @public
172
140
  export type LayoutRegionType = (typeof layoutRegionValue)[number];
173
141
 
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)
142
+ // @public (undocumented)
180
143
  export class LayoutRegistrationError extends Error {
181
144
  constructor(message: string);
182
145
  }
183
146
 
184
- // @beta
147
+ // @public
185
148
  export const layoutStyles: ElementStyles;
186
149
 
187
- // @beta
150
+ // @public
188
151
  export const layoutTemplate: ViewTemplate<FoundationLayout, any>;
189
152
 
190
- // @beta (undocumented)
153
+ // @public (undocumented)
191
154
  export class LayoutUsageError extends Error {
192
155
  constructor(message: string);
193
156
  }
194
157
 
195
- // @beta
158
+ // @public
196
159
  export type Placement = {
197
160
  area: 'top' | 'left' | 'bottom' | 'right';
198
161
  };
199
162
 
200
- // @beta
163
+ // @public
201
164
  export interface RegisteredElementConfig {
202
165
  // (undocumented)
203
166
  closable?: boolean;
@@ -219,17 +182,12 @@ export interface RegistrationConfig {
219
182
  id?: string;
220
183
  }
221
184
 
222
- // @beta
185
+ // @public
223
186
  export type SerialisedLayout = {
224
187
  v: '1';
225
188
  c: ResolvedLayoutConfig;
226
189
  };
227
190
 
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
191
  // (No @packageDocumentation comment for this package)
234
192
 
235
193
  ```
package/jsdom.setup.ts ADDED
@@ -0,0 +1 @@
1
+ export * from '@genesislcap/foundation-testing/jsdom';