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.

feat: select sibling after delete instance (#2476)

Bogdan Chadkin45aca1884300
diff --git a/apps/builder/app/builder/shared/commands.test.ts b/apps/builder/app/builder/shared/commands.test.ts
new file mode 100644
index 0000000000..fe35a5504d
--- /dev/null
+++ b/apps/builder/app/builder/shared/commands.test.ts
@@ -0,0 +1,82 @@
+import { describe, expect, test } from "@jest/globals";
+import type { Instance } from "@webstudio-is/sdk";
+import * as baseMetas from "@webstudio-is/sdk-components-react/metas";
+import {
+ instancesStore,
+ registeredComponentMetasStore,
+ selectedInstanceSelectorStore,
+} from "~/shared/nano-states";
+import { registerContainers } from "~/shared/sync";
+import { emitCommand } from "./commands";
+
+registerContainers();
+
+const createInstancePair = (
+ id: Instance["id"],
+ component: string,
+ children: Instance["children"]
+): [Instance["id"], Instance] => {
+ return [id, { type: "instance", id, component, children }];
+};
+
+const metas = new Map(Object.entries(baseMetas));
+
+describe("deleteInstance", () => {
+ // body
+ // parent
+ // child1
+ // child2
+ // child3
+ const threeChildInstances = new Map([
+ createInstancePair("body", "Body", [{ type: "id", value: "parent" }]),
+ createInstancePair("parent", "Box", [
+ { type: "id", value: "child1" },
+ { type: "id", value: "child2" },
+ { type: "id", value: "child3" },
+ ]),
+ createInstancePair("child1", "Box", []),
+ createInstancePair("child2", "Box", []),
+ createInstancePair("child3", "Box", []),
+ ]);
+
+ test("delete selected instance and select next one", () => {
+ registeredComponentMetasStore.set(metas);
+ selectedInstanceSelectorStore.set(["child2", "parent", "body"]);
+ instancesStore.set(threeChildInstances);
+ emitCommand("deleteInstance");
+ expect(selectedInstanceSelectorStore.get()).toEqual([
+ "child3",
+ "parent",
+ "body",
+ ]);
+ });
+
+ test("delete selected instance and select previous one", () => {
+ registeredComponentMetasStore.set(metas);
+ selectedInstanceSelectorStore.set(["child3", "parent", "body"]);
+ instancesStore.set(threeChildInstances);
+ emitCommand("deleteInstance");
+ expect(selectedInstanceSelectorStore.get()).toEqual([
+ "child2",
+ "parent",
+ "body",
+ ]);
+ });
+
+ test("delete selected instance and select parent one", () => {
+ selectedInstanceSelectorStore.set(["child1", "parent", "body"]);
+ registeredComponentMetasStore.set(metas);
+ // body
+ // parent
+ // child1
+ instancesStore.set(
+ new Map([
+ createInstancePair("body", "Body", [{ type: "id", value: "parent" }]),
+ createInstancePair("parent", "Box", [{ type: "id", value: "child1" }]),
+ createInstancePair("child1", "Box", []),
+ ])
+ );
+ emitCommand("deleteInstance");
+ expect(selectedInstanceSelectorStore.get()).toEqual(["parent", "body"]);
+ });
+});
diff --git a/apps/builder/app/builder/shared/commands.ts b/apps/builder/app/builder/shared/commands.ts
index 41061d7140..7c6115b7e9 100644
--- a/apps/builder/app/builder/shared/commands.ts
+++ b/apps/builder/app/builder/shared/commands.ts
@@ -2,14 +2,18 @@ import { createCommandsEmitter, type Command } from "~/shared/commands-emitter";
import {
$isPreviewMode,
editingItemIdStore,
+ instancesStore,
selectedInstanceSelectorStore,
+ selectedStyleSourceSelectorStore,
+ textEditingInstanceSelectorStore,
} from "~/shared/nano-states";
import {
$breakpointsMenuView,
selectBreakpointByOrder,
} from "~/shared/breakpoints";
import { onCopy, onPaste } from "~/shared/copy-paste/plugin-instance";
-import { deleteSelectedInstance } from "~/shared/instance-utils";
+import { deleteInstance } from "~/shared/instance-utils";
+import type { InstanceSelector } from "~/shared/tree-utils";
const makeBreakpointCommand = <CommandName extends string>(
name: CommandName,
@@ -22,6 +26,46 @@ const makeBreakpointCommand = <CommandName extends string>(
},
});
+const deleteSelectedInstance = () => {
+ const textEditingInstanceSelector = textEditingInstanceSelectorStore.get();
+ const selectedInstanceSelector = selectedInstanceSelectorStore.get();
+ // cannot delete instance while editing
+ if (textEditingInstanceSelector) {
+ return;
+ }
+ if (selectedInstanceSelector === undefined) {
+ return;
+ }
+ if (selectedInstanceSelector.length === 1) {
+ return;
+ }
+ let newSelectedInstanceSelector: undefined | InstanceSelector;
+ const instances = instancesStore.get();
+ const [selectedInstanceId, parentInstanceId] = selectedInstanceSelector;
+ const parentInstance = instances.get(parentInstanceId);
+ if (parentInstance) {
+ const siblingIds = parentInstance.children
+ .filter((child) => child.type === "id")
+ .map((child) => child.value);
+ const position = siblingIds.indexOf(selectedInstanceId);
+ const siblingId = siblingIds[position + 1] ?? siblingIds[position - 1];
+ if (siblingId) {
+ // select next or previous sibling if possible
+ newSelectedInstanceSelector = [
+ siblingId,
+ ...selectedInstanceSelector.slice(1),
+ ];
+ } else {
+ // fallback to parent
+ newSelectedInstanceSelector = selectedInstanceSelector.slice(1);
+ }
+ }
+ if (deleteInstance(selectedInstanceSelector)) {
+ selectedInstanceSelectorStore.set(newSelectedInstanceSelector);
+ selectedStyleSourceSelectorStore.set(undefined);
+ }
+};
+
export const { emitCommand, subscribeCommands } = createCommandsEmitter({
source: "builder",
externalCommands: ["editInstanceText"],
@@ -61,9 +105,7 @@ export const { emitCommand, subscribeCommands } = createCommandsEmitter({
// this disables hotkey for inputs on style panel
// but still work for input on canvas which call event.preventDefault() in keydown handler
disableHotkeyOnFormTags: true,
- handler: () => {
- deleteSelectedInstance();
- },
+ handler: deleteSelectedInstance,
},
{
name: "duplicateInstance",
diff --git a/apps/builder/app/shared/commands-emitter.ts b/apps/builder/app/shared/commands-emitter.ts
index 50a302209f..8c63eca7b1 100644
--- a/apps/builder/app/shared/commands-emitter.ts
+++ b/apps/builder/app/shared/commands-emitter.ts
@@ -66,13 +66,19 @@ export const createCommandsEmitter = <CommandName extends string>({
const emitCommand = (name: CommandName) => {
const { publish } = $publisher.get();
- publish({
- type: "command",
- payload: {
- source,
- name,
- },
- });
+ // continue to work without emitter
+ // for example in tests
+ if (publish) {
+ publish({
+ type: "command",
+ payload: {
+ source,
+ name,
+ },
+ });
+ } else {
+ commandHandlers.get(name)?.();
+ }
};
/**
diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.ts
index 763fbd7a3f..d490eceef0 100644
--- a/apps/builder/app/shared/instance-utils.ts
+++ b/apps/builder/app/shared/instance-utils.ts
@@ -19,7 +19,6 @@ import {
styleSourcesStore,
instancesStore,
selectedStyleSourceSelectorStore,
- textEditingInstanceSelectorStore,
breakpointsStore,
registeredComponentMetasStore,
dataSourcesStore,
@@ -393,13 +392,13 @@ export const reparentInstance = (
export const deleteInstance = (instanceSelector: InstanceSelector) => {
// @todo tell user they can't delete root
if (instanceSelector.length === 1) {
- return;
+ return false;
}
if (isInstanceDetachable(instanceSelector) === false) {
toast.error(
"This instance can not be moved outside of its parent component."
);
- return;
+ return false;
}
serverSyncStore.createTransaction(
[
@@ -484,26 +483,7 @@ export const deleteInstance = (instanceSelector: InstanceSelector) => {
styles.delete(styleDeclKey);
}
}
-
- if (parentInstance) {
- selectedInstanceSelectorStore.set(
- getAncestorInstanceSelector(instanceSelector, parentInstance.id)
- );
- selectedStyleSourceSelectorStore.set(undefined);
- }
}
);
-};
-
-export const deleteSelectedInstance = () => {
- const textEditingInstanceSelector = textEditingInstanceSelectorStore.get();
- const selectedInstanceSelector = selectedInstanceSelectorStore.get();
- // cannot delete instance while editing
- if (textEditingInstanceSelector) {
- return;
- }
- if (selectedInstanceSelector === undefined) {
- return;
- }
- deleteInstance(selectedInstanceSelector);
+ return true;
};
diff --git a/apps/builder/app/shared/pubsub/index.ts b/apps/builder/app/shared/pubsub/index.ts
index fc37e9e049..6c3541e806 100644
--- a/apps/builder/app/shared/pubsub/index.ts
+++ b/apps/builder/app/shared/pubsub/index.ts
@@ -13,8 +13,4 @@ export const { publish, usePublish, useSubscribe, subscribe } =
export type Publish = typeof publish;
export type UsePublish = typeof usePublish;
-export const $publisher = atom<{
- publish: Publish;
-}>({
- publish: () => {},
-});
+export const $publisher = atom<{ publish?: Publish }>({});