@cntrl-site/sdk-nextjs 1.10.14 → 1.10.16
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/jest.config.js +4 -1
- package/lib/common/useComponentElement.js +40 -0
- package/lib/components/Navigation/NavigationComponent.js +5 -4
- package/lib/components/StructuredBlockItem/StructuredComponent/StructuredComponent.js +6 -5
- package/lib/components/items/ComponentItem/ComponentItem.js +7 -6
- package/lib/provider/CntrlSdkContext.js +0 -7
- package/package.json +3 -3
- package/src/common/useComponentElement.test.ts +71 -0
- package/src/common/useComponentElement.ts +48 -0
- package/src/components/Navigation/NavigationComponent.tsx +7 -4
- package/src/components/StructuredBlockItem/StructuredComponent/StructuredComponent.tsx +7 -4
- package/src/components/items/ComponentItem/ComponentItem.tsx +8 -5
- package/src/provider/CntrlSdkContext.ts +1 -8
package/jest.config.js
CHANGED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.useComponentElement = exports.pendingElementProps = void 0;
|
|
4
|
+
const react_1 = require("react");
|
|
5
|
+
const elements_1 = require("@cntrl-site/components/elements");
|
|
6
|
+
const useCntrlContext_1 = require("../provider/useCntrlContext");
|
|
7
|
+
exports.pendingElementProps = {
|
|
8
|
+
dangerouslySetInnerHTML: { __html: '' },
|
|
9
|
+
suppressHydrationWarning: true
|
|
10
|
+
};
|
|
11
|
+
function useComponentElement(componentId) {
|
|
12
|
+
var _a, _b;
|
|
13
|
+
const sdk = (0, useCntrlContext_1.useCntrlContext)();
|
|
14
|
+
const [, refresh] = (0, react_1.useReducer)((count) => count + 1, 0);
|
|
15
|
+
const Element = (_b = (_a = sdk.getComponent(componentId)) === null || _a === void 0 ? void 0 : _a.element) !== null && _b !== void 0 ? _b : (0, elements_1.getComponentElement)(componentId);
|
|
16
|
+
const isLoading = !Element && (0, elements_1.hasComponentElement)(componentId);
|
|
17
|
+
const isFailed = isLoading && (0, elements_1.hasComponentElementFailed)(componentId);
|
|
18
|
+
const isPending = isLoading && !isFailed;
|
|
19
|
+
if (isPending) {
|
|
20
|
+
(0, elements_1.loadComponentElement)(componentId).catch(() => undefined);
|
|
21
|
+
}
|
|
22
|
+
(0, react_1.useEffect)(() => {
|
|
23
|
+
if (!isLoading)
|
|
24
|
+
return;
|
|
25
|
+
let cancelled = false;
|
|
26
|
+
(0, elements_1.loadComponentElement)(componentId)
|
|
27
|
+
.catch((error) => {
|
|
28
|
+
console.error(`Failed to load component "${componentId}":`, error);
|
|
29
|
+
})
|
|
30
|
+
.then(() => {
|
|
31
|
+
if (!cancelled)
|
|
32
|
+
refresh();
|
|
33
|
+
});
|
|
34
|
+
return () => {
|
|
35
|
+
cancelled = true;
|
|
36
|
+
};
|
|
37
|
+
}, [componentId, isLoading]);
|
|
38
|
+
return { Element, isPending, isFailed };
|
|
39
|
+
}
|
|
40
|
+
exports.useComponentElement = useComponentElement;
|
|
@@ -11,6 +11,7 @@ const react_1 = require("react");
|
|
|
11
11
|
const useCntrlContext_1 = require("../../provider/useCntrlContext");
|
|
12
12
|
const useLayoutContext_1 = require("../useLayoutContext");
|
|
13
13
|
const mergeComponentSettings_1 = require("../../utils/mergeComponentSettings");
|
|
14
|
+
const useComponentElement_1 = require("../../common/useComponentElement");
|
|
14
15
|
const NavigationComponent = ({ component: block, pages, currentState, isSwitchClone }) => {
|
|
15
16
|
var _a, _b;
|
|
16
17
|
const sdk = (0, useCntrlContext_1.useCntrlContext)();
|
|
@@ -19,17 +20,17 @@ const NavigationComponent = ({ component: block, pages, currentState, isSwitchCl
|
|
|
19
20
|
const fallbackLayout = (_a = layouts[0]) === null || _a === void 0 ? void 0 : _a.id;
|
|
20
21
|
const effectiveLayout = layout !== null && layout !== void 0 ? layout : fallbackLayout;
|
|
21
22
|
const layoutValues = [block.layoutParams];
|
|
22
|
-
const
|
|
23
|
-
const
|
|
23
|
+
const { Element, isPending, isFailed } = (0, useComponentElement_1.useComponentElement)(block.commonParams.componentId);
|
|
24
|
+
const keepsServerMarkup = isPending || isFailed;
|
|
24
25
|
const layoutParameters = effectiveLayout ? (_b = block.layoutParams[effectiveLayout]) === null || _b === void 0 ? void 0 : _b.parameters : undefined;
|
|
25
26
|
const commonParameters = block.commonParams.parameters;
|
|
26
27
|
const parameters = layoutParameters ? Object.assign(Object.assign({}, layoutParameters), { settings: (0, mergeComponentSettings_1.mergeComponentSettings)(layoutParameters.settings, commonParameters === null || commonParameters === void 0 ? void 0 : commonParameters.settings) }) : undefined;
|
|
27
28
|
const reactId = (0, react_1.useId)();
|
|
28
29
|
const id = `${reactId}-custom-component-${block.id}`;
|
|
29
|
-
return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { className: `custom-component-${block.id}`, style: { opacity: layout == null ? 0 : undefined }, children: parameters && Element && ((0, jsx_runtime_1.jsx)(Element, Object.assign({ metadata: {
|
|
30
|
+
return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", Object.assign({ className: `custom-component-${block.id}`, style: { opacity: layout == null || isPending ? 0 : undefined } }, (keepsServerMarkup ? useComponentElement_1.pendingElementProps : {}), { children: keepsServerMarkup ? null : parameters && Element && ((0, jsx_runtime_1.jsx)(Element, Object.assign({ metadata: {
|
|
30
31
|
itemId: block.id,
|
|
31
32
|
submitUrl: sdk.getSubmitUrl(commonParameters === null || commonParameters === void 0 ? void 0 : commonParameters.pluginConfigId)
|
|
32
|
-
}, portalId: "component-portal", content: block.commonParams.content }, parameters, { layoutId: effectiveLayout, pages: pages, currentState: currentState, isSwitchClone: isSwitchClone }))) }), (0, jsx_runtime_1.jsx)(style_1.default, { id: id, children: `
|
|
33
|
+
}, portalId: "component-portal", content: block.commonParams.content }, parameters, { layoutId: effectiveLayout, pages: pages, currentState: currentState, isSwitchClone: isSwitchClone }))) }), keepsServerMarkup ? 'pending' : 'ready'), (0, jsx_runtime_1.jsx)(style_1.default, { id: id, children: `
|
|
33
34
|
.custom-component-${block.id} {
|
|
34
35
|
width: 100%;
|
|
35
36
|
height: 100%;
|
|
@@ -12,6 +12,7 @@ const useCntrlContext_1 = require("../../../provider/useCntrlContext");
|
|
|
12
12
|
const useLayoutContext_1 = require("../../useLayoutContext");
|
|
13
13
|
const useItemGeometry_1 = require("../../../ItemGeometry/useItemGeometry");
|
|
14
14
|
const mergeComponentSettings_1 = require("../../../utils/mergeComponentSettings");
|
|
15
|
+
const useComponentElement_1 = require("../../../common/useComponentElement");
|
|
15
16
|
const StructuredComponent = ({ block }) => {
|
|
16
17
|
var _a, _b;
|
|
17
18
|
const sdk = (0, useCntrlContext_1.useCntrlContext)();
|
|
@@ -20,19 +21,19 @@ const StructuredComponent = ({ block }) => {
|
|
|
20
21
|
const fallbackLayout = (_a = layouts[0]) === null || _a === void 0 ? void 0 : _a.id;
|
|
21
22
|
const effectiveLayout = layout !== null && layout !== void 0 ? layout : fallbackLayout;
|
|
22
23
|
const layoutValues = [block.layoutParams];
|
|
23
|
-
const
|
|
24
|
+
const { Element, isPending, isFailed } = (0, useComponentElement_1.useComponentElement)(block.commonParams.componentId);
|
|
25
|
+
const keepsServerMarkup = isPending || isFailed;
|
|
24
26
|
const [ref, setRef] = (0, react_1.useState)(null);
|
|
25
27
|
(0, useItemGeometry_1.useItemGeometry)(block.id, ref);
|
|
26
|
-
const Element = component ? component.element : undefined;
|
|
27
28
|
const layoutParameters = effectiveLayout ? (_b = block.layoutParams[effectiveLayout]) === null || _b === void 0 ? void 0 : _b.parameters : undefined;
|
|
28
29
|
const commonParameters = block.commonParams.parameters;
|
|
29
30
|
const parameters = layoutParameters ? Object.assign(Object.assign({}, layoutParameters), { settings: (0, mergeComponentSettings_1.mergeComponentSettings)(layoutParameters.settings, commonParameters === null || commonParameters === void 0 ? void 0 : commonParameters.settings) }) : undefined;
|
|
30
|
-
return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { className: `custom-component-${block.id}`, ref: setRef,
|
|
31
|
+
return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", Object.assign({ className: `custom-component-${block.id}`, ref: setRef,
|
|
31
32
|
// preventing layout shift while supporting SSG for proper SEO
|
|
32
|
-
style: { opacity: layout == null ? 0 : undefined }, children: parameters && Element && ((0, jsx_runtime_1.jsx)(Element, Object.assign({ metadata: {
|
|
33
|
+
style: { opacity: layout == null || isPending ? 0 : undefined } }, (keepsServerMarkup ? useComponentElement_1.pendingElementProps : {}), { children: keepsServerMarkup ? null : parameters && Element && ((0, jsx_runtime_1.jsx)(Element, Object.assign({ metadata: {
|
|
33
34
|
itemId: block.id,
|
|
34
35
|
submitUrl: sdk.getSubmitUrl(commonParameters === null || commonParameters === void 0 ? void 0 : commonParameters.pluginConfigId)
|
|
35
|
-
}, portalId: "component-portal", content: block.commonParams.content }, parameters))) }), (0, jsx_runtime_1.jsx)(style_1.default, { id: block.id, children: `
|
|
36
|
+
}, portalId: "component-portal", content: block.commonParams.content }, parameters))) }), keepsServerMarkup ? 'pending' : 'ready'), (0, jsx_runtime_1.jsx)(style_1.default, { id: block.id, children: `
|
|
36
37
|
.custom-component-${block.id} {
|
|
37
38
|
width: 100%;
|
|
38
39
|
height: 100%;
|
|
@@ -17,6 +17,7 @@ const useLayoutContext_1 = require("../../useLayoutContext");
|
|
|
17
17
|
const useItemGeometry_1 = require("../../../ItemGeometry/useItemGeometry");
|
|
18
18
|
const LinkWrapper_1 = require("../LinkWrapper");
|
|
19
19
|
const mergeComponentSettings_1 = require("../../../utils/mergeComponentSettings");
|
|
20
|
+
const useComponentElement_1 = require("../../../common/useComponentElement");
|
|
20
21
|
const ComponentItem = ({ item, sectionId, onResize, interactionCtrl }) => {
|
|
21
22
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
22
23
|
const sdk = (0, useCntrlContext_1.useCntrlContext)();
|
|
@@ -26,7 +27,8 @@ const ComponentItem = ({ item, sectionId, onResize, interactionCtrl }) => {
|
|
|
26
27
|
const fallbackLayout = (_a = layouts[0]) === null || _a === void 0 ? void 0 : _a.id;
|
|
27
28
|
const effectiveLayout = layout !== null && layout !== void 0 ? layout : fallbackLayout;
|
|
28
29
|
const layoutValues = [item.area, item.layoutParams];
|
|
29
|
-
const
|
|
30
|
+
const { Element, isPending, isFailed } = (0, useComponentElement_1.useComponentElement)(item.commonParams.componentId);
|
|
31
|
+
const keepsServerMarkup = isPending || isFailed;
|
|
30
32
|
const [ref, setRef] = (0, react_1.useState)(null);
|
|
31
33
|
const { opacity: itemOpacity, blur: itemBlur } = (0, useComponentItem_1.useComponentItem)(item, sectionId);
|
|
32
34
|
(0, useRegisterResize_1.useRegisterResize)(ref, onResize);
|
|
@@ -35,7 +37,6 @@ const ComponentItem = ({ item, sectionId, onResize, interactionCtrl }) => {
|
|
|
35
37
|
const angle = (0, getStyleFromItemStateAndParams_1.getStyleFromItemStateAndParams)((_b = stateParams === null || stateParams === void 0 ? void 0 : stateParams.styles) === null || _b === void 0 ? void 0 : _b.angle, itemAngle);
|
|
36
38
|
const opacity = (0, getStyleFromItemStateAndParams_1.getStyleFromItemStateAndParams)((_c = stateParams === null || stateParams === void 0 ? void 0 : stateParams.styles) === null || _c === void 0 ? void 0 : _c.opacity, itemOpacity);
|
|
37
39
|
const blur = (0, getStyleFromItemStateAndParams_1.getStyleFromItemStateAndParams)((_d = stateParams === null || stateParams === void 0 ? void 0 : stateParams.styles) === null || _d === void 0 ? void 0 : _d.blur, itemBlur);
|
|
38
|
-
const Element = component ? component.element : undefined;
|
|
39
40
|
const layoutParameters = effectiveLayout ? (_e = item.layoutParams[effectiveLayout]) === null || _e === void 0 ? void 0 : _e.parameters : undefined;
|
|
40
41
|
const commonParameters = item.commonParams.parameters;
|
|
41
42
|
const parameters = layoutParameters ? Object.assign(Object.assign({}, layoutParameters), { settings: (0, mergeComponentSettings_1.mergeComponentSettings)(layoutParameters.settings, commonParameters === null || commonParameters === void 0 ? void 0 : commonParameters.settings) }) : undefined;
|
|
@@ -43,12 +44,12 @@ const ComponentItem = ({ item, sectionId, onResize, interactionCtrl }) => {
|
|
|
43
44
|
return ((0, jsx_runtime_1.jsx)(LinkWrapper_1.LinkWrapper, { url: (_g = item.link) === null || _g === void 0 ? void 0 : _g.url, target: (_h = item.link) === null || _h === void 0 ? void 0 : _h.target,
|
|
44
45
|
// Let the component define its own hit area (e.g. rounded button),
|
|
45
46
|
// so empty space around it does not activate the link.
|
|
46
|
-
style: hasLink ? { pointerEvents: 'none' } : undefined, children: (0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { className: `custom-component-${item.id}`, ref: setRef, style: Object.assign(Object.assign(Object.assign(Object.assign({}, (opacity !== undefined
|
|
47
|
-
? { opacity: layout == null ? 0 : opacity }
|
|
48
|
-
: layout == null ? { opacity: 0 } : {})), (angle !== undefined ? { transform: `rotate(${angle}deg)` } : {})), (blur !== undefined && blur !== 0 ? { filter: `blur(${blur * 100}vw)` } : {})), { willChange: blur !== 0 && blur !== undefined ? 'transform' : 'unset', transition: (_j = stateParams === null || stateParams === void 0 ? void 0 : stateParams.transition) !== null && _j !== void 0 ? _j : 'none' }), children: parameters && Element && ((0, jsx_runtime_1.jsx)(Element, Object.assign({ metadata: {
|
|
47
|
+
style: hasLink ? { pointerEvents: 'none' } : undefined, children: (0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", Object.assign({ className: `custom-component-${item.id}`, ref: setRef, style: Object.assign(Object.assign(Object.assign(Object.assign({}, (opacity !== undefined
|
|
48
|
+
? { opacity: layout == null || isPending ? 0 : opacity }
|
|
49
|
+
: layout == null || isPending ? { opacity: 0 } : {})), (angle !== undefined ? { transform: `rotate(${angle}deg)` } : {})), (blur !== undefined && blur !== 0 ? { filter: `blur(${blur * 100}vw)` } : {})), { willChange: blur !== 0 && blur !== undefined ? 'transform' : 'unset', transition: (_j = stateParams === null || stateParams === void 0 ? void 0 : stateParams.transition) !== null && _j !== void 0 ? _j : 'none' }) }, (keepsServerMarkup ? useComponentElement_1.pendingElementProps : {}), { children: keepsServerMarkup ? null : parameters && Element && ((0, jsx_runtime_1.jsx)(Element, Object.assign({ metadata: {
|
|
49
50
|
itemId: item.id,
|
|
50
51
|
submitUrl: sdk.getSubmitUrl(commonParameters === null || commonParameters === void 0 ? void 0 : commonParameters.pluginConfigId)
|
|
51
|
-
}, portalId: "component-portal", content: item.commonParams.content }, parameters, { hasLink: hasLink }))) }), (0, jsx_runtime_1.jsx)(style_1.default, { id: item.id, children: `
|
|
52
|
+
}, portalId: "component-portal", content: item.commonParams.content }, parameters, { hasLink: hasLink }))) }), keepsServerMarkup ? 'pending' : 'ready'), (0, jsx_runtime_1.jsx)(style_1.default, { id: item.id, children: `
|
|
52
53
|
.custom-component-${item.id} {
|
|
53
54
|
width: 100%;
|
|
54
55
|
height: 100%;
|
|
@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
10
10
|
};
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
12
|
exports.CntrlSdkContext = void 0;
|
|
13
|
-
const components_1 = require("@cntrl-site/components");
|
|
14
13
|
class CntrlSdkContext {
|
|
15
14
|
constructor(customItems, customSections) {
|
|
16
15
|
this.customItems = customItems;
|
|
@@ -42,7 +41,6 @@ class CntrlSdkContext {
|
|
|
42
41
|
this._publicApiBase = publicApiBase;
|
|
43
42
|
}
|
|
44
43
|
this.setLayouts(project.layouts);
|
|
45
|
-
this.setComponents(components_1.components);
|
|
46
44
|
if (customComponents) {
|
|
47
45
|
this.setCustomComponents(customComponents);
|
|
48
46
|
}
|
|
@@ -63,11 +61,6 @@ class CntrlSdkContext {
|
|
|
63
61
|
setLayouts(layouts) {
|
|
64
62
|
this._layouts = layouts;
|
|
65
63
|
}
|
|
66
|
-
setComponents(components) {
|
|
67
|
-
for (const component of components) {
|
|
68
|
-
this.components.set(component.id, component);
|
|
69
|
-
}
|
|
70
|
-
}
|
|
71
64
|
setCustomComponents(customComponents) {
|
|
72
65
|
for (const [id, component] of customComponents) {
|
|
73
66
|
this.components.set(id, component);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cntrl-site/sdk-nextjs",
|
|
3
|
-
"version": "1.10.
|
|
3
|
+
"version": "1.10.16",
|
|
4
4
|
"description": "SDK for Next.js",
|
|
5
5
|
"author": "arsen@momdesign.nyc",
|
|
6
6
|
"license": "MIT",
|
|
@@ -30,9 +30,9 @@
|
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
32
|
"@cntrl-site/color": "^1.0.0",
|
|
33
|
-
"@cntrl-site/components": "^1.0.
|
|
33
|
+
"@cntrl-site/components": "^1.0.103",
|
|
34
34
|
"@cntrl-site/effects": "^1.4.2",
|
|
35
|
-
"@cntrl-site/sdk": "^1.28.
|
|
35
|
+
"@cntrl-site/sdk": "^1.28.12",
|
|
36
36
|
"@types/vimeo__player": "^2.18.0",
|
|
37
37
|
"@vimeo/player": "^2.25.0",
|
|
38
38
|
"franc-min": "^5.0.0",
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { renderHook, waitFor } from '@testing-library/react';
|
|
2
|
+
import { components } from '@cntrl-site/components';
|
|
3
|
+
import * as elements from '@cntrl-site/components/elements';
|
|
4
|
+
import { useComponentElement } from './useComponentElement';
|
|
5
|
+
|
|
6
|
+
jest.mock('@cntrl-site/components/elements', () => {
|
|
7
|
+
const actual = jest.requireActual('@cntrl-site/components/elements');
|
|
8
|
+
return {
|
|
9
|
+
...actual,
|
|
10
|
+
getComponentElement: jest.fn(actual.getComponentElement),
|
|
11
|
+
hasComponentElementFailed: jest.fn(actual.hasComponentElementFailed),
|
|
12
|
+
loadComponentElement: jest.fn(actual.loadComponentElement)
|
|
13
|
+
};
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
const mocked = jest.mocked(elements);
|
|
17
|
+
const actual = jest.requireActual<typeof elements>('@cntrl-site/components/elements');
|
|
18
|
+
|
|
19
|
+
describe('useComponentElement', () => {
|
|
20
|
+
afterEach(() => {
|
|
21
|
+
jest.restoreAllMocks();
|
|
22
|
+
mocked.getComponentElement.mockReset().mockImplementation(actual.getComponentElement);
|
|
23
|
+
mocked.hasComponentElementFailed.mockReset().mockImplementation(actual.hasComponentElementFailed);
|
|
24
|
+
mocked.loadComponentElement.mockReset().mockImplementation(actual.loadComponentElement);
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it('gets built-in elements synchronously from elements.node under jest', () => {
|
|
28
|
+
const faq = components.find(component => component.id === 'faq');
|
|
29
|
+
const { result } = renderHook(() => useComponentElement('faq'));
|
|
30
|
+
expect(result.current).toEqual({ Element: faq?.element, isPending: false, isFailed: false });
|
|
31
|
+
expect(mocked.loadComponentElement).not.toHaveBeenCalled();
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
it('switches from pending to failed once the load rejects, without retrying on re-render', async () => {
|
|
35
|
+
let failed = false;
|
|
36
|
+
const error = new Error('ChunkLoadError');
|
|
37
|
+
const consoleError = jest.spyOn(console, 'error').mockImplementation(() => undefined);
|
|
38
|
+
mocked.getComponentElement.mockReturnValue(undefined);
|
|
39
|
+
mocked.hasComponentElementFailed.mockImplementation(() => failed);
|
|
40
|
+
mocked.loadComponentElement.mockImplementation(() => {
|
|
41
|
+
failed = true;
|
|
42
|
+
return Promise.reject(error);
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
const { result, rerender } = renderHook(() => useComponentElement('faq'));
|
|
46
|
+
expect(result.current).toEqual({ Element: undefined, isPending: true, isFailed: false });
|
|
47
|
+
|
|
48
|
+
await waitFor(() => expect(result.current.isFailed).toBe(true));
|
|
49
|
+
expect(result.current.isPending).toBe(false);
|
|
50
|
+
expect(consoleError).toHaveBeenCalledWith('Failed to load component "faq":', error);
|
|
51
|
+
const calls = mocked.loadComponentElement.mock.calls.length;
|
|
52
|
+
|
|
53
|
+
rerender();
|
|
54
|
+
rerender();
|
|
55
|
+
expect(mocked.loadComponentElement).toHaveBeenCalledTimes(calls);
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it('shows the element once a pending load resolves', async () => {
|
|
59
|
+
const faq = components.find(component => component.id === 'faq');
|
|
60
|
+
let loaded = false;
|
|
61
|
+
mocked.getComponentElement.mockImplementation(() => (loaded ? faq?.element : undefined));
|
|
62
|
+
mocked.loadComponentElement.mockImplementation(() => {
|
|
63
|
+
loaded = true;
|
|
64
|
+
return Promise.resolve(faq?.element);
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
const { result } = renderHook(() => useComponentElement('faq'));
|
|
68
|
+
expect(result.current.isPending).toBe(true);
|
|
69
|
+
await waitFor(() => expect(result.current).toEqual({ Element: faq?.element, isPending: false, isFailed: false }));
|
|
70
|
+
});
|
|
71
|
+
});
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { ComponentType, useEffect, useReducer } from 'react';
|
|
2
|
+
import {
|
|
3
|
+
getComponentElement,
|
|
4
|
+
hasComponentElement,
|
|
5
|
+
hasComponentElementFailed,
|
|
6
|
+
loadComponentElement
|
|
7
|
+
} from '@cntrl-site/components/elements';
|
|
8
|
+
import { useCntrlContext } from '../provider/useCntrlContext';
|
|
9
|
+
|
|
10
|
+
type ComponentElement = {
|
|
11
|
+
Element: ComponentType<any> | undefined;
|
|
12
|
+
isPending: boolean;
|
|
13
|
+
isFailed: boolean;
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
export const pendingElementProps = {
|
|
17
|
+
dangerouslySetInnerHTML: { __html: '' },
|
|
18
|
+
suppressHydrationWarning: true
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
export function useComponentElement(componentId: string): ComponentElement {
|
|
22
|
+
const sdk = useCntrlContext();
|
|
23
|
+
const [, refresh] = useReducer((count: number) => count + 1, 0);
|
|
24
|
+
const Element = sdk.getComponent(componentId)?.element ?? getComponentElement(componentId);
|
|
25
|
+
const isLoading = !Element && hasComponentElement(componentId);
|
|
26
|
+
const isFailed = isLoading && hasComponentElementFailed(componentId);
|
|
27
|
+
const isPending = isLoading && !isFailed;
|
|
28
|
+
if (isPending) {
|
|
29
|
+
loadComponentElement(componentId).catch(() => undefined);
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
useEffect(() => {
|
|
33
|
+
if (!isLoading) return;
|
|
34
|
+
let cancelled = false;
|
|
35
|
+
loadComponentElement(componentId)
|
|
36
|
+
.catch((error) => {
|
|
37
|
+
console.error(`Failed to load component "${componentId}":`, error);
|
|
38
|
+
})
|
|
39
|
+
.then(() => {
|
|
40
|
+
if (!cancelled) refresh();
|
|
41
|
+
});
|
|
42
|
+
return () => {
|
|
43
|
+
cancelled = true;
|
|
44
|
+
};
|
|
45
|
+
}, [componentId, isLoading]);
|
|
46
|
+
|
|
47
|
+
return { Element, isPending, isFailed };
|
|
48
|
+
}
|
|
@@ -4,6 +4,7 @@ import { FC, useId } from 'react';
|
|
|
4
4
|
import { useCntrlContext } from '../../provider/useCntrlContext';
|
|
5
5
|
import { useLayoutContext } from '../useLayoutContext';
|
|
6
6
|
import { mergeComponentSettings } from '../../utils/mergeComponentSettings';
|
|
7
|
+
import { pendingElementProps, useComponentElement } from '../../common/useComponentElement';
|
|
7
8
|
|
|
8
9
|
interface Props {
|
|
9
10
|
component: TNavigationComponent;
|
|
@@ -24,8 +25,8 @@ export const NavigationComponent: FC<Props> = ({
|
|
|
24
25
|
const fallbackLayout = layouts[0]?.id;
|
|
25
26
|
const effectiveLayout = layout ?? fallbackLayout;
|
|
26
27
|
const layoutValues: Record<string, any>[] = [block.layoutParams];
|
|
27
|
-
const
|
|
28
|
-
const
|
|
28
|
+
const { Element, isPending, isFailed } = useComponentElement(block.commonParams.componentId);
|
|
29
|
+
const keepsServerMarkup = isPending || isFailed;
|
|
29
30
|
const layoutParameters = effectiveLayout ? block.layoutParams[effectiveLayout]?.parameters : undefined;
|
|
30
31
|
const commonParameters = block.commonParams.parameters;
|
|
31
32
|
const parameters = layoutParameters ? {
|
|
@@ -38,10 +39,12 @@ export const NavigationComponent: FC<Props> = ({
|
|
|
38
39
|
return (
|
|
39
40
|
<>
|
|
40
41
|
<div
|
|
42
|
+
key={keepsServerMarkup ? 'pending' : 'ready'}
|
|
41
43
|
className={`custom-component-${block.id}`}
|
|
42
|
-
style={{ opacity: layout == null ? 0 : undefined }}
|
|
44
|
+
style={{ opacity: layout == null || isPending ? 0 : undefined }}
|
|
45
|
+
{...(keepsServerMarkup ? pendingElementProps : {})}
|
|
43
46
|
>
|
|
44
|
-
{parameters && Element && (
|
|
47
|
+
{keepsServerMarkup ? null : parameters && Element && (
|
|
45
48
|
<Element
|
|
46
49
|
metadata={{
|
|
47
50
|
itemId: block.id,
|
|
@@ -5,6 +5,7 @@ import { useCntrlContext } from '../../../provider/useCntrlContext';
|
|
|
5
5
|
import { useLayoutContext } from '../../useLayoutContext';
|
|
6
6
|
import { useItemGeometry } from '../../../ItemGeometry/useItemGeometry';
|
|
7
7
|
import { mergeComponentSettings } from '../../../utils/mergeComponentSettings';
|
|
8
|
+
import { pendingElementProps, useComponentElement } from '../../../common/useComponentElement';
|
|
8
9
|
|
|
9
10
|
interface Props {
|
|
10
11
|
block: StructuredBlock<StructuredBlockType.Component>;
|
|
@@ -17,10 +18,10 @@ export const StructuredComponent: FC<Props> = ({ block }) => {
|
|
|
17
18
|
const fallbackLayout = layouts[0]?.id;
|
|
18
19
|
const effectiveLayout = layout ?? fallbackLayout;
|
|
19
20
|
const layoutValues: Record<string, any>[] = [block.layoutParams];
|
|
20
|
-
const
|
|
21
|
+
const { Element, isPending, isFailed } = useComponentElement(block.commonParams.componentId);
|
|
22
|
+
const keepsServerMarkup = isPending || isFailed;
|
|
21
23
|
const [ref, setRef] = useState<HTMLDivElement | null>(null);
|
|
22
24
|
useItemGeometry(block.id, ref);
|
|
23
|
-
const Element = component ? component.element : undefined;
|
|
24
25
|
const layoutParameters = effectiveLayout ? block.layoutParams[effectiveLayout]?.parameters : undefined;
|
|
25
26
|
const commonParameters = block.commonParams.parameters;
|
|
26
27
|
const parameters = layoutParameters ? {
|
|
@@ -31,12 +32,14 @@ export const StructuredComponent: FC<Props> = ({ block }) => {
|
|
|
31
32
|
return (
|
|
32
33
|
<>
|
|
33
34
|
<div
|
|
35
|
+
key={keepsServerMarkup ? 'pending' : 'ready'}
|
|
34
36
|
className={`custom-component-${block.id}`}
|
|
35
37
|
ref={setRef}
|
|
36
38
|
// preventing layout shift while supporting SSG for proper SEO
|
|
37
|
-
style={{ opacity: layout == null ? 0 : undefined }}
|
|
39
|
+
style={{ opacity: layout == null || isPending ? 0 : undefined }}
|
|
40
|
+
{...(keepsServerMarkup ? pendingElementProps : {})}
|
|
38
41
|
>
|
|
39
|
-
{parameters && Element && (
|
|
42
|
+
{keepsServerMarkup ? null : parameters && Element && (
|
|
40
43
|
<Element
|
|
41
44
|
metadata={{
|
|
42
45
|
itemId: block.id,
|
|
@@ -11,6 +11,7 @@ import { useLayoutContext } from '../../useLayoutContext';
|
|
|
11
11
|
import { useItemGeometry } from '../../../ItemGeometry/useItemGeometry';
|
|
12
12
|
import { LinkWrapper } from '../LinkWrapper';
|
|
13
13
|
import { mergeComponentSettings } from '../../../utils/mergeComponentSettings';
|
|
14
|
+
import { pendingElementProps, useComponentElement } from '../../../common/useComponentElement';
|
|
14
15
|
|
|
15
16
|
export const ComponentItem: FC<ItemProps<TComponentItem>> = ({ item, sectionId, onResize, interactionCtrl }) => {
|
|
16
17
|
const sdk = useCntrlContext();
|
|
@@ -20,7 +21,8 @@ export const ComponentItem: FC<ItemProps<TComponentItem>> = ({ item, sectionId,
|
|
|
20
21
|
const fallbackLayout = layouts[0]?.id;
|
|
21
22
|
const effectiveLayout = layout ?? fallbackLayout;
|
|
22
23
|
const layoutValues: Record<string, any>[] = [item.area, item.layoutParams];
|
|
23
|
-
const
|
|
24
|
+
const { Element, isPending, isFailed } = useComponentElement(item.commonParams.componentId);
|
|
25
|
+
const keepsServerMarkup = isPending || isFailed;
|
|
24
26
|
const [ref, setRef] = useState<HTMLDivElement | null>(null);
|
|
25
27
|
const { opacity: itemOpacity, blur: itemBlur } = useComponentItem(item, sectionId);
|
|
26
28
|
useRegisterResize(ref, onResize);
|
|
@@ -29,7 +31,6 @@ export const ComponentItem: FC<ItemProps<TComponentItem>> = ({ item, sectionId,
|
|
|
29
31
|
const angle = getStyleFromItemStateAndParams(stateParams?.styles?.angle, itemAngle);
|
|
30
32
|
const opacity = getStyleFromItemStateAndParams(stateParams?.styles?.opacity, itemOpacity);
|
|
31
33
|
const blur = getStyleFromItemStateAndParams(stateParams?.styles?.blur, itemBlur);
|
|
32
|
-
const Element = component ? component.element : undefined;
|
|
33
34
|
const layoutParameters = effectiveLayout ? item.layoutParams[effectiveLayout]?.parameters : undefined;
|
|
34
35
|
const commonParameters = item.commonParams.parameters;
|
|
35
36
|
const parameters = layoutParameters ? {
|
|
@@ -49,20 +50,22 @@ export const ComponentItem: FC<ItemProps<TComponentItem>> = ({ item, sectionId,
|
|
|
49
50
|
>
|
|
50
51
|
<>
|
|
51
52
|
<div
|
|
53
|
+
key={keepsServerMarkup ? 'pending' : 'ready'}
|
|
52
54
|
className={`custom-component-${item.id}`}
|
|
53
55
|
ref={setRef}
|
|
54
56
|
style={{
|
|
55
57
|
// preventing layout shift while supporting SSG for proper SEO
|
|
56
58
|
...(opacity !== undefined
|
|
57
|
-
? { opacity: layout == null ? 0 : opacity }
|
|
58
|
-
: layout == null ? { opacity: 0 } : {}),
|
|
59
|
+
? { opacity: layout == null || isPending ? 0 : opacity }
|
|
60
|
+
: layout == null || isPending ? { opacity: 0 } : {}),
|
|
59
61
|
...(angle !== undefined ? { transform: `rotate(${angle}deg)` } : {}),
|
|
60
62
|
...(blur !== undefined && blur !== 0 ? { filter: `blur(${blur * 100}vw)` } : {}),
|
|
61
63
|
willChange: blur !== 0 && blur !== undefined ? 'transform' : 'unset',
|
|
62
64
|
transition: stateParams?.transition ?? 'none'
|
|
63
65
|
}}
|
|
66
|
+
{...(keepsServerMarkup ? pendingElementProps : {})}
|
|
64
67
|
>
|
|
65
|
-
{parameters && Element && (
|
|
68
|
+
{keepsServerMarkup ? null : parameters && Element && (
|
|
66
69
|
<Element
|
|
67
70
|
metadata={{
|
|
68
71
|
itemId: item.id,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CustomItemRegistry } from './CustomItemRegistry';
|
|
2
2
|
import { Article, Section, Layout, Project, SectionHeight } from '@cntrl-site/sdk';
|
|
3
|
-
import {
|
|
3
|
+
import type { Component as TComponent } from '@cntrl-site/components';
|
|
4
4
|
import { CustomSectionRegistry } from './CustomSectionRegistry';
|
|
5
5
|
|
|
6
6
|
interface SdkContextInitProps {
|
|
@@ -43,7 +43,6 @@ export class CntrlSdkContext {
|
|
|
43
43
|
this._publicApiBase = publicApiBase;
|
|
44
44
|
}
|
|
45
45
|
this.setLayouts(project.layouts);
|
|
46
|
-
this.setComponents(components);
|
|
47
46
|
if (customComponents) {
|
|
48
47
|
this.setCustomComponents(customComponents);
|
|
49
48
|
}
|
|
@@ -68,12 +67,6 @@ export class CntrlSdkContext {
|
|
|
68
67
|
this._layouts = layouts;
|
|
69
68
|
}
|
|
70
69
|
|
|
71
|
-
private setComponents(components: TComponent[]) {
|
|
72
|
-
for (const component of components) {
|
|
73
|
-
this.components.set(component.id, component);
|
|
74
|
-
}
|
|
75
|
-
}
|
|
76
|
-
|
|
77
70
|
setCustomComponents(customComponents: Map<string, TComponent>) {
|
|
78
71
|
for (const [id, component] of customComponents) {
|
|
79
72
|
this.components.set(id, component);
|