Files
webmail/components/email/resizable-image.tsx
T
Linus Rath 53cb49d3ce feat: ask for alt text when an image goes into a message
Pasted and dropped images used to get the file name as alt text, and
there was no way to change it. Now a small dialog asks what the image
shows right after it is inserted, with a "Decorative image" option that
writes alt="". An image already in the text can be described from the
toolbar or from the ALT button on the selected image. The plain-text
part of an HTML mail writes described images as "[Image: ...]" and
leaves decorative ones out.

The formatting toolbar now also re-renders when only the selection
changes, so its pressed states and the image button follow the caret.
2026-10-29 17:53:43 +01:00

187 lines
6.1 KiB
TypeScript

"use client";
import React, { useCallback, useEffect, useRef, useState } from "react";
import { Node, mergeAttributes } from "@tiptap/core";
import { NodeViewWrapper, ReactNodeViewRenderer } from "@tiptap/react";
import type { NodeViewProps } from "@tiptap/react";
export interface ResizableImageOptions {
/** Open the alt text dialog for the image at this position. */
onEditAlt?: (pos: number) => void;
/** The name of the button that does it ("Image description"). */
editAltLabel?: string;
}
function ResizableImageView({ node, updateAttributes, selected, extension, getPos }: NodeViewProps) {
const { onEditAlt, editAltLabel } = extension.options as ResizableImageOptions;
const imgRef = useRef<HTMLImageElement>(null);
const [resizing, setResizing] = useState(false);
const startState = useRef<{ x: number; y: number; width: number; height: number; handle: string }>({
x: 0, y: 0, width: 0, height: 0, handle: "",
});
const onMouseDown = useCallback((e: React.MouseEvent, handle: string) => {
e.preventDefault();
e.stopPropagation();
const img = imgRef.current;
if (!img) return;
startState.current = {
x: e.clientX,
y: e.clientY,
width: img.offsetWidth,
height: img.offsetHeight,
handle,
};
setResizing(true);
}, []);
useEffect(() => {
if (!resizing) return;
const onMouseMove = (e: MouseEvent) => {
const { x, width, handle } = startState.current;
const dx = e.clientX - x;
let newWidth: number;
if (handle === "right" || handle === "bottom-right" || handle === "top-right") {
newWidth = Math.max(50, width + dx);
} else {
newWidth = Math.max(50, width - dx);
}
updateAttributes({ width: Math.round(newWidth) });
};
const onMouseUp = () => {
setResizing(false);
};
document.addEventListener("mousemove", onMouseMove);
document.addEventListener("mouseup", onMouseUp);
return () => {
document.removeEventListener("mousemove", onMouseMove);
document.removeEventListener("mouseup", onMouseUp);
};
}, [resizing, updateAttributes]);
const width = node.attrs.width;
const style: React.CSSProperties = {
...(width ? { width: `${width}px` } : {}),
maxWidth: "100%",
};
return (
<NodeViewWrapper as="span" className="inline-block relative" draggable data-drag-handle>
<span
className={`relative inline-block group ${selected ? "ring-2 ring-primary rounded" : ""}`}
style={style}
>
<img
ref={imgRef}
src={node.attrs.src}
alt={node.attrs.alt || ""}
title={node.attrs.title || undefined}
style={{ width: "100%", height: "auto", display: "block" }}
draggable={false}
/>
{selected && onEditAlt && (
// Edit what the image says to screen readers. Reachable with Tab
// while the image is selected, and from the toolbar.
<button
type="button"
contentEditable={false}
data-testid="image-alt-edit"
onMouseDown={(e) => e.preventDefault()}
onClick={(e) => {
e.stopPropagation();
const pos = typeof getPos === "function" ? getPos() : undefined;
if (typeof pos === "number") onEditAlt(pos);
}}
className="absolute top-1 start-1 rounded bg-background/90 px-1.5 py-0.5 text-xs font-medium text-foreground shadow border border-border"
>
{node.attrs.alt === "" ? "ALT ∅" : "ALT"}
<span className="sr-only">{editAltLabel}</span>
</button>
)}
{selected && (
<>
{/* Resize handle: right */}
<span
onMouseDown={(e) => onMouseDown(e, "right")}
className="absolute top-1/2 -right-1.5 -translate-y-1/2 w-3 h-8 bg-primary rounded cursor-ew-resize"
/>
{/* Resize handle: left */}
<span
onMouseDown={(e) => onMouseDown(e, "left")}
className="absolute top-1/2 -left-1.5 -translate-y-1/2 w-3 h-8 bg-primary rounded cursor-ew-resize"
/>
{/* Resize handle: bottom-right corner */}
<span
onMouseDown={(e) => onMouseDown(e, "bottom-right")}
className="absolute -bottom-1.5 -right-1.5 w-3 h-3 bg-primary rounded cursor-nwse-resize"
/>
</>
)}
</span>
</NodeViewWrapper>
);
}
export const ResizableImage = Node.create<ResizableImageOptions>({
name: "image",
addOptions() {
return { onEditAlt: undefined, editAltLabel: undefined };
},
group: "inline",
inline: true,
draggable: true,
selectable: true,
addAttributes() {
return {
src: { default: null },
// null: nobody said what the image shows; "": decorative (kept as alt="").
alt: {
default: null,
parseHTML: (el) => el.getAttribute("alt"),
renderHTML: (attrs) => (attrs.alt == null ? {} : { alt: attrs.alt }),
},
title: { default: null },
width: { default: null },
cid: {
default: null,
parseHTML: (el) => {
const dataCid = el.getAttribute("data-cid");
if (dataCid) return dataCid;
// Fall back to deriving the cid from `src="cid:xxx"` so inline
// image refs survive editor round-trips even when data-cid was
// never set (defensive — the composer normally pre-rewrites
// quoted-body cid: refs into data-cid).
const src = el.getAttribute("src") || "";
if (/^cid:/i.test(src)) return src.slice(4) || null;
return null;
},
renderHTML: (attrs) => (attrs.cid ? { "data-cid": attrs.cid } : {}),
},
};
},
parseHTML() {
return [{ tag: "img[src]" }];
},
renderHTML({ HTMLAttributes }) {
const attrs: Record<string, string> = { ...HTMLAttributes };
if (attrs.width) {
attrs.style = `width: ${attrs.width}px; max-width: 100%;`;
delete attrs.width;
}
return ["img", mergeAttributes(attrs)];
},
addNodeView() {
return ReactNodeViewRenderer(ResizableImageView);
},
});