@zuilib/text-editor 0.1.0 → 0.2.0

package/README.md

@@ -120,6 +120,8 @@ Toggle modes in parent state; the editor preserves content via an internal ref w
 | `autoFocus` | `boolean` | `false` | Focus on mount |
 | `className` | `string` | — | Root wrapper class |
 | `toolbar` | `boolean` | `true` | Formatting/insert toolbar in `edit-md` mode |
+| `outline` | `boolean` | `false` | Table-of-contents sidebar listing headings |
+| `foldable` | `boolean` | `true` | Collapse sections under their headings |
 
 ## Markdown features
 
@@ -167,6 +169,12 @@ Drawings persist inside the markdown as a fenced block, so the document stays a
 
 In `view` mode (or `readOnly`) the canvas renders the shapes without any editing chrome.
 
+## Outline & section folding
+
+`outline` docks a collapsible table-of-contents sidebar on the right: it lists the document's headings live (indented by level), scrolls to a heading on click, and highlights the section currently in view. Pure UI — nothing is added to the document. Works in `edit-md` and `view` modes (not `edit-raw`).
+
+`foldable` (on by default) adds a chevron in the left gutter of every heading (visible on hover). Clicking it collapses the section — everything up to the next heading of the same or higher level — marked by a trailing `…` on the heading. Folding is view-layer only: the markdown string is unaffected, and fold state resets on remount. If the cursor enters a folded section (e.g. via arrow keys), it auto-expands so content can never be edited invisibly.
+
 ## Form integration
 
 With `@zuilib/form`:

package/dist/index.d.ts

@@ -13,8 +13,12 @@ type Props = Readonly<{
     autoFocus?: boolean;
     /** Show the formatting/insert toolbar in edit-md mode (default true) */
     toolbar?: boolean;
+    /** Show a table-of-contents sidebar listing the document's headings */
+    outline?: boolean;
+    /** Allow collapsing sections under their headings (default true) */
+    foldable?: boolean;
 }>;
-declare function MarkdownEditor({ value, onChange, placeholder, readOnly, className, mode, autoFocus, toolbar, }: Props): react_jsx_runtime.JSX.Element;
+declare function MarkdownEditor({ value, onChange, placeholder, readOnly, className, mode, autoFocus, toolbar, outline, foldable, }: Props): react_jsx_runtime.JSX.Element;
 
 type SerializedFrontmatterNode = SerializedElementNode;
 /**