@genesislcap/foundation-layout 14.367.0 → 14.367.1-FUI-2341-3.2

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 (32) hide show
  1. package/dist/custom-elements.json +245 -106
  2. package/dist/dts/index.d.ts +2 -1
  3. package/dist/dts/index.d.ts.map +1 -1
  4. package/dist/dts/main/layout-item.d.ts +20 -0
  5. package/dist/dts/main/layout-item.d.ts.map +1 -1
  6. package/dist/dts/main/layout-main.d.ts +36 -8
  7. package/dist/dts/main/layout-main.d.ts.map +1 -1
  8. package/dist/dts/utils/factory-registry.d.ts +64 -0
  9. package/dist/dts/utils/factory-registry.d.ts.map +1 -0
  10. package/dist/dts/utils/index.d.ts +1 -0
  11. package/dist/dts/utils/index.d.ts.map +1 -1
  12. package/dist/dts/utils/types.d.ts +44 -3
  13. package/dist/dts/utils/types.d.ts.map +1 -1
  14. package/dist/esm/index.js +1 -0
  15. package/dist/esm/main/layout-item.js +26 -4
  16. package/dist/esm/main/layout-main.js +145 -46
  17. package/dist/esm/utils/factory-registry.js +89 -0
  18. package/dist/esm/utils/index.js +1 -0
  19. package/dist/foundation-layout.api.json +206 -9
  20. package/dist/foundation-layout.d.ts +157 -9
  21. package/docs/FRAMEWORK_COMPONENTS.md +568 -0
  22. package/docs/api/foundation-layout.componentfactory.md +46 -0
  23. package/docs/api/foundation-layout.foundationlayout.md +2 -2
  24. package/docs/api/foundation-layout.foundationlayout.registeritem.md +31 -7
  25. package/docs/api/foundation-layout.foundationlayoutitem.md +2 -0
  26. package/docs/api/foundation-layout.foundationlayoutitem.registration.md +18 -0
  27. package/docs/api/foundation-layout.getfactory.md +56 -0
  28. package/docs/api/foundation-layout.md +59 -0
  29. package/docs/api/foundation-layout.registerfactory.md +95 -0
  30. package/docs/api/foundation-layout.unregisterfactory.md +63 -0
  31. package/docs/api-report.md.api.md +20 -7
  32. package/package.json +12 -12
@@ -0,0 +1,64 @@
1
+ import type { ComponentFactory } from './types';
2
+ /**
3
+ * Registers a factory function with a unique key.
4
+ * This allows framework components to be used in the declarative layout API
5
+ * without needing to pass function references through HTML attributes.
6
+ *
7
+ * @param key - Unique identifier for the factory. Should be descriptive and unique across the application.
8
+ * @param factory - The factory function that creates the component.
9
+ * @throws {Error} If a factory with the same key is already registered.
10
+ *
11
+ * @example
12
+ * ```typescript
13
+ * // React example
14
+ * import { registerFactory } from '@genesislcap/foundation-layout';
15
+ * import { reactFactory } from './utils/react-layout-factory';
16
+ * import { MyComponent } from './components/MyComponent';
17
+ *
18
+ * registerFactory('my-component', reactFactory(MyComponent, { someProp: 'value' }));
19
+ * ```
20
+ *
21
+ * Then in your JSX:
22
+ * ```tsx
23
+ * <rapid-layout-item
24
+ * registration="my-item"
25
+ * title="My Component"
26
+ * factory-key="my-component"
27
+ * />
28
+ * ```
29
+ *
30
+ * @public
31
+ */
32
+ export declare function registerFactory(key: string, factory: ComponentFactory): void;
33
+ /**
34
+ * Retrieves a factory function by its key.
35
+ *
36
+ * @param key - The unique identifier for the factory.
37
+ * @returns The factory function, or undefined if not found.
38
+ *
39
+ * @public
40
+ */
41
+ export declare function getFactory(key: string): ComponentFactory | undefined;
42
+ /**
43
+ * Removes a factory from the registry.
44
+ * This is useful for cleanup when a component is unmounted or no longer needed.
45
+ *
46
+ * @param key - The unique identifier for the factory to remove.
47
+ * @returns True if the factory was found and removed, false otherwise.
48
+ *
49
+ * @example
50
+ * ```typescript
51
+ * unregisterFactory('my-component');
52
+ * ```
53
+ *
54
+ * @public
55
+ */
56
+ export declare function unregisterFactory(key: string): boolean;
57
+ /**
58
+ * Clears all registered factories from the registry.
59
+ * This is primarily useful for testing purposes.
60
+ *
61
+ * @internal
62
+ */
63
+ export declare function clearFactoryRegistry(): void;
64
+ //# sourceMappingURL=factory-registry.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"factory-registry.d.ts","sourceRoot":"","sources":["../../../src/utils/factory-registry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAShD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAQ5E;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAEpE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAQtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAG3C"}
@@ -1,6 +1,7 @@
1
1
  export * from './constants';
2
2
  export * from './error';
3
3
  export * from './events';
4
+ export * from './factory-registry';
4
5
  export * from './misc';
5
6
  export * from './templates';
6
7
  export * from './types';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
@@ -134,11 +134,52 @@ export type InstanceContainer = {
134
134
  export type LayoutComponentItem<T> = Element & Partial<LayoutComponentWithState<T>> & {
135
135
  [instanceContainer]?: InstanceContainer;
136
136
  };
137
+ /**
138
+ * @public
139
+ * Factory function for creating component instances in the layout.
140
+ * @remarks
141
+ * This is the recommended approach for framework-rendered components (React, Angular, Vue, etc.)
142
+ * because it allows each layout instance to create a fresh component rather than cloning existing
143
+ * DOM elements (which loses event listeners and framework bindings).
144
+ *
145
+ * The factory function receives a container element and should render the component into it.
146
+ * Optionally, it can return a cleanup function that will be called when the component is removed
147
+ * from the layout.
148
+ *
149
+ * @param container - The HTMLElement container where the component should be rendered
150
+ * @returns Optional cleanup function to be called when the component is removed
151
+ *
152
+ * @example
153
+ * React example:
154
+ * ```typescript
155
+ * layout.registerItem('my-component', (container) => {
156
+ * const root = createRoot(container);
157
+ * root.render(<MyComponent />);
158
+ * return () => root.unmount();
159
+ * });
160
+ * ```
161
+ *
162
+ * @example
163
+ * Angular example:
164
+ * ```typescript
165
+ * layout.registerItem('my-component', (container) => {
166
+ * const componentRef = createComponent(MyComponent, {
167
+ * environmentInjector: this.injector,
168
+ * hostElement: container
169
+ * });
170
+ * return () => componentRef.destroy();
171
+ * });
172
+ * ```
173
+ */
174
+ export type ComponentFactory = (container: HTMLElement) => void | (() => void);
137
175
  /** @internal */
138
- export interface RegistrationConfig {
139
- elements: Element[];
176
+ export type RegistrationConfig = {
140
177
  id?: string;
141
- }
178
+ } & ({
179
+ elements: Element[];
180
+ } | {
181
+ factory: ComponentFactory;
182
+ });
142
183
  /** @internal */
143
184
  export declare const layoutRegionValue: readonly ["horizontal", "vertical", "tabs"];
144
185
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC5F,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,EAAE,GAAG,CAAC;IACP,CAAC,EAAE,oBAAoB,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAoDK;AACL,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC;;OAEG;IACH,eAAe,IAAI,CAAC,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;CACnC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,gBAAgB,CAAC;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,OAAO,GAC1C,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,GAAG;IACrC,CAAC,iBAAiB,CAAC,CAAC,EAAE,iBAAiB,CAAC;CACzC,CAAC;AAEJ,gBAAgB;AAChB,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,6CAA8C,CAAC;AAC7E;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAClE,gBAAgB;AAChB,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEhE,gBAAgB;AAChB,MAAM,WAAW,eAAe;IAC9B,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IAChC,wBAAwB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC7D,mBAAmB,IAAI,IAAI,CAAC;CAC7B;AAED,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACrB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC5F,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;CAC9D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,EAAE,GAAG,CAAC;IACP,CAAC,EAAE,oBAAoB,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAoDK;AACL,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC;;OAEG;IACH,eAAe,IAAI,CAAC,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;CACnC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,gBAAgB,CAAC;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,OAAO,GAC1C,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,GAAG;IACrC,CAAC,iBAAiB,CAAC,CAAC,EAAE,iBAAiB,CAAC;CACzC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,WAAW,KAAK,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;AAE/E,gBAAgB;AAChB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,GAAG,CACA;IACE,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,GACD;IACE,OAAO,EAAE,gBAAgB,CAAC;CAC3B,CACJ,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,6CAA8C,CAAC;AAC7E;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAClE,gBAAgB;AAChB,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEhE,gBAAgB;AAChB,MAAM,WAAW,eAAe;IAC9B,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IAChC,wBAAwB,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC7D,mBAAmB,IAAI,IAAI,CAAC;CAC7B;AAED,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACrB,CAAC"}
package/dist/esm/index.js CHANGED
@@ -1,3 +1,4 @@
1
1
  export * from './main';
2
2
  export { LAYOUT_ICONS } from './styles';
3
3
  export { DEFAULT_RELOAD_BUFFER, LayoutEmitEvents, LayoutReceiveEvents, LayoutRegistrationError, LayoutUsageError, LAYOUT_POPOUT_CONTAINER_CLASS, } from './utils';
4
+ export { registerFactory, getFactory, unregisterFactory } from './utils/factory-registry';
@@ -3,6 +3,8 @@ import { __decorate } from "tslib";
3
3
  import { attr } from '@microsoft/fast-element';
4
4
  import { FoundationElement } from '@microsoft/fast-foundation';
5
5
  import { componentType, getParentLayoutComponent, wrapperTemplate, } from '../utils';
6
+ import { LayoutUsageError } from '../utils/error';
7
+ import { getFactory } from '../utils/factory-registry';
6
8
  /**
7
9
  * @public
8
10
  * `FoundationLayoutItem` is a custom element that represents an item in the layout.
@@ -10,6 +12,9 @@ import { componentType, getParentLayoutComponent, wrapperTemplate, } from '../ut
10
12
  * This element is used to wrap html elements and configure their layout settings as part of the layout system.
11
13
  *
12
14
  * 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}.
15
+ *
16
+ * The item can either use slotted content or a factory function registered via {@link registerFactory}.
17
+ * When a factory is registered with the same name as the registration attribute, it takes precedence over slotted content.
13
18
  * @tagname %%prefix%%-layout-item
14
19
  */
15
20
  export class FoundationLayoutItem extends FoundationElement {
@@ -28,11 +33,28 @@ export class FoundationLayoutItem extends FoundationElement {
28
33
  connectedCallback() {
29
34
  var _b;
30
35
  super.connectedCallback();
36
+ let registeredID;
37
+ // Look up factory from registry using registration name
38
+ const factory = getFactory(this.registration);
39
+ // Get slotted elements to check for conflicts
31
40
  this.slottedElements = this.shadowRoot.querySelector('slot.target').assignedElements();
32
- const registeredID = this.cacheElementsAndRegister({
33
- elements: this.slottedElements,
34
- id: this.registration,
35
- });
41
+ // Validate: cannot have both factory and slotted content
42
+ if (factory && this.slottedElements.length > 0) {
43
+ throw new LayoutUsageError(`Cannot use both factory registration and slotted content for registration "${this.registration}". ` +
44
+ `Either register a factory via registerFactory() OR provide slotted content, but not both.`);
45
+ }
46
+ if (factory) {
47
+ registeredID = this.cacheElementsAndRegister({
48
+ factory: factory,
49
+ id: this.registration,
50
+ });
51
+ }
52
+ else {
53
+ registeredID = this.cacheElementsAndRegister({
54
+ elements: this.slottedElements,
55
+ id: this.registration,
56
+ });
57
+ }
36
58
  const itemConfig = {
37
59
  type: 'component',
38
60
  componentType: registeredID,
@@ -8,6 +8,7 @@ import { FoundationElement } from '@microsoft/fast-foundation';
8
8
  import { globalDraggingStyles, glVisualConfig, LAYOUT_ICONS, layoutStyles } from '../styles';
9
9
  import { AUTOSAVE_KEY, componentType, DEFAULT_RELOAD_BUFFER, getMissingArrayItems, instanceContainer, LAYOUT_POPOUT_CONTAINER_CLASS, LAYOUT_POPOUT_CONTROL_KEY, LayoutEmitEvents, LayoutReceiveEvents, regionConveter, } from '../utils/';
10
10
  import { LayoutRegistrationError, LayoutUsageError } from '../utils/error';
11
+ import { getFactory } from '../utils/factory-registry';
11
12
  import { logger } from '../utils/logger';
12
13
  export { layoutStyles } from '../styles';
13
14
  /*
@@ -248,6 +249,13 @@ export class FoundationLayout extends FoundationElement {
248
249
  return;
249
250
  const orderedStates = [...items].map((item) => { var _b; return (_b = item.getCurrentState) === null || _b === void 0 ? void 0 : _b.call(item); });
250
251
  const componentInstanceContainer = items[0][instanceContainer];
252
+ // TODO: Factory based components dont handle the LayoutWithState interface, so we need to handle this differently.
253
+ // For now we will just log a warning and return. We need to assess whether to deprecate that interface and handle it in TAM directly
254
+ // or whether adding support is needed
255
+ if (!componentInstanceContainer) {
256
+ logger.warn('Component instance container not found for items:', items);
257
+ return;
258
+ }
251
259
  // known use of deprecated API, but there is no other way of implementing it and we control
252
260
  // the underlying library anyway
253
261
  componentInstanceContainer.container.setState({
@@ -528,28 +536,70 @@ export class FoundationLayout extends FoundationElement {
528
536
  }
529
537
  /**
530
538
  * @public
531
- * Register a collection of `Element` and associate them with an `ID` with the layout system for later use.
539
+ * Register a collection of `Element` or a factory function and associate them with an `ID` with the layout system for later use.
532
540
  * @remarks
533
- * You would use this to register elements that you later want to load when using {@link FoundationLayout.loadLayout}.
541
+ * You can register either an array of elements or a factory function.
542
+ *
543
+ * **Element registration**: Use this to register elements that you later want to load when using {@link FoundationLayout.loadLayout}.
534
544
  * Use {@link FoundationLayout.layoutRequiredRegistrations} to see what components need to be registered for a certain config
535
545
  * and then register them using this function before calling {@link FoundationLayout.loadLayout}.
546
+ * 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.
547
+ * If you want to avoid this you can pass copies using `element.cloneNode(true)`.
536
548
  *
537
- * 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)`.
549
+ * **Factory registration**: This is the recommended approach for framework-rendered components (React, Angular, Vue, etc.)
550
+ * because it allows each layout instance to create a fresh component rather than cloning existing
551
+ * DOM elements (which loses event listeners and framework bindings).
552
+ * The factory function will be called each time a new instance of the component is needed. It receives
553
+ * a container element and should render the component into it. Optionally, it can return a cleanup
554
+ * function that will be called when the component is removed from the layout.
538
555
  *
539
556
  * @param registration - string of the registration ID
540
- * @param elements - Elements[] containing the reference to the elements to register for later usage
557
+ * @param elementsOrFactory - Either Elements[] containing the reference to the elements to register, or a ComponentFactory function
541
558
  * @throws {@link LayoutUsageError} if you attempt to add an item before the layout has been initialised.
542
559
  * @throws {@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).
543
560
  * @returns - string defining the name of the registered item with the layout system (config.id if set).
561
+ *
562
+ * @example
563
+ * Element registration:
564
+ * ```typescript
565
+ * const div = document.createElement('div');
566
+ * div.innerHTML = '<h1>Hello</h1>';
567
+ * layout.registerItem('my-element', [div]);
568
+ * ```
569
+ *
570
+ * @example
571
+ * Factory registration (React):
572
+ * ```typescript
573
+ * layout.registerItem('text-field', (container) => {
574
+ * const root = createRoot(container);
575
+ * root.render(<TextFieldComponent />);
576
+ * return () => root.unmount();
577
+ * });
578
+ * ```
544
579
  */
545
- registerItem(registration, elements) {
580
+ registerItem(registration, elementsOrFactory) {
546
581
  if (!this.layout.isInitialised) {
547
582
  throw new LayoutUsageError('Cannot add item via JS API until initialised');
548
583
  }
549
- return this.cacheElementsAndRegister({
550
- elements: elements,
551
- id: registration,
552
- });
584
+ // Check if a factory is already registered with this name
585
+ const existingFactory = getFactory(registration);
586
+ if (existingFactory) {
587
+ throw new LayoutRegistrationError(`Registration "${registration}" already has a factory registered via registerFactory(). ` +
588
+ `Cannot register the same name via the JavaScript API. ` +
589
+ `Use a different registration name or unregister the factory first.`);
590
+ }
591
+ if (typeof elementsOrFactory === 'function') {
592
+ return this.cacheElementsAndRegister({
593
+ factory: elementsOrFactory,
594
+ id: registration,
595
+ });
596
+ }
597
+ else {
598
+ return this.cacheElementsAndRegister({
599
+ elements: elementsOrFactory,
600
+ id: registration,
601
+ });
602
+ }
553
603
  }
554
604
  /**
555
605
  * Internal APIs
@@ -610,13 +660,14 @@ export class FoundationLayout extends FoundationElement {
610
660
  /**
611
661
  * Registers a function with golden layout to create a pane
612
662
  * @param elements - Elements[] to add to new new pane
663
+ * @param factory - ComponentFactory function to create component instances
613
664
  * @param id - optional string which is used to register the new function with golden layout. Defaults to sequentially setting the IDs for default items
614
665
  * @returns - string which is the registered ID
615
666
  * @throws - {@link LayoutRegistrationError} if the id is already in use
616
667
  * @internal
617
668
  */
618
- cacheElementsAndRegister({ elements, id }) {
619
- const reg = id || `${(this.registeredComponents += 1)}`;
669
+ cacheElementsAndRegister(config) {
670
+ const reg = config.id || `${(this.registeredComponents += 1)}`;
620
671
  if (this.layout.getRegisteredComponentTypeNames().includes(reg)) {
621
672
  throw new LayoutRegistrationError(`Cannot register item with already registered name: '${reg}'`);
622
673
  }
@@ -632,45 +683,93 @@ export class FoundationLayout extends FoundationElement {
632
683
  *
633
684
  * As part of creating each instance we attach a reference to the instance container which is used
634
685
  * to be able to optionally save state, and any state which has been saved we apply to the component.
686
+ *
687
+ * For factory functions:
688
+ * The factory is called for each new instance instead of cloning. This preserves event listeners
689
+ * and framework bindings that would be lost during cloning.
635
690
  */
636
691
  const registrationFunction = (() => {
637
- // Use appendChild to consume the elements and save them in the master copy
638
- const masterCopy = document.createDocumentFragment();
639
- masterCopy[layoutCacheDocument] = true;
640
- elements.forEach((e) => masterCopy.appendChild(e));
641
- const instances = new Map();
642
- return (container, state) => {
643
- var _b;
644
- // If this is a new instance then assign it uuid instance
645
- if (!(state === null || state === void 0 ? void 0 : state['instance'])) {
646
- state['instance'] = this.uuid.createId();
647
- }
648
- container.state['instance'] = state['instance'];
649
- container.state['originalTitle'] = (_b = state['originalTitle']) !== null && _b !== void 0 ? _b : container.title;
650
- // If this is a new instance then copy the master copy into the instances map
651
- // this is then the instance that is recalled for this version each time
652
- // the key point is "cloneNode" which makes a copy at this point
653
- if (!instances.has(state === null || state === void 0 ? void 0 : state['instance'])) {
654
- const instanceCopy = document.createDocumentFragment();
655
- Array.from(masterCopy.children).forEach((e) => {
656
- instanceCopy.appendChild(e.cloneNode(true));
692
+ if ('factory' in config) {
693
+ // Factory-based registration for framework components
694
+ const instances = new Map();
695
+ const cleanupFunctions = new Map();
696
+ return (container, state) => {
697
+ var _b;
698
+ // If this is a new instance then assign it uuid instance
699
+ if (!(state === null || state === void 0 ? void 0 : state['instance'])) {
700
+ state['instance'] = this.uuid.createId();
701
+ }
702
+ container.state['instance'] = state['instance'];
703
+ container.state['originalTitle'] = (_b = state['originalTitle']) !== null && _b !== void 0 ? _b : container.title;
704
+ // Store instance container reference for state management FIRST
705
+ const componentInstanceContainer = {
706
+ container,
707
+ instance: state['instance'],
708
+ registration: reg,
709
+ };
710
+ // If this is a new instance, call the factory to create it
711
+ if (!instances.has(state === null || state === void 0 ? void 0 : state['instance'])) {
712
+ const componentContainer = document.createElement('div');
713
+ componentContainer.style.width = '100%';
714
+ componentContainer.style.height = '100%';
715
+ componentContainer[instanceContainer] = componentInstanceContainer;
716
+ const cleanup = config.factory(componentContainer);
717
+ instances.set(state['instance'], componentContainer);
718
+ if (cleanup) {
719
+ cleanupFunctions.set(state['instance'], cleanup);
720
+ }
721
+ }
722
+ // Append the instance container to the layout container
723
+ const componentContainer = instances.get(state['instance']);
724
+ if (!componentContainer) {
725
+ logger.error(`Failed to get component container for instance ${state['instance']}`);
726
+ return;
727
+ }
728
+ // Ensure the property is set (in case it was lost)
729
+ componentContainer[instanceContainer] = componentInstanceContainer;
730
+ container.element.appendChild(componentContainer);
731
+ this.setupLayoutReceiveEvents(container, state);
732
+ };
733
+ }
734
+ else {
735
+ // Element-based registration (existing behavior)
736
+ const masterCopy = document.createDocumentFragment();
737
+ masterCopy[layoutCacheDocument] = true;
738
+ config.elements.forEach((e) => masterCopy.appendChild(e));
739
+ const instances = new Map();
740
+ return (container, state) => {
741
+ var _b;
742
+ // If this is a new instance then assign it uuid instance
743
+ if (!(state === null || state === void 0 ? void 0 : state['instance'])) {
744
+ state['instance'] = this.uuid.createId();
745
+ }
746
+ container.state['instance'] = state['instance'];
747
+ container.state['originalTitle'] = (_b = state['originalTitle']) !== null && _b !== void 0 ? _b : container.title;
748
+ // If this is a new instance then copy the master copy into the instances map
749
+ // this is then the instance that is recalled for this version each time
750
+ // the key point is "cloneNode" which makes a copy at this point
751
+ if (!instances.has(state === null || state === void 0 ? void 0 : state['instance'])) {
752
+ const instanceCopy = document.createDocumentFragment();
753
+ Array.from(masterCopy.children).forEach((e) => {
754
+ instanceCopy.appendChild(e.cloneNode(true));
755
+ });
756
+ instances.set(state['instance'], [...instanceCopy.children]);
757
+ }
758
+ // provide each component with a reference to the instance container
759
+ // so they can optionally save and load their own state
760
+ const componentInstanceContainer = {
761
+ container,
762
+ instance: state['instance'],
763
+ registration: reg,
764
+ };
765
+ // get the instance from the map and append it to the container
766
+ instances.get(state['instance']).forEach((component) => {
767
+ container.element.appendChild(component);
768
+ component[instanceContainer] = componentInstanceContainer;
657
769
  });
658
- instances.set(state['instance'], [...instanceCopy.children]);
659
- }
660
- // provide each component with a reference to the instance container
661
- // so they can optionally save and load their own state
662
- const componentInstanceContainer = {
663
- container,
664
- instance: state['instance'],
665
- registration: reg,
770
+ this.setupLayoutReceiveEvents(container, state);
666
771
  };
667
- // get the instance from the map and append it to the container
668
- instances.get(state['instance']).forEach((component) => {
669
- container.element.appendChild(component);
670
- component[instanceContainer] = componentInstanceContainer;
671
- });
672
- this.setupLayoutReceiveEvents(container, state);
673
- };
772
+ }
674
773
  })();
675
774
  this.layout.registerComponentFactoryFunction(reg, registrationFunction);
676
775
  return reg;
@@ -0,0 +1,89 @@
1
+ import { logger } from './logger';
2
+ /**
3
+ * Global registry for component factories.
4
+ * Maps factory keys (strings) to factory functions.
5
+ * @internal
6
+ */
7
+ const factoryRegistry = new Map();
8
+ /**
9
+ * Registers a factory function with a unique key.
10
+ * This allows framework components to be used in the declarative layout API
11
+ * without needing to pass function references through HTML attributes.
12
+ *
13
+ * @param key - Unique identifier for the factory. Should be descriptive and unique across the application.
14
+ * @param factory - The factory function that creates the component.
15
+ * @throws {Error} If a factory with the same key is already registered.
16
+ *
17
+ * @example
18
+ * ```typescript
19
+ * // React example
20
+ * import { registerFactory } from '@genesislcap/foundation-layout';
21
+ * import { reactFactory } from './utils/react-layout-factory';
22
+ * import { MyComponent } from './components/MyComponent';
23
+ *
24
+ * registerFactory('my-component', reactFactory(MyComponent, { someProp: 'value' }));
25
+ * ```
26
+ *
27
+ * Then in your JSX:
28
+ * ```tsx
29
+ * <rapid-layout-item
30
+ * registration="my-item"
31
+ * title="My Component"
32
+ * factory-key="my-component"
33
+ * />
34
+ * ```
35
+ *
36
+ * @public
37
+ */
38
+ export function registerFactory(key, factory) {
39
+ if (factoryRegistry.has(key)) {
40
+ throw new Error(`Factory with key "${key}" is already registered. Cannot register duplicate factory.`);
41
+ }
42
+ factoryRegistry.set(key, factory);
43
+ logger.debug(`Factory registered with key: ${key}`);
44
+ }
45
+ /**
46
+ * Retrieves a factory function by its key.
47
+ *
48
+ * @param key - The unique identifier for the factory.
49
+ * @returns The factory function, or undefined if not found.
50
+ *
51
+ * @public
52
+ */
53
+ export function getFactory(key) {
54
+ return factoryRegistry.get(key);
55
+ }
56
+ /**
57
+ * Removes a factory from the registry.
58
+ * This is useful for cleanup when a component is unmounted or no longer needed.
59
+ *
60
+ * @param key - The unique identifier for the factory to remove.
61
+ * @returns True if the factory was found and removed, false otherwise.
62
+ *
63
+ * @example
64
+ * ```typescript
65
+ * unregisterFactory('my-component');
66
+ * ```
67
+ *
68
+ * @public
69
+ */
70
+ export function unregisterFactory(key) {
71
+ const deleted = factoryRegistry.delete(key);
72
+ if (deleted) {
73
+ logger.debug(`Factory unregistered with key: ${key}`);
74
+ }
75
+ else {
76
+ logger.warn(`Attempted to unregister factory with key "${key}", but it was not found.`);
77
+ }
78
+ return deleted;
79
+ }
80
+ /**
81
+ * Clears all registered factories from the registry.
82
+ * This is primarily useful for testing purposes.
83
+ *
84
+ * @internal
85
+ */
86
+ export function clearFactoryRegistry() {
87
+ factoryRegistry.clear();
88
+ logger.debug('Factory registry cleared');
89
+ }
@@ -1,6 +1,7 @@
1
1
  export * from './constants';
2
2
  export * from './error';
3
3
  export * from './events';
4
+ export * from './factory-registry';
4
5
  export * from './misc';
5
6
  export * from './templates';
6
7
  export * from './types';