Skip to content

Build your personal knowledge base with Trilium Notes

feat(share): draw a shared Mermaid note with the page's renderer, in a pan and zoom viewer

Elian Doran45cc4ff56a68
diff --git a/apps/client/vite-plugins.mts b/apps/client/vite-plugins.mts
index 22784777a2..64309f62fc 100644
--- a/apps/client/vite-plugins.mts
+++ b/apps/client/vite-plugins.mts
@@ -135,7 +135,7 @@ const SHARE_THEME_TARGET = "chrome96";
const LAZY_MODULES: Record<string, { specifier: string; importer: string }[]> = {
mermaid: [
{ specifier: "mermaid", importer: "content/mermaid.ts" },
- { specifier: "./mermaid_zoom.js", importer: "content/mermaid.ts" }
+ { specifier: "./zoom_viewer.js", importer: "content/mermaid.ts" }
],
app: [
{ specifier: "./app_globals.js", importer: "content/app_view.ts" },
diff --git a/apps/client/vite-plugins.spec.ts b/apps/client/vite-plugins.spec.ts
index 1fd841f1a1..fea6d41a98 100644
--- a/apps/client/vite-plugins.spec.ts
+++ b/apps/client/vite-plugins.spec.ts
@@ -123,7 +123,7 @@ describe("stripUniverEmojiData", () => {
describe("buildShareThemeManifest", () => {
const MERMAID_ID = "/node_modules/mermaid/dist/mermaid.core.mjs";
- const VIEWER_ID = "/packages/share-theme/src/content/mermaid_zoom.tsx";
+ const VIEWER_ID = "/packages/share-theme/src/content/zoom_viewer.tsx";
const chunk = (fileName: string, extra: { facade?: string; imports?: string[];
dynamicImports?: string[]; css?: string[]; assets?: string[] } = {}) => ({
type: "chunk" as const,
@@ -140,7 +140,7 @@ describe("buildShareThemeManifest", () => {
const bundle = Object.fromEntries([
chunk("src/scripts.js", {
imports: [ "src/shared-a.js", "src/shared-k.js" ],
- dynamicImports: [ "src/fuse-b.js", "src/mermaid.core-c.js", "src/mermaid_zoom-l.js" ],
+ dynamicImports: [ "src/fuse-b.js", "src/mermaid.core-c.js", "src/zoom_viewer-l.js" ],
css: [ "src/scripts-j.css" ]
}),
chunk("src/shared-a.js", { css: [ "src/shared-a.css" ] }),
@@ -155,7 +155,7 @@ describe("buildShareThemeManifest", () => {
imports: [ "src/shared-k.js", "src/dagre-f.js" ],
dynamicImports: [ "src/flowchart-g.js" ]
}),
- chunk("src/mermaid_zoom-l.js", { facade: VIEWER_ID, imports: [ "src/preact-m.js" ] }),
+ chunk("src/zoom_viewer-l.js", { facade: VIEWER_ID, imports: [ "src/preact-m.js" ] }),
chunk("src/preact-m.js"),
chunk("src/dagre-f.js"),
chunk("src/flowchart-g.js"),
@@ -177,8 +177,8 @@ describe("buildShareThemeManifest", () => {
],
lazy: {
mermaid: [
- "dagre-f.js", "flowchart-g.js", "mermaid.core-c.js", "mermaid_zoom-l.js",
- "preact-m.js", "shared-k.css"
+ "dagre-f.js", "flowchart-g.js", "mermaid.core-c.js", "preact-m.js",
+ "shared-k.css", "zoom_viewer-l.js"
]
}
});
diff --git a/packages/share-theme/src/content/app_host.tsx b/packages/share-theme/src/content/app_host.tsx
index 44bc5df210..cb4cdb0e00 100644
--- a/packages/share-theme/src/content/app_host.tsx
+++ b/packages/share-theme/src/content/app_host.tsx
@@ -3,8 +3,6 @@ import Component from "@triliumnext/client/src/components/component.js";
import TabManager from "@triliumnext/client/src/components/tab_manager.js";
import type FNote from "@triliumnext/client/src/entities/fnote.js";
import froca from "@triliumnext/client/src/services/froca.js";
-import LoadResults from "@triliumnext/client/src/services/load_results.js";
-import noteAttributeCache from "@triliumnext/client/src/services/note_attribute_cache.js";
import options, { type OptionValue } from "@triliumnext/client/src/services/options.js";
import { ParentComponent } from "@triliumnext/client/src/widgets/react/react_utils.js";
import type { ComponentChildren } from "preact";
@@ -55,35 +53,6 @@ export default function ShareAppHost({ noteId, payload, children }: ShareAppHost
);
}
-/**
- * Sets a label on a note for this page only, as a visitor cannot change notes: froca takes the new
- * value and the views hear of it as they hear of a change in the app, through `entitiesReloaded`.
- */
-export function setLocalLabel(noteId: string, name: string, value: string) {
- const row = {
- attributeId: `${noteId}-share-${name}`,
- noteId,
- type: "label" as const,
- name,
- value,
- position: 0,
- isInheritable: false
- };
- froca.addResp({ notes: [], branches: [], attributes: [ row ] });
- noteAttributeCache.invalidate();
-
- const loadResults = new LoadResults([ {
- entityName: "attributes",
- entityId: row.attributeId,
- entity: { ...row, isDeleted: false },
- hash: "",
- isSynced: false,
- isErased: false
- } ]);
- loadResults.addAttribute(row.attributeId, "share");
- appContext.triggerEvent("entitiesReloaded", { loadResults });
-}
-
function loadPayload(noteId: string, payload: AppPayload): HostedApp | null {
const { options: optionValues, links, ...rows } = payload;
options.load(Object.fromEntries(Object.entries(optionValues)
diff --git a/packages/share-theme/src/content/mermaid.spec.ts b/packages/share-theme/src/content/mermaid.spec.ts
index 4756d1ae1b..68509272d3 100644
--- a/packages/share-theme/src/content/mermaid.spec.ts
+++ b/packages/share-theme/src/content/mermaid.spec.ts
@@ -19,7 +19,7 @@ vi.mock("mermaid", () => ({
}));
const mountZoomPan = vi.hoisted(() => vi.fn());
-vi.mock("./mermaid_zoom.js", () => ({ default: mountZoomPan }));
+vi.mock("./zoom_viewer.js", () => ({ default: mountZoomPan }));
describe("setupMermaid", () => {
afterEach(() => {
diff --git a/packages/share-theme/src/content/mermaid.ts b/packages/share-theme/src/content/mermaid.ts
index 033a431006..4e01e07262 100644
--- a/packages/share-theme/src/content/mermaid.ts
+++ b/packages/share-theme/src/content/mermaid.ts
@@ -1,7 +1,7 @@
import { getMermaidConfig, type MermaidTheme, parseMermaidTheme } from "@triliumnext/commons/src/lib/mermaid_config.js";
import type { Mermaid } from "mermaid";
-import type { ZoomPanLabels } from "./mermaid_zoom.js";
+import type { ZoomPanLabels } from "./zoom_viewer.js";
/**
* Draws the Mermaid diagrams on the page: code blocks in a text note, and Mermaid notes. A code
@@ -14,7 +14,7 @@ export default async function setupMermaid() {
return;
}
- const { default: mermaid } = await import("mermaid");
+ const mermaid = await loadMermaid();
let theme = readMermaidTheme();
let rendering = renderDiagrams(mermaid, diagrams, theme);
@@ -83,11 +83,9 @@ let renderCount = 0;
* for it before: its placeholder, or its drawing in the previous theme.
*/
async function renderDiagrams(mermaid: Mermaid, diagrams: Diagram[], theme: MermaidTheme) {
- mermaid.initialize({ ...getMermaidConfig(theme), startOnLoad: false });
for (const { placeholder, element, source, labels } of diagrams) {
try {
- const { svg } = await mermaid.render(`share-mermaid-${renderCount++}`, source);
- element.innerHTML = svg;
+ element.innerHTML = await drawMermaid(mermaid, source, theme);
} catch (error) {
console.error(error);
continue;
@@ -102,19 +100,33 @@ async function renderDiagrams(mermaid: Mermaid, diagrams: Diagram[], theme: Merm
}
}
+/** Loads Mermaid, which only a page with a diagram needs. */
+export async function loadMermaid() {
+ const { default: mermaid } = await import("mermaid");
+ return mermaid;
+}
+
+/** Returns the SVG of the diagram `source` describes, drawn in `theme`. */
+export async function drawMermaid(mermaid: Mermaid, source: string, theme: MermaidTheme) {
+ mermaid.initialize({ ...getMermaidConfig(theme), startOnLoad: false });
+ const { svg } = await mermaid.render(`share-mermaid-${renderCount++}`, source);
+ return svg;
+}
+
/**
* Puts a drawn diagram in a viewer that pans and zooms it. Loaded on demand, so that only a page
* with a Mermaid note loads it. A diagram whose viewer fails to load stays as it is.
*/
async function addZoomPan(element: HTMLElement, labels: ZoomPanLabels) {
try {
- const { default: mountZoomPan } = await import("./mermaid_zoom.js");
+ const { default: mountZoomPan } = await import("./zoom_viewer.js");
mountZoomPan(element, labels);
} catch (error) {
console.error(error);
}
}
-function readMermaidTheme() {
+/** The Mermaid theme of the page's current theme, which the theme switch changes. */
+export function readMermaidTheme() {
return parseMermaidTheme(getComputedStyle(document.documentElement).getPropertyValue("--mermaid-theme"));
}
diff --git a/packages/share-theme/src/content/note_view.tsx b/packages/share-theme/src/content/note_view.tsx
index f169cd8e08..3e81330719 100644
--- a/packages/share-theme/src/content/note_view.tsx
+++ b/packages/share-theme/src/content/note_view.tsx
@@ -1,27 +1,25 @@
import type FNote from "@triliumnext/client/src/entities/fnote.js";
import { t } from "@triliumnext/client/src/services/i18n.js";
import { TYPE_MAPPINGS, type TypeWidget } from "@triliumnext/client/src/widgets/note_types.js";
-import { useNoteLabel } from "@triliumnext/client/src/widgets/react/hooks.js";
-import OverlayControlGroup, {
- OverlayControlButton
-} from "@triliumnext/client/src/widgets/react/OverlayControlGroup.js";
-import {
- type DisplayMode, resolveDisplayMode
-} from "@triliumnext/client/src/widgets/type_widgets/helpers/split_editor_mode.js";
+import { useNoteBlob } from "@triliumnext/client/src/widgets/react/hooks.js";
+import { RawHtmlBlock } from "@triliumnext/client/src/widgets/react/RawHtml.js";
import { render } from "preact";
import { useEffect, useState } from "preact/hooks";
-import ShareAppHost, { type AppPayload, setLocalLabel } from "./app_host.js";
+import ShareAppHost, { type AppPayload } from "./app_host.js";
+import { drawMermaid, loadMermaid, readMermaidTheme } from "./mermaid.js";
+import { ZoomViewer } from "./zoom_viewer.js";
/**
- * Mounts the app's own widget for the note's type, read-only, in place of the content the page
- * rendered for visitors without scripts.
+ * Mounts the note in place of the content the page rendered for visitors without scripts: a
+ * Mermaid note as a diagram that pans and zooms, any other note with the app's own widget for its
+ * type, read-only.
*/
export default function mountNoteView(container: HTMLElement, payload: AppPayload) {
container.replaceChildren();
render(
<ShareAppHost noteId={container.dataset.noteId ?? ""} payload={payload}>
- {({ note }) => <NoteView note={note} />}
+ {({ note }) => (note.type === "mermaid" ? <MermaidView note={note} /> : <NoteView note={note} />)}
</ShareAppHost>,
container
);
@@ -48,33 +46,60 @@ function NoteView({ note }: { note: FNote }) {
noteContext={undefined}
isVisible
/>
- {note.type === "mermaid" && <DisplayModeSwitcher note={note} />}
</div>
);
}
-/** The app's choice of source, split or preview, which a visitor makes for this page only. */
-function DisplayModeSwitcher({ note }: { note: FNote }) {
- const [ displayMode ] = useNoteLabel(note, "displayMode");
- const mode = resolveDisplayMode(displayMode, true);
+/**
+ * Draws a Mermaid note the way the page draws the diagrams of a text note, in a viewer that takes
+ * the page, and draws it again when the theme changes.
+ */
+function MermaidView({ note }: { note: FNote }) {
+ const blob = useNoteBlob(note);
+ const theme = useMermaidTheme();
+ const [ svg, setSvg ] = useState<string>();
+
+ useEffect(() => {
+ const source = blob?.content;
+ if (!source) {
+ return;
+ }
+
+ let isCurrent = true;
+ loadMermaid().then((mermaid) => drawMermaid(mermaid, source, theme)).then((drawn) => {
+ if (isCurrent) {
+ setSvg(drawn);
+ }
+ }, (error: unknown) => console.error(error));
+ return () => { isCurrent = false; };
+ }, [ blob, theme ]);
return (
- <OverlayControlGroup className="share-display-mode" placement="top-end">
- {DISPLAY_MODES.map(({ value, icon, text }) => (
- <OverlayControlButton
- key={value}
- icon={icon}
- title={t(text)}
- active={mode === value}
- onClick={() => setLocalLabel(note.noteId, "displayMode", value)}
- />
- ))}
- </OverlayControlGroup>
+ <ZoomViewer labels={getZoomPanLabels()} fillsPage>
+ {svg && <RawHtmlBlock className="mermaid" html={svg} />}
+ </ZoomViewer>
);
}
-const DISPLAY_MODES: { value: DisplayMode; icon: string; text: string }[] = [
- { value: "source", icon: "bx bx-code", text: "display_mode.source" },
- { value: "split", icon: "bx bxs-dock-left", text: "display_mode.split" },
- { value: "preview", icon: "bx bx-show", text: "display_mode.preview" }
-];
+/** The page's Mermaid theme, which follows the theme switch's class on `<html>`. */
+function useMermaidTheme() {
+ const [ theme, setTheme ] = useState(readMermaidTheme);
+
+ useEffect(() => {
+ const observer = new MutationObserver(() => setTheme(readMermaidTheme()));
+ observer.observe(document.documentElement, { attributes: true, attributeFilter: [ "class" ] });
+ return () => observer.disconnect();
+ }, []);
+
+ return theme;
+}
+
+/** The texts of the viewer, from the app's catalogue. */
+function getZoomPanLabels() {
+ return {
+ label: t("svg.preview"),
+ zoomIn: t("zoom_controls.zoom_in"),
+ zoomOut: t("zoom_controls.zoom_out"),
+ zoomReset: t("zoom_controls.reset")
+ };
+}
diff --git a/packages/share-theme/src/content/mermaid_zoom.css b/packages/share-theme/src/content/zoom_viewer.css
similarity index 54%
rename from packages/share-theme/src/content/mermaid_zoom.css
rename to packages/share-theme/src/content/zoom_viewer.css
index 68b430e584..74ba68b81e 100644
--- a/packages/share-theme/src/content/mermaid_zoom.css
+++ b/packages/share-theme/src/content/zoom_viewer.css
@@ -1,31 +1,31 @@
-.mermaid-zoom {
+.zoom-viewer {
position: relative;
}
-.mermaid-zoom-viewport {
+.zoom-viewer-viewport {
border-radius: 6px;
outline: 2px solid transparent;
outline-offset: 2px;
}
-.mermaid-zoom-viewport:focus-visible {
+.zoom-viewer-viewport:focus-visible {
outline-color: var(--link-focus-outline-color);
}
-.mermaid-zoom .mermaid-zoom-wrapper,
-.mermaid-zoom .mermaid-zoom-content {
+.zoom-viewer .zoom-viewer-wrapper,
+.zoom-viewer .zoom-viewer-content {
width: 100%;
}
-.mermaid-zoom .mermaid-zoom-content {
+.zoom-viewer .zoom-viewer-content {
justify-content: center;
}
-.mermaid-zoom .mermaid-zoom-content > div {
+.zoom-viewer .zoom-viewer-content > div {
width: 100%;
}
-.mermaid-zoom-controls {
+.zoom-viewer-controls {
position: absolute;
bottom: 8px;
inset-inline-end: 8px;
@@ -36,7 +36,7 @@
background: var(--background-highlight);
}
-.mermaid-zoom-controls button {
+.zoom-viewer-controls button {
display: flex;
align-items: center;
justify-content: center;
@@ -52,23 +52,47 @@
transition: background-color 150ms ease, color 150ms ease;
}
-.mermaid-zoom-controls button:hover:not(:disabled) {
+.zoom-viewer-controls button:hover:not(:disabled) {
background: var(--background-primary);
color: var(--text-primary);
}
-.mermaid-zoom-controls button:focus-visible {
+.zoom-viewer-controls button:focus-visible {
outline: 2px solid var(--link-focus-outline-color);
outline-offset: 1px;
}
-.mermaid-zoom-controls button:disabled {
+.zoom-viewer-controls button:disabled {
opacity: 0.4;
cursor: default;
}
-.mermaid-zoom-controls .mermaid-zoom-reset {
+.zoom-viewer-controls .zoom-viewer-reset {
min-width: 48px;
font-size: 12px;
font-variant-numeric: tabular-nums;
}
+
+.zoom-viewer.fills-page {
+ display: flex;
+ flex-direction: column;
+
+ .zoom-viewer-viewport {
+ flex: 1;
+ min-height: 0;
+ }
+
+ .zoom-viewer-viewport,
+ .zoom-viewer-wrapper,
+ .zoom-viewer-content,
+ .zoom-viewer-content > * {
+ width: 100%;
+ height: 100%;
+ }
+
+ .zoom-viewer-content svg {
+ width: 100%;
+ height: 100%;
+ max-width: 100% !important;
+ }
+}
diff --git a/packages/share-theme/src/content/mermaid_zoom.spec.tsx b/packages/share-theme/src/content/zoom_viewer.spec.tsx
similarity index 78%
rename from packages/share-theme/src/content/mermaid_zoom.spec.tsx
rename to packages/share-theme/src/content/zoom_viewer.spec.tsx
index 97a8988add..e2519be9b3 100644
--- a/packages/share-theme/src/content/mermaid_zoom.spec.tsx
+++ b/packages/share-theme/src/content/zoom_viewer.spec.tsx
@@ -3,7 +3,7 @@ import { type ComponentChildren, render } from "preact";
import { act } from "preact/test-utils";
import { afterEach, describe, expect, it, vi } from "vitest";
-import mountZoomPan from "./mermaid_zoom.js";
+import mountZoomPan, { ZoomViewer } from "./zoom_viewer.js";
// react-zoom-pan-pinch measures its boxes, which happy-dom cannot do. As in the client's
// `SvgSplitEditor.spec.tsx`, this fake keeps what the controls drive: `zoomIn`/`zoomOut` add their
@@ -54,9 +54,9 @@ vi.mock("react-zoom-pan-pinch", async () => {
describe("mountZoomPan", () => {
afterEach(() => {
- const container = document.querySelector<HTMLElement>(".mermaid-zoom");
- if (container) {
- act(() => render(null, container));
+ const host = document.querySelector(".zoom-viewer")?.parentElement;
+ if (host) {
+ act(() => render(null, host));
}
document.body.innerHTML = "";
transformWrapperSpy.mockClear();
@@ -65,11 +65,11 @@ describe("mountZoomPan", () => {
it("moves the diagram into a labelled viewer in its place", () => {
const diagram = mountDiagram();
- expect(document.querySelector("#content > .mermaid-zoom")).not.toBeNull();
- const viewport = document.querySelector(".mermaid-zoom > .mermaid-zoom-viewport");
+ expect(document.querySelector("#content > div > .zoom-viewer:not(.fills-page)")).not.toBeNull();
+ const viewport = document.querySelector(".zoom-viewer > .zoom-viewer-viewport");
expect(viewport?.getAttribute("aria-label")).toBe("Diagram");
expect(viewport?.getAttribute("tabindex")).toBe("0");
- expect(viewport?.querySelector(".mermaid-zoom-content")?.contains(diagram)).toBe(true);
+ expect(viewport?.querySelector(".zoom-viewer-content")?.contains(diagram)).toBe(true);
expect(buttons().map((button) => button.title))
.toEqual([ "Zoom out", "Reset zoom", "Zoom in" ]);
expect(buttons().map((button) => button.getAttribute("aria-label")))
@@ -91,7 +91,7 @@ describe("mountZoomPan", () => {
act(() => zoomIn.click());
expect(readout()).toBe("120%");
expect(lastProps().panning).toEqual({ disabled: false });
- expect(document.querySelector(".mermaid-zoom-content")?.contains(diagram)).toBe(true);
+ expect(document.querySelector(".zoom-viewer-content")?.contains(diagram)).toBe(true);
act(() => reset.click());
expect(readout()).toBe("100%");
@@ -103,6 +103,20 @@ describe("mountZoomPan", () => {
expect(zoomOut.disabled).toBe(true);
expect(zoomIn.disabled).toBe(false);
});
+
+ it("pans at any zoom when it takes the page", () => {
+ document.body.innerHTML = `<div id="content"></div>`;
+ const host = document.getElementById("content");
+ if (!host) {
+ throw new Error("The host is missing.");
+ }
+
+ act(() => render(<ZoomViewer labels={LABELS} fillsPage><svg /></ZoomViewer>, host));
+
+ expect(document.querySelector("#content > .zoom-viewer.fills-page .zoom-viewer-content > svg"))
+ .not.toBeNull();
+ expect(lastProps().panning).toEqual({ disabled: false });
+ });
});
const LABELS = {
@@ -125,11 +139,11 @@ function mountDiagram() {
}
function buttons() {
- return [ ...document.querySelectorAll<HTMLButtonElement>(".mermaid-zoom-controls button") ];
+ return [ ...document.querySelectorAll<HTMLButtonElement>(".zoom-viewer-controls button") ];
}
function readout() {
- return document.querySelector(".mermaid-zoom-reset")?.textContent;
+ return document.querySelector(".zoom-viewer-reset")?.textContent;
}
function lastProps() {
diff --git a/packages/share-theme/src/content/mermaid_zoom.tsx b/packages/share-theme/src/content/zoom_viewer.tsx
similarity index 53%
rename from packages/share-theme/src/content/mermaid_zoom.tsx
rename to packages/share-theme/src/content/zoom_viewer.tsx
index 62fd1c4d79..e337a02ebf 100644
--- a/packages/share-theme/src/content/mermaid_zoom.tsx
+++ b/packages/share-theme/src/content/zoom_viewer.tsx
@@ -1,13 +1,13 @@
-import "./mermaid_zoom.css";
+import "./zoom_viewer.css";
import {
useZoomPanPinch, useZoomPanWheel
} from "@triliumnext/client/src/widgets/react/zoom_pan.js";
-import { render } from "preact";
+import { type ComponentChildren, render } from "preact";
import { useLayoutEffect, useRef, useState } from "preact/hooks";
import { TransformComponent, TransformWrapper } from "react-zoom-pan-pinch";
-/** The texts of a viewer, which the page carries on the Mermaid note it shows. */
+/** The texts of a viewer, which the page or the app's catalogue gives in the visitor's language. */
export interface ZoomPanLabels {
label: string;
zoomIn: string;
@@ -16,33 +16,40 @@ export interface ZoomPanLabels {
}
/**
- * Moves `diagram` into a viewer that pans and zooms it, with the zoom steps and wheel handling of
- * the app's diagram preview. The wheel zooms only while the viewer has focus, and dragging pans
- * only once the diagram is zoomed in, so that both scroll the page otherwise.
+ * Moves `element` into a viewer that pans and zooms it, in the flow of the page. The element
+ * stays the same node, so a script that draws into it, such as `mermaid.ts`, keeps drawing there.
*/
-export default function mountZoomPan(diagram: HTMLElement, labels: ZoomPanLabels) {
- const container = document.createElement("div");
- container.className = "mermaid-zoom";
- diagram.replaceWith(container);
- render(<ZoomPanViewer diagram={diagram} labels={labels} />, container);
+export default function mountZoomPan(element: HTMLElement, labels: ZoomPanLabels) {
+ const host = document.createElement("div");
+ element.replaceWith(host);
+ render(<ZoomViewer labels={labels}><ElementSlot element={element} /></ZoomViewer>, host);
}
-function ZoomPanViewer({ diagram, labels }: { diagram: HTMLElement; labels: ZoomPanLabels }) {
+interface ZoomViewerProps {
+ labels: ZoomPanLabels;
+ /**
+ * Whether the viewer takes the page, so that the wheel and dragging always zoom and pan it, as
+ * there is no page around it to scroll.
+ */
+ fillsPage?: boolean;
+ children: ComponentChildren;
+}
+
+/**
+ * Pans and zooms its `children`, with the zoom steps and wheel handling of the app's diagram
+ * preview. In the flow of a page, the wheel zooms only while the viewer has focus and dragging pans
+ * only once the content is zoomed in, so that both scroll the page otherwise.
+ */
+export function ZoomViewer({ labels, fillsPage = false, children }: ZoomViewerProps) {
const zoom = useZoomPanPinch({ minScale: MIN_ZOOM, maxScale: MAX_ZOOM });
const [ viewport, setViewport ] = useState<HTMLDivElement | null>(null);
- const contentRef = useRef<HTMLDivElement>(null);
- useZoomPanWheel(zoom.ref, viewport, true);
-
- // The diagram stays the element `mermaid.ts` draws into, so a theme change redraws it in place.
- useLayoutEffect(() => {
- contentRef.current?.append(diagram);
- }, [ diagram ]);
+ useZoomPanWheel(zoom.ref, viewport, !fillsPage);
return (
- <>
+ <div className={fillsPage ? "zoom-viewer fills-page" : "zoom-viewer"}>
<div
ref={setViewport}
- className="mermaid-zoom-viewport"
+ className="zoom-viewer-viewport"
tabIndex={0}
role="group"
aria-label={labels.label}
@@ -53,19 +60,19 @@ function ZoomPanViewer({ diagram, labels }: { diagram: HTMLElement; labels: Zoom
maxScale={MAX_ZOOM}
centerZoomedOut
wheel={zoom.wheel}
- panning={{ disabled: zoom.scale <= 1 }}
+ panning={{ disabled: !fillsPage && zoom.scale <= 1 }}
doubleClick={{ mode: "reset" }}
onTransform={zoom.onTransform}
>
<TransformComponent
- wrapperClass="mermaid-zoom-wrapper"
- contentClass="mermaid-zoom-content"
+ wrapperClass="zoom-viewer-wrapper"
+ contentClass="zoom-viewer-content"
>
- <div ref={contentRef} />
+ {children}
</TransformComponent>
</TransformWrapper>
</div>
- <div className="mermaid-zoom-controls">
+ <div className="zoom-viewer-controls">
<button
type="button"
title={labels.zoomOut}
@@ -77,7 +84,7 @@ function ZoomPanViewer({ diagram, labels }: { diagram: HTMLElement; labels: Zoom
</button>
<button
type="button"
- className="mermaid-zoom-reset"
+ className="zoom-viewer-reset"
title={labels.zoomReset}
onClick={zoom.reset}
>
@@ -93,10 +100,19 @@ function ZoomPanViewer({ diagram, labels }: { diagram: HTMLElement; labels: Zoom
<span className="tn-icon bx bx-plus-circle" aria-hidden="true" />
</button>
</div>
- </>
+ </div>
);
}
-/** The zoom bounds of the app's diagram preview, as a multiple of the diagram's fitted width. */
+/** Holds an element that something other than Preact renders. */
+function ElementSlot({ element }: { element: HTMLElement }) {
+ const ref = useRef<HTMLDivElement>(null);
+ useLayoutEffect(() => {
+ ref.current?.append(element);
+ }, [ element ]);
+ return <div ref={ref} />;
+}
+
+/** The zoom bounds of the app's diagram preview, as a multiple of the content's fitted width. */
const MIN_ZOOM = 0.5;
const MAX_ZOOM = 10;