@genesislcap/foundation-layout 10.3.1 → 11.3.0

package/dist/foundation-layout.api.json

@@ -175,7 +175,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-layout!DEFAULT_RELOAD_BUFFER:var",
-          "docComment": "/**\n * Default time in milliseconds for the layout to buffer calls to reloading the layout while the declarative API is loading.\n *\n * During the first load of the layout, a loading spinner will be shown.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Default time in milliseconds for the layout to buffer calls to reloading the layout while the declarative API is loading.\n *\n * During the first load of the layout, a loading spinner will be shown.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -192,7 +192,7 @@
             "endIndex": 2
           },
           "isReadonly": true,
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "DEFAULT_RELOAD_BUFFER",
           "variableTypeTokenRange": {
             "startIndex": 0,
@@ -202,7 +202,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout:class",
-          "docComment": "/**\n * Top level web component which is used to initialise a custom layout\n *\n * @remarks\n *\n * Can be used in a composition to customise the styles of the layout.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FoundationLayout` class.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Top level web component which is used to initialise a custom layout\n *\n * @remarks\n *\n * Can be used in a composition to customise the styles of the layout.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `FoundationLayout` class.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -220,7 +220,7 @@
             {
               "kind": "Reference",
               "text": "LayoutComponent",
-              "canonicalReference": "@genesislcap/foundation-layout!LayoutComponent:interface"
+              "canonicalReference": "@genesislcap/foundation-layout!~LayoutComponent:interface"
             },
             {
               "kind": "Content",
@@ -228,7 +228,7 @@
             }
           ],
           "fileUrlPath": "src/main/layout-main.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "isAbstract": false,
           "name": "FoundationLayout",
           "preserveMemberOrder": false,
@@ -236,7 +236,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#addItem:member(1)",
-              "docComment": "/**\n * Dynamically add a new item to the layout. The user can move the new plane to whenever they want once it has been added.\n *\n * @remarks\n *\n * Adding a new item invokes the registration previously made explicitly via {@link FoundationLayout.registerItem | registerItem()} or implicitly via the html declerative API.\n *\n * The elements added onto the new pane are copies using `element.cloneNode()` of the original element references used during registration.\n *\n * @param config - {@link RegisteredElementConfig} configuration items for the new pane\n *\n * @param placement - where to add the new pane on the layout (defaults to the right hand side)\n *\n * @throws\n *\n * {@link LayoutRegistrationError} if you attempt to add an item before it has been registered\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Dynamically add a new item to the layout. The user can move the new plane to whenever they want once it has been added.\n *\n * @remarks\n *\n * Adding a new item invokes the registration previously made explicitly via {@link FoundationLayout.registerItem | registerItem()} or implicitly via the html declerative API.\n *\n * The elements added onto the new pane are copies using `element.cloneNode()` of the original element references used during registration.\n *\n * @param config - {@link RegisteredElementConfig} configuration items for the new pane\n *\n * @param placement - where to add the new pane on the layout (defaults to the right hand side)\n *\n * @throws\n *\n * {@link LayoutRegistrationError} if you attempt to add an item before it has been registered\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -274,7 +274,7 @@
                 "startIndex": 5,
                 "endIndex": 6
               },
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -299,10 +299,40 @@
               "isAbstract": false,
               "name": "addItem"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#autoSaveKey:member",
+              "docComment": "/**\n * Attribute which if set will auto save and load the layout as the user changes it. Omit this attribute to disable this feature. Set attribute using `auto-save-key`.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "autoSaveKey?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "autoSaveKey",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#dragging:member",
-              "docComment": "/**\n * Set to true when the user is currently dragging the panes inside of the layout\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Set to true when the user is currently dragging the panes inside of the layout\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -319,7 +349,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "dragging",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -332,7 +362,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#getLayout:member(1)",
-              "docComment": "/**\n * Gets a minified string containing the config describing the current layout of the layout object to later restore in {@link FoundationLayout.loadLayout | function}\n *\n * @returns - latest version of {@link SerialisedLayout} describing the layout\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Gets a minified string containing the config describing the current layout of the layout object to later restore in {@link FoundationLayout.loadLayout | function}\n *\n * @returns - latest version of {@link SerialisedLayout} describing the layout\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -353,7 +383,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [],
@@ -364,7 +394,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout.layoutRequiredRegistrations:member(1)",
-              "docComment": "/**\n * Gets all of the required registration function names for a set of config\n *\n * @remarks\n *\n * You can use this with {@link FoundationLayout.registeredItems | registeredItems} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()} before loading the layout with {@link FoundationLayout.loadLayout | loadLayout()}\n *\n * @param layout - any version of {@link SerialisedLayout} object describing the layout\n *\n * @returns string[] - an item for each registered element in the config. These must all be added before {@link FoundationLayout.loadLayout | function}\n *\n * @throws\n *\n * - various errors if the layout parameter cannot be parsed\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Gets all of the required registration function names for a set of config\n *\n * @remarks\n *\n * You can use this with {@link FoundationLayout.registeredItems | registeredItems} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()} before loading the layout with {@link FoundationLayout.loadLayout | loadLayout()}\n *\n * @param layout - any version of {@link SerialisedLayout} object describing the layout\n *\n * @returns string[] - an item for each registered element in the config. These must all be added before {@link FoundationLayout.loadLayout | function}\n *\n * @throws\n *\n * - various errors if the layout parameter cannot be parsed\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -393,7 +423,7 @@
                 "startIndex": 3,
                 "endIndex": 4
               },
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -413,7 +443,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#loadLayout:member(1)",
-              "docComment": "/**\n * Restores a layout described in the config from {@link FoundationLayout.getLayout | getLayout()}\n *\n * @remarks\n *\n * In order to restore a layout you must have registered all of the required panes with the layout system before restoring it. If you are just setting the layout using the declarative API then all of the same components will be registered. <br/ >If you have added any elements using {@link FoundationLayout.registerItem} then you must ensure all of the same items have been added again. To make tracking what items are registered easier it is recommended in this case you explicitly name your registrations using the `id` parameter available on the {@link RegisteredElementConfig} and `foundation-layout-item` APIs. <br/> You can use {@link FoundationLayout.layoutRequiredRegistrations} to check which items are registered in a current layout in order to dynamically add any missing items before you can restore the layout\n *\n * @param layout - any version of {@link SerialisedLayout} object describing the layout\n *\n * @throws\n *\n * {@link LayoutUsageError} if you attempt to load a layout with registered items that are not currently registered with the layout system\n *\n * @throws\n *\n * various errors if the layout string is malformed and cannot be parsed\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Restores a layout described in the config from {@link FoundationLayout.getLayout | getLayout()}\n *\n * @remarks\n *\n * In order to restore a layout you must have registered all of the required panes with the layout system before restoring it. If you are just setting the layout using the declarative API then all of the same components will be registered. If you have added any elements using {@link FoundationLayout.registerItem} then you must ensure all of the same items have been added again. To make tracking what items are registered easier it is recommended in this case you explicitly name your registrations using the `id` parameter available on the {@link RegisteredElementConfig} and `foundation-layout-item` APIs. You can use {@link FoundationLayout.layoutRequiredRegistrations} to check which items are registered in a current layout in order to dynamically add any missing items before you can restore the layout\n *\n * @param layout - any version of {@link SerialisedLayout} object describing the layout\n *\n * @param handleMissingItem - what to do if the layout contains items that are not currently registered with the layout system. Defaults to 'error' which will throw an error. If set to 'placeholder' then any missing items will be replaced with a placeholder element. You can control the text of the placeholder element with {@link FoundationLayout.missingItemPlaceholder}.\n *\n * @throws\n *\n * {@link LayoutUsageError} if you attempt to load a layout with registered items that are not currently registered with the layout system, and handleMissingItem is set to 'error' (default).\n *\n * @throws\n *\n * various errors if the layout string is malformed and cannot be parsed\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -424,6 +454,14 @@
                   "text": "SerialisedLayout",
                   "canonicalReference": "@genesislcap/foundation-layout!SerialisedLayout:type"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", handleMissingItem?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "'placeholder' | 'error'"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -439,10 +477,10 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
+                "startIndex": 5,
+                "endIndex": 6
               },
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -453,16 +491,54 @@
                     "endIndex": 2
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "handleMissingItem",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
               "name": "loadLayout"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#missingItemPlaceholder:member",
+              "docComment": "/**\n * Function which is used to generate the placeholder text when a layout is loaded with a missing item.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "missingItemPlaceholder: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(missingItem: string) => string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "missingItemPlaceholder",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#registeredItems:member(1)",
-              "docComment": "/**\n * Gets all of the currently registered names\n *\n * @remarks\n *\n * You can use this with {@link FoundationLayout.layoutRequiredRegistrations | layoutRequiredRegistrations} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()} before loading the layout with {@link FoundationLayout.loadLayout | loadLayout()}\n *\n * @returns string[] - an item for each registered element currently registered with the layout system\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Gets all of the currently registered names\n *\n * @remarks\n *\n * You can use this with {@link FoundationLayout.layoutRequiredRegistrations | layoutRequiredRegistrations} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()} before loading the layout with {@link FoundationLayout.loadLayout | loadLayout()}\n *\n * @returns string[] - an item for each registered element currently registered with the layout system\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -482,7 +558,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [],
@@ -493,7 +569,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#registerItem:member(1)",
-              "docComment": "/**\n * Register a collection of `Element` and associate them with an `ID` with the layout system for later use.\n *\n * @remarks\n *\n * You would use this to register elements that you later want to load when using {@link FoundationLayout.loadLayout}. Use {@link FoundationLayout.layoutRequiredRegistrations} to see what components need to be registered for a certain config and then register them using this function before calling {@link FoundationLayout.loadLayout}.\n *\n * When registering an element it is moved by reference into the internals of the layout, so if you pass elements already in the DOM then they will disappear. If you want to avoid this you can pass copies using `element.cloneNode(true)`.\n *\n * @param registration - string of the registration ID\n *\n * @param elements - Elements[] containing the reference to the elements to register for later usage\n *\n * @returns - string defining the name of the registered item with the layout system (config.id if set).\n *\n * @throws\n *\n * {@link LayoutUsageError} if you attempt to add an item before the layout has been initialised.\n *\n * @throws\n *\n * {@link LayoutRegistrationError} if you attempt to use a `registration` name which is already in use (declarative html API and JavaScript API registrations use the same \"pool\" of registration names).\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Register a collection of `Element` and associate them with an `ID` with the layout system for later use.\n *\n * @remarks\n *\n * You would use this to register elements that you later want to load when using {@link FoundationLayout.loadLayout}. Use {@link FoundationLayout.layoutRequiredRegistrations} to see what components need to be registered for a certain config and then register them using this function before calling {@link FoundationLayout.loadLayout}.\n *\n * When registering an element it is moved by reference into the internals of the layout, so if you pass elements already in the DOM then they will disappear. If you want to avoid this you can pass copies using `element.cloneNode(true)`.\n *\n * @param registration - string of the registration ID\n *\n * @param elements - Elements[] containing the reference to the elements to register for later usage\n *\n * @returns - string defining the name of the registered item with the layout system (config.id if set).\n *\n * @throws\n *\n * {@link LayoutUsageError} if you attempt to add an item before the layout has been initialised.\n *\n * @throws\n *\n * {@link LayoutRegistrationError} if you attempt to use a `registration` name which is already in use (declarative html API and JavaScript API registrations use the same \"pool\" of registration names).\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -534,7 +610,7 @@
                 "startIndex": 6,
                 "endIndex": 7
               },
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -562,7 +638,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#reloadBuffer:member",
-              "docComment": "/**\n * Number describing how long to wait in ms before reloading the config when adding items declaratively by the html API. Default 500 (ms).\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Number describing how long to wait in ms before reloading the config when adding items declaratively by the html API. Default 500 (ms).\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -579,7 +655,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "reloadBuffer",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -588,6 +664,37 @@
               "isStatic": false,
               "isProtected": false,
               "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#tryLoadLayoutFromLocalStorage:member(1)",
+              "docComment": "/**\n * Try to load a layout from local storage, or return false. Only required if manually calling {@link FoundationLayout.registerItem}\n *\n * @remarks\n *\n * 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.\n *\n * 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 {@link FoundationLayout.registerItem} then you should call this function immediately afterwards.\n *\n * Will load the layout with `handleMissingItem = 'placeholder` so placeholder text will be shown for any missing items.\n *\n * @returns boolean - true if a layout was loaded, false if not\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "tryLoadLayoutFromLocalStorage(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "tryLoadLayoutFromLocalStorage"
             }
           ],
           "extendsTokenRange": {
@@ -604,7 +711,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-layout!foundationLayoutComponents:var",
-          "docComment": "/**\n * Registration object to register the layout with your design system.\n *\n * @remarks\n *\n * 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 {@link FoundationLayout} as this contains the styles for the entire layout.\n *\n * @example\n *\n * `<zero-layout></zero-layout>` if you are using the layout with the `zero` design-system.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Registration object to register the layout with your design system.\n *\n * @remarks\n *\n * 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 {@link FoundationLayout} as this contains the styles for the entire layout.\n *\n * @example\n *\n * `<zero-layout></zero-layout>` if you are using the layout with the `zero` design-system.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -797,7 +904,7 @@
           ],
           "fileUrlPath": "src/main/layout-components.ts",
           "isReadonly": true,
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "foundationLayoutComponents",
           "variableTypeTokenRange": {
             "startIndex": 1,
@@ -807,7 +914,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutItem:class",
-          "docComment": "/**\n * `FoundationLayoutItem` is a custom element that represents an item in the layout.\n *\n * @remarks\n *\n * This element is used to wrap html elements and configure their layout settings as part of the layout system.\n *\n * This is a simple component which is only used to define the layout splits; any JavaScript API interactions or custom styling is used via {@link FoundationLayout}.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `FoundationLayoutItem` is a custom element that represents an item in the layout.\n *\n * @remarks\n *\n * This element is used to wrap html elements and configure their layout settings as part of the layout system.\n *\n * This is a simple component which is only used to define the layout splits; any JavaScript API interactions or custom styling is used via {@link FoundationLayout}.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -825,7 +932,7 @@
             {
               "kind": "Reference",
               "text": "LayoutComponent",
-              "canonicalReference": "@genesislcap/foundation-layout!LayoutComponent:interface"
+              "canonicalReference": "@genesislcap/foundation-layout!~LayoutComponent:interface"
             },
             {
               "kind": "Content",
@@ -833,7 +940,7 @@
             }
           ],
           "fileUrlPath": "src/main/layout-item.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "isAbstract": false,
           "name": "FoundationLayoutItem",
           "preserveMemberOrder": false,
@@ -841,7 +948,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutItem#closable:member",
-              "docComment": "/**\n * Boolean attribute controls whether the window can be closed in the GUI. Defaults to `false`.\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Boolean attribute controls whether the window can be closed in the GUI. Defaults to `false`.\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -858,7 +965,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "closable",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -871,7 +978,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutItem#registration:member",
-              "docComment": "/**\n * Sets the registration name for the item, which can be used later to add the item via the JavaScript API using {@link FoundationLayout.addItem()}.\n *\n * @remarks\n *\n * 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.\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Sets the registration name for the item, which can be used later to add the item via the JavaScript API using {@link FoundationLayout.addItem}.\n *\n * @remarks\n *\n * 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.\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -888,7 +995,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "registration",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -901,7 +1008,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutItem#size:member",
-              "docComment": "/**\n * optional string describing the size of the new item (see the written documentation for more info)\n *\n * @beta\n */\n",
+              "docComment": "/**\n * optional string describing the size of the new item (see the written documentation for more info)\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -918,7 +1025,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "size",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -931,7 +1038,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutItem#title:member",
-              "docComment": "/**\n * Sets the title of the item which is displayed on the tab.\n *\n * @remarks\n *\n * Defaults to `Item ` + {@link FoundationLayoutItem.registration}\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Sets the title of the item which is displayed on the tab.\n *\n * @remarks\n *\n * Defaults to `Item ` + {@link FoundationLayoutItem.registration}\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -948,7 +1055,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "title",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -973,7 +1080,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutRegion:class",
-          "docComment": "/**\n * `FoundationLayoutRegion` is a custom element that represents a region in the layout.\n *\n * @remarks\n *\n * 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.\n *\n * This is a simple component which is only used to define the layout splits; any JavaScript API interactions or custom styling is used via {@link FoundationLayout}.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `FoundationLayoutRegion` is a custom element that represents a region in the layout.\n *\n * @remarks\n *\n * 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.\n *\n * This is a simple component which is only used to define the layout splits; any JavaScript API interactions or custom styling is used via {@link FoundationLayout}.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -991,7 +1098,7 @@
             {
               "kind": "Reference",
               "text": "LayoutComponent",
-              "canonicalReference": "@genesislcap/foundation-layout!LayoutComponent:interface"
+              "canonicalReference": "@genesislcap/foundation-layout!~LayoutComponent:interface"
             },
             {
               "kind": "Content",
@@ -999,7 +1106,7 @@
             }
           ],
           "fileUrlPath": "src/main/layout-region.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "isAbstract": false,
           "name": "FoundationLayoutRegion",
           "preserveMemberOrder": false,
@@ -1007,7 +1114,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutRegion#size:member",
-              "docComment": "/**\n * optional string describing the size of the new item (see the written documentation for more info)\n *\n * @beta\n */\n",
+              "docComment": "/**\n * optional string describing the size of the new item (see the written documentation for more info)\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1024,7 +1131,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "size",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1037,7 +1144,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutRegion#type:member",
-              "docComment": "/**\n * Defines the {@link LayoutRegionType | type} of the region. Defaults to `horizontal`.\n *\n * @beta\n */\n",
+              "docComment": "/**\n * Defines the {@link LayoutRegionType | type} of the region. Defaults to `horizontal`.\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1055,7 +1162,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "type",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1080,7 +1187,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-layout!LayoutEmitEvents:var",
-          "docComment": "/**\n * Defines events that the layout system emits\n *\n * 'firstLoaded' - emitted when the layout has finished loading the first time using the declarative API after {@link DEFAULT_RELOAD_BUFFER} ms. <br/> 'itemAdded' - emitted when an item is added to the layout' <br/> 'itemRemoved' - emitted when an item is removed from the layout'\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Defines events that the layout system emits\n *\n * 'firstLoaded' - emitted when the layout has finished loading the first time using the declarative API after {@link DEFAULT_RELOAD_BUFFER} 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\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1088,12 +1195,12 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    readonly firstLoaded: \"first-loaded\";\n    readonly itemAdded: \"item-added\";\n    readonly itemRemoved: \"item-removed\";\n}"
+              "text": "{\n    readonly firstLoaded: \"first-loaded\";\n    readonly itemAdded: \"item-added\";\n    readonly itemRemoved: \"item-removed\";\n    readonly itemResized: \"item-resized\";\n}"
             }
           ],
           "fileUrlPath": "src/utils/events.ts",
           "isReadonly": true,
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "LayoutEmitEvents",
           "variableTypeTokenRange": {
             "startIndex": 1,
@@ -1103,7 +1210,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-layout!LayoutReceiveEvents:var",
-          "docComment": "/**\n * Defines events that the layout system listens for\n *\n * 'changeTitle' - emit this from a contained item to update the title of the window that contains it.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Defines events that the layout system listens for\n *\n * 'changeTitle' - emit this from a contained item to update the title of the window that contains it.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1116,7 +1223,7 @@
           ],
           "fileUrlPath": "src/utils/events.ts",
           "isReadonly": true,
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "LayoutReceiveEvents",
           "variableTypeTokenRange": {
             "startIndex": 1,
@@ -1126,7 +1233,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-layout!LayoutReceiveEventsDetail:type",
-          "docComment": "/**\n * Defines the shape of the detail that the layout listens works with for events it listens on\n *\n * '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.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Defines the shape of the detail that the layout listens works with for events it listens on\n *\n * '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.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1142,7 +1249,7 @@
             }
           ],
           "fileUrlPath": "src/utils/events.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "LayoutReceiveEventsDetail",
           "typeTokenRange": {
             "startIndex": 1,
@@ -1152,7 +1259,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-layout!LayoutRegionType:type",
-          "docComment": "/**\n * Union type describing the three different types of region splits. Set on the `type` attribute on {@link FoundationLayoutRegion}.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Union type describing the three different types of region splits. Set on the `type` attribute on {@link FoundationLayoutRegion}.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1165,7 +1272,7 @@
             {
               "kind": "Reference",
               "text": "layoutRegionValue",
-              "canonicalReference": "@genesislcap/foundation-layout!layoutRegionValue:var"
+              "canonicalReference": "@genesislcap/foundation-layout!~layoutRegionValue:var"
             },
             {
               "kind": "Content",
@@ -1177,7 +1284,7 @@
             }
           ],
           "fileUrlPath": "src/utils/types.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "LayoutRegionType",
           "typeTokenRange": {
             "startIndex": 1,
@@ -1187,7 +1294,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-layout!LayoutRegistrationError:class",
-          "docComment": "/**\n * @beta\n */\n",
+          "docComment": "/**\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1204,7 +1311,7 @@
             }
           ],
           "fileUrlPath": "src/utils/error.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "isAbstract": false,
           "name": "LayoutRegistrationError",
           "preserveMemberOrder": false,
@@ -1227,7 +1334,7 @@
                   "text": ");"
                 }
               ],
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -1251,7 +1358,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-layout!layoutStyles:var",
-          "docComment": "/**\n * `ElementStyles` which defines the css for {@link FoundationLayout}.\n *\n * @remarks\n *\n * Can be used in a composition to customise the styles of the layout.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `ElementStyles` which defines the css for {@link FoundationLayout}.\n *\n * @remarks\n *\n * Can be used in a composition to customise the styles of the layout.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1269,7 +1376,7 @@
           ],
           "fileUrlPath": "src/styles/layout.styles.ts",
           "isReadonly": true,
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "layoutStyles",
           "variableTypeTokenRange": {
             "startIndex": 1,
@@ -1279,7 +1386,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-layout!layoutTemplate:var",
-          "docComment": "/**\n * `ViewTemplate` which defines the html for {@link FoundationLayout}.\n *\n * @remarks\n *\n * Can be used in a composition to customise the styles of the layout.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `ViewTemplate` which defines the html for {@link FoundationLayout}.\n *\n * @remarks\n *\n * Can be used in a composition to customise the styles of the layout.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1310,7 +1417,7 @@
           ],
           "fileUrlPath": "src/main/layout-main.ts",
           "isReadonly": true,
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "layoutTemplate",
           "variableTypeTokenRange": {
             "startIndex": 1,
@@ -1320,7 +1427,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-layout!LayoutUsageError:class",
-          "docComment": "/**\n * @beta\n */\n",
+          "docComment": "/**\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1337,7 +1444,7 @@
             }
           ],
           "fileUrlPath": "src/utils/error.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "isAbstract": false,
           "name": "LayoutUsageError",
           "preserveMemberOrder": false,
@@ -1360,7 +1467,7 @@
                   "text": ");"
                 }
               ],
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
@@ -1384,7 +1491,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-layout!Placement:type",
-          "docComment": "/**\n * Where to add the new item into the layout when using the {@link FoundationLayout.addItem} API\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Where to add the new item into the layout when using the {@link FoundationLayout.addItem} API\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1400,7 +1507,7 @@
             }
           ],
           "fileUrlPath": "src/utils/types.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "Placement",
           "typeTokenRange": {
             "startIndex": 1,
@@ -1410,7 +1517,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-layout!RegisteredElementConfig:interface",
-          "docComment": "/**\n * The parameters that can be set on a new item when being added by the {@link FoundationLayout.addItem} API\n *\n * @remarks\n *\n * `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)\n *\n * @beta\n */\n",
+          "docComment": "/**\n * The parameters that can be set on a new item when being added by the {@link FoundationLayout.addItem} API\n *\n * @remarks\n *\n * `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)\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1418,7 +1525,7 @@
             }
           ],
           "fileUrlPath": "src/utils/types.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "RegisteredElementConfig",
           "preserveMemberOrder": false,
           "members": [
@@ -1442,7 +1549,7 @@
               ],
               "isReadonly": false,
               "isOptional": true,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "closable",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1469,7 +1576,7 @@
               ],
               "isReadonly": false,
               "isOptional": false,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "registration",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1496,7 +1603,7 @@
               ],
               "isReadonly": false,
               "isOptional": true,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "size",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1523,7 +1630,7 @@
               ],
               "isReadonly": false,
               "isOptional": true,
-              "releaseTag": "Beta",
+              "releaseTag": "Public",
               "name": "title",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
@@ -1536,7 +1643,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-layout!SerialisedLayout:type",
-          "docComment": "/**\n * Versioned layout config objects. `v` is the version and `c` contains the layout config.\n *\n * @remarks\n *\n * 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.\n *\n * As more versions of configurations are added this type will have extra union types as part of SerialisedLayout.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Versioned layout config objects. `v` is the version and `c` contains the layout config.\n *\n * @remarks\n *\n * 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.\n *\n * As more versions of configurations are added this type will have extra union types as part of SerialisedLayout.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1561,7 +1668,7 @@
             }
           ],
           "fileUrlPath": "src/utils/types.ts",
-          "releaseTag": "Beta",
+          "releaseTag": "Public",
           "name": "SerialisedLayout",
           "typeTokenRange": {
             "startIndex": 1,