smartrte-react 0.3.4 → 1.0.0-beta.1

package/dist/components/CanonicalAuthorityEditor.d.ts

@@ -0,0 +1,59 @@
+import React from "react";
+import { type PersistedEditorDocument, type ClipboardDiagnosticReport } from "smartrte-core/foundation";
+import type { MediaProvider } from "../mediaProvider.js";
+import type { VersionProvider } from "../versionProvider.js";
+import type { CommentProvider } from "../commentProvider.js";
+import type { SuggestionProvider } from "../suggestionProvider.js";
+import { type MediaPickerComponent } from "./MediaPicker.js";
+import type { EditorCapabilityPreset } from "../capabilityPresets.js";
+import { CanonicalEditorRuntime, type SmartEditorChange, type SmartEditorHandle } from "../canonicalEditorRuntime.js";
+export interface CanonicalAuthorityEditorProps {
+    /** Initial value only. Later replacements must use SmartEditorHandle.replaceValue. */
+    defaultValue?: string | PersistedEditorDocument;
+    /**
+     * Which built-in plugins this instance is constructed with - see
+     * capabilityPresets.ts. Construction-time only, matching `defaultValue`'s
+     * own uncontrolled-after-mount contract (the underlying runtime is
+     * created once and retained; changing this prop on an already-mounted
+     * instance has no effect). Defaults to "full" - every existing consumer
+     * that never sets this is unaffected.
+     */
+    preset?: EditorCapabilityPreset;
+    onChange?: (change: SmartEditorChange) => void;
+    /** Transitional serialization callback for hosts that still persist HTML. */
+    onHtmlChange?: (html: string) => void;
+    onClipboardDiagnostic?: (report: ClipboardDiagnosticReport) => void;
+    /** Host-owned upload/search/remove boundary for canonical media insertion. */
+    mediaProvider?: MediaProvider;
+    /** Replaceable picker; the default only selects a local file. Used for video/audio, and for images when mediaManager is false. */
+    mediaPicker?: MediaPickerComponent;
+    /**
+     * Phase 11.5 §2.1: a library/search/duplicate-detection picker for
+     * images, replacing the bare file-input default. Defaults to true
+     * (MediaManager, adapted via mediaManagerAdapterFrom) whenever
+     * mediaProvider is supplied; set to false to keep the simple mediaPicker
+     * for images too.
+     */
+    mediaManager?: boolean;
+    /** Host-owned save/list/load/remove boundary for document version history. Absent hides the version-history toolbar button entirely, mirroring mediaProvider's absent-disables-the-feature contract. */
+    versionProvider?: VersionProvider;
+    /** Host-owned save/list/remove boundary for comment threads. Absent hides the comment toolbar buttons and markers entirely, mirroring versionProvider's absent-disables-the-feature contract. */
+    commentProvider?: CommentProvider;
+    /**
+     * Host-owned save/list/remove boundary for *structural* suggestions only
+     * (see suggestionProvider.ts) - inline suggestions need no provider since
+     * they are marks embedded in the document itself. Absent hides the
+     * suggestion toolbar buttons, markers, and panel entirely.
+     */
+    suggestionProvider?: SuggestionProvider;
+    /** Attributed to new comment replies and suggestions. Defaults to "anonymous" when absent. */
+    authorId?: string;
+    placeholder?: string;
+    minHeight?: number | string;
+    maxHeight?: number | string;
+    readOnly?: boolean;
+    className?: string;
+    /** Test/diagnostic hook; not part of the editing contract. */
+    onRuntime?: (runtime: CanonicalEditorRuntime) => void;
+}
+export declare const CanonicalAuthorityEditor: React.ForwardRefExoticComponent<CanonicalAuthorityEditorProps & React.RefAttributes<SmartEditorHandle>>;