@genesislcap/foundation-layout 14.20.1 → 14.20.2-alpha-97d057d.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.
@@ -81,7 +81,7 @@ export declare class FoundationLayout extends FoundationElement implements Layou
81
81
  */
82
82
  /**
83
83
  * @public
84
- * Gets all of the required registration function names for a set of config
84
+ * Gets all of the required element registry function names for a set of config
85
85
  * @remarks
86
86
  * You can use this with {@link FoundationLayout.registeredItems | registeredItems} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()}
87
87
  * before loading the layout with {@link FoundationLayout.loadLayout | loadLayout()}
@@ -123,7 +123,7 @@ export class FoundationLayout extends FoundationElement {
123
123
  */
124
124
  /**
125
125
  * @public
126
- * Gets all of the required registration function names for a set of config
126
+ * Gets all of the required element registry function names for a set of config
127
127
  * @remarks
128
128
  * You can use this with {@link FoundationLayout.registeredItems | registeredItems} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()}
129
129
  * before loading the layout with {@link FoundationLayout.loadLayout | loadLayout()}
@@ -345,7 +345,7 @@ export class FoundationLayout extends FoundationElement {
345
345
  throw new LayoutRegistrationError(`Cannot register item with already registered name: '${reg}'`);
346
346
  }
347
347
  /**
348
- * What we need the registration function to do:
348
+ * What we need the element registry function to do:
349
349
  * "Consume" the registered elements initially, so we don't have duplicate items from the declarative API
350
350
  * We need to hold a master copy of the registered items
351
351
  * When an item is created at first, it is copied from the master copy so it behaves as expected
@@ -430,7 +430,7 @@
430
430
  {
431
431
  "kind": "Method",
432
432
  "canonicalReference": "@genesislcap/foundation-layout!FoundationLayout.layoutRequiredRegistrations:member(1)",
433
- "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",
433
+ "docComment": "/**\n * Gets all of the required element registry 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",
434
434
  "excerptTokens": [
435
435
  {
436
436
  "kind": "Content",
@@ -104,7 +104,7 @@ export declare class FoundationLayout extends FoundationElement implements Layou
104
104
  */
105
105
  /**
106
106
  * @public
107
- * Gets all of the required registration function names for a set of config
107
+ * Gets all of the required element registry function names for a set of config
108
108
  * @remarks
109
109
  * You can use this with {@link FoundationLayout.registeredItems | registeredItems} to work out what items you need to register with {@link FoundationLayout.registerItem | registerItem()}
110
110
  * before loading the layout with {@link FoundationLayout.loadLayout | loadLayout()}
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## FoundationLayout.layoutRequiredRegistrations() method
6
6
 
7
- Gets all of the required registration function names for a set of config
7
+ Gets all of the required element registry function names for a set of config
8
8
 
9
9
  **Signature:**
10
10
 
@@ -37,7 +37,7 @@ The constructor for this class is marked as internal. Third-party code should no
37
37
  | --- | --- | --- |
38
38
  | [addItem(config, placement)](./foundation-layout.foundationlayout.additem.md) | | Dynamically add a new item to the layout. The user can move the new plane to whenever they want once it has been added. |
39
39
  | [getLayout()](./foundation-layout.foundationlayout.getlayout.md) | | Gets a minified string containing the config describing the current layout of the layout object to later restore in [function](./foundation-layout.foundationlayout.loadlayout.md) |
40
- | [layoutRequiredRegistrations(layout)](./foundation-layout.foundationlayout.layoutrequiredregistrations.md) | <code>static</code> | Gets all of the required registration function names for a set of config |
40
+ | [layoutRequiredRegistrations(layout)](./foundation-layout.foundationlayout.layoutrequiredregistrations.md) | <code>static</code> | Gets all of the required element registry function names for a set of config |
41
41
  | [loadLayout(layout, handleMissingItem)](./foundation-layout.foundationlayout.loadlayout.md) | | Restores a layout described in the config from [getLayout()](./foundation-layout.foundationlayout.getlayout.md) |
42
42
  | [registeredItems()](./foundation-layout.foundationlayout.registereditems.md) | | Gets all of the currently registered names |
43
43
  | [registerItem(registration, elements)](./foundation-layout.foundationlayout.registeritem.md) | | Register a collection of <code>Element</code> and associate them with an <code>ID</code> with the layout system for later use. |
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-layout",
3
3
  "description": "Genesis Foundation UI App Layout",
4
- "version": "14.20.1",
4
+ "version": "14.20.2-alpha-97d057d.0",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-layout.d.ts",
@@ -38,8 +38,8 @@
38
38
  },
39
39
  "devDependencies": {
40
40
  "@custom-elements-manifest/analyzer": "^0.8.2",
41
- "@genesislcap/foundation-testing": "^14.20.1",
42
- "@genesislcap/genx": "^14.20.1",
41
+ "@genesislcap/foundation-testing": "14.20.2-alpha-97d057d.0",
42
+ "@genesislcap/genx": "14.20.2-alpha-97d057d.0",
43
43
  "@module-federation/dashboard-plugin": "2.3.0",
44
44
  "@pixability-ui/federated-types": "^0.2.0",
45
45
  "@playwright/test": "^1.18.1",
@@ -78,8 +78,8 @@
78
78
  },
79
79
  "dependencies": {
80
80
  "@genesis-community/golden-layout": "^2.9.3",
81
- "@genesislcap/foundation-comms": "^14.20.1",
82
- "@genesislcap/foundation-utils": "^14.20.1",
81
+ "@genesislcap/foundation-comms": "14.20.2-alpha-97d057d.0",
82
+ "@genesislcap/foundation-utils": "14.20.2-alpha-97d057d.0",
83
83
  "@microsoft/fast-components": "^2.21.3",
84
84
  "@microsoft/fast-element": "^1.7.0",
85
85
  "@microsoft/fast-foundation": "^2.33.2",
@@ -90,5 +90,5 @@
90
90
  "access": "public"
91
91
  },
92
92
  "customElements": "dist/custom-elements.json",
93
- "gitHead": "42802f45b0f6761369bb13c84cd8f8e30ce4fba1"
93
+ "gitHead": "0859360a22f4f1a102f0a9421ad77fd666a7b379"
94
94
  }