Support explicit empty slot drop zones in shared editor
This commit is contained in:
1 parent
7110e1a7f1
commit
0f8d10eb91
7 files changed
+100
-11
No files matched your search
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@wrnexus/block-editor",
|
"name": "@wrnexus/block-editor",
|
||||||
"version": "0.1.4",
|
"version": "0.1.5",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"description": "Hydrated accessible editor runtime for WRNexus block documents.",
|
"description": "Hydrated accessible editor runtime for WRNexus block documents.",
|
||||||
"exports": {
|
"exports": {
|
||||||
|
|||||||
@@ -107,6 +107,16 @@ export function mountBlockEditor(root: HTMLElement, options: MountEditorOptions)
|
|||||||
});
|
});
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
for (const element of root.querySelectorAll<HTMLElement>("[data-block-slot-target][data-block-parent]")) {
|
||||||
|
const parentId = element.dataset.blockParent!;
|
||||||
|
const slot = element.dataset.blockSlotTarget!;
|
||||||
|
const hasChildren = [...root.querySelectorAll<HTMLElement>("[data-block-id][data-block-parent][data-block-slot]")]
|
||||||
|
.some(child => child.dataset.blockParent === parentId && child.dataset.blockSlot === slot);
|
||||||
|
if (hasChildren) continue;
|
||||||
|
const group = JSON.stringify([parentId, slot]);
|
||||||
|
groups.set(group, { parentId, slot });
|
||||||
|
cleanups.push(manager.registerDropZone({ id: `wrn-slot:${group}`, group, index: 0, element }));
|
||||||
|
}
|
||||||
for (const element of root.querySelectorAll<HTMLElement>(
|
for (const element of root.querySelectorAll<HTMLElement>(
|
||||||
"[data-block-id][data-block-parent][data-block-slot]",
|
"[data-block-id][data-block-parent][data-block-slot]",
|
||||||
)) {
|
)) {
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { expect, test } from "bun:test";
|
import { expect, test } from "bun:test";
|
||||||
import { readFileSync } from "node:fs";
|
import { readFileSync } from "node:fs";
|
||||||
import { Window } from "happy-dom";
|
import { Window } from "happy-dom";
|
||||||
import type { DndManagerOptions, SortableRegistration } from "@wrnexus/dnd";
|
import type { DndManagerOptions, SortableRegistration, DropZoneRegistration } from "@wrnexus/dnd";
|
||||||
import type { MountedEditor, MountEditorOptions } from "../src/runtime.ts";
|
import type { MountedEditor, MountEditorOptions } from "../src/runtime.ts";
|
||||||
|
|
||||||
const code = new Bun.Transpiler({ loader: "ts" })
|
const code = new Bun.Transpiler({ loader: "ts" })
|
||||||
@@ -19,13 +19,18 @@ function fixture(onMove: MountEditorOptions["onMove"] = () => false) {
|
|||||||
const backends: Array<{
|
const backends: Array<{
|
||||||
options: DndManagerOptions;
|
options: DndManagerOptions;
|
||||||
registrations: SortableRegistration[];
|
registrations: SortableRegistration[];
|
||||||
|
zones: DropZoneRegistration[];
|
||||||
destroyed: number;
|
destroyed: number;
|
||||||
}> = [];
|
}> = [];
|
||||||
const mount = new Function("createDndManager", code + ";return mountBlockEditor;")(
|
const mount = new Function("createDndManager", code + ";return mountBlockEditor;")(
|
||||||
(options: DndManagerOptions) => {
|
(options: DndManagerOptions) => {
|
||||||
const backend = { options, registrations: [] as SortableRegistration[], destroyed: 0 };
|
const backend = { options, registrations: [] as SortableRegistration[], zones: [] as DropZoneRegistration[], destroyed: 0 };
|
||||||
backends.push(backend);
|
backends.push(backend);
|
||||||
return {
|
return {
|
||||||
|
registerDropZone: (registration: DropZoneRegistration) => {
|
||||||
|
backend.zones.push(registration);
|
||||||
|
return () => {};
|
||||||
|
},
|
||||||
registerSortable: (registration: SortableRegistration) => {
|
registerSortable: (registration: SortableRegistration) => {
|
||||||
backend.registrations.push(registration);
|
backend.registrations.push(registration);
|
||||||
return () => {};
|
return () => {};
|
||||||
@@ -66,6 +71,28 @@ test("cancelled optimistic moves restore original DOM nodes across containers",
|
|||||||
f.editor.destroy();
|
f.editor.destroy();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("empty named slot targets produce validated editor move intents and refresh away when populated", async () => {
|
||||||
|
const moves: unknown[] = [];
|
||||||
|
const f = fixture(intent => { moves.push(intent); return true; });
|
||||||
|
const target = f.document.createElement("div");
|
||||||
|
target.dataset.blockParent = "parent:empty";
|
||||||
|
target.dataset.blockSlotTarget = "content:empty";
|
||||||
|
f.root.append(target);
|
||||||
|
f.editor.refresh();
|
||||||
|
const backend = f.backends.at(-1)!;
|
||||||
|
expect(backend.zones).toHaveLength(1);
|
||||||
|
const zone = backend.zones[0]!;
|
||||||
|
expect(backend.options.accept!(["a"], { group: zone.group, index: 0 })).toBe(true);
|
||||||
|
await backend.options.onMoveIntent({ ids: ["a"], from: [], to: { group: zone.group, index: 0 } });
|
||||||
|
expect(moves).toEqual([{ nodeIds: ["a"], to: { parentId: "parent:empty", slot: "content:empty", index: 0 } }]);
|
||||||
|
const child = f.root.querySelector('[data-block-id="a"]')! as any;
|
||||||
|
child.dataset.blockParent = "parent:empty"; child.dataset.blockSlot = "content:empty";
|
||||||
|
target.append(child);
|
||||||
|
f.editor.refresh();
|
||||||
|
expect(f.backends.at(-1)!.zones).toHaveLength(0);
|
||||||
|
f.editor.destroy();
|
||||||
|
});
|
||||||
|
|
||||||
test("slot and parent identifiers containing colons round-trip without collisions", async () => {
|
test("slot and parent identifiers containing colons round-trip without collisions", async () => {
|
||||||
const moves: unknown[] = [];
|
const moves: unknown[] = [];
|
||||||
const f = fixture((intent) => {
|
const f = fixture((intent) => {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@wrnexus/dnd",
|
"name": "@wrnexus/dnd",
|
||||||
"version": "0.1.2",
|
"version": "0.1.3",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"description": "Stable accessible drag-and-drop primitives for WRNexus.",
|
"description": "Stable accessible drag-and-drop primitives for WRNexus.",
|
||||||
"exports": {
|
"exports": {
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { DragDropManager } from "@dnd-kit/dom";
|
import { DragDropManager, Droppable } from "@dnd-kit/dom";
|
||||||
import { Sortable } from "@dnd-kit/dom/sortable";
|
import { Sortable } from "@dnd-kit/dom/sortable";
|
||||||
import type {
|
import type {
|
||||||
DndManager,
|
DndManager,
|
||||||
@@ -19,6 +19,7 @@ export function createDndManager(options: DndManagerOptions): DndManager {
|
|||||||
}
|
}
|
||||||
>();
|
>();
|
||||||
const manager = new DragDropManager();
|
const manager = new DragDropManager();
|
||||||
|
const zones = new Map<string | number, { droppable: Droppable; location: { group: string | number; index: number } }>();
|
||||||
let activeIds: Array<string | number> = [];
|
let activeIds: Array<string | number> = [];
|
||||||
let generation = 0;
|
let generation = 0;
|
||||||
let destroyed = false;
|
let destroyed = false;
|
||||||
@@ -39,7 +40,7 @@ export function createDndManager(options: DndManagerOptions): DndManager {
|
|||||||
const target = event.operation.target as
|
const target = event.operation.target as
|
||||||
(typeof event.operation.target & { group?: string | number; index?: number }) | null;
|
(typeof event.operation.target & { group?: string | number; index?: number }) | null;
|
||||||
if (!target) return;
|
if (!target) return;
|
||||||
const destination = { group: target.group ?? "default", index: target.index ?? 0 };
|
const destination = zones.get(target.id)?.location ?? { group: target.group ?? "default", index: target.index ?? 0 };
|
||||||
if (options.accept && !options.accept(activeIds, destination)) {
|
if (options.accept && !options.accept(activeIds, destination)) {
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
options.announce?.({ type: "invalid", ids: activeIds, location: destination });
|
options.announce?.({ type: "invalid", ids: activeIds, location: destination });
|
||||||
@@ -70,7 +71,7 @@ export function createDndManager(options: DndManagerOptions): DndManager {
|
|||||||
index: source.initialIndex ?? source.index ?? 0,
|
index: source.initialIndex ?? source.index ?? 0,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
to: { group: source.group ?? "default", index: source.index ?? 0 },
|
to: { ...(event.operation.target ? zones.get(event.operation.target.id)?.location : undefined) ?? { group: source.group ?? "default", index: source.index ?? 0 } },
|
||||||
};
|
};
|
||||||
// A pending commit must not own the next gesture's selection or lifecycle.
|
// A pending commit must not own the next gesture's selection or lifecycle.
|
||||||
activeIds = [];
|
activeIds = [];
|
||||||
@@ -96,9 +97,21 @@ export function createDndManager(options: DndManagerOptions): DndManager {
|
|||||||
});
|
});
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
registerDropZone(registration) {
|
||||||
|
if (destroyed) throw new Error("Cannot register a drop zone after manager destruction.");
|
||||||
|
if (entries.has(registration.id) || zones.has(registration.id)) throw new Error(`Duplicate draggable or drop zone id ${String(registration.id)}.`);
|
||||||
|
if (!Number.isSafeInteger(registration.index) || registration.index < 0) throw new Error("Drop zone index must be a non-negative safe integer.");
|
||||||
|
const droppable = new Droppable({ id: registration.id, element: registration.element, accept: registration.accepts, disabled: registration.disabled }, manager);
|
||||||
|
zones.set(registration.id, { droppable, location: { group: registration.group, index: registration.index } });
|
||||||
|
return () => {
|
||||||
|
if (zones.get(registration.id)?.droppable !== droppable) return;
|
||||||
|
droppable.destroy();
|
||||||
|
zones.delete(registration.id);
|
||||||
|
};
|
||||||
|
},
|
||||||
registerSortable(registration) {
|
registerSortable(registration) {
|
||||||
if (destroyed) throw new Error("Cannot register a sortable after manager destruction.");
|
if (destroyed) throw new Error("Cannot register a sortable after manager destruction.");
|
||||||
if (entries.has(registration.id))
|
if (entries.has(registration.id) || zones.has(registration.id))
|
||||||
throw new Error(`Duplicate sortable id ${String(registration.id)}.`);
|
throw new Error(`Duplicate sortable id ${String(registration.id)}.`);
|
||||||
const sortable = new Sortable(
|
const sortable = new Sortable(
|
||||||
{
|
{
|
||||||
@@ -134,6 +147,8 @@ export function createDndManager(options: DndManagerOptions): DndManager {
|
|||||||
activeIds = [];
|
activeIds = [];
|
||||||
for (const entry of entries.values()) entry.sortable.destroy();
|
for (const entry of entries.values()) entry.sortable.destroy();
|
||||||
entries.clear();
|
entries.clear();
|
||||||
|
for (const zone of zones.values()) zone.droppable.destroy();
|
||||||
|
zones.clear();
|
||||||
manager.destroy();
|
manager.destroy();
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -40,6 +40,14 @@ export interface DndManagerOptions {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export interface DndManager {
|
export interface DndManager {
|
||||||
|
registerDropZone(registration: DropZoneRegistration): () => void;
|
||||||
registerSortable(registration: SortableRegistration): () => void;
|
registerSortable(registration: SortableRegistration): () => void;
|
||||||
destroy(): void;
|
destroy(): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface DropZoneRegistration extends SortableLocation {
|
||||||
|
id: DndId;
|
||||||
|
element: HTMLElement;
|
||||||
|
accepts?: DndId[];
|
||||||
|
disabled?: boolean;
|
||||||
|
}
|
||||||
@@ -36,8 +36,9 @@ function fixture(overrides: Partial<DndManagerOptions> = {}) {
|
|||||||
const create = new Function(
|
const create = new Function(
|
||||||
"DragDropManager",
|
"DragDropManager",
|
||||||
"Sortable",
|
"Sortable",
|
||||||
|
"Droppable",
|
||||||
compiled + ";return createDndManager;",
|
compiled + ";return createDndManager;",
|
||||||
)(Backend, Sortable);
|
)(Backend, Sortable, Sortable);
|
||||||
const manager: DndManager = create({
|
const manager: DndManager = create({
|
||||||
onMoveIntent: () => true,
|
onMoveIntent: () => true,
|
||||||
announce: (event: DndAnnouncement) => announcements.push(event),
|
announce: (event: DndAnnouncement) => announcements.push(event),
|
||||||
@@ -54,8 +55,8 @@ function fixture(overrides: Partial<DndManagerOptions> = {}) {
|
|||||||
announcements,
|
announcements,
|
||||||
instances,
|
instances,
|
||||||
start: (id: string) => listeners.dragstart!(event(id)),
|
start: (id: string) => listeners.dragstart!(event(id)),
|
||||||
end: (id: string) => listeners.dragend!(event(id)),
|
end: (id: string, target?: { id: string }) => listeners.dragend!({ ...event(id), operation: { ...event(id).operation, target } }),
|
||||||
over: (target: { group: string; index: number }) => {
|
over: (target: { id?: string; group?: string; index?: number }) => {
|
||||||
let prevented = false;
|
let prevented = false;
|
||||||
listeners.dragover!({
|
listeners.dragover!({
|
||||||
...event("first"),
|
...event("first"),
|
||||||
@@ -93,6 +94,34 @@ test("late drop resolution cannot clear or announce a newer gesture", async () =
|
|||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("empty drop zones use explicit locations for acceptance and commit", async () => {
|
||||||
|
const commits: unknown[] = [];
|
||||||
|
const f = fixture({ accept: (_ids, to) => to.group === "empty", onMoveIntent: intent => { commits.push(intent.to); } });
|
||||||
|
const registration = { id: "zone", group: "empty", index: 0, element: {} as HTMLElement };
|
||||||
|
const cleanup = f.manager.registerDropZone(registration);
|
||||||
|
f.start("block");
|
||||||
|
expect(f.over({ id: "zone" })).toBe(false);
|
||||||
|
expect(f.announcements.at(-1)?.location).toEqual({ group: "empty", index: 0 });
|
||||||
|
await f.end("block", { id: "zone" });
|
||||||
|
expect(commits).toEqual([{ group: "empty", index: 0 }]);
|
||||||
|
expect(() => f.manager.registerSortable(registration)).toThrow("Duplicate");
|
||||||
|
cleanup();
|
||||||
|
f.manager.registerDropZone(registration);
|
||||||
|
cleanup();
|
||||||
|
expect(() => f.manager.registerDropZone(registration)).toThrow("Duplicate");
|
||||||
|
f.manager.destroy(); f.manager.destroy();
|
||||||
|
expect(f.instances.map(instance => instance.destroyed)).toEqual([1, 1]);
|
||||||
|
expect(() => f.manager.registerDropZone(registration)).toThrow("destruction");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("invalid drop zone indices are rejected before backend registration", () => {
|
||||||
|
const f = fixture();
|
||||||
|
for (const index of [-1, 0.5, Infinity, Number.MAX_SAFE_INTEGER + 1]) {
|
||||||
|
expect(() => f.manager.registerDropZone({ id: "zone", group: "empty", index, element: {} as HTMLElement })).toThrow("index");
|
||||||
|
}
|
||||||
|
expect(f.instances).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
test("hover acceptance checks the proposed target instead of the source's old group", () => {
|
test("hover acceptance checks the proposed target instead of the source's old group", () => {
|
||||||
const f = fixture({ accept: (_ids, to) => to.group === "allowed" });
|
const f = fixture({ accept: (_ids, to) => to.group === "allowed" });
|
||||||
f.start("first");
|
f.start("first");
|
||||||
|
|||||||
Reference in new issue
Block a user