mirror of
https://github.com/webstudio-is/webstudio.git
synced 2026-11-09 14:03:33 +09:00
Closes #6470 Closes #4806 Closes #4392 Closes #4804 Closes #4616 Closes #4863 Closes #4912 Ref #1798 Advanced styles now uses a CSS block editor in the panel and a centered editor. Local declarations are editable. Cascaded or inherited, preset, and global declarations are grouped below them and are read-only. The editor suggests properties and values, highlights search matches, shows source details and color swatches, and previews valid local edits on the canvas. Keyframe CSS declarations use the reusable local block editor. The old Add styles field, property-row editor, declaration menu actions, and Navigator CSS Preview are removed. ### Delivery checklist - [x] Edit and validate local CSS declarations, including shorthand display and likely typo hints - [x] Show other style sources with source colors, tooltips, and read-only protection - [x] Add search navigation, color swatches, and the centered editor shortcut - [x] Reuse the block editor for animation keyframes and preserve transform controls - [x] Preserve uploaded background layers when editing gradients or reordering layers - [x] Remove superseded editor and Navigator UI - [x] Review and update the Style panel and Navigator guides - [x] Remove the outdated CSS Preview sentence from the Builder anatomy guide - [x] Rename the stale Code view test title to match the Advanced editor - [x] Regenerate fixtures and keep the Vercel build manifest through regeneration - [x] Resolve review threads and verify required CI ### Implementation notes Styles remain stored as individual properties; equivalent shorthand text is reconstructed for editing. Unknown property names become CSS variables unless they resemble a known property, in which case the editor warns and skips the typo. Editing is limited to the selected local style block; read-only source groups remain visible for reference. Existing uploaded image and hidden background layers are retained when neighboring layers change. No schema migration is needed. The Vercel manifest setting lives in the React Router template, so fixture regeneration produces a clean worktree. The shared template also generates the setting for the Docker fixture. ### Verification On commit `7fb44d358`, both fixture checks, `check-size`, the main workflow, all ten end-to-end shards, and the label-approved visual comparison passed. The fixture regeneration, Vercel build, Builder typecheck, focused lint, and formatting checks passed locally before the final documentation and test-title cleanup; `git diff --check` passed afterward. No local tests were run for the final cleanup, which changes no behavior.
285 lines
8.2 KiB
TypeScript
285 lines
8.2 KiB
TypeScript
import { act } from "react-dom/test-utils";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { EditorSelection } from "@codemirror/state";
|
|
import { EditorView } from "@codemirror/view";
|
|
import { autocompletion, startCompletion } from "@codemirror/autocomplete";
|
|
import { afterEach, beforeEach, expect, test, vi } from "vitest";
|
|
import { userEvent } from "@vitest/browser/context";
|
|
import {
|
|
cssVar,
|
|
Dialog,
|
|
DialogContent,
|
|
DialogTitle,
|
|
selectedItemBackground,
|
|
} from "@webstudio-is/design-system";
|
|
import "@webstudio-is/design-system/global.css";
|
|
import {
|
|
EditorContent,
|
|
EditorDialogButton,
|
|
EditorDialogControl,
|
|
EditorDialog,
|
|
} from "./code-editor-base";
|
|
|
|
(
|
|
globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
|
|
).IS_REACT_ACT_ENVIRONMENT = true;
|
|
|
|
let container: HTMLDivElement;
|
|
let root: Root;
|
|
const rangeGetClientRects = Object.getOwnPropertyDescriptor(
|
|
Range.prototype,
|
|
"getClientRects"
|
|
);
|
|
|
|
beforeEach(() => {
|
|
vi.stubGlobal(
|
|
"ResizeObserver",
|
|
class {
|
|
observe() {}
|
|
unobserve() {}
|
|
disconnect() {}
|
|
}
|
|
);
|
|
Object.defineProperty(Range.prototype, "getClientRects", {
|
|
configurable: true,
|
|
value: () => [new DOMRect(0, 0, 20, 16)],
|
|
});
|
|
container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
root = createRoot(container);
|
|
});
|
|
|
|
afterEach(() => {
|
|
act(() => root.unmount());
|
|
container.remove();
|
|
document.documentElement.removeAttribute("data-color-scheme");
|
|
vi.unstubAllGlobals();
|
|
if (rangeGetClientRects === undefined) {
|
|
delete (Range.prototype as { getClientRects?: unknown }).getClientRects;
|
|
} else {
|
|
Object.defineProperty(
|
|
Range.prototype,
|
|
"getClientRects",
|
|
rangeGetClientRects
|
|
);
|
|
}
|
|
});
|
|
|
|
test.each(["light", "dark"] as const)(
|
|
"uses the shared selection color in %s mode",
|
|
async (mode) => {
|
|
document.documentElement.dataset.colorScheme = mode;
|
|
act(() => {
|
|
root.render(
|
|
<EditorContent
|
|
value="selected text"
|
|
onChange={() => {}}
|
|
onChangeComplete={() => {}}
|
|
/>
|
|
);
|
|
});
|
|
|
|
const editor = container.querySelector<HTMLElement>('[role="textbox"]');
|
|
if (editor === null) {
|
|
throw new Error("Expected the code editor");
|
|
}
|
|
const view = EditorView.findFromDOM(editor);
|
|
if (view === null) {
|
|
throw new Error("Expected the CodeMirror view");
|
|
}
|
|
act(() => {
|
|
view.dispatch({
|
|
selection: EditorSelection.range(0, view.state.doc.length),
|
|
});
|
|
view.focus();
|
|
});
|
|
await act(
|
|
() =>
|
|
new Promise<void>((resolve) =>
|
|
requestAnimationFrame(() => requestAnimationFrame(() => resolve()))
|
|
)
|
|
);
|
|
|
|
const selection = container.querySelector<HTMLElement>(
|
|
".cm-selectionBackground"
|
|
);
|
|
if (selection === null) {
|
|
throw new Error("Expected a rendered selection");
|
|
}
|
|
const reference = document.createElement("span");
|
|
reference.style.background = cssVar("--background-text-selection");
|
|
reference.style.color = "var(--foreground-on-text-selection)";
|
|
document.body.appendChild(reference);
|
|
|
|
const selectionColor = getComputedStyle(selection).backgroundColor;
|
|
const referenceColor = getComputedStyle(reference).backgroundColor;
|
|
const content = container.querySelector<HTMLElement>(".cm-content");
|
|
if (content === null) {
|
|
throw new Error("Expected editor content");
|
|
}
|
|
const selectedTextColor = getComputedStyle(content, "::selection").color;
|
|
const referenceTextColor = getComputedStyle(reference).color;
|
|
reference.remove();
|
|
expect(selectionColor).toBe(referenceColor);
|
|
expect(selectedTextColor).toBe(referenceTextColor);
|
|
}
|
|
);
|
|
|
|
test("scopes disabled styles to the Webstudio code editor", () => {
|
|
act(() => {
|
|
root.render(
|
|
<fieldset disabled>
|
|
<EditorContent
|
|
value="disabled editor"
|
|
onChange={() => {}}
|
|
onChangeComplete={() => {}}
|
|
/>
|
|
<div className="cm-editor" data-foreign-editor />
|
|
</fieldset>
|
|
);
|
|
});
|
|
|
|
const editors = container.querySelectorAll<HTMLElement>(".cm-editor");
|
|
const foreignEditor = container.querySelector<HTMLElement>(
|
|
"[data-foreign-editor]"
|
|
);
|
|
if (editors[0] === undefined || foreignEditor === null) {
|
|
throw new Error("Expected both code editors");
|
|
}
|
|
|
|
expect(getComputedStyle(editors[0]).opacity).toBe("0.3");
|
|
expect(getComputedStyle(foreignEditor).opacity).toBe("1");
|
|
});
|
|
|
|
test.each(["light", "dark"] as const)(
|
|
"distinguishes the selected autocomplete row in %s mode",
|
|
async (mode) => {
|
|
document.documentElement.dataset.colorScheme = mode;
|
|
act(() =>
|
|
root.render(
|
|
<EditorContent
|
|
value="a"
|
|
onChange={() => {}}
|
|
onChangeComplete={() => {}}
|
|
extensions={[
|
|
autocompletion({
|
|
override: [
|
|
() => ({
|
|
from: 0,
|
|
options: [{ label: "alpha" }, { label: "alpine" }],
|
|
}),
|
|
],
|
|
}),
|
|
]}
|
|
/>
|
|
)
|
|
);
|
|
const editor = container.querySelector<HTMLElement>('[role="textbox"]')!;
|
|
const view = EditorView.findFromDOM(editor)!;
|
|
act(() => {
|
|
view.dispatch({ selection: { anchor: 1 } });
|
|
view.focus();
|
|
startCompletion(view);
|
|
});
|
|
await vi.waitFor(() =>
|
|
expect(
|
|
document.querySelectorAll('.cm-tooltip-autocomplete [role="option"]')
|
|
.length
|
|
).toBe(2)
|
|
);
|
|
const selected = document.querySelector<HTMLElement>(
|
|
'.cm-tooltip-autocomplete [aria-selected="true"]'
|
|
)!;
|
|
const unselected = document.querySelector<HTMLElement>(
|
|
'.cm-tooltip-autocomplete [role="option"]:not([aria-selected="true"])'
|
|
)!;
|
|
const reference = document.createElement("div");
|
|
reference.style.backgroundColor = selectedItemBackground;
|
|
document.body.appendChild(reference);
|
|
try {
|
|
expect(getComputedStyle(selected).backgroundColor).toBe(
|
|
getComputedStyle(reference).backgroundColor
|
|
);
|
|
expect(getComputedStyle(selected).backgroundColor).not.toBe(
|
|
getComputedStyle(unselected).backgroundColor
|
|
);
|
|
} finally {
|
|
reference.remove();
|
|
}
|
|
}
|
|
);
|
|
|
|
test("uses the standard icon button hover style for editor maximize", async () => {
|
|
act(() => {
|
|
root.render(
|
|
<div style={{ width: 320, height: 160 }}>
|
|
<EditorDialogControl>
|
|
<EditorContent
|
|
value="editor content"
|
|
onChange={() => {}}
|
|
onChangeComplete={() => {}}
|
|
/>
|
|
<EditorDialogButton aria-label="Expand" />
|
|
</EditorDialogControl>
|
|
</div>
|
|
);
|
|
});
|
|
|
|
const maximizeButton = container.querySelector<HTMLButtonElement>(
|
|
'[aria-label="Expand"]'
|
|
);
|
|
if (maximizeButton === null) {
|
|
throw new Error("Expected the maximize button");
|
|
}
|
|
await userEvent.hover(maximizeButton.parentElement!);
|
|
await userEvent.hover(maximizeButton);
|
|
expect(getComputedStyle(maximizeButton).backgroundColor).not.toBe(
|
|
"rgba(0, 0, 0, 0)"
|
|
);
|
|
});
|
|
|
|
test("keeps editor chrome in form dialogs but removes it in editor dialogs", () => {
|
|
act(() => {
|
|
root.render(
|
|
<Dialog open>
|
|
<DialogContent aria-describedby={undefined}>
|
|
<DialogTitle>Settings</DialogTitle>
|
|
<EditorContent
|
|
value="settings code"
|
|
onChange={() => {}}
|
|
onChangeComplete={() => {}}
|
|
/>
|
|
</DialogContent>
|
|
</Dialog>
|
|
);
|
|
});
|
|
const formEditor = document.querySelector<HTMLElement>(
|
|
'[role="dialog"] .cm-editor'
|
|
)?.parentElement;
|
|
expect(formEditor).toBeDefined();
|
|
expect(getComputedStyle(formEditor!).borderLeftWidth).toBe("1px");
|
|
expect(getComputedStyle(formEditor!).paddingLeft).not.toBe("0px");
|
|
|
|
act(() => {
|
|
root.render(
|
|
<EditorDialog
|
|
open
|
|
title="Code editor"
|
|
content={
|
|
<EditorContent
|
|
value="full editor"
|
|
onChange={() => {}}
|
|
onChangeComplete={() => {}}
|
|
/>
|
|
}
|
|
/>
|
|
);
|
|
});
|
|
const fullEditor = document.querySelector<HTMLElement>(
|
|
'[role="dialog"] .cm-editor'
|
|
)?.parentElement;
|
|
expect(fullEditor).toBeDefined();
|
|
expect(getComputedStyle(fullEditor!).borderLeftWidth).toBe("0px");
|
|
expect(getComputedStyle(fullEditor!).paddingLeft).toBe("0px");
|
|
});
|