@zuilib/text-editor 0.11.1 → 0.12.0

package/dist/presets-BtNPH0pa.d.ts

@@ -0,0 +1,78 @@
+import { ReactNode } from 'react';
+import { Klass, LexicalNode } from 'lexical';
+import { Transformer } from '@lexical/markdown';
+
+/**
+ * Horizontal sizing of a block that would otherwise span the editor:
+ *
+ * - `full` — the container width (the content pane, minus its gutters).
+ *   The default; omitted when serialised.
+ * - `text` — the text column: the block's edges align with the paragraphs
+ *   around it. Only differs from `full` when a text-column cap is set
+ *   (`--zui-text-editor-measure` / the `maxTextWidth` prop); otherwise the
+ *   two are visually identical.
+ * - `content` — shrinks to fit what is inside (table columns, drawing
+ *   shapes), left-aligned with the text and never wider than the column.
+ */
+type BlockWidth = 'full' | 'text' | 'content';
+declare const BLOCK_WIDTHS: readonly BlockWidth[];
+declare function isBlockWidth(value: unknown): value is BlockWidth;
+/**
+ * Width written into the markdown when a new table / drawing is inserted
+ * (`MarkdownEditor.Root`'s `newBlockWidth`). Only affects insertion:
+ * existing markdown without a width marker always means `full`.
+ */
+type NewBlockWidths = Readonly<{
+    table?: BlockWidth;
+    drawing?: BlockWidth;
+}>;
+
+/**
+ * "Ink" rendering: one confident pen stroke instead of a plotted outline.
+ * Every shape's centerline is resampled densely, displaced along its normal
+ * by a smooth low-frequency field (two sines, integer frequencies on closed
+ * paths so the seam is continuous) and widened by a slowly varying pressure
+ * factor. The result is a filled ring path, not an SVG stroke, so the width
+ * can breathe along the path. Everything is seeded from the shape id: the
+ * same shape draws the same way on every render, undo, export and machine.
+ *
+ * This is a renderer concern only — the drawing format never sees it.
+ */
+type DrawingStyle = 'clean' | 'ink';
+
+/**
+ * What an entry point wires into the composer before the host's own
+ * `nodes` / `transformers` / children are applied. The default entry adds
+ * the drawing node, its transformers and `DrawingPlugin` on top of `CORE`.
+ */
+type EditorPreset = Readonly<{
+    nodes: ReadonlyArray<Klass<LexicalNode>>;
+    /** Full import / export set, in matching order */
+    transformers: readonly Transformer[];
+    /** Non-visual plugins mounted under the composer */
+    plugins?: ReactNode;
+}>;
+declare const MARKDOWN_NODES: ReadonlyArray<Klass<LexicalNode>>;
+/**
+ * Markdown transformers of the `./core` entry (no drawings). FRONTMATTER
+ * first so it claims a leading `---` block before anything else, then LISTS
+ * and CHECK_LIST so they match before UNORDERED_LIST on import. CODE_BLOCK
+ * replaces CODE so untagged blocks export as bare fences.
+ */
+declare const MARKDOWN_TRANSFORMERS: readonly Transformer[];
+declare const MARKDOWN_PRESET: EditorPreset;
+type TransformersInput = readonly Transformer[] | ((defaults: readonly Transformer[]) => readonly Transformer[]);
+/**
+ * The import / export list for a host's `transformers` prop: an array is
+ * placed before the defaults (so it claims its syntax first); a function
+ * receives the defaults and returns the whole list.
+ */
+declare function resolveTransformers(defaults: readonly Transformer[], prop: TransformersInput | undefined): Transformer[];
+/**
+ * The typing-shortcut subset of a transformer list: fenced blocks are
+ * handled by CodeBlockShortcutPlugin, checklists by ChecklistShortcutPlugin
+ * and the remaining multiline transformers only make sense on import.
+ */
+declare function shortcutTransformers(transformers: readonly Transformer[]): Transformer[];
+
+export { BLOCK_WIDTHS as B, type DrawingStyle as D, type EditorPreset as E, MARKDOWN_NODES as M, type NewBlockWidths as N, type TransformersInput as T, type BlockWidth as a, MARKDOWN_PRESET as b, MARKDOWN_TRANSFORMERS as c, isBlockWidth as i, resolveTransformers as r, shortcutTransformers as s };