Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

Simplify text editor store updates (#1054)

Bogdan Chadkin0ab3c60659c8
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 3f57175ed5..822d00d9e0 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -1,6 +1,5 @@
-import { useCallback, useMemo } from "react";
+import { useMemo } from "react";
import { computed } from "nanostores";
-import store from "immerhin";
import type { CanvasData } from "@webstudio-is/project";
import {
createElementsTree,
@@ -10,7 +9,6 @@ import {
customComponentMetas,
customComponentPropsMetas,
setParams,
- type OnChangeChildren,
} from "@webstudio-is/react-sdk";
import { publish } from "~/shared/pubsub";
import { registerContainers, useCanvasStore } from "~/shared/sync";
@@ -23,8 +21,6 @@ import { WrapperComponentDev } from "./features/wrapper-component";
import {
propsIndexStore,
assetsStore,
- rootInstanceContainer,
- useBreakpoints,
useRootInstance,
useSetBreakpoints,
useSetProps,
@@ -39,7 +35,6 @@ import {
} from "~/shared/nano-states";
import { usePublishScrollState } from "./shared/use-publish-scroll-state";
import { useDragAndDrop } from "./shared/use-drag-drop";
-import { utils } from "@webstudio-is/project";
import { useSubscribeBuilderReady } from "./shared/use-builder-ready";
import { useCopyPasteInstance } from "~/shared/copy-paste";
import { customComponents } from "./custom-components";
@@ -54,26 +49,6 @@ const propsByInstanceIdStore = computed(
const useElementsTree = () => {
const [rootInstance] = useRootInstance();
- const [breakpoints] = useBreakpoints();
-
- const onChangeChildren: OnChangeChildren = useCallback(
- (change) => {
- store.createTransaction([rootInstanceContainer], (rootInstance) => {
- if (rootInstance === undefined) {
- return;
- }
-
- const { instanceId, updates } = change;
- utils.tree.setInstanceChildrenMutable(
- instanceId,
- updates,
- rootInstance,
- Array.from(breakpoints.values())[0].id
- );
- });
- },
- [breakpoints]
- );
return useMemo(() => {
if (rootInstance === undefined) {
@@ -86,9 +61,8 @@ const useElementsTree = () => {
propsByInstanceIdStore,
assetsStore,
Component: WrapperComponentDev,
- onChangeChildren,
});
- }, [rootInstance, onChangeChildren]);
+ }, [rootInstance]);
};
const DesignMode = () => {
diff --git a/apps/builder/app/canvas/features/text-editor/interop.ts b/apps/builder/app/canvas/features/text-editor/interop.ts
index 6fa1035979..a2aeb6a034 100644
--- a/apps/builder/app/canvas/features/text-editor/interop.ts
+++ b/apps/builder/app/canvas/features/text-editor/interop.ts
@@ -12,7 +12,6 @@ import {
} from "lexical";
import { $createLinkNode, $isLinkNode } from "@lexical/link";
import type { Instance, Text } from "@webstudio-is/project-build";
-import type { ChildrenUpdates } from "@webstudio-is/react-sdk";
import { utils } from "@webstudio-is/project";
import { $isSpanNode, $setNodeSpan } from "./toolbar-connector";
@@ -28,7 +27,7 @@ const lexicalFormats = [
const $writeUpdates = (
node: ElementNode,
- updates: ChildrenUpdates,
+ updates: Instance["children"],
refs: Refs
) => {
const children = node.getChildren();
@@ -40,8 +39,10 @@ const $writeUpdates = (
updates.push({ type: "text", value: "\n" });
}
if ($isLinkNode(child)) {
- const id = refs.get(child.getKey());
- const childrenUpdates: ChildrenUpdates = [];
+ const key = child.getKey();
+ const id = refs.get(key) ?? utils.tree.createInstanceId();
+ refs.set(key, id);
+ const childrenUpdates: Instance["children"] = [];
$writeUpdates(child, childrenUpdates, refs);
updates.push({
type: "instance",
@@ -58,12 +59,10 @@ const $writeUpdates = (
let parentUpdates = updates;
if ($isSpanNode(child)) {
// prematurely generate span id to select it right after applying
- const storedId = refs.get(`${child.getKey()}:span`);
- const id = storedId ?? utils.tree.createInstanceId();
- if (storedId == null) {
- refs.set(`${child.getKey()}:span`, id);
- }
- const update: ChildrenUpdates[number] = {
+ const key = `${child.getKey()}:span`;
+ const id = refs.get(key) ?? utils.tree.createInstanceId();
+ refs.set(key, id);
+ const update: Instance["children"][number] = {
type: "instance",
id,
component: "Span",
@@ -75,8 +74,10 @@ const $writeUpdates = (
// convert all lexical formats
for (const [format, component] of lexicalFormats) {
if (child.hasFormat(format)) {
- const id = refs.get(`${child.getKey()}:${format}`);
- const update: ChildrenUpdates[number] = {
+ const key = `${child.getKey()}:${format}`;
+ const id = refs.get(key) ?? utils.tree.createInstanceId();
+ refs.set(key, id);
+ const update: Instance["children"][number] = {
type: "instance",
id,
component,
@@ -92,7 +93,7 @@ const $writeUpdates = (
};
export const $convertToUpdates = (refs: Refs) => {
- const updates: ChildrenUpdates = [];
+ const updates: Instance["children"] = [];
const root = $getRoot();
$writeUpdates(root, updates, refs);
return updates;
diff --git a/apps/builder/app/canvas/features/text-editor/text-editor.tsx b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
index 8b59fa8cad..58c27bb2c6 100644
--- a/apps/builder/app/canvas/features/text-editor/text-editor.tsx
+++ b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
@@ -20,7 +20,6 @@ import { LinkPlugin } from "@lexical/react/LexicalLinkPlugin";
import { nanoid } from "nanoid";
import { createCssEngine } from "@webstudio-is/css-engine";
import type { Instance } from "@webstudio-is/project-build";
-import type { ChildrenUpdates } from "@webstudio-is/react-sdk";
import { idAttribute } from "@webstudio-is/react-sdk";
import { ToolbarConnectorPlugin } from "./toolbar-connector";
import { type Refs, $convertToLexical, $convertToUpdates } from "./interop";
@@ -116,7 +115,7 @@ const onError = (error: Error) => {
type TextEditorProps = {
instance: Instance;
contentEditable: JSX.Element;
- onChange: (updates: ChildrenUpdates) => void;
+ onChange: (updates: Instance["children"]) => void;
onSelectInstance: (instanceId: string) => void;
};
diff --git a/apps/builder/app/canvas/features/wrapper-component/wrapper-component.tsx b/apps/builder/app/canvas/features/wrapper-component/wrapper-component.tsx
index 40bb2384c5..98610fa196 100644
--- a/apps/builder/app/canvas/features/wrapper-component/wrapper-component.tsx
+++ b/apps/builder/app/canvas/features/wrapper-component/wrapper-component.tsx
@@ -2,19 +2,21 @@ import type { MouseEvent, FormEvent } from "react";
import { Suspense, lazy, useCallback, useMemo, useRef } from "react";
import { useStore } from "@nanostores/react";
import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext";
+import store from "immerhin";
import type { Instance, Prop } from "@webstudio-is/project-build";
import {
- type OnChangeChildren,
renderWrapperComponentChildren,
getComponent,
idAttribute,
} from "@webstudio-is/react-sdk";
import {
+ rootInstanceContainer,
selectedInstanceIdStore,
useInstanceProps,
useInstanceStyles,
useTextEditingInstanceId,
} from "~/shared/nano-states";
+import { createInstancesIndex } from "~/shared/tree-utils";
import { useCssRules } from "~/canvas/shared/styles";
import { SelectedInstanceConnector } from "./selected-instance-connector";
@@ -46,13 +48,11 @@ type UserProps = Record<Prop["name"], string | number | boolean>;
type WrapperComponentDevProps = {
instance: Instance;
children: Array<JSX.Element | string>;
- onChangeChildren?: OnChangeChildren;
};
export const WrapperComponentDev = ({
instance,
children,
- onChangeChildren,
}: WrapperComponentDevProps) => {
const instanceId = instance.id;
@@ -145,7 +145,13 @@ export const WrapperComponentDev = ({
/>
}
onChange={(updates) => {
- onChangeChildren?.({ instanceId: instance.id, updates });
+ store.createTransaction([rootInstanceContainer], (rootInstance) => {
+ const { instancesById } = createInstancesIndex(rootInstance);
+ const instance = instancesById.get(instanceId);
+ if (instance) {
+ instance.children = updates;
+ }
+ });
}}
onSelectInstance={(instanceId) => {
setTextEditingInstanceId(undefined);
diff --git a/packages/project/src/shared/tree-utils/index.ts b/packages/project/src/shared/tree-utils/index.ts
index a9582ab4f6..41effc3fab 100644
--- a/packages/project/src/shared/tree-utils/index.ts
+++ b/packages/project/src/shared/tree-utils/index.ts
@@ -2,5 +2,4 @@ export * from "./create-instance";
export * from "./find-instance";
export * from "./get-instance-path";
export * from "./find-closest-non-inline-parent";
-export * from "./set-instance-children";
export * from "./find-instance";
diff --git a/packages/project/src/shared/tree-utils/set-instance-children.ts b/packages/project/src/shared/tree-utils/set-instance-children.ts
deleted file mode 100644
index 14ce695865..0000000000
--- a/packages/project/src/shared/tree-utils/set-instance-children.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-import type { Breakpoint, Instance, Text } from "@webstudio-is/project-build";
-import type { ChildrenUpdates } from "@webstudio-is/react-sdk";
-import { createInstance, createInstanceId } from "./create-instance";
-import { findInstanceById } from "./find-instance";
-
-type InstanceChild = Instance | Text;
-
-const hydrateTree = (
- parent: Instance,
- updates: ChildrenUpdates,
- breakpoint: Breakpoint["id"]
-) => {
- const children: InstanceChild[] = [];
- for (const update of updates) {
- // Set a string as a child
- if (update.type === "text") {
- children.push(update);
- continue;
- }
- // create new child or update existing
- const instanceId = update.id ?? createInstanceId();
- let child = findInstanceById(parent, instanceId);
- if (child == null) {
- child = createInstance({
- id: instanceId,
- component: update.component,
- children: [],
- });
- }
- children.push(child);
- hydrateTree(child, update.children, breakpoint);
- }
- parent.children = children;
-};
-
-/**
- * Update children of an instance with new text.
- * When child is an instance - we update it's children with a single text entry.
- */
-export const setInstanceChildrenMutable = (
- id: Instance["id"],
- // Not a consistent format now, maybe better:
- // [{set: 'string'}, {set: instance}, {update: {id,text}}]
- updates: ChildrenUpdates,
- rootInstance: Instance,
- breakpoint: Breakpoint["id"] = ""
-) => {
- const instance = findInstanceById(rootInstance, id);
- if (instance === undefined) {
- return false;
- }
- hydrateTree(instance, updates, breakpoint);
- return true;
-};
diff --git a/packages/react-sdk/src/tree/create-elements-tree.tsx b/packages/react-sdk/src/tree/create-elements-tree.tsx
index e82dcd08e9..fbf16ea824 100644
--- a/packages/react-sdk/src/tree/create-elements-tree.tsx
+++ b/packages/react-sdk/src/tree/create-elements-tree.tsx
@@ -7,43 +7,22 @@ import type { Assets, PropsByInstanceId } from "../props";
import type { WrapperComponent } from "./wrapper-component";
import { SessionStoragePolyfill } from "./session-storage-polyfill";
-export type ChildrenUpdates = Array<
- | {
- type: "text";
- value: string;
- }
- | {
- type: "instance";
- id: undefined | Instance["id"];
- component: Instance["component"];
- children: ChildrenUpdates;
- }
->;
-
-export type OnChangeChildren = (change: {
- instanceId: Instance["id"];
- updates: ChildrenUpdates;
-}) => void;
-
export const createElementsTree = ({
sandbox,
instance,
propsByInstanceIdStore,
assetsStore,
Component,
- onChangeChildren,
}: {
sandbox?: boolean;
instance: Instance;
propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;
assetsStore: ReadableAtom<Assets>;
Component: (props: ComponentProps<typeof WrapperComponent>) => JSX.Element;
- onChangeChildren?: OnChangeChildren;
}) => {
const children = createInstanceChildrenElements({
Component,
children: instance.children,
- onChangeChildren,
});
const body = createInstanceElement({
Component,
@@ -67,11 +46,9 @@ export const createElementsTree = ({
const createInstanceChildrenElements = ({
children,
Component,
- onChangeChildren,
}: {
children: Instance["children"];
Component: (props: ComponentProps<typeof WrapperComponent>) => JSX.Element;
- onChangeChildren?: OnChangeChildren;
}) => {
const elements = [];
for (const child of children) {
@@ -82,12 +59,10 @@ const createInstanceChildrenElements = ({
const children = createInstanceChildrenElements({
children: child.children,
Component,
- onChangeChildren,
});
const element = createInstanceElement({
instance: child,
Component,
- onChangeChildren,
children,
});
elements.push(element);
@@ -99,18 +74,15 @@ const createInstanceElement = ({
Component,
instance,
children = [],
- onChangeChildren,
}: {
instance: Instance;
Component: (props: ComponentProps<typeof WrapperComponent>) => JSX.Element;
- onChangeChildren?: OnChangeChildren;
children?: Array<JSX.Element | string>;
}) => {
const props = {
instance,
children,
key: instance.id,
- onChangeChildren,
};
return <Component {...props} />;
diff --git a/packages/react-sdk/src/tree/wrapper-component.tsx b/packages/react-sdk/src/tree/wrapper-component.tsx
index 504e7b44cd..a1a1673c78 100644
--- a/packages/react-sdk/src/tree/wrapper-component.tsx
+++ b/packages/react-sdk/src/tree/wrapper-component.tsx
@@ -2,7 +2,6 @@ import { Fragment } from "react";
import type { Instance } from "@webstudio-is/project-build";
import { getComponent } from "../components";
import { useInstanceProps } from "../props";
-import type { OnChangeChildren } from "./create-elements-tree";
const renderText = (text: string): Array<JSX.Element> => {
const lines = text.split("\n");
@@ -30,12 +29,10 @@ export const renderWrapperComponentChildren = (
type WrapperComponentProps = {
instance: Instance;
children: Array<JSX.Element | string>;
- onChangeChildren?: OnChangeChildren;
};
export const WrapperComponent = ({
instance,
- onChangeChildren, // prevent it from passing to sdk component
children,
...rest
}: WrapperComponentProps) => {