@coldsmirk/inkstone-react 0.9.0 → 0.10.0

package/dist/codemirror-B3GlIVaX.d.ts

@@ -0,0 +1,348 @@
+import { Extension } from "@codemirror/state";
+import { EditorView } from "@codemirror/view";
+import { CodeMirrorLanguage, CodeMirrorLanguage as CodeMirrorLanguage$1, EditorContext, EditorContext as EditorContext$1, MergeView, MergeView as MergeView$1, SqlSchema, SqlSchema as SqlSchema$1, codeMirrorLanguages, normalizeContext as normalizeContext$1, searchPhrasesZhCn as searchPhrasesZhCn$1 } from "@coldsmirk/inkstone-codemirror";
+import { ReactNode } from "react";
+
+//#region src/codemirror-diff-editor.d.ts
+interface CodeMirrorDiffEditorProps {
+  /**
+   * The controlled original text (the left side). Always read-only in the view — it changes
+   * only through this prop, and external changes reconcile in place without a rebuild.
+   */
+  original: string;
+  /**
+   * The controlled modified text (the right side) — editable unless `readOnly`; external
+   * changes reconcile into the live editor without resetting the caret.
+   */
+  modified: string;
+  /**
+   * Called with the full modified document after every edit made in the view — typing, or a
+   * revert-control copy from the original side. Same contract as `<CodeMirrorEditor>`'s
+   * `onChange`.
+   */
+  onChange?: (value: string) => void;
+  /**
+   * Language id, applied to both sides — lazily loads the matching CodeMirror grammar as its
+   * own chunk, exactly like `<CodeMirrorEditor>`. For anything beyond the built-in set, pass
+   * your own support through `extensions`.
+   */
+  language?: CodeMirrorLanguage;
+  /**
+   * Lock the modified side too, turning the component into a pure diff viewer. The original
+   * side is read-only regardless. Revert controls stay disabled while this is set.
+   *
+   * @default false
+   */
+  readOnly?: boolean;
+  /**
+   * Show a per-chunk revert arrow between the editors that copies the original chunk into
+   * the modified document (the edit flows through `onChange`). Swaps in place, and remains
+   * unavailable while `readOnly` is set.
+   *
+   * @default false
+   */
+  revertControls?: boolean;
+  /**
+   * Collapse long unchanged stretches behind an expandable "⦚ n lines ⦚" bar, keeping a few
+   * context lines around each change. Swaps in place.
+   *
+   * @default false
+   */
+  collapseUnchanged?: boolean;
+  /**
+   * Soft-wrap long lines on both sides. Swaps in place.
+   *
+   * @default false
+   */
+  lineWrapping?: boolean;
+  /**
+   * Show the line-number gutters. On by default — unlike a single document field, a diff
+   * reads by line reference. Swaps in place.
+   *
+   * @default true
+   */
+  showLineNumbers?: boolean;
+  /**
+   * Static extensions applied to both sides, fixed for the view's lifetime. Hoist the
+   * array — a new identity per render is ignored by design (create-once).
+   */
+  extensions?: Extension[];
+  /**
+   * Extensions swapped in place on both sides when the identity changes — memoize with
+   * `useMemo` keyed on what actually changes. Layered after (and so able to override)
+   * inkstone's default catppuccin theme.
+   */
+  dynamicExtensions?: Extension[];
+  /**
+   * Use the dark catppuccin flavor (macchiato) instead of the light one (latte). The
+   * component never reads the OS `prefers-color-scheme` — same policy as every inkstone
+   * editor.
+   *
+   * @default false
+   */
+  dark?: boolean;
+  /**
+   * View height — a number is treated as px. The merge view scrolls as one surface (both
+   * sides together, which is what keeps chunks aligned); omit to grow with content.
+   */
+  height?: string | number;
+  /**
+   * View width — a number is treated as px. Omit to fill the container.
+   */
+  width?: string | number;
+  /**
+   * Editor font size in px, applied to both sides.
+   *
+   * @default 14
+   */
+  fontSize?: number;
+  /**
+   * Line height, both sides — same convention as the other inkstone editors: values below 8
+   * multiply the font size, larger values are absolute pixels.
+   *
+   * @default 1.6
+   */
+  lineHeight?: number;
+  className?: string;
+  /**
+   * Accessible name for the original (read-only) textbox. English by default — same policy
+   * as every inkstone label; localizing hosts pass their own. Fixed for the view's lifetime,
+   * like the other create-once wiring.
+   *
+   * @default "Original content"
+   */
+  originalAriaLabel?: string;
+  /**
+   * Accessible name for the modified (editable) textbox. Fixed for the view's lifetime.
+   *
+   * @default "Modified content"
+   */
+  modifiedAriaLabel?: string;
+  /**
+   * Runs once after the view is created, with the `MergeView` — the imperative handle to
+   * both `EditorView`s (`view.a` is the original, `view.b` the modified) and the computed
+   * chunks.
+   */
+  onMount?: (view: MergeView) => void;
+}
+/**
+ * A controlled side-by-side CodeMirror diff editor: `@codemirror/merge`'s `MergeView` behind
+ * the same create-once / reconcile-in-place discipline as `<CodeMirrorEditor>`, with the
+ * catppuccin flavors extended to the diff chrome (red deletions, green insertions, themed
+ * collapse bars and revert controls).
+ *
+ * The original side is read-only and follows the `original` prop; the modified side is the
+ * editable document behind `modified` / `onChange` (set `readOnly` for a pure viewer). Both
+ * sides share `language`, `extensions`, and the theme; dark flips, language loads, and
+ * `revertControls` / `collapseUnchanged` all swap in place without rebuilding the view.
+ */
+declare function CodeMirrorDiffEditor({
+  original,
+  modified,
+  onChange,
+  language,
+  readOnly,
+  revertControls,
+  collapseUnchanged,
+  lineWrapping,
+  showLineNumbers,
+  extensions,
+  dynamicExtensions,
+  dark,
+  height,
+  width,
+  fontSize,
+  lineHeight,
+  className,
+  originalAriaLabel,
+  modifiedAriaLabel,
+  onMount
+}: CodeMirrorDiffEditorProps): ReactNode;
+//#endregion
+//#region src/codemirror-editor.d.ts
+interface CodeMirrorEditorProps {
+  /**
+   * The controlled document text — external changes reconcile into the live editor
+   * without resetting the caret.
+   */
+  value: string;
+  onChange?: (value: string) => void;
+  /**
+   * Language id — lazily loads the matching CodeMirror grammar as its own chunk (only the
+   * selected language is fetched, never the whole catalog). For a language outside this set,
+   * or for parser options / mixed languages, pass your own support through `extensions`.
+   */
+  language?: CodeMirrorLanguage;
+  /**
+   * Render-context schema for variable / member autocomplete — currently consumed by the
+   * `minijinja` languages, where it makes `{{ }}` / `{% if %}` / `{% for x in %}` suggest the
+   * template's context variables and walk member access (`user.address.city`). Pass a JSON Schema
+   * (`{ schema }`, e.g. what Rust `schemars` derives) or a sample value (`{ sample }`); it updates
+   * reactively without recreating the editor. Memoize/hoist it — a new identity each render
+   * re-normalizes and re-dispatches. No effect on languages that don't read it.
+   */
+  context?: EditorContext;
+  /**
+   * Database schema for SQL table / column autocomplete. Updates reactively without
+   * recreating the editor; memoize/hoist it to avoid redundant serialization. No effect on
+   * languages that do not consume it.
+   */
+  sqlSchema?: SqlSchema;
+  placeholder?: string;
+  /**
+   * Soft-wrap long lines.
+   *
+   * @default false
+   */
+  lineWrapping?: boolean;
+  /**
+   * Show the line-number gutter. Fixed at creation, like `lineWrapping` / `placeholder`.
+   *
+   * @default false
+   */
+  showLineNumbers?: boolean;
+  /**
+   * Enable code folding (fold gutter + keymap). Fixed at creation; fold points come from the
+   * language, so set `language` too.
+   *
+   * @default false
+   */
+  folding?: boolean;
+  /**
+   * Turn native browser spell-check on. Off by default (CodeMirror's own default, right for
+   * code); enable for prose-grade documents like prompt templates. Fixed at creation.
+   *
+   * @default false
+   */
+  spellcheck?: boolean;
+  /**
+   * Enable in-editor search: Ctrl/Cmd-F opens a catppuccin-styled search/replace panel; F3 /
+   * Ctrl/Cmd-G cycle matches, Ctrl/Cmd-D selects the next occurrence, Alt-G jumps to a line.
+   * The panel speaks CodeMirror's stock English — set `locale="zh-cn"` (or pass
+   * `searchPhrasesZhCn` through `extensions`) for Simplified Chinese. Off by default —
+   * embedded fields rarely want a search UI. Fixed at creation.
+   *
+   * @default false
+   */
+  search?: boolean;
+  /**
+   * Editor font size in px, applied as a theme extension.
+   *
+   * @default 14
+   */
+  fontSize?: number;
+  /**
+   * Line height, applied as a theme extension on the scroller so content and gutters stay
+   * in step. Same convention as `<MonacoEditor>` (Monaco's own): values below 8 multiply the
+   * font size (e.g. `1.6` — CSS's unitless line-height), larger values are absolute pixels
+   * (e.g. `22`).
+   *
+   * @default 1.6
+   */
+  lineHeight?: number;
+  /**
+   * Tab width in spaces — sets both the displayed tab width (`EditorState.tabSize`) and the
+   * indent string inserted on Tab (`indentUnit`), so display and indentation stay in sync.
+   */
+  tabSize?: number;
+  /**
+   * Static extensions (language support, keymaps …), fixed for the editor's lifetime.
+   * Hoist the array — a new identity per render is ignored by design (create-once).
+   */
+  extensions?: Extension[];
+  /**
+   * Extensions swapped in place when the identity changes (theme, language config) —
+   * memoize with `useMemo` keyed on what actually changes. Layered after (and so able to
+   * override) inkstone's default catppuccin theme.
+   */
+  dynamicExtensions?: Extension[];
+  /**
+   * Use the dark catppuccin flavor (macchiato) instead of the light one (latte). The
+   * component never reads the OS `prefers-color-scheme`; wire this to your app's
+   * color-scheme state — same policy as `<MonacoEditor>`.
+   *
+   * @default false
+   */
+  dark?: boolean;
+  /**
+   * Locale for the phrase tables inkstone ships for CodeMirror's stock UI strings —
+   * currently the search / goto-line panel. Unlike Monaco's page-global locale, this is
+   * genuinely per-editor (`EditorState.phrases`) and swaps in place. Equivalent to passing
+   * `searchPhrasesZhCn` through `extensions`, which stays the framework-agnostic surface.
+   *
+   * @default "en"
+   */
+  locale?: "en" | "zh-cn";
+  /**
+   * Editor height — a number is treated as px. Sizes the editor box and hands overflow to
+   * the scroller; omit to grow with content.
+   */
+  height?: string | number;
+  /**
+   * Editor width — a number is treated as px. Omit to fill the container.
+   */
+  width?: string | number;
+  className?: string;
+  /**
+   * Runs once after the editor is created, with the CodeMirror `EditorView` — the imperative
+   * handle for focus, dispatch, scrolling, selection, etc. This is CodeMirror's analog of
+   * Monaco's `onMount`. Monaco's `loading` / `beforeMount` have no counterpart here: the
+   * editor mounts synchronously (no host or editor chunk to await — only the optional
+   * `language` grammar streams in behind an already-usable editor), and pre-creation setup is
+   * the `extensions` prop rather than a global instance to configure.
+   */
+  onMount?: (view: EditorView) => void;
+  /**
+   * Called when the editor gains focus.
+   */
+  onFocus?: () => void;
+  /**
+   * Called when the editor loses focus.
+   */
+  onBlur?: () => void;
+  /**
+   * Accessible name for the editor textbox.
+   *
+   * @default "Editor content"
+   */
+  ariaLabel?: string;
+}
+/**
+ * A controlled CodeMirror 6 document editor: the standard document extension bundle
+ * (line numbers, history, brackets, completion UI — see `documentExtensions`) plus the
+ * create-once / reconcile-in-place plumbing of `ControlledEditorHost`, exposed as a plain
+ * React component.
+ *
+ * Ships the catppuccin theme by default (latte / macchiato, flipped by `dark`) and takes
+ * `height` / `width` for sizing — parity with `<MonacoEditor>`. Bring your own language
+ * support via `extensions`; a theme passed through `dynamicExtensions` overrides the default.
+ */
+declare function CodeMirrorEditor({
+  value,
+  onChange,
+  language,
+  context,
+  sqlSchema,
+  placeholder,
+  lineWrapping,
+  showLineNumbers,
+  folding,
+  spellcheck,
+  search,
+  extensions,
+  dynamicExtensions,
+  dark,
+  locale,
+  height,
+  width,
+  fontSize,
+  lineHeight,
+  tabSize,
+  className,
+  onMount,
+  onFocus,
+  onBlur,
+  ariaLabel
+}: CodeMirrorEditorProps): ReactNode;
+//#endregion
+export { codeMirrorLanguages as a, CodeMirrorEditor as c, CodeMirrorDiffEditorProps as d, SqlSchema$1 as i, CodeMirrorEditorProps as l, EditorContext$1 as n, normalizeContext$1 as o, MergeView$1 as r, searchPhrasesZhCn$1 as s, CodeMirrorLanguage$1 as t, CodeMirrorDiffEditor as u };

package/dist/codemirror.d.ts

@@ -0,0 +1,2 @@
+import { a as codeMirrorLanguages, c as CodeMirrorEditor, d as CodeMirrorDiffEditorProps, i as SqlSchema, l as CodeMirrorEditorProps, n as EditorContext, o as normalizeContext, r as MergeView, s as searchPhrasesZhCn, t as CodeMirrorLanguage, u as CodeMirrorDiffEditor } from "./codemirror-B3GlIVaX.js";
+export { CodeMirrorDiffEditor, type CodeMirrorDiffEditorProps, CodeMirrorEditor, type CodeMirrorEditorProps, type CodeMirrorLanguage, type EditorContext, type MergeView, type SqlSchema, codeMirrorLanguages, normalizeContext, searchPhrasesZhCn };

package/dist/codemirror.js

@@ -0,0 +1,2 @@
+import { a as CodeMirrorDiffEditor, i as CodeMirrorEditor, n as normalizeContext, r as searchPhrasesZhCn, t as codeMirrorLanguages } from "./codemirror-B27C5np1.js";
+export { CodeMirrorDiffEditor, CodeMirrorEditor, codeMirrorLanguages, normalizeContext, searchPhrasesZhCn };