blixify-ui-web 1.2.126 → 1.2.127

package/lib/components/input/markdown/headings.d.ts

@@ -0,0 +1,84 @@
+/**
+ * A document's headings — the outline a reader navigates by.
+ *
+ * INFO: read from the markdown, not from the rendered DOM. The editor and the
+ * static renderer draw a heading through completely different paths (tiptap
+ * nodes vs markdown-it html), and an outline built from either one would only
+ * be correct in that one. The markdown is the single thing they agree on, so it
+ * is what the outline is derived from and what both of them are then labelled
+ * against.
+ *
+ * INFO: no id is ever written INTO the markdown. Ids are slugs computed from
+ * the heading text every time, so a note saved before this existed gets an
+ * outline with no migration, and adding one changes no stored byte — the same
+ * commitment the embed's `data-view` makes by omitting itself for the default.
+ */
+export interface MarkdownHeading {
+    /** Slug of the heading text, unique within the document */
+    id: string;
+    /** 1, 2 or 3 — deeper headings are not offered as navigation */
+    level: number;
+    text: string;
+}
+export declare const MAX_OUTLINE_LEVEL = 3;
+/**
+ * INFO: a document with one or two headings is not navigated, it is read. The
+ * rail would cost a column of width to say what the first screen already shows.
+ */
+export declare const MIN_OUTLINE_HEADINGS = 3;
+/**
+ * The anchor id for a heading's text.
+ *
+ * INFO: exported because both renderers have to arrive at the same id from the
+ * same text without talking to each other — that identity is the whole
+ * mechanism, so it lives in one function rather than being spelled twice.
+ */
+export declare const handleSlugHeading: (text: string) => string;
+/**
+ * Makes a slug unique within one document by suffixing repeats.
+ *
+ * INFO: two "Overview" headings are ordinary in a long page. Without this they
+ * share an id, and every click on the second one jumps to the first.
+ */
+export declare const handleDedupeSlug: (slug: string, seen: Map<string, number>) => string;
+/**
+ * Reads the outline out of a markdown document.
+ *
+ * INFO: fenced blocks are tracked and skipped, because a `# comment` inside a
+ * ```bash block and a `%% title` inside a ```mermaid one are code, not
+ * structure — a diagram-heavy page would otherwise produce an outline of its
+ * own source. The closing fence must be at least as long as the opening one,
+ * which is how a ``` block nested inside a ```` one stays inside it.
+ */
+export declare const handleParseMarkdownHeadings: (markdown?: string | null) => MarkdownHeading[];
+/**
+ * Writes the outline's ids into rendered html, in document order.
+ *
+ * INFO: into the HTML STRING, not onto the mounted DOM. The static renderer sets
+ * its html through dangerouslySetInnerHTML, and React re-commits that html
+ * whenever it re-renders the element — which wipes every attribute added
+ * afterwards. Ids set from an effect therefore survived until the first
+ * re-render and then vanished silently, leaving an outline whose entries no
+ * longer scrolled anywhere. Being part of the html itself, these cannot be lost.
+ *
+ * INFO: the heading order is the only thing tying the two together, and it is
+ * reliable because both come from one parse of one document — the nth `<h1-3>`
+ * in the html is the nth entry in the outline. Levels deeper than the outline
+ * carry no id, which is why the pattern stops at h3.
+ */
+export declare const handleInjectHeadingIds: (html: string, headings: MarkdownHeading[]) => string;
+/**
+ * The id a heading node carries in the editor, as a ProseMirror decoration.
+ *
+ * INFO: a decoration rather than a node attribute or a DOM write. An attribute
+ * would reach `getHTML()` — turndown's input — and be written into the saved
+ * markdown; a DOM write is undone the next time ProseMirror redraws that node.
+ * Decorations are recomputed from the document on every redraw by construction,
+ * so an anchor cannot drift out of the view or into the file.
+ */
+export declare const handleBuildHeadingAnchors: (doc: any) => {
+    from: number;
+    to: number;
+    id: string;
+}[];
+//# sourceMappingURL=headings.d.ts.map

package/lib/components/input/markdown/headings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"headings.d.ts","sourceRoot":"","sources":["../../../../src/components/input/markdown/headings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,eAAe;IAC9B,2DAA2D;IAC3D,EAAE,EAAE,MAAM,CAAC;IACX,gEAAgE;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAsBtC;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,SAAU,MAAM,KAAG,MAgBhD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,SACrB,MAAM,QACN,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KACxB,MAIF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,cAC3B,MAAM,GAAG,IAAI,KACvB,eAAe,EAqCjB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,sBAAsB,SAC3B,MAAM,YACF,eAAe,EAAE,KAC1B,MASF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,QAC/B,GAAG,KACP;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,EAgB1C,CAAC"}

package/lib/components/input/markdown/headings.js

@@ -0,0 +1,192 @@
+"use strict";
+/**
+ * A document's headings — the outline a reader navigates by.
+ *
+ * INFO: read from the markdown, not from the rendered DOM. The editor and the
+ * static renderer draw a heading through completely different paths (tiptap
+ * nodes vs markdown-it html), and an outline built from either one would only
+ * be correct in that one. The markdown is the single thing they agree on, so it
+ * is what the outline is derived from and what both of them are then labelled
+ * against.
+ *
+ * INFO: no id is ever written INTO the markdown. Ids are slugs computed from
+ * the heading text every time, so a note saved before this existed gets an
+ * outline with no migration, and adding one changes no stored byte — the same
+ * commitment the embed's `data-view` makes by omitting itself for the default.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleBuildHeadingAnchors = exports.handleInjectHeadingIds = exports.handleParseMarkdownHeadings = exports.handleDedupeSlug = exports.handleSlugHeading = exports.MIN_OUTLINE_HEADINGS = exports.MAX_OUTLINE_LEVEL = void 0;
+exports.MAX_OUTLINE_LEVEL = 3;
+/**
+ * INFO: a document with one or two headings is not navigated, it is read. The
+ * rail would cost a column of width to say what the first screen already shows.
+ */
+exports.MIN_OUTLINE_HEADINGS = 3;
+var FENCE = /^\s{0,3}(`{3,}|~{3,})/;
+var HEADING = /^(#{1,6})\s+(.*)$/;
+/**
+ * Strips the inline markup a heading may carry, so the outline shows the words
+ * rather than the syntax around them.
+ */
+var handleCleanHeadingText = function (raw) {
+    return raw
+        // INFO: trailing #s of a closed atx heading — "## Title ##"
+        .replace(/\s+#+\s*$/, "")
+        // INFO: link and image syntax reduced to the text that was visible
+        .replace(/!\[([^\]]*)\]\([^)]*\)/g, "$1")
+        .replace(/\[([^\]]*)\]\([^)]*\)/g, "$1")
+        .replace(/`([^`]*)`/g, "$1")
+        .replace(/[*_~]/g, "")
+        .replace(/<[^>]+>/g, "")
+        .replace(/\s+/g, " ")
+        .trim();
+};
+/**
+ * The anchor id for a heading's text.
+ *
+ * INFO: exported because both renderers have to arrive at the same id from the
+ * same text without talking to each other — that identity is the whole
+ * mechanism, so it lives in one function rather than being spelled twice.
+ */
+var handleSlugHeading = function (text) {
+    var slug = handleCleanHeadingText(text)
+        .toLowerCase()
+        // INFO: punctuation is REMOVED rather than letters being kept. A
+        // `\p{L}`-style whitelist needs the unicode flag, which this library cannot
+        // use at an es5 target — and matching `[a-z0-9]` instead would slug a
+        // heading in Chinese or Malay to an empty string. Full-width punctuation is
+        // listed too, since it is what a CJK heading actually carries.
+        .replace(/["'’“”!?@#$%^&*()+=[\]{}<>,.:;/\\|`~]/g, "")
+        .replace(/[，。！？：；（）【】、「」…]/g, "")
+        .replace(/\s+/g, "-")
+        .replace(/-+/g, "-")
+        .replace(/^-|-$/g, "");
+    // INFO: a heading of only punctuation would otherwise slug to "" and every
+    // such heading would share one id
+    return slug || "section";
+};
+exports.handleSlugHeading = handleSlugHeading;
+/**
+ * Makes a slug unique within one document by suffixing repeats.
+ *
+ * INFO: two "Overview" headings are ordinary in a long page. Without this they
+ * share an id, and every click on the second one jumps to the first.
+ */
+var handleDedupeSlug = function (slug, seen) {
+    var _a;
+    var count = (_a = seen.get(slug)) !== null && _a !== void 0 ? _a : 0;
+    seen.set(slug, count + 1);
+    return count === 0 ? slug : "".concat(slug, "-").concat(count + 1);
+};
+exports.handleDedupeSlug = handleDedupeSlug;
+/**
+ * Reads the outline out of a markdown document.
+ *
+ * INFO: fenced blocks are tracked and skipped, because a `# comment` inside a
+ * ```bash block and a `%% title` inside a ```mermaid one are code, not
+ * structure — a diagram-heavy page would otherwise produce an outline of its
+ * own source. The closing fence must be at least as long as the opening one,
+ * which is how a ``` block nested inside a ```` one stays inside it.
+ */
+var handleParseMarkdownHeadings = function (markdown) {
+    if (!markdown)
+        return [];
+    var headings = [];
+    var seen = new Map();
+    var fence = "";
+    for (var _i = 0, _a = markdown.split("\n"); _i < _a.length; _i++) {
+        var eachLine = _a[_i];
+        var fenceMatch = eachLine.match(FENCE);
+        if (fenceMatch) {
+            var marker = fenceMatch[1];
+            if (!fence) {
+                fence = marker;
+                continue;
+            }
+            // INFO: only a fence of the same character and at least the same length
+            // closes the block
+            if (marker[0] === fence[0] && marker.length >= fence.length)
+                fence = "";
+            continue;
+        }
+        if (fence)
+            continue;
+        var headingMatch = eachLine.match(HEADING);
+        if (!headingMatch)
+            continue;
+        var level = headingMatch[1].length;
+        if (level > exports.MAX_OUTLINE_LEVEL)
+            continue;
+        var text = handleCleanHeadingText(headingMatch[2]);
+        // INFO: "###" with nothing after it is not a section anyone can navigate to
+        if (!text)
+            continue;
+        headings.push({
+            id: (0, exports.handleDedupeSlug)((0, exports.handleSlugHeading)(text), seen),
+            level: level,
+            text: text,
+        });
+    }
+    return headings;
+};
+exports.handleParseMarkdownHeadings = handleParseMarkdownHeadings;
+/**
+ * Writes the outline's ids into rendered html, in document order.
+ *
+ * INFO: into the HTML STRING, not onto the mounted DOM. The static renderer sets
+ * its html through dangerouslySetInnerHTML, and React re-commits that html
+ * whenever it re-renders the element — which wipes every attribute added
+ * afterwards. Ids set from an effect therefore survived until the first
+ * re-render and then vanished silently, leaving an outline whose entries no
+ * longer scrolled anywhere. Being part of the html itself, these cannot be lost.
+ *
+ * INFO: the heading order is the only thing tying the two together, and it is
+ * reliable because both come from one parse of one document — the nth `<h1-3>`
+ * in the html is the nth entry in the outline. Levels deeper than the outline
+ * carry no id, which is why the pattern stops at h3.
+ */
+var handleInjectHeadingIds = function (html, headings) {
+    if (!headings.length)
+        return html;
+    var index = 0;
+    return html.replace(/<h([1-3])(\s[^>]*)?>/g, function (match, level, attrs) {
+        var heading = headings[index];
+        if (!heading)
+            return match;
+        index += 1;
+        return "<h".concat(level).concat(attrs !== null && attrs !== void 0 ? attrs : "", " id=\"").concat(heading.id, "\" data-heading-id=\"").concat(heading.id, "\">");
+    });
+};
+exports.handleInjectHeadingIds = handleInjectHeadingIds;
+/**
+ * The id a heading node carries in the editor, as a ProseMirror decoration.
+ *
+ * INFO: a decoration rather than a node attribute or a DOM write. An attribute
+ * would reach `getHTML()` — turndown's input — and be written into the saved
+ * markdown; a DOM write is undone the next time ProseMirror redraws that node.
+ * Decorations are recomputed from the document on every redraw by construction,
+ * so an anchor cannot drift out of the view or into the file.
+ */
+var handleBuildHeadingAnchors = function (doc) {
+    var anchors = [];
+    var seen = new Map();
+    doc.descendants(function (node, pos) {
+        var _a, _b, _c, _d;
+        if (((_a = node.type) === null || _a === void 0 ? void 0 : _a.name) !== "heading")
+            return;
+        var level = (_c = (_b = node.attrs) === null || _b === void 0 ? void 0 : _b.level) !== null && _c !== void 0 ? _c : 1;
+        if (level > exports.MAX_OUTLINE_LEVEL)
+            return;
+        var text = ((_d = node.textContent) !== null && _d !== void 0 ? _d : "").trim();
+        if (!text)
+            return;
+        anchors.push({
+            from: pos,
+            to: pos + node.nodeSize,
+            id: (0, exports.handleDedupeSlug)((0, exports.handleSlugHeading)(text), seen),
+        });
+    });
+    return anchors;
+};
+exports.handleBuildHeadingAnchors = handleBuildHeadingAnchors;
+//# sourceMappingURL=headings.js.map

package/lib/components/input/markdown/headings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headings.js","sourceRoot":"","sources":["../../../../src/components/input/markdown/headings.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAUU,QAAA,iBAAiB,GAAG,CAAC,CAAC;AAEnC;;;GAGG;AACU,QAAA,oBAAoB,GAAG,CAAC,CAAC;AAEtC,IAAM,KAAK,GAAG,uBAAuB,CAAC;AACtC,IAAM,OAAO,GAAG,mBAAmB,CAAC;AAEpC;;;GAGG;AACH,IAAM,sBAAsB,GAAG,UAAC,GAAW;IACzC,OAAA,GAAG;QACD,4DAA4D;SAC3D,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;QACzB,mEAAmE;SAClE,OAAO,CAAC,yBAAyB,EAAE,IAAI,CAAC;SACxC,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC;SACvC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC;SAC3B,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,IAAI,EAAE;AAVT,CAUS,CAAC;AAEZ;;;;;;GAMG;AACI,IAAM,iBAAiB,GAAG,UAAC,IAAY;IAC5C,IAAM,IAAI,GAAG,sBAAsB,CAAC,IAAI,CAAC;SACtC,WAAW,EAAE;QACd,iEAAiE;QACjE,4EAA4E;QAC5E,sEAAsE;QACtE,4EAA4E;QAC5E,+DAA+D;SAC9D,OAAO,CAAC,wCAAwC,EAAE,EAAE,CAAC;SACrD,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC;SAChC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzB,2EAA2E;IAC3E,kCAAkC;IAClC,OAAO,IAAI,IAAI,SAAS,CAAC;AAC3B,CAAC,CAAC;AAhBW,QAAA,iBAAiB,qBAgB5B;AAEF;;;;;GAKG;AACI,IAAM,gBAAgB,GAAG,UAC9B,IAAY,EACZ,IAAyB;;IAEzB,IAAM,KAAK,GAAG,MAAA,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAI,CAAC,CAAC;IAClC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IAC1B,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAG,IAAI,cAAI,KAAK,GAAG,CAAC,CAAE,CAAC;AACrD,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B;AAEF;;;;;;;;GAQG;AACI,IAAM,2BAA2B,GAAG,UACzC,QAAwB;IAExB,IAAI,CAAC,QAAQ;QAAE,OAAO,EAAE,CAAC;IAEzB,IAAM,QAAQ,GAAsB,EAAE,CAAC;IACvC,IAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,IAAI,KAAK,GAAG,EAAE,CAAC;IAEf,KAAuB,UAAoB,EAApB,KAAA,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAApB,cAAoB,EAApB,IAAoB,EAAE,CAAC;QAAzC,IAAM,QAAQ,SAAA;QACjB,IAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,UAAU,EAAE,CAAC;YACf,IAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,KAAK,GAAG,MAAM,CAAC;gBACf,SAAS;YACX,CAAC;YACD,wEAAwE;YACxE,mBAAmB;YACnB,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM;gBAAE,KAAK,GAAG,EAAE,CAAC;YACxE,SAAS;QACX,CAAC;QACD,IAAI,KAAK;YAAE,SAAS;QAEpB,IAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,YAAY;YAAE,SAAS;QAC5B,IAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACrC,IAAI,KAAK,GAAG,yBAAiB;YAAE,SAAS;QACxC,IAAM,IAAI,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,4EAA4E;QAC5E,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,QAAQ,CAAC,IAAI,CAAC;YACZ,EAAE,EAAE,IAAA,wBAAgB,EAAC,IAAA,yBAAiB,EAAC,IAAI,CAAC,EAAE,IAAI,CAAC;YACnD,KAAK,OAAA;YACL,IAAI,MAAA;SACL,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAvCW,QAAA,2BAA2B,+BAuCtC;AAEF;;;;;;;;;;;;;;GAcG;AACI,IAAM,sBAAsB,GAAG,UACpC,IAAY,EACZ,QAA2B;IAE3B,IAAI,CAAC,QAAQ,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAClC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,UAAC,KAAK,EAAE,KAAK,EAAE,KAAK;QAC/D,IAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAC3B,KAAK,IAAI,CAAC,CAAC;QACX,OAAO,YAAK,KAAK,SAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,mBAAQ,OAAO,CAAC,EAAE,kCAAsB,OAAO,CAAC,EAAE,QAAI,CAAC;IACxF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAZW,QAAA,sBAAsB,0BAYjC;AAEF;;;;;;;;GAQG;AACI,IAAM,yBAAyB,GAAG,UACvC,GAAQ;IAER,IAAM,OAAO,GAA+C,EAAE,CAAC;IAC/D,IAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,GAAG,CAAC,WAAW,CAAC,UAAC,IAAS,EAAE,GAAW;;QACrC,IAAI,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,IAAI,MAAK,SAAS;YAAE,OAAO;QAC1C,IAAM,KAAK,GAAG,MAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,KAAK,mCAAI,CAAC,CAAC;QACrC,IAAI,KAAK,GAAG,yBAAiB;YAAE,OAAO;QACtC,IAAM,IAAI,GAAG,CAAC,MAAA,IAAI,CAAC,WAAW,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAI;YAAE,OAAO;QAClB,OAAO,CAAC,IAAI,CAAC;YACX,IAAI,EAAE,GAAG;YACT,EAAE,EAAE,GAAG,GAAG,IAAI,CAAC,QAAQ;YACvB,EAAE,EAAE,IAAA,wBAAgB,EAAC,IAAA,yBAAiB,EAAC,IAAI,CAAC,EAAE,IAAI,CAAC;SACpD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAlBW,QAAA,yBAAyB,6BAkBpC"}

package/lib/components/input/markdown/index.d.ts

@@ -1,5 +1,6 @@
 import React, { ReactElement } from "react";
 import { MermaidLoader } from "./mermaid";
+import { MarkdownHeading } from "./headings";
 export type EmbedView = "grid" | "list";
 export declare const handleParseEmbedView: (value?: string | null) => EmbedView;
 export interface EmbedActions {
@@ -76,6 +77,16 @@ interface Props {
      * until the supplied callback runs, so the host can confirm first.
      */
     onRequestRemove?: (spaceId: string, remove: () => void) => void;
+    /**
+     * Called with the document's headings whenever they change, for a host that
+     * renders an outline beside the editor.
+     *
+     * INFO: the headings are read from the markdown rather than from the editor's
+     * nodes, so the list a host gets here is identical to the one MarkdownStatic
+     * reports for the same document — the editor and a published page cannot show
+     * different outlines for the same note.
+     */
+    onHeadingsChange?: (headings: MarkdownHeading[]) => void;
     /**
      * Extra entries for the `/` menu, appended after the built-in formatting
      * commands. Use for actions the host app owns, such as creating a database.
@@ -100,6 +111,11 @@ interface MarkdownStaticProps {
     value: string;
     darkMode?: boolean;
     containerClassName?: string;
+    /**
+     * Called with the document's headings whenever they change, for a host that
+     * renders an outline beside the page.
+     */
+    onHeadingsChange?: (headings: MarkdownHeading[]) => void;
     lib?: {
         /**
          * Loads mermaid, e.g. `() => import("mermaid")`. When given, ```mermaid
@@ -115,7 +131,7 @@ interface MarkdownStaticProps {
  * many markdown fields stay responsive instead of freezing from 50+ ProseMirror
  * instances or a heavy re-parse.
  */
-export declare const MarkdownStatic: ({ id, label, labelExtra, subLabel, value, darkMode, containerClassName, lib, }: MarkdownStaticProps) => React.JSX.Element;
+export declare const MarkdownStatic: ({ id, label, labelExtra, subLabel, value, darkMode, containerClassName, onHeadingsChange, lib, }: MarkdownStaticProps) => React.JSX.Element;
 export declare const MarkdownInput: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<unknown>>;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/lib/components/input/markdown/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/input/markdown/index.tsx"],"names":[],"mappings":"AA8BA,OAAO,KAAK,EAAE,EACZ,YAAY,EAQb,MAAM,OAAO,CAAC;AAKf,OAAO,EAGL,aAAa,EAGd,MAAM,WAAW,CAAC;AAiGnB,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAIxC,eAAO,MAAM,oBAAoB,WAAY,MAAM,GAAG,IAAI,KAAG,SACzB,CAAC;AA+lBrC,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC;IAChB,YAAY,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,UAC9B,GAAG,iBACK,MAAM,KACpB,SAUF,CAAC;AA6WF,UAAU,KAAK;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,QAAQ,CAAC,EAAE;QACT,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,GAAG,CAAC,EAAE;QACJ,KAAK,CAAC,EAAE,GAAG,CAAC;QACZ;;;;WAIG;QACH,OAAO,CAAC,EAAE,aAAa,CAAC;KACzB,CAAC;IACF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,CACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,KAClB,YAAY,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAChE;;;OAGG;IACH,cAAc,CAAC,EAAE;QACf,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,CAAC;QACX;;;;WAIG;QACH,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC5E,EAAE,CAAC;CACL;AA8lDD,UAAU,mBAAmB;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,GAAG,CAAC,EAAE;QACJ;;;WAGG;QACH,OAAO,CAAC,EAAE,aAAa,CAAC;KACzB,CAAC;CACH;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,mFASxB,mBAAmB,sBAiErB,CAAC;AAEF,eAAO,MAAM,aAAa,oFAiBxB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/input/markdown/index.tsx"],"names":[],"mappings":"AA+BA,OAAO,KAAK,EAAE,EACZ,YAAY,EAQb,MAAM,OAAO,CAAC;AAKf,OAAO,EAGL,aAAa,EAGd,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,eAAe,EAIhB,MAAM,YAAY,CAAC;AAiGpB,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAIxC,eAAO,MAAM,oBAAoB,WAAY,MAAM,GAAG,IAAI,KAAG,SACzB,CAAC;AA2mBrC,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC;IAChB,YAAY,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,UAC9B,GAAG,iBACK,MAAM,KACpB,SAUF,CAAC;AAqoBF,UAAU,KAAK;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,QAAQ,CAAC,EAAE;QACT,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,GAAG,CAAC,EAAE;QACJ,KAAK,CAAC,EAAE,GAAG,CAAC;QACZ;;;;WAIG;QACH,OAAO,CAAC,EAAE,aAAa,CAAC;KACzB,CAAC;IACF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,CACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,KAClB,YAAY,GAAG,IAAI,CAAC;IACzB;;;OAGG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAChE;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,IAAI,CAAC;IACzD;;;OAGG;IACH,cAAc,CAAC,EAAE;QACf,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,CAAC;QACX;;;;WAIG;QACH,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC5E,EAAE,CAAC;CACL;AAinDD,UAAU,mBAAmB;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,IAAI,CAAC;IAEzD,GAAG,CAAC,EAAE;QACJ;;;WAGG;QACH,OAAO,CAAC,EAAE,aAAa,CAAC;KACzB,CAAC;CACH;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,qGAUxB,mBAAmB,sBAwFrB,CAAC;AAEF,eAAO,MAAM,aAAa,oFAiBxB,CAAC"}