@genesislcap/foundation-layout 14.366.2-alpha-11da8b5.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.
- package/dist/custom-elements.json +142 -3
- package/dist/dts/index.d.ts +2 -1
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/main/layout-item.d.ts +20 -0
- package/dist/dts/main/layout-item.d.ts.map +1 -1
- package/dist/dts/main/layout-main.d.ts +36 -8
- package/dist/dts/main/layout-main.d.ts.map +1 -1
- package/dist/dts/utils/factory-registry.d.ts +64 -0
- package/dist/dts/utils/factory-registry.d.ts.map +1 -0
- package/dist/dts/utils/index.d.ts +1 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/dts/utils/types.d.ts +44 -3
- package/dist/dts/utils/types.d.ts.map +1 -1
- package/dist/esm/index.js +1 -0
- package/dist/esm/main/layout-item.js +26 -4
- package/dist/esm/main/layout-main.js +145 -46
- package/dist/esm/utils/factory-registry.js +89 -0
- package/dist/esm/utils/index.js +1 -0
- package/dist/foundation-layout.api.json +206 -9
- package/dist/foundation-layout.d.ts +157 -9
- package/docs/FRAMEWORK_COMPONENTS.md +568 -0
- package/docs/api/foundation-layout.componentfactory.md +46 -0
- package/docs/api/foundation-layout.foundationlayout.md +2 -2
- package/docs/api/foundation-layout.foundationlayout.registeritem.md +31 -7
- package/docs/api/foundation-layout.foundationlayoutitem.md +2 -0
- package/docs/api/foundation-layout.foundationlayoutitem.registration.md +18 -0
- package/docs/api/foundation-layout.getfactory.md +56 -0
- package/docs/api/foundation-layout.md +59 -0
- package/docs/api/foundation-layout.registerfactory.md +95 -0
- package/docs/api/foundation-layout.unregisterfactory.md +63 -0
- package/docs/api-report.md.api.md +20 -7
- package/package.json +12 -12
|
@@ -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
|
|
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
|
-
*
|
|
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
|
|
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,
|
|
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
|
-
|
|
550
|
-
|
|
551
|
-
|
|
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(
|
|
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
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
+
}
|
package/dist/esm/utils/index.js
CHANGED
|
@@ -184,6 +184,41 @@
|
|
|
184
184
|
"name": "",
|
|
185
185
|
"preserveMemberOrder": false,
|
|
186
186
|
"members": [
|
|
187
|
+
{
|
|
188
|
+
"kind": "TypeAlias",
|
|
189
|
+
"canonicalReference": "@genesislcap/foundation-layout!ComponentFactory:type",
|
|
190
|
+
"docComment": "/**\n * Factory function for creating component instances in the layout.\n *\n * @remarks\n *\n * This is the recommended approach for framework-rendered components (React, Angular, Vue, etc.) because it allows each layout instance to create a fresh component rather than cloning existing DOM elements (which loses event listeners and framework bindings).\n *\n * The factory function receives a container element and should render the component into it. Optionally, it can return a cleanup function that will be called when the component is removed from the layout.\n *\n * @param container - The HTMLElement container where the component should be rendered\n *\n * @returns Optional cleanup function to be called when the component is removed\n *\n * @example\n *\n * React example:\n * ```typescript\n * layout.registerItem('my-component', (container) => {\n * const root = createRoot(container);\n * root.render(<MyComponent />);\n * return () => root.unmount();\n * });\n * ```\n *\n * @example\n *\n * Angular example:\n * ```typescript\n * layout.registerItem('my-component', (container) => {\n * const componentRef = createComponent(MyComponent, {\n * environmentInjector: this.injector,\n * hostElement: container\n * });\n * return () => componentRef.destroy();\n * });\n * ```\n *\n * @public\n */\n",
|
|
191
|
+
"excerptTokens": [
|
|
192
|
+
{
|
|
193
|
+
"kind": "Content",
|
|
194
|
+
"text": "export type ComponentFactory = "
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"kind": "Content",
|
|
198
|
+
"text": "(container: "
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"kind": "Reference",
|
|
202
|
+
"text": "HTMLElement",
|
|
203
|
+
"canonicalReference": "!HTMLElement:interface"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"kind": "Content",
|
|
207
|
+
"text": ") => void | (() => void)"
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"kind": "Content",
|
|
211
|
+
"text": ";"
|
|
212
|
+
}
|
|
213
|
+
],
|
|
214
|
+
"fileUrlPath": "src/utils/types.ts",
|
|
215
|
+
"releaseTag": "Public",
|
|
216
|
+
"name": "ComponentFactory",
|
|
217
|
+
"typeTokenRange": {
|
|
218
|
+
"startIndex": 1,
|
|
219
|
+
"endIndex": 4
|
|
220
|
+
}
|
|
221
|
+
},
|
|
187
222
|
{
|
|
188
223
|
"kind": "TypeAlias",
|
|
189
224
|
"canonicalReference": "@genesislcap/foundation-layout!CustomButton:type",
|
|
@@ -871,7 +906,7 @@
|
|
|
871
906
|
{
|
|
872
907
|
"kind": "Method",
|
|
873
908
|
"canonicalReference": "@genesislcap/foundation-layout!FoundationLayout#registerItem:member(1)",
|
|
874
|
-
"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
|
|
909
|
+
"docComment": "/**\n * Register a collection of `Element` or a factory function and associate them with an `ID` with the layout system for later use.\n *\n * @remarks\n *\n * You can register either an array of elements or a factory function.\n *\n * **Element registration**: 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}. 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 * **Factory registration**: This is the recommended approach for framework-rendered components (React, Angular, Vue, etc.) because it allows each layout instance to create a fresh component rather than cloning existing DOM elements (which loses event listeners and framework bindings). The factory function will be called each time a new instance of the component is needed. It receives a container element and should render the component into it. Optionally, it can return a cleanup function that will be called when the component is removed from the layout.\n *\n * @param registration - string of the registration ID\n *\n * @param elementsOrFactory - Either Elements[] containing the reference to the elements to register, or a ComponentFactory function\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 * @example\n *\n * Element registration:\n * ```typescript\n * const div = document.createElement('div');\n * div.innerHTML = '<h1>Hello</h1>';\n * layout.registerItem('my-element', [div]);\n * ```\n *\n * @example\n *\n * Factory registration (React):\n * ```typescript\n * layout.registerItem('text-field', (container) => {\n * const root = createRoot(container);\n * root.render(<TextFieldComponent />);\n * return () => root.unmount();\n * });\n * ```\n *\n * @public\n */\n",
|
|
875
910
|
"excerptTokens": [
|
|
876
911
|
{
|
|
877
912
|
"kind": "Content",
|
|
@@ -883,7 +918,7 @@
|
|
|
883
918
|
},
|
|
884
919
|
{
|
|
885
920
|
"kind": "Content",
|
|
886
|
-
"text": ",
|
|
921
|
+
"text": ", elementsOrFactory: "
|
|
887
922
|
},
|
|
888
923
|
{
|
|
889
924
|
"kind": "Reference",
|
|
@@ -892,7 +927,12 @@
|
|
|
892
927
|
},
|
|
893
928
|
{
|
|
894
929
|
"kind": "Content",
|
|
895
|
-
"text": "[]"
|
|
930
|
+
"text": "[] | "
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"kind": "Reference",
|
|
934
|
+
"text": "ComponentFactory",
|
|
935
|
+
"canonicalReference": "@genesislcap/foundation-layout!ComponentFactory:type"
|
|
896
936
|
},
|
|
897
937
|
{
|
|
898
938
|
"kind": "Content",
|
|
@@ -909,8 +949,8 @@
|
|
|
909
949
|
],
|
|
910
950
|
"isStatic": false,
|
|
911
951
|
"returnTypeTokenRange": {
|
|
912
|
-
"startIndex":
|
|
913
|
-
"endIndex":
|
|
952
|
+
"startIndex": 7,
|
|
953
|
+
"endIndex": 8
|
|
914
954
|
},
|
|
915
955
|
"releaseTag": "Public",
|
|
916
956
|
"isProtected": false,
|
|
@@ -925,10 +965,10 @@
|
|
|
925
965
|
"isOptional": false
|
|
926
966
|
},
|
|
927
967
|
{
|
|
928
|
-
"parameterName": "
|
|
968
|
+
"parameterName": "elementsOrFactory",
|
|
929
969
|
"parameterTypeTokenRange": {
|
|
930
970
|
"startIndex": 3,
|
|
931
|
-
"endIndex":
|
|
971
|
+
"endIndex": 6
|
|
932
972
|
},
|
|
933
973
|
"isOptional": false
|
|
934
974
|
}
|
|
@@ -1311,7 +1351,7 @@
|
|
|
1311
1351
|
{
|
|
1312
1352
|
"kind": "Class",
|
|
1313
1353
|
"canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutItem:class",
|
|
1314
|
-
"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 * @tagname\n *\n * %%prefix%%-layout-item\n *\n * @public\n */\n",
|
|
1354
|
+
"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 * The item can either use slotted content or a factory function registered via {@link registerFactory}. When a factory is registered with the same name as the registration attribute, it takes precedence over slotted content.\n *\n * @tagname\n *\n * %%prefix%%-layout-item\n *\n * @public\n */\n",
|
|
1315
1355
|
"excerptTokens": [
|
|
1316
1356
|
{
|
|
1317
1357
|
"kind": "Content",
|
|
@@ -1375,7 +1415,7 @@
|
|
|
1375
1415
|
{
|
|
1376
1416
|
"kind": "Property",
|
|
1377
1417
|
"canonicalReference": "@genesislcap/foundation-layout!FoundationLayoutItem#registration:member",
|
|
1378
|
-
"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",
|
|
1418
|
+
"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 * When using the declarative API with framework components, register a factory function via {@link registerFactory} using the same name as this registration attribute.\n *\n * @example\n * ```typescript\n * import { registerFactory } from '@genesislcap/foundation-layout';\n * import { reactFactory } from './utils/react-layout-factory';\n *\n * // Register factory with the same name as the registration\n * registerFactory('my-component', reactFactory(MyComponent));\n * ```\n *\n * Then in JSX/HTML:\n * ```tsx\n * <rapid-layout-item registration=\"my-component\" title=\"My Component\" />\n * ```\n *\n * @public\n */\n",
|
|
1379
1419
|
"excerptTokens": [
|
|
1380
1420
|
{
|
|
1381
1421
|
"kind": "Content",
|
|
@@ -1581,6 +1621,56 @@
|
|
|
1581
1621
|
}
|
|
1582
1622
|
]
|
|
1583
1623
|
},
|
|
1624
|
+
{
|
|
1625
|
+
"kind": "Function",
|
|
1626
|
+
"canonicalReference": "@genesislcap/foundation-layout!getFactory:function(1)",
|
|
1627
|
+
"docComment": "/**\n * Retrieves a factory function by its key.\n *\n * @param key - The unique identifier for the factory.\n *\n * @returns The factory function, or undefined if not found.\n *\n * @public\n */\n",
|
|
1628
|
+
"excerptTokens": [
|
|
1629
|
+
{
|
|
1630
|
+
"kind": "Content",
|
|
1631
|
+
"text": "export declare function getFactory(key: "
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"kind": "Content",
|
|
1635
|
+
"text": "string"
|
|
1636
|
+
},
|
|
1637
|
+
{
|
|
1638
|
+
"kind": "Content",
|
|
1639
|
+
"text": "): "
|
|
1640
|
+
},
|
|
1641
|
+
{
|
|
1642
|
+
"kind": "Reference",
|
|
1643
|
+
"text": "ComponentFactory",
|
|
1644
|
+
"canonicalReference": "@genesislcap/foundation-layout!ComponentFactory:type"
|
|
1645
|
+
},
|
|
1646
|
+
{
|
|
1647
|
+
"kind": "Content",
|
|
1648
|
+
"text": " | undefined"
|
|
1649
|
+
},
|
|
1650
|
+
{
|
|
1651
|
+
"kind": "Content",
|
|
1652
|
+
"text": ";"
|
|
1653
|
+
}
|
|
1654
|
+
],
|
|
1655
|
+
"fileUrlPath": "src/utils/factory-registry.ts",
|
|
1656
|
+
"returnTypeTokenRange": {
|
|
1657
|
+
"startIndex": 3,
|
|
1658
|
+
"endIndex": 5
|
|
1659
|
+
},
|
|
1660
|
+
"releaseTag": "Public",
|
|
1661
|
+
"overloadIndex": 1,
|
|
1662
|
+
"parameters": [
|
|
1663
|
+
{
|
|
1664
|
+
"parameterName": "key",
|
|
1665
|
+
"parameterTypeTokenRange": {
|
|
1666
|
+
"startIndex": 1,
|
|
1667
|
+
"endIndex": 2
|
|
1668
|
+
},
|
|
1669
|
+
"isOptional": false
|
|
1670
|
+
}
|
|
1671
|
+
],
|
|
1672
|
+
"name": "getFactory"
|
|
1673
|
+
},
|
|
1584
1674
|
{
|
|
1585
1675
|
"kind": "Variable",
|
|
1586
1676
|
"canonicalReference": "@genesislcap/foundation-layout!LAYOUT_ICONS:var",
|
|
@@ -2227,6 +2317,68 @@
|
|
|
2227
2317
|
],
|
|
2228
2318
|
"extendsTokenRanges": []
|
|
2229
2319
|
},
|
|
2320
|
+
{
|
|
2321
|
+
"kind": "Function",
|
|
2322
|
+
"canonicalReference": "@genesislcap/foundation-layout!registerFactory:function(1)",
|
|
2323
|
+
"docComment": "/**\n * Registers a factory function with a unique key. This allows framework components to be used in the declarative layout API without needing to pass function references through HTML attributes.\n *\n * @param key - Unique identifier for the factory. Should be descriptive and unique across the application.\n *\n * @param factory - The factory function that creates the component.\n *\n * @throws\n *\n * {Error} If a factory with the same key is already registered.\n *\n * @example\n * ```typescript\n * // React example\n * import { registerFactory } from '@genesislcap/foundation-layout';\n * import { reactFactory } from './utils/react-layout-factory';\n * import { MyComponent } from './components/MyComponent';\n *\n * registerFactory('my-component', reactFactory(MyComponent, { someProp: 'value' }));\n * ```\n *\n * Then in your JSX:\n * ```tsx\n * <rapid-layout-item\n * registration=\"my-item\"\n * title=\"My Component\"\n * factory-key=\"my-component\"\n * />\n * ```\n *\n * @public\n */\n",
|
|
2324
|
+
"excerptTokens": [
|
|
2325
|
+
{
|
|
2326
|
+
"kind": "Content",
|
|
2327
|
+
"text": "export declare function registerFactory(key: "
|
|
2328
|
+
},
|
|
2329
|
+
{
|
|
2330
|
+
"kind": "Content",
|
|
2331
|
+
"text": "string"
|
|
2332
|
+
},
|
|
2333
|
+
{
|
|
2334
|
+
"kind": "Content",
|
|
2335
|
+
"text": ", factory: "
|
|
2336
|
+
},
|
|
2337
|
+
{
|
|
2338
|
+
"kind": "Reference",
|
|
2339
|
+
"text": "ComponentFactory",
|
|
2340
|
+
"canonicalReference": "@genesislcap/foundation-layout!ComponentFactory:type"
|
|
2341
|
+
},
|
|
2342
|
+
{
|
|
2343
|
+
"kind": "Content",
|
|
2344
|
+
"text": "): "
|
|
2345
|
+
},
|
|
2346
|
+
{
|
|
2347
|
+
"kind": "Content",
|
|
2348
|
+
"text": "void"
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
"kind": "Content",
|
|
2352
|
+
"text": ";"
|
|
2353
|
+
}
|
|
2354
|
+
],
|
|
2355
|
+
"fileUrlPath": "src/utils/factory-registry.ts",
|
|
2356
|
+
"returnTypeTokenRange": {
|
|
2357
|
+
"startIndex": 5,
|
|
2358
|
+
"endIndex": 6
|
|
2359
|
+
},
|
|
2360
|
+
"releaseTag": "Public",
|
|
2361
|
+
"overloadIndex": 1,
|
|
2362
|
+
"parameters": [
|
|
2363
|
+
{
|
|
2364
|
+
"parameterName": "key",
|
|
2365
|
+
"parameterTypeTokenRange": {
|
|
2366
|
+
"startIndex": 1,
|
|
2367
|
+
"endIndex": 2
|
|
2368
|
+
},
|
|
2369
|
+
"isOptional": false
|
|
2370
|
+
},
|
|
2371
|
+
{
|
|
2372
|
+
"parameterName": "factory",
|
|
2373
|
+
"parameterTypeTokenRange": {
|
|
2374
|
+
"startIndex": 3,
|
|
2375
|
+
"endIndex": 4
|
|
2376
|
+
},
|
|
2377
|
+
"isOptional": false
|
|
2378
|
+
}
|
|
2379
|
+
],
|
|
2380
|
+
"name": "registerFactory"
|
|
2381
|
+
},
|
|
2230
2382
|
{
|
|
2231
2383
|
"kind": "TypeAlias",
|
|
2232
2384
|
"canonicalReference": "@genesislcap/foundation-layout!SerialisedLayout:type",
|
|
@@ -2261,6 +2413,51 @@
|
|
|
2261
2413
|
"startIndex": 1,
|
|
2262
2414
|
"endIndex": 4
|
|
2263
2415
|
}
|
|
2416
|
+
},
|
|
2417
|
+
{
|
|
2418
|
+
"kind": "Function",
|
|
2419
|
+
"canonicalReference": "@genesislcap/foundation-layout!unregisterFactory:function(1)",
|
|
2420
|
+
"docComment": "/**\n * Removes a factory from the registry. This is useful for cleanup when a component is unmounted or no longer needed.\n *\n * @param key - The unique identifier for the factory to remove.\n *\n * @returns True if the factory was found and removed, false otherwise.\n *\n * @example\n * ```typescript\n * unregisterFactory('my-component');\n * ```\n *\n * @public\n */\n",
|
|
2421
|
+
"excerptTokens": [
|
|
2422
|
+
{
|
|
2423
|
+
"kind": "Content",
|
|
2424
|
+
"text": "export declare function unregisterFactory(key: "
|
|
2425
|
+
},
|
|
2426
|
+
{
|
|
2427
|
+
"kind": "Content",
|
|
2428
|
+
"text": "string"
|
|
2429
|
+
},
|
|
2430
|
+
{
|
|
2431
|
+
"kind": "Content",
|
|
2432
|
+
"text": "): "
|
|
2433
|
+
},
|
|
2434
|
+
{
|
|
2435
|
+
"kind": "Content",
|
|
2436
|
+
"text": "boolean"
|
|
2437
|
+
},
|
|
2438
|
+
{
|
|
2439
|
+
"kind": "Content",
|
|
2440
|
+
"text": ";"
|
|
2441
|
+
}
|
|
2442
|
+
],
|
|
2443
|
+
"fileUrlPath": "src/utils/factory-registry.ts",
|
|
2444
|
+
"returnTypeTokenRange": {
|
|
2445
|
+
"startIndex": 3,
|
|
2446
|
+
"endIndex": 4
|
|
2447
|
+
},
|
|
2448
|
+
"releaseTag": "Public",
|
|
2449
|
+
"overloadIndex": 1,
|
|
2450
|
+
"parameters": [
|
|
2451
|
+
{
|
|
2452
|
+
"parameterName": "key",
|
|
2453
|
+
"parameterTypeTokenRange": {
|
|
2454
|
+
"startIndex": 1,
|
|
2455
|
+
"endIndex": 2
|
|
2456
|
+
},
|
|
2457
|
+
"isOptional": false
|
|
2458
|
+
}
|
|
2459
|
+
],
|
|
2460
|
+
"name": "unregisterFactory"
|
|
2264
2461
|
}
|
|
2265
2462
|
]
|
|
2266
2463
|
}
|