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.

Restrict allowed parents with config in meta (#1542)

Bogdan Chadkin4e31256b2a44
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx b/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx
index 29236b1c20..bf39efd921 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/components/use-draggable.tsx
@@ -158,10 +158,12 @@ export const useDraggable = ({
const dropTarget = findClosestDroppableTarget(
instancesStore.get(),
// fallback to root as drop target
- selectedInstanceSelectorStore.get() ?? [selectedPage.rootInstanceId]
+ selectedInstanceSelectorStore.get() ?? [selectedPage.rootInstanceId],
+ [component]
);
-
- insertNewComponentInstance(component, dropTarget);
+ if (dropTarget) {
+ insertNewComponentInstance(component, dropTarget);
+ }
};
return {
diff --git a/apps/builder/app/builder/shared/tree/index.tsx b/apps/builder/app/builder/shared/tree/index.tsx
index e5e8be9309..cdd49bb5d8 100644
--- a/apps/builder/app/builder/shared/tree/index.tsx
+++ b/apps/builder/app/builder/shared/tree/index.tsx
@@ -1,4 +1,4 @@
-import { useCallback } from "react";
+import { useCallback, useMemo } from "react";
import { useStore } from "@nanostores/react";
import {
Tree,
@@ -9,10 +9,11 @@ import {
} from "@webstudio-is/design-system";
import type { Instance } from "@webstudio-is/project-build";
import {
+ canAcceptComponent,
getComponentMeta,
type WsComponentMeta,
} from "@webstudio-is/react-sdk";
-import { instancesStore } from "~/shared/nano-states";
+import { instancesStore, useDragAndDropState } from "~/shared/nano-states";
const instanceRelatedProps = {
renderItem(props: TreeItemRenderProps<Instance>) {
@@ -40,6 +41,22 @@ export const InstanceTree = (
>
) => {
const instances = useStore(instancesStore);
+ const [state] = useDragAndDropState();
+
+ const dragPayload = state.dragPayload;
+
+ const dragComponent = useMemo(() => {
+ let dragComponent: undefined | string;
+ if (dragPayload?.type === "insert") {
+ dragComponent = dragPayload.dragComponent;
+ }
+ if (dragPayload?.type === "reparent") {
+ dragComponent = instances.get(
+ dragPayload.dragInstanceSelector[0]
+ )?.component;
+ }
+ return dragComponent;
+ }, [dragPayload, instances]);
const canLeaveParent = useCallback(
(instanceId: Instance["id"]) => {
@@ -56,13 +73,12 @@ export const InstanceTree = (
const canAcceptChild = useCallback(
(instanceId: Instance["id"]) => {
const instance = instances.get(instanceId);
- if (instance === undefined) {
+ if (instance === undefined || dragComponent === undefined) {
return false;
}
- const meta = getComponentMeta(instance.component);
- return meta?.type === "container";
+ return canAcceptComponent(instance.component, dragComponent);
},
- [instances]
+ [instances, dragComponent]
);
const getItemChildren = useCallback(
diff --git a/apps/builder/app/canvas/shared/use-drag-drop.ts b/apps/builder/app/canvas/shared/use-drag-drop.ts
index 3c9d3a67c4..57e2433e55 100644
--- a/apps/builder/app/canvas/shared/use-drag-drop.ts
+++ b/apps/builder/app/canvas/shared/use-drag-drop.ts
@@ -9,7 +9,7 @@ import {
useDrop,
computeIndicatorPlacement,
} from "@webstudio-is/design-system";
-import { getComponentMeta } from "@webstudio-is/react-sdk";
+import { canAcceptComponent, getComponentMeta } from "@webstudio-is/react-sdk";
import { instancesStore } from "~/shared/nano-states";
import { textEditingInstanceSelectorStore } from "~/shared/nano-states";
import { publish, useSubscribe } from "~/shared/pubsub";
@@ -71,14 +71,23 @@ const findClosestRichTextInstanceSelector = (
};
const findClosestDroppableInstanceSelector = (
- instanceSelector: InstanceSelector
+ instanceSelector: InstanceSelector,
+ dragPayload: DragStartPayload
) => {
const instances = instancesStore.get();
+ let dragComponent: undefined | string;
+ if (dragPayload.type === "insert") {
+ dragComponent = dragPayload.dragComponent;
+ }
+ if (dragPayload.type === "reparent") {
+ dragComponent = instances.get(
+ dragPayload.dragInstanceSelector[0]
+ )?.component;
+ }
for (const instanceId of instanceSelector) {
const instance = instances.get(instanceId);
- if (instance !== undefined) {
- const meta = getComponentMeta(instance.component);
- if (meta?.type === "container") {
+ if (instance !== undefined && dragComponent !== undefined) {
+ if (canAcceptComponent(instance.component, dragComponent)) {
return getAncestorInstanceSelector(instanceSelector, instanceId);
}
}
@@ -144,7 +153,8 @@ export const useDragAndDrop = () => {
}
const droppableInstanceSelector = findClosestDroppableInstanceSelector(
- newDropInstanceSelector
+ newDropInstanceSelector,
+ dragPayload
);
if (droppableInstanceSelector === undefined) {
return;
diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.ts b/apps/builder/app/shared/copy-paste/plugin-instance.ts
index ca24c4bbd5..5687ebfd19 100644
--- a/apps/builder/app/shared/copy-paste/plugin-instance.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-instance.ts
@@ -147,10 +147,15 @@ export const onPaste = (clipboardData: string) => {
const instanceSelector = selectedInstanceSelectorStore.get() ?? [
selectedPage.rootInstanceId,
];
+ const dragComponent = data.instances[0].component;
const dropTarget = findClosestDroppableTarget(
instancesStore.get(),
- instanceSelector
+ instanceSelector,
+ [dragComponent]
);
+ if (dropTarget === undefined) {
+ return;
+ }
store.createTransaction(
[
breakpointsStore,
diff --git a/apps/builder/app/shared/copy-paste/plugin-markdown.ts b/apps/builder/app/shared/copy-paste/plugin-markdown.ts
index ee410bede5..8e0b68ceb4 100644
--- a/apps/builder/app/shared/copy-paste/plugin-markdown.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-markdown.ts
@@ -211,10 +211,22 @@ export const onPaste = (clipboardData: string) => {
const instanceSelector = selectedInstanceSelectorStore.get() ?? [
selectedPage.rootInstanceId,
];
+ const instances = instancesStore.get();
+ const dragComponents = [];
+ for (const instanceId of data.rootIds) {
+ const component = instances.get(instanceId)?.component;
+ if (component !== undefined) {
+ dragComponents.push(component);
+ }
+ }
const dropTarget = findClosestDroppableTarget(
instancesStore.get(),
- instanceSelector
+ instanceSelector,
+ dragComponents
);
+ if (dropTarget === undefined) {
+ return;
+ }
store.createTransaction([instancesStore, propsStore], (instances, props) => {
insertInstancesMutable(instances, data.instances, data.rootIds, dropTarget);
for (const prop of data.props) {
diff --git a/apps/builder/app/shared/tree-utils.test.ts b/apps/builder/app/shared/tree-utils.test.ts
index e8bfb0769e..98794b9f26 100644
--- a/apps/builder/app/shared/tree-utils.test.ts
+++ b/apps/builder/app/shared/tree-utils.test.ts
@@ -170,33 +170,51 @@ test("find closest droppable target", () => {
createInstancePair("box3", "Box", [
{ type: "id", value: "box31" },
{ type: "id", value: "box32" },
- { type: "id", value: "box33" },
+ { type: "id", value: "list33" },
]),
createInstancePair("box31", "Box", []),
createInstancePair("box32", "Box", []),
- createInstancePair("box33", "Box", []),
+ createInstancePair("list33", "List", []),
]);
+
expect(
- findClosestDroppableTarget(instances, [
- "bold",
- "paragraph21",
- "box2",
- "root",
- ])
+ findClosestDroppableTarget(
+ instances,
+ ["bold", "paragraph21", "box2", "root"],
+ ["Box"]
+ )
).toEqual({
parentSelector: ["box2", "root"],
position: 1,
});
- expect(findClosestDroppableTarget(instances, ["box3", "root"])).toEqual({
+ expect(
+ findClosestDroppableTarget(instances, ["box3", "root"], ["Box"])
+ ).toEqual({
parentSelector: ["box3", "root"],
position: "end",
});
- expect(findClosestDroppableTarget(instances, ["root"])).toEqual({
+ expect(findClosestDroppableTarget(instances, ["root"], ["Box"])).toEqual({
parentSelector: ["root"],
position: "end",
});
- expect(findClosestDroppableTarget(instances, ["box4", "root"])).toEqual({
- parentSelector: ["root"],
+ expect(
+ findClosestDroppableTarget(instances, ["box4", "root"], ["Box"])
+ ).toEqual(undefined);
+ expect(
+ findClosestDroppableTarget(
+ instances,
+ ["box32", "box3", "root"],
+ ["Box", "ListItem"]
+ )
+ ).toEqual(undefined);
+ expect(
+ findClosestDroppableTarget(
+ instances,
+ ["list33", "box3", "root"],
+ ["Box", "ListItem"]
+ )
+ ).toEqual({
+ parentSelector: ["list33", "box3", "root"],
position: "end",
});
});
diff --git a/apps/builder/app/shared/tree-utils.ts b/apps/builder/app/shared/tree-utils.ts
index c754af1791..2b884e1c90 100644
--- a/apps/builder/app/shared/tree-utils.ts
+++ b/apps/builder/app/shared/tree-utils.ts
@@ -17,6 +17,7 @@ import {
StyleSourceSelections,
} from "@webstudio-is/project-build";
import {
+ canAcceptComponent,
generateDataFromEmbedTemplate,
getComponentMeta,
} from "@webstudio-is/react-sdk";
@@ -77,11 +78,6 @@ export const createComponentInstance = (
return { instances, props, styleSourceSelections, styleSources, styles };
};
-const isInstanceDroppable = (instance: Instance) => {
- const meta = getComponentMeta(instance.component);
- return meta?.type === "container";
-};
-
export type DroppableTarget = {
parentSelector: InstanceSelector;
position: number | "end";
@@ -89,19 +85,16 @@ export type DroppableTarget = {
export const findClosestDroppableTarget = (
instances: Instances,
- instanceSelector: InstanceSelector
-): DroppableTarget => {
+ instanceSelector: InstanceSelector,
+ dragComponents: string[]
+): undefined | DroppableTarget => {
// fallback to root as drop target when selector is stale
- const rootDropTarget: DroppableTarget = {
- parentSelector: [instanceSelector[instanceSelector.length - 1]],
- position: "end",
- };
let position = -1;
let lastChild: undefined | Instance = undefined;
for (const instanceId of instanceSelector) {
const instance = instances.get(instanceId);
if (instance === undefined) {
- return rootDropTarget;
+ return;
}
// find the index of child from selector
if (lastChild) {
@@ -111,21 +104,22 @@ export const findClosestDroppableTarget = (
);
}
lastChild = instance;
- if (isInstanceDroppable(instance)) {
+ const canAcceptAllDragComponents = dragComponents.every((dragComponent) =>
+ canAcceptComponent(instance.component, dragComponent)
+ );
+ if (canAcceptAllDragComponents) {
const parentSelector = getAncestorInstanceSelector(
instanceSelector,
instance.id
);
- if (parentSelector === undefined) {
- return rootDropTarget;
+ if (parentSelector !== undefined) {
+ return {
+ parentSelector: parentSelector,
+ position: position === -1 ? "end" : position + 1,
+ };
}
- return {
- parentSelector: parentSelector,
- position: position === -1 ? "end" : position + 1,
- };
}
}
- return rootDropTarget;
};
const getInstanceOrCreateFragmentIfNecessary = (
diff --git a/packages/react-sdk/src/components/component-meta.ts b/packages/react-sdk/src/components/component-meta.ts
index bad51966df..b91268f0d4 100644
--- a/packages/react-sdk/src/components/component-meta.ts
+++ b/packages/react-sdk/src/components/component-meta.ts
@@ -46,6 +46,7 @@ const WsComponentMeta = z.object({
"rich-text",
"rich-text-child",
]),
+ acceptedParents: z.optional(z.array(z.string())),
label: z.string(),
Icon: z.function(),
presetStyle: z.optional(z.any()),
diff --git a/packages/react-sdk/src/components/index.ts b/packages/react-sdk/src/components/index.ts
index f722c80f84..775eca2ecd 100644
--- a/packages/react-sdk/src/components/index.ts
+++ b/packages/react-sdk/src/components/index.ts
@@ -219,3 +219,18 @@ const computeInitialProps = (
// order of initialProps must be preserved
return [...initialProps, ...requiredProps];
};
+
+export const canAcceptComponent = (
+ parentComponent: string,
+ childComponent: string
+) => {
+ const parentMeta = getComponentMeta(parentComponent);
+ const childMeta = getComponentMeta(childComponent);
+ if (parentMeta?.type !== "container" || childMeta === undefined) {
+ return false;
+ }
+ return (
+ childMeta.acceptedParents === undefined ||
+ childMeta.acceptedParents.includes(parentComponent)
+ );
+};
diff --git a/packages/react-sdk/src/components/list-item.ws.tsx b/packages/react-sdk/src/components/list-item.ws.tsx
index 8313419957..02689e88a9 100644
--- a/packages/react-sdk/src/components/list-item.ws.tsx
+++ b/packages/react-sdk/src/components/list-item.ws.tsx
@@ -15,6 +15,7 @@ const presetStyle = {
export const meta: WsComponentMeta = {
category: "typography",
type: "rich-text",
+ acceptedParents: ["List"],
label: "List Item",
Icon: ListItemIcon,
children: [{ type: "text", value: "List Item you can edit" }],