@seekalfred/primitives 0.5.1 → 0.7.1

package/dist/rich-text-editor/index.d.ts

@@ -0,0 +1,3 @@
+import { BlockType, RichTextValue } from "./rich-text-engine.js";
+import { RichTextEditor, RichTextEditorHandle, RichTextEditorProps } from "./rich-text-editor.js";
+export { type BlockType, RichTextEditor, type RichTextEditorHandle, type RichTextEditorProps, type RichTextValue };

package/dist/rich-text-editor/index.js

@@ -0,0 +1,2 @@
+import { RichTextEditor } from "./rich-text-editor.js";
+export { RichTextEditor };

package/dist/rich-text-editor/rich-text-editor.d.ts

@@ -0,0 +1,70 @@
+import { BlockType, RichTextValue } from "./rich-text-engine.js";
+import { ReactNode } from "react";
+//#region src/rich-text-editor/rich-text-editor.d.ts
+/** What the editor can be told to do from outside. */
+export interface RichTextEditorHandle {
+  focus: () => void;
+  getHTML: () => string;
+  getMarkdown: () => string;
+  getText: () => string;
+  /** Replaces the document. Reports a change, like an edit. */
+  setHTML: (html: string) => void;
+  /** Replaces the document with Markdown. Reports a change, like an edit. */
+  setMarkdown: (markdown: string) => void;
+  /** Empties the document. Reports a change, like an edit. */
+  clear: () => void;
+  undo: () => void;
+  redo: () => void;
+  /** The editable element. Null before mount. */
+  element: HTMLDivElement | null;
+}
+/**
+ * A rich text field: headings, lists, quotes, code, dividers, links and marks, with a floating
+ * selection toolbar, a slash menu for blocks and Markdown shortcuts as you type.
+ *
+ * The value is canonical HTML in a fixed vocabulary (p, h1-h3, ul, ol, li, blockquote, pre, hr,
+ * strong, em, u, s, code, a[href], br), cleaned on the way in and on the way out. It is not the
+ * engine's own format, so a stored value does not depend on the engine.
+ *
+ * @example
+ * <RichTextEditor label="Notes" value={html} onChange={(v) => setHtml(v.html)} />
+ */
+export interface RichTextEditorProps {
+  /** Controlled HTML. The editor rewrites its content only when this differs from what it last reported, so typing never fights the caret. */
+  value?: string;
+  /** Initial HTML for an uncontrolled editor. */
+  defaultValue?: string;
+  /** Initial content as Markdown, used when no HTML is given. */
+  defaultMarkdown?: string;
+  /** Called with the document in every format after each edit (not after a controlled `value` arrives). */
+  onChange?: (value: RichTextValue) => void;
+  /** Reports whether undo and redo are available, for your own buttons. */
+  onHistoryChange?: (state: {
+    canUndo: boolean;
+    canRedo: boolean;
+  }) => void;
+  /** Shown while the document is empty. @default "Start writing" */
+  placeholder?: string;
+  /** The hint on an empty line while typing. @default "Type / for blocks" */
+  blockHint?: string;
+  /** Not focusable and not editable, muted. */
+  isDisabled?: boolean;
+  /** Focusable and selectable, but not editable. The toolbar and slash menu do not open. */
+  isReadOnly?: boolean;
+  autoFocus?: boolean;
+  /** A visible label above the field, which names it. */
+  label?: ReactNode;
+  /** Helper text under the field, named by `aria-describedby`. */
+  description?: string;
+  /** Error text under the field. Sets `aria-invalid` and is announced when it appears. */
+  error?: string;
+  /** The accessible name when there is no `label`. @default "Editor" */
+  "aria-label"?: string;
+  id?: string;
+  /** Extra classes on the outer element. */
+  className?: string;
+}
+export declare const RichTextEditor: import("react").ForwardRefExoticComponent<RichTextEditorProps & import("react").RefAttributes<RichTextEditorHandle>>;
+//#endregion
+export type { BlockType, RichTextValue };
+//# sourceMappingURL=rich-text-editor.d.ts.map