mirror of
https://github.com/outline/outline.git
synced 2026-11-20 21:23:06 +03:00
* feat: Render Mermaid diagrams with Pele * fix: Translate empty diagram label * fix: Prevent diagram flash when editors swap on load
115 lines
3.0 KiB
TypeScript
115 lines
3.0 KiB
TypeScript
import type { Node } from "prosemirror-model";
|
|
import { isMermaid } from "./isCode";
|
|
import type { EditorView } from "prosemirror-view";
|
|
import { sanitizeImageSrc } from "@shared/utils/urls";
|
|
|
|
export abstract class LightboxImage {
|
|
public pos: number;
|
|
public src: string;
|
|
public alt: string;
|
|
public source: string;
|
|
|
|
protected element: Element;
|
|
|
|
constructor() {}
|
|
|
|
public abstract getElement(): Element | null | undefined;
|
|
}
|
|
|
|
class LightboxRegularImage extends LightboxImage {
|
|
constructor(view: EditorView, pos: number) {
|
|
super();
|
|
this.pos = pos;
|
|
const node = view.state.doc.nodeAt(pos);
|
|
this.src = sanitizeImageSrc(node?.attrs.src) ?? "";
|
|
this.alt = node?.attrs.alt ?? "";
|
|
this.source = node?.attrs.source;
|
|
this.element = view.nodeDOM(pos) as HTMLSpanElement;
|
|
}
|
|
|
|
getElement() {
|
|
return this.element.querySelector("img");
|
|
}
|
|
}
|
|
|
|
/** Theme variables that a rendered diagram inherits from its container. */
|
|
const diagramVariables = [
|
|
"--pele-bg",
|
|
"--pele-fg",
|
|
"--pele-muted",
|
|
"--pele-line",
|
|
"--pele-surface",
|
|
"--pele-surface-alt",
|
|
"--pele-border",
|
|
"--pele-accent",
|
|
"--pele-critical",
|
|
"--pele-font",
|
|
"--pele-font-mono",
|
|
];
|
|
|
|
class LightboxMermaidImage extends LightboxImage {
|
|
constructor(view: EditorView, pos: number) {
|
|
super();
|
|
this.element = view.nodeDOM(pos) as HTMLDivElement;
|
|
this.pos = pos;
|
|
this.src = this.svgToSrc(this.extractSvg());
|
|
this.alt = "";
|
|
}
|
|
|
|
private svgToSrc(svg: string): string {
|
|
return `data:image/svg+xml;charset=utf-8,${encodeURIComponent(svg)}`;
|
|
}
|
|
|
|
private extractSvg(): string {
|
|
const mermaidWrapper = this.element.nextElementSibling;
|
|
if (!mermaidWrapper) {
|
|
return "";
|
|
}
|
|
const svg = mermaidWrapper.firstElementChild;
|
|
if (!svg || !(svg instanceof SVGElement)) {
|
|
return "";
|
|
}
|
|
|
|
// The diagram reads its colors from variables on the container, which an
|
|
// image does not inherit, so copy them onto the SVG.
|
|
const clone = svg.cloneNode(true);
|
|
if (!(clone instanceof SVGElement)) {
|
|
return "";
|
|
}
|
|
const style = getComputedStyle(svg);
|
|
for (const name of diagramVariables) {
|
|
const value = style.getPropertyValue(name).trim();
|
|
if (value) {
|
|
clone.style.setProperty(name, value);
|
|
}
|
|
}
|
|
clone.style.setProperty("background", "var(--pele-bg)");
|
|
|
|
const serializer = new XMLSerializer();
|
|
return serializer.serializeToString(clone);
|
|
}
|
|
|
|
getElement() {
|
|
return this.element.nextElementSibling?.firstElementChild;
|
|
}
|
|
}
|
|
|
|
export class LightboxImageFactory {
|
|
static createLightboxImage(view: EditorView, pos: number): LightboxImage {
|
|
const node = view.state.doc.nodeAt(pos)!;
|
|
if (isImage(node)) {
|
|
return new LightboxRegularImage(view, pos);
|
|
}
|
|
|
|
if (isMermaid(node)) {
|
|
return new LightboxMermaidImage(view, pos);
|
|
}
|
|
|
|
throw new Error("Unsupported node type for LightboxImage");
|
|
}
|
|
}
|
|
|
|
const isImage = (node: Node) => node.type.name === "image";
|
|
|
|
export const isLightboxNode = (node: Node) => isImage(node) || isMermaid(node);
|