feat(editor): Error message for invalid hex color input (#11782)

---------
Signed-off-by: Mark Tolmacs <mark@lazycat.hu>
Co-authored-by: Mark Tolmacs <mark@lazycat.hu>
This commit is contained in:
cyforkk
2026-07-30 19:30:20 +08:00
committed by GitHub
parent 69d4c346cc
commit 786ab266ff
5 changed files with 492 additions and 175 deletions
@@ -29,6 +29,7 @@ export const ColorInput = ({
}) => {
const editorInterface = useEditorInterface();
const [innerValue, setInnerValue] = useState(color);
const [errorMessage, setErrorMessage] = useState<string | null>(null);
const [activeSection, setActiveColorPickerSection] = useAtom(
activeColorPickerSectionAtom,
);
@@ -39,11 +40,18 @@ export const ColorInput = ({
const changeColor = useCallback(
(inputValue: string) => {
const value = inputValue.toLowerCase();
const value = inputValue.toLowerCase().trim();
const color = normalizeInputColor(value);
if (color) {
onChange(color);
setErrorMessage(null);
} else if (value.length === 0) {
setErrorMessage(null);
} else if (/^#?[0-9a-f]+$/.test(value)) {
setErrorMessage(t("colorPicker.invalidHexLength"));
} else {
setErrorMessage(t("colorPicker.invalidColor"));
}
setInnerValue(value);
},
@@ -68,66 +76,79 @@ export const ColorInput = ({
}, [setEyeDropperState]);
return (
<div className="color-picker__input-label">
<div className="color-picker__input-hash">#</div>
<input
ref={activeSection === "hex" ? inputRef : undefined}
style={{ border: 0, padding: 0 }}
spellCheck={false}
className="color-picker-input"
aria-label={label}
onChange={(event) => {
changeColor(event.target.value);
}}
value={(innerValue || "").replace(/^#/, "")}
onBlur={() => {
setInnerValue(color);
}}
tabIndex={-1}
onFocus={() => setActiveColorPickerSection("hex")}
onKeyDown={(event) => {
if (event.key === KEYS.TAB) {
return;
} else if (event.key === KEYS.ESCAPE) {
eyeDropperTriggerRef.current?.focus();
}
event.stopPropagation();
}}
placeholder={placeholder}
/>
{/* TODO reenable on mobile with a better UX */}
{editorInterface.formFactor !== "phone" && (
<>
<div
style={{
width: "1px",
height: "1.25rem",
backgroundColor: "var(--default-border-color)",
}}
/>
<div
ref={eyeDropperTriggerRef}
className={clsx("excalidraw-eye-dropper-trigger", {
selected: eyeDropperState,
})}
onClick={() =>
setEyeDropperState((s) =>
s
? null
: {
keepOpenOnAlt: false,
onSelect: (color) => onChange(color),
colorPickerType,
},
)
<div className="color-picker__input-label-container">
<div
className={clsx("color-picker__input-label", {
"has-error": errorMessage,
})}
>
<div className="color-picker__input-hash">#</div>
<input
ref={activeSection === "hex" ? inputRef : undefined}
style={{ border: 0, padding: 0 }}
spellCheck={false}
className="color-picker-input"
aria-label={label}
aria-invalid={!!errorMessage}
onChange={(event) => {
changeColor(event.target.value);
}}
value={(innerValue || "").replace(/^#/, "")}
onBlur={() => {
setInnerValue(color);
setErrorMessage(null);
}}
tabIndex={-1}
onFocus={() => setActiveColorPickerSection("hex")}
onKeyDown={(event) => {
if (event.key === KEYS.TAB) {
return;
} else if (event.key === KEYS.ESCAPE) {
eyeDropperTriggerRef.current?.focus();
}
title={`${t(
"labels.eyeDropper",
)}${KEYS.I.toLocaleUpperCase()} or ${getShortcutKey("Alt")} `}
>
{eyeDropperIcon}
</div>
</>
event.stopPropagation();
}}
placeholder={placeholder}
/>
{/* TODO reenable on mobile with a better UX */}
{editorInterface.formFactor !== "phone" && (
<>
<div
style={{
width: "1px",
height: "1.25rem",
backgroundColor: "var(--default-border-color)",
}}
/>
<div
ref={eyeDropperTriggerRef}
className={clsx("excalidraw-eye-dropper-trigger", {
selected: eyeDropperState,
})}
onClick={() =>
setEyeDropperState((s) =>
s
? null
: {
keepOpenOnAlt: false,
onSelect: (color) => onChange(color),
colorPickerType,
},
)
}
title={`${t(
"labels.eyeDropper",
)}${KEYS.I.toLocaleUpperCase()} or ${getShortcutKey("Alt")} `}
>
{eyeDropperIcon}
</div>
</>
)}
</div>
{errorMessage && (
<div className="color-picker__error-message" role="alert">
{errorMessage}
</div>
)}
</div>
);
@@ -368,6 +368,12 @@
}
}
.color-picker__input-label-container {
display: flex;
flex-direction: column;
gap: 4px;
}
.color-picker__input-label {
display: grid;
grid-template-columns: auto 1fr auto auto;
@@ -383,12 +389,28 @@
box-shadow: 0 0 0 1px var(--color-primary-darkest);
border-radius: var(--border-radius-lg);
}
&.has-error {
border-color: var(--color-danger, #e03131);
&:focus-within {
box-shadow: 0 0 0 1px var(--color-danger, #e03131);
}
}
}
.color-picker__input-hash {
padding: 0 0.25rem;
}
.color-picker__error-message {
color: var(--color-danger, #e03131);
font-size: 0.75rem;
padding: 0 8px 4px 8px;
text-align: left;
line-height: 1.3;
}
.color-picker-input {
box-sizing: border-box;
width: 100%;
+3 -1
View File
@@ -604,7 +604,9 @@
"colors": "Colors",
"shades": "Shades",
"hexCode": "Hex code",
"noShades": "No shades available for this color"
"noShades": "No shades available for this color",
"invalidColor": "Not a valid color",
"invalidHexLength": "Hex code must be 3, 4, 6, or 8 characters"
},
"overwriteConfirm": {
"action": {
@@ -1,114 +0,0 @@
import { normalizeInputColor } from "@excalidraw/common";
describe("normalizeInputColor", () => {
describe("hex colors", () => {
it("returns hex color with hash as-is", () => {
expect(normalizeInputColor("#ff0000")).toBe("#ff0000");
expect(normalizeInputColor("#FF0000")).toBe("#FF0000");
expect(normalizeInputColor("#abc")).toBe("#abc");
expect(normalizeInputColor("#ABC")).toBe("#ABC");
});
it("adds hash to hex color without hash", () => {
expect(normalizeInputColor("ff0000")).toBe("#ff0000");
expect(normalizeInputColor("FF0000")).toBe("#FF0000");
expect(normalizeInputColor("abc")).toBe("#abc");
expect(normalizeInputColor("ABC")).toBe("#ABC");
});
it("handles 8-digit hex (hexa) with alpha", () => {
expect(normalizeInputColor("#ff000080")).toBe("#ff000080");
expect(normalizeInputColor("#ff0000ff")).toBe("#ff0000ff");
});
it("does NOT add hash to hexa without hash (tinycolor detects as hex8, not hex)", () => {
// Note: tinycolor detects 8-digit hex as "hex8" format, not "hex"
expect(normalizeInputColor("ff000080")).toBe("#ff000080");
});
});
describe("named colors", () => {
it("returns named colors as-is", () => {
expect(normalizeInputColor("red")).toBe("red");
expect(normalizeInputColor("blue")).toBe("blue");
expect(normalizeInputColor("green")).toBe("green");
expect(normalizeInputColor("white")).toBe("white");
expect(normalizeInputColor("black")).toBe("black");
expect(normalizeInputColor("transparent")).toBe("transparent");
});
it("handles case variations of named colors", () => {
expect(normalizeInputColor("RED")).toBe("RED");
expect(normalizeInputColor("Red")).toBe("Red");
});
});
describe("rgb/rgba colors", () => {
it("returns rgb colors as-is", () => {
expect(normalizeInputColor("rgb(255, 0, 0)")).toBe("rgb(255, 0, 0)");
expect(normalizeInputColor("rgb(0,0,0)")).toBe("rgb(0,0,0)");
});
// NOTE: tinycolor clamps values, so rgb(256, 0, 0) is treated as valid
it("tinycolor considers out-of-range rgb values as valid (clamped)", () => {
expect(normalizeInputColor("rgb(256, 0, 0)")).toBe("rgb(256, 0, 0)");
});
it("returns rgba colors as-is", () => {
expect(normalizeInputColor("rgba(255, 0, 0, 0.5)")).toBe(
"rgba(255, 0, 0, 0.5)",
);
expect(normalizeInputColor("rgba(0,0,0,1)")).toBe("rgba(0,0,0,1)");
});
});
describe("hsl/hsla colors", () => {
it("returns hsl colors as-is", () => {
expect(normalizeInputColor("hsl(0, 100%, 50%)")).toBe(
"hsl(0, 100%, 50%)",
);
});
it("returns hsla colors as-is", () => {
expect(normalizeInputColor("hsla(0, 100%, 50%, 0.5)")).toBe(
"hsla(0, 100%, 50%, 0.5)",
);
});
});
describe("whitespace handling", () => {
it("trims leading whitespace", () => {
expect(normalizeInputColor(" #ff0000")).toBe("#ff0000");
expect(normalizeInputColor(" red")).toBe("red");
});
it("trims trailing whitespace", () => {
expect(normalizeInputColor("#ff0000 ")).toBe("#ff0000");
expect(normalizeInputColor("red ")).toBe("red");
});
it("trims both leading and trailing whitespace", () => {
expect(normalizeInputColor(" #ff0000 ")).toBe("#ff0000");
expect(normalizeInputColor(" red ")).toBe("red");
});
it("adds hash to trimmed hex without hash", () => {
expect(normalizeInputColor(" ff0000 ")).toBe("#ff0000");
});
});
describe("invalid colors", () => {
it("returns null for invalid color strings", () => {
expect(normalizeInputColor("notacolor")).toBe(null);
expect(normalizeInputColor("gggggg")).toBe(null);
expect(normalizeInputColor("#gggggg")).toBe(null);
expect(normalizeInputColor("")).toBe(null);
expect(normalizeInputColor(" ")).toBe(null);
});
it("returns null for partial/malformed colors", () => {
expect(normalizeInputColor("#ff")).toBe(null);
expect(normalizeInputColor("rgb(")).toBe(null);
});
});
});
@@ -0,0 +1,386 @@
import { normalizeInputColor } from "@excalidraw/common";
import { Excalidraw } from "../index";
import { fireEvent, render, waitFor, toggleMenu } from "./test-utils";
describe("normalizeInputColor", () => {
describe("hex colors", () => {
it("returns hex color with hash as-is", () => {
expect(normalizeInputColor("#ff0000")).toBe("#ff0000");
expect(normalizeInputColor("#FF0000")).toBe("#FF0000");
expect(normalizeInputColor("#abc")).toBe("#abc");
expect(normalizeInputColor("#ABC")).toBe("#ABC");
});
it("adds hash to hex color without hash", () => {
expect(normalizeInputColor("ff0000")).toBe("#ff0000");
expect(normalizeInputColor("FF0000")).toBe("#FF0000");
expect(normalizeInputColor("abc")).toBe("#abc");
expect(normalizeInputColor("ABC")).toBe("#ABC");
});
it("handles 8-digit hex (hexa) with alpha", () => {
expect(normalizeInputColor("#ff000080")).toBe("#ff000080");
expect(normalizeInputColor("#ff0000ff")).toBe("#ff0000ff");
});
it("does NOT add hash to hexa without hash (tinycolor detects as hex8, not hex)", () => {
// Note: tinycolor detects 8-digit hex as "hex8" format, not "hex"
expect(normalizeInputColor("ff000080")).toBe("#ff000080");
});
});
describe("named colors", () => {
it("returns named colors as-is", () => {
expect(normalizeInputColor("red")).toBe("red");
expect(normalizeInputColor("blue")).toBe("blue");
expect(normalizeInputColor("green")).toBe("green");
expect(normalizeInputColor("white")).toBe("white");
expect(normalizeInputColor("black")).toBe("black");
expect(normalizeInputColor("transparent")).toBe("transparent");
});
it("handles case variations of named colors", () => {
expect(normalizeInputColor("RED")).toBe("RED");
expect(normalizeInputColor("Red")).toBe("Red");
});
});
describe("rgb/rgba colors", () => {
it("returns rgb colors as-is", () => {
expect(normalizeInputColor("rgb(255, 0, 0)")).toBe("rgb(255, 0, 0)");
expect(normalizeInputColor("rgb(0,0,0)")).toBe("rgb(0,0,0)");
});
// NOTE: tinycolor clamps values, so rgb(256, 0, 0) is treated as valid
it("tinycolor considers out-of-range rgb values as valid (clamped)", () => {
expect(normalizeInputColor("rgb(256, 0, 0)")).toBe("rgb(256, 0, 0)");
});
it("returns rgba colors as-is", () => {
expect(normalizeInputColor("rgba(255, 0, 0, 0.5)")).toBe(
"rgba(255, 0, 0, 0.5)",
);
expect(normalizeInputColor("rgba(0,0,0,1)")).toBe("rgba(0,0,0,1)");
});
});
describe("hsl/hsla colors", () => {
it("returns hsl colors as-is", () => {
expect(normalizeInputColor("hsl(0, 100%, 50%)")).toBe(
"hsl(0, 100%, 50%)",
);
});
it("returns hsla colors as-is", () => {
expect(normalizeInputColor("hsla(0, 100%, 50%, 0.5)")).toBe(
"hsla(0, 100%, 50%, 0.5)",
);
});
});
describe("whitespace handling", () => {
it("trims leading whitespace", () => {
expect(normalizeInputColor(" #ff0000")).toBe("#ff0000");
expect(normalizeInputColor(" red")).toBe("red");
});
it("trims trailing whitespace", () => {
expect(normalizeInputColor("#ff0000 ")).toBe("#ff0000");
expect(normalizeInputColor("red ")).toBe("red");
});
it("trims both leading and trailing whitespace", () => {
expect(normalizeInputColor(" #ff0000 ")).toBe("#ff0000");
expect(normalizeInputColor(" red ")).toBe("red");
});
it("adds hash to trimmed hex without hash", () => {
expect(normalizeInputColor(" ff0000 ")).toBe("#ff0000");
});
});
describe("invalid colors", () => {
it("returns null for invalid color strings", () => {
expect(normalizeInputColor("notacolor")).toBe(null);
expect(normalizeInputColor("gggggg")).toBe(null);
expect(normalizeInputColor("#gggggg")).toBe(null);
expect(normalizeInputColor("")).toBe(null);
expect(normalizeInputColor(" ")).toBe(null);
});
it("returns null for partial/malformed colors", () => {
expect(normalizeInputColor("#ff")).toBe(null);
expect(normalizeInputColor("rgb(")).toBe(null);
});
});
});
describe("ColorInput error handling", () => {
const openCanvasBackgroundColorPicker = async () => {
const { container } = await render(<Excalidraw />);
// Open main menu to access canvas background color picker
toggleMenu(container);
// Set up ResizeObserver for radix-ui components
(global as any).ResizeObserver = class ResizeObserver {
constructor(cb: any) {
(this as any).cb = cb;
}
observe() {}
unobserve() {}
disconnect() {}
};
// Open color picker for canvas background
const canvasBgButton = container.querySelector(
'[data-openpopup="canvasBackground"]',
) as HTMLButtonElement;
expect(canvasBgButton).toBeTruthy();
fireEvent.click(canvasBgButton);
// Wait for color picker to open
await waitFor(() => {
const colorInput = container.querySelector(
".color-picker-input",
) as HTMLInputElement;
expect(colorInput).toBeTruthy();
});
return container.querySelector(".color-picker-input") as HTMLInputElement;
};
it("shows error for invalid hex length (too short)", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter invalid hex code with length 1
fireEvent.change(colorInput, { target: { value: "1" } });
// Check error message appears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeTruthy();
expect(errorMessage.textContent).toContain(
"Hex code must be 3, 4, 6, or 8 characters",
);
});
});
it("shows error for invalid hex length (too long)", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter invalid hex code with length 9
fireEvent.change(colorInput, { target: { value: "123456789" } });
// Check error message appears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeTruthy();
expect(errorMessage.textContent).toContain(
"Hex code must be 3, 4, 6, or 8 characters",
);
});
});
it("shows generic error for non-hex-shaped invalid input", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter invalid input that isn't hex-shaped
fireEvent.change(colorInput, { target: { value: "zzzzzz" } });
// Check error message appears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeTruthy();
expect(errorMessage.textContent).toContain("Not a valid color");
});
});
it("shows generic error for unrecognized color names", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter non-hex text (not a valid color name)
fireEvent.change(colorInput, { target: { value: "notacolor" } });
// Check error message appears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeTruthy();
expect(errorMessage.textContent).toContain("Not a valid color");
});
});
it("does not show an error for a complete named color", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
fireEvent.change(colorInput, { target: { value: "transparent" } });
await waitFor(() => {
expect(colorInput.value).toBe("transparent");
expect(
document.querySelector(".color-picker__error-message"),
).toBeFalsy();
});
});
it("does not show an error for valid rgb() input", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
fireEvent.change(colorInput, { target: { value: "rgb(255, 0, 0)" } });
await waitFor(() => {
expect(
document.querySelector(".color-picker__error-message"),
).toBeFalsy();
});
});
it("does not show error for valid hex codes", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter valid hex code
fireEvent.change(colorInput, { target: { value: "ff0000" } });
// Check no error message appears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeFalsy();
});
});
it("clears error when input is cleared", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter invalid hex code to trigger error
fireEvent.change(colorInput, { target: { value: "notacolor" } });
// Check error message appears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeTruthy();
});
// Clear input
fireEvent.change(colorInput, { target: { value: "" } });
// Check error message disappears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeFalsy();
});
});
it("clears error when blurring input", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter invalid hex code to trigger error
fireEvent.change(colorInput, { target: { value: "notacolor" } });
// Check error message appears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeTruthy();
});
// Blur input (simulate clicking outside)
fireEvent.blur(colorInput);
// Check error message disappears
await waitFor(() => {
const errorMessage = document.querySelector(
".color-picker__error-message",
) as HTMLElement;
expect(errorMessage).toBeFalsy();
});
});
it("keeps the typed value when editing a valid color", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
fireEvent.change(colorInput, { target: { value: "ff0000" } });
await waitFor(() => {
expect(colorInput.value).toBe("ff0000");
});
// deleting a char makes it invalid, but must not be reverted
fireEvent.change(colorInput, { target: { value: "ff000" } });
await waitFor(() => {
expect(colorInput.value).toBe("ff000");
expect(
document.querySelector(".color-picker__error-message"),
).toBeTruthy();
});
// retyping it resolves to the color we're already at, so the `color` prop
// doesn't change — the input must still show what was typed
fireEvent.change(colorInput, { target: { value: "ff0000" } });
await waitFor(() => {
expect(colorInput.value).toBe("ff0000");
expect(
document.querySelector(".color-picker__error-message"),
).toBeFalsy();
});
});
it("can delete a valid color down to an empty input", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
fireEvent.change(colorInput, { target: { value: "1e9df0" } });
await waitFor(() => {
expect(colorInput.value).toBe("1e9df0");
});
for (const value of ["1e9df", "1e9d", "1e9", "1e", "1", ""]) {
fireEvent.change(colorInput, { target: { value } });
await waitFor(() => {
expect(colorInput.value).toBe(value);
});
}
expect(document.querySelector(".color-picker__error-message")).toBeFalsy();
});
it("input has aria-invalid attribute when error is shown", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter invalid hex code to trigger error
fireEvent.change(colorInput, { target: { value: "notacolor" } });
// Check aria-invalid attribute is set to true
await waitFor(() => {
expect(colorInput.getAttribute("aria-invalid")).toBe("true");
});
});
it("input has aria-invalid attribute set to false when no error", async () => {
const colorInput = await openCanvasBackgroundColorPicker();
// Enter valid hex code
fireEvent.change(colorInput, { target: { value: "ff0000" } });
// Check aria-invalid attribute is set to false
await waitFor(() => {
expect(colorInput.getAttribute("aria-invalid")).toBe("false");
});
});
});