@webiny/website-builder-react 6.0.0-alpha.4 β 6.0.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -2
- package/components/DocumentFragment.d.ts +10 -3
- package/components/DocumentFragment.js +5 -4
- package/components/DocumentFragment.js.map +1 -1
- package/components/DocumentRenderer.js +19 -10
- package/components/DocumentRenderer.js.map +1 -1
- package/components/DocumentStoreProvider.d.ts +1 -1
- package/components/FragmentsProvider.d.ts +10 -1
- package/components/FragmentsProvider.js +17 -4
- package/components/FragmentsProvider.js.map +1 -1
- package/components/useBindingsForElement.d.ts +137 -68
- package/components/useDocumentState.d.ts +1 -1
- package/components/useSelectFromState.d.ts +0 -1
- package/createComponent.d.ts +3 -2
- package/createComponent.js +27 -7
- package/createComponent.js.map +1 -1
- package/createComponent.test.d.ts +1 -0
- package/createComponent.test.js +129 -0
- package/createComponent.test.js.map +1 -0
- package/editorComponents/Box.manifest.d.ts +1 -1
- package/editorComponents/Fragment.d.ts +1 -1
- package/editorComponents/Fragment.js +9 -3
- package/editorComponents/Fragment.js.map +1 -1
- package/editorComponents/Grid.d.ts +1 -0
- package/editorComponents/Grid.js.map +1 -1
- package/editorComponents/Grid.manifest.d.ts +0 -1
- package/editorComponents/Image.d.ts +2 -2
- package/editorComponents/Image.js.map +1 -1
- package/editorComponents/Image.manifest.js +21 -20
- package/editorComponents/Image.manifest.js.map +1 -1
- package/editorComponents/Lexical.d.ts +2 -2
- package/editorComponents/Lexical.js +3 -7
- package/editorComponents/Lexical.js.map +1 -1
- package/editorComponents/Root.manifest.d.ts +1 -1
- package/editorComponents/index.d.ts +1 -1
- package/index.d.ts +1 -1
- package/index.js.map +1 -1
- package/package.json +8 -11
- package/types.d.ts +4 -1
- package/types.js.map +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @webiny/website-builder-react
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> [!NOTE]
|
|
4
|
+
> This package is part of the [Webiny](https://www.webiny.com) monorepo.
|
|
5
|
+
> Itβs **included in every Webiny project by default** and is not meant to be used as a standalone package.
|
|
6
|
+
|
|
7
|
+
π **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
_This README file is automatically generated during the publish process._
|
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
import React from "react";
|
|
2
|
-
export
|
|
2
|
+
export type DocumentFragmentProps = {
|
|
3
3
|
name: string;
|
|
4
4
|
children: React.ReactNode;
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
component?: never;
|
|
6
|
+
inputs?: never;
|
|
7
|
+
} | {
|
|
8
|
+
component: string;
|
|
9
|
+
inputs?: Record<string, any>;
|
|
10
|
+
name?: never;
|
|
11
|
+
children?: never;
|
|
12
|
+
};
|
|
13
|
+
export declare function DocumentFragment(props: DocumentFragmentProps): React.JSX.Element | null;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
"use client";
|
|
2
2
|
|
|
3
3
|
import React from "react";
|
|
4
|
-
export function DocumentFragment({
|
|
5
|
-
children
|
|
6
|
-
|
|
7
|
-
|
|
4
|
+
export function DocumentFragment(props) {
|
|
5
|
+
if (props.children) {
|
|
6
|
+
return /*#__PURE__*/React.createElement(React.Fragment, null, props.children);
|
|
7
|
+
}
|
|
8
|
+
return null;
|
|
8
9
|
}
|
|
9
10
|
|
|
10
11
|
//# sourceMappingURL=DocumentFragment.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["React","DocumentFragment","children","createElement","Fragment"],"sources":["DocumentFragment.tsx"],"sourcesContent":["\"use client\";\nimport React from \"react\";\n\nexport
|
|
1
|
+
{"version":3,"names":["React","DocumentFragment","props","children","createElement","Fragment"],"sources":["DocumentFragment.tsx"],"sourcesContent":["\"use client\";\nimport React from \"react\";\n\nexport type DocumentFragmentProps =\n | {\n name: string;\n children: React.ReactNode;\n component?: never;\n inputs?: never;\n }\n | {\n component: string;\n inputs?: Record<string, any>;\n name?: never;\n children?: never;\n };\n\nexport function DocumentFragment(props: DocumentFragmentProps) {\n if (props.children) {\n return <>{props.children}</>;\n }\n\n return null;\n}\n"],"mappings":"AAAA,YAAY;;AACZ,OAAOA,KAAK,MAAM,OAAO;AAgBzB,OAAO,SAASC,gBAAgBA,CAACC,KAA4B,EAAE;EAC3D,IAAIA,KAAK,CAACC,QAAQ,EAAE;IAChB,oBAAOH,KAAA,CAAAI,aAAA,CAAAJ,KAAA,CAAAK,QAAA,QAAGH,KAAK,CAACC,QAAW,CAAC;EAChC;EAEA,OAAO,IAAI;AACf","ignoreList":[]}
|
|
@@ -12,17 +12,26 @@ export const DocumentRenderer = ({
|
|
|
12
12
|
}) => {
|
|
13
13
|
const allComponents = [...editorComponents, ...components];
|
|
14
14
|
allComponents.forEach(blueprint => contentSdk.registerComponent(blueprint));
|
|
15
|
-
const fragments =
|
|
16
|
-
React.Children.toArray(children).forEach(child => {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
15
|
+
const fragments = [];
|
|
16
|
+
React.Children.toArray(children).filter(child => /*#__PURE__*/React.isValidElement(child)).forEach(child => {
|
|
17
|
+
const props = child.props;
|
|
18
|
+
// Case 1:
|
|
19
|
+
if (props.name && props.children) {
|
|
20
|
+
fragments.push({
|
|
21
|
+
type: "fixed",
|
|
22
|
+
name: props.name,
|
|
23
|
+
element: /*#__PURE__*/React.createElement(React.Fragment, null, props.children)
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
// Case 2:
|
|
28
|
+
if (props.component) {
|
|
29
|
+
fragments.push({
|
|
30
|
+
type: "component",
|
|
31
|
+
component: props.component,
|
|
32
|
+
inputs: props.inputs ?? {}
|
|
33
|
+
});
|
|
24
34
|
}
|
|
25
|
-
fragments[name] = /*#__PURE__*/React.createElement(React.Fragment, null, children);
|
|
26
35
|
});
|
|
27
36
|
if (!document) {
|
|
28
37
|
return /*#__PURE__*/React.createElement("div", {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["React","contentSdk","ElementRenderer","DocumentStoreProvider","ConnectToEditor","editorComponents","FragmentsProvider","DocumentRenderer","document","components","children","allComponents","forEach","blueprint","registerComponent","fragments","Children","toArray","child","
|
|
1
|
+
{"version":3,"names":["React","contentSdk","ElementRenderer","DocumentStoreProvider","ConnectToEditor","editorComponents","FragmentsProvider","DocumentRenderer","document","components","children","allComponents","forEach","blueprint","registerComponent","fragments","Children","toArray","filter","child","isValidElement","props","name","push","type","element","createElement","Fragment","component","inputs","isEditing","id","properties"],"sources":["DocumentRenderer.tsx"],"sourcesContent":["import React from \"react\";\nimport { type Component, contentSdk, type Document } from \"@webiny/website-builder-sdk\";\nimport { ElementRenderer } from \"./ElementRenderer.js\";\nimport { DocumentStoreProvider } from \"./DocumentStoreProvider.js\";\nimport { ConnectToEditor } from \"./ConnectToEditor.js\";\nimport { editorComponents } from \"../editorComponents/index.js\";\nimport type { DocumentFragments } from \"./FragmentsProvider.js\";\nimport { FragmentsProvider } from \"./FragmentsProvider.js\";\nimport type { DocumentFragmentProps } from \"~/components/DocumentFragment.js\";\n\ninterface DocumentRendererProps {\n document: Document | null;\n components: Component[];\n children?: React.ReactNode | React.ReactNode[];\n}\n\nexport const DocumentRenderer = ({ document, components, children }: DocumentRendererProps) => {\n const allComponents = [...editorComponents, ...components];\n allComponents.forEach(blueprint => contentSdk.registerComponent(blueprint));\n const fragments: DocumentFragments = [];\n\n React.Children.toArray(children)\n .filter(child => React.isValidElement(child))\n .forEach(child => {\n const props = child.props as DocumentFragmentProps;\n // Case 1:\n if (props.name && props.children) {\n fragments.push({\n type: \"fixed\",\n name: props.name,\n element: <>{props.children}</>\n });\n }\n\n // Case 2:\n if (props.component) {\n fragments.push({\n type: \"component\",\n component: props.component,\n inputs: props.inputs ?? {}\n });\n }\n });\n\n if (!document) {\n return <div data-role={\"document-renderer\"}>{children}</div>;\n }\n\n return (\n <div data-role={\"document-renderer\"}>\n <FragmentsProvider fragments={fragments ?? {}}>\n {contentSdk.isEditing() ? (\n <ConnectToEditor document={document} components={components} />\n ) : (\n <DocumentStoreProvider id={document.properties.id} document={document}>\n <ElementRenderer id={\"root\"} />\n </DocumentStoreProvider>\n )}\n </FragmentsProvider>\n </div>\n );\n};\n"],"mappings":"AAAA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAAyBC,UAAU,QAAuB,6BAA6B;AACvF,SAASC,eAAe;AACxB,SAASC,qBAAqB;AAC9B,SAASC,eAAe;AACxB,SAASC,gBAAgB;AAEzB,SAASC,iBAAiB;AAS1B,OAAO,MAAMC,gBAAgB,GAAGA,CAAC;EAAEC,QAAQ;EAAEC,UAAU;EAAEC;AAAgC,CAAC,KAAK;EAC3F,MAAMC,aAAa,GAAG,CAAC,GAAGN,gBAAgB,EAAE,GAAGI,UAAU,CAAC;EAC1DE,aAAa,CAACC,OAAO,CAACC,SAAS,IAAIZ,UAAU,CAACa,iBAAiB,CAACD,SAAS,CAAC,CAAC;EAC3E,MAAME,SAA4B,GAAG,EAAE;EAEvCf,KAAK,CAACgB,QAAQ,CAACC,OAAO,CAACP,QAAQ,CAAC,CAC3BQ,MAAM,CAACC,KAAK,iBAAInB,KAAK,CAACoB,cAAc,CAACD,KAAK,CAAC,CAAC,CAC5CP,OAAO,CAACO,KAAK,IAAI;IACd,MAAME,KAAK,GAAGF,KAAK,CAACE,KAA8B;IAClD;IACA,IAAIA,KAAK,CAACC,IAAI,IAAID,KAAK,CAACX,QAAQ,EAAE;MAC9BK,SAAS,CAACQ,IAAI,CAAC;QACXC,IAAI,EAAE,OAAO;QACbF,IAAI,EAAED,KAAK,CAACC,IAAI;QAChBG,OAAO,eAAEzB,KAAA,CAAA0B,aAAA,CAAA1B,KAAA,CAAA2B,QAAA,QAAGN,KAAK,CAACX,QAAW;MACjC,CAAC,CAAC;IACN;;IAEA;IACA,IAAIW,KAAK,CAACO,SAAS,EAAE;MACjBb,SAAS,CAACQ,IAAI,CAAC;QACXC,IAAI,EAAE,WAAW;QACjBI,SAAS,EAAEP,KAAK,CAACO,SAAS;QAC1BC,MAAM,EAAER,KAAK,CAACQ,MAAM,IAAI,CAAC;MAC7B,CAAC,CAAC;IACN;EACJ,CAAC,CAAC;EAEN,IAAI,CAACrB,QAAQ,EAAE;IACX,oBAAOR,KAAA,CAAA0B,aAAA;MAAK,aAAW;IAAoB,GAAEhB,QAAc,CAAC;EAChE;EAEA,oBACIV,KAAA,CAAA0B,aAAA;IAAK,aAAW;EAAoB,gBAChC1B,KAAA,CAAA0B,aAAA,CAACpB,iBAAiB;IAACS,SAAS,EAAEA,SAAS,IAAI,CAAC;EAAE,GACzCd,UAAU,CAAC6B,SAAS,CAAC,CAAC,gBACnB9B,KAAA,CAAA0B,aAAA,CAACtB,eAAe;IAACI,QAAQ,EAAEA,QAAS;IAACC,UAAU,EAAEA;EAAW,CAAE,CAAC,gBAE/DT,KAAA,CAAA0B,aAAA,CAACvB,qBAAqB;IAAC4B,EAAE,EAAEvB,QAAQ,CAACwB,UAAU,CAACD,EAAG;IAACvB,QAAQ,EAAEA;EAAS,gBAClER,KAAA,CAAA0B,aAAA,CAACxB,eAAe;IAAC6B,EAAE,EAAE;EAAO,CAAE,CACX,CAEZ,CAClB,CAAC;AAEd,CAAC","ignoreList":[]}
|
|
@@ -3,7 +3,7 @@ import type { DocumentStore } from "@webiny/website-builder-sdk";
|
|
|
3
3
|
import { type Document } from "@webiny/website-builder-sdk";
|
|
4
4
|
export declare const DocumentStoreProvider: ({ id, document, children }: {
|
|
5
5
|
id: string;
|
|
6
|
-
document?: Document
|
|
6
|
+
document?: Document;
|
|
7
7
|
children: React.ReactNode;
|
|
8
8
|
}) => React.JSX.Element;
|
|
9
9
|
export declare const useDocumentStore: () => DocumentStore;
|
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
import React from "react";
|
|
2
|
-
|
|
2
|
+
type FragmentConfig = {
|
|
3
|
+
type: "fixed";
|
|
4
|
+
name: string;
|
|
5
|
+
element: React.ReactNode;
|
|
6
|
+
} | {
|
|
7
|
+
type: "component";
|
|
8
|
+
component: string;
|
|
9
|
+
inputs: Record<string, any>;
|
|
10
|
+
};
|
|
11
|
+
export type DocumentFragments = FragmentConfig[];
|
|
3
12
|
interface FragmentsProviderProps {
|
|
4
13
|
fragments: DocumentFragments;
|
|
5
14
|
children: React.ReactNode;
|
|
@@ -7,14 +7,27 @@ export const FragmentsProvider = ({
|
|
|
7
7
|
fragments,
|
|
8
8
|
children
|
|
9
9
|
}) => {
|
|
10
|
-
const fragmentNames = Object.keys(fragments);
|
|
11
10
|
useEffect(() => {
|
|
12
11
|
if (contentSdk.isEditing()) {
|
|
12
|
+
// Extract serializable data
|
|
13
|
+
const fragmentsData = fragments.map(fragment => {
|
|
14
|
+
if (fragment.type === "fixed") {
|
|
15
|
+
return {
|
|
16
|
+
type: "fixed",
|
|
17
|
+
name: fragment.name
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
return {
|
|
21
|
+
type: "component",
|
|
22
|
+
component: fragment.component,
|
|
23
|
+
inputs: fragment.inputs
|
|
24
|
+
};
|
|
25
|
+
});
|
|
13
26
|
contentSdk.getEditingSdk().messenger.send("document.fragments", {
|
|
14
|
-
fragments:
|
|
27
|
+
fragments: fragmentsData
|
|
15
28
|
});
|
|
16
29
|
}
|
|
17
|
-
}, [
|
|
30
|
+
}, [fragments.length]);
|
|
18
31
|
return /*#__PURE__*/React.createElement(FragmentsContext.Provider, {
|
|
19
32
|
value: fragments
|
|
20
33
|
}, children);
|
|
@@ -22,7 +35,7 @@ export const FragmentsProvider = ({
|
|
|
22
35
|
export const useDocumentFragments = () => {
|
|
23
36
|
const context = React.useContext(FragmentsContext);
|
|
24
37
|
if (!context) {
|
|
25
|
-
return
|
|
38
|
+
return [];
|
|
26
39
|
}
|
|
27
40
|
return context;
|
|
28
41
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["React","useEffect","contentSdk","FragmentsContext","createContext","undefined","FragmentsProvider","fragments","children","
|
|
1
|
+
{"version":3,"names":["React","useEffect","contentSdk","FragmentsContext","createContext","undefined","FragmentsProvider","fragments","children","isEditing","fragmentsData","map","fragment","type","name","component","inputs","getEditingSdk","messenger","send","length","createElement","Provider","value","useDocumentFragments","context","useContext"],"sources":["FragmentsProvider.tsx"],"sourcesContent":["\"use client\";\nimport React, { useEffect } from \"react\";\nimport { contentSdk } from \"@webiny/website-builder-sdk\";\n\ntype FragmentConfig =\n | {\n type: \"fixed\";\n name: string;\n element: React.ReactNode;\n }\n | { type: \"component\"; component: string; inputs: Record<string, any> };\n\nexport type DocumentFragments = FragmentConfig[];\n\nconst FragmentsContext = React.createContext<DocumentFragments | undefined>(undefined);\n\ninterface FragmentsProviderProps {\n fragments: DocumentFragments;\n children: React.ReactNode;\n}\n\nexport const FragmentsProvider = ({ fragments, children }: FragmentsProviderProps) => {\n useEffect(() => {\n if (contentSdk.isEditing()) {\n // Extract serializable data\n const fragmentsData = fragments.map(fragment => {\n if (fragment.type === \"fixed\") {\n return {\n type: \"fixed\",\n name: fragment.name\n };\n }\n\n return {\n type: \"component\",\n component: fragment.component,\n inputs: fragment.inputs\n };\n });\n\n contentSdk\n .getEditingSdk()!\n .messenger.send(\"document.fragments\", { fragments: fragmentsData });\n }\n }, [fragments.length]);\n\n return <FragmentsContext.Provider value={fragments}>{children}</FragmentsContext.Provider>;\n};\n\nexport const useDocumentFragments = () => {\n const context = React.useContext(FragmentsContext);\n if (!context) {\n return [];\n }\n\n return context;\n};\n"],"mappings":"AAAA,YAAY;;AACZ,OAAOA,KAAK,IAAIC,SAAS,QAAQ,OAAO;AACxC,SAASC,UAAU,QAAQ,6BAA6B;AAYxD,MAAMC,gBAAgB,gBAAGH,KAAK,CAACI,aAAa,CAAgCC,SAAS,CAAC;AAOtF,OAAO,MAAMC,iBAAiB,GAAGA,CAAC;EAAEC,SAAS;EAAEC;AAAiC,CAAC,KAAK;EAClFP,SAAS,CAAC,MAAM;IACZ,IAAIC,UAAU,CAACO,SAAS,CAAC,CAAC,EAAE;MACxB;MACA,MAAMC,aAAa,GAAGH,SAAS,CAACI,GAAG,CAACC,QAAQ,IAAI;QAC5C,IAAIA,QAAQ,CAACC,IAAI,KAAK,OAAO,EAAE;UAC3B,OAAO;YACHA,IAAI,EAAE,OAAO;YACbC,IAAI,EAAEF,QAAQ,CAACE;UACnB,CAAC;QACL;QAEA,OAAO;UACHD,IAAI,EAAE,WAAW;UACjBE,SAAS,EAAEH,QAAQ,CAACG,SAAS;UAC7BC,MAAM,EAAEJ,QAAQ,CAACI;QACrB,CAAC;MACL,CAAC,CAAC;MAEFd,UAAU,CACLe,aAAa,CAAC,CAAC,CACfC,SAAS,CAACC,IAAI,CAAC,oBAAoB,EAAE;QAAEZ,SAAS,EAAEG;MAAc,CAAC,CAAC;IAC3E;EACJ,CAAC,EAAE,CAACH,SAAS,CAACa,MAAM,CAAC,CAAC;EAEtB,oBAAOpB,KAAA,CAAAqB,aAAA,CAAClB,gBAAgB,CAACmB,QAAQ;IAACC,KAAK,EAAEhB;EAAU,GAAEC,QAAoC,CAAC;AAC9F,CAAC;AAED,OAAO,MAAMgB,oBAAoB,GAAGA,CAAA,KAAM;EACtC,MAAMC,OAAO,GAAGzB,KAAK,CAAC0B,UAAU,CAACvB,gBAAgB,CAAC;EAClD,IAAI,CAACsB,OAAO,EAAE;IACV,OAAO,EAAE;EACb;EAEA,OAAOA,OAAO;AAClB,CAAC","ignoreList":[]}
|