@apollohg/react-native-prose-editor 0.1.1 → 0.3.0

package/dist/NativeRichTextEditor.d.ts

@@ -0,0 +1,142 @@
+import React from 'react';
+import { type StyleProp, type ViewStyle } from 'react-native';
+import { type ActiveState, type DocumentJSON, type HistoryState, type Selection } from './NativeEditorBridge';
+import { type EditorToolbarItem } from './EditorToolbar';
+import { type EditorTheme } from './EditorTheme';
+import { type EditorAddons } from './addons';
+import { type SchemaDefinition } from './schemas';
+import { type ImageNodeAttributes } from './schemas';
+export type NativeRichTextEditorHeightBehavior = 'fixed' | 'autoGrow';
+export type NativeRichTextEditorToolbarPlacement = 'keyboard' | 'inline';
+export interface RemoteSelectionDecoration {
+    clientId: number;
+    anchor: number;
+    head: number;
+    color: string;
+    name?: string;
+    avatarUrl?: string;
+    isFocused?: boolean;
+}
+export interface LinkRequestContext {
+    href?: string;
+    isActive: boolean;
+    selection: Selection;
+    setLink: (href: string) => void;
+    unsetLink: () => void;
+}
+export interface ImageRequestContext {
+    selection: Selection;
+    allowBase64: boolean;
+    insertImage: (src: string, attrs?: Omit<ImageNodeAttributes, 'src'>) => void;
+}
+export interface NativeRichTextEditorProps {
+    /** Initial content as HTML (uncontrolled mode). */
+    initialContent?: string;
+    /** Initial content as ProseMirror JSON (uncontrolled mode). */
+    initialJSON?: DocumentJSON;
+    /** Controlled HTML content. External changes are diffed and applied. */
+    value?: string;
+    /** Controlled ProseMirror JSON content. Ignored if value is set. */
+    valueJSON?: DocumentJSON;
+    /** Schema definition. Defaults to tiptapSchema if not provided. */
+    schema?: SchemaDefinition;
+    /** Placeholder text shown when editor is empty. */
+    placeholder?: string;
+    /** Whether the editor is editable. */
+    editable?: boolean;
+    /** Maximum character length. */
+    maxLength?: number;
+    /** Whether to auto-focus on mount. */
+    autoFocus?: boolean;
+    /** Controls whether the editor scrolls internally or grows with content. */
+    heightBehavior?: NativeRichTextEditorHeightBehavior;
+    /** Whether to show the formatting toolbar. Defaults to true. */
+    showToolbar?: boolean;
+    /** Whether the toolbar is attached to the keyboard natively or rendered inline in React. */
+    toolbarPlacement?: NativeRichTextEditorToolbarPlacement;
+    /** Displayed toolbar buttons, in order. Supports custom marks/nodes. */
+    toolbarItems?: readonly EditorToolbarItem[];
+    /** Called when a custom `action` toolbar item is pressed. */
+    onToolbarAction?: (key: string) => void;
+    /** Called when a toolbar link item is pressed so the host can collect/edit a URL. */
+    onRequestLink?: (context: LinkRequestContext) => void;
+    /** Called when a toolbar image item is pressed so the host can choose an image source. */
+    onRequestImage?: (context: ImageRequestContext) => void;
+    /** Whether `data:image/...` sources are accepted for image insertion and HTML parsing. */
+    allowBase64Images?: boolean;
+    /** Whether selected images show native resize handles. */
+    allowImageResizing?: boolean;
+    /** Called when content changes with the current HTML. */
+    onContentChange?: (html: string) => void;
+    /** Called when content changes with the current ProseMirror JSON. */
+    onContentChangeJSON?: (json: DocumentJSON) => void;
+    /** Called when selection changes. */
+    onSelectionChange?: (selection: Selection) => void;
+    /** Called when active formatting state changes. */
+    onActiveStateChange?: (state: ActiveState) => void;
+    /** Called when undo/redo availability changes. */
+    onHistoryStateChange?: (state: HistoryState) => void;
+    /** Called when the editor gains focus. */
+    onFocus?: () => void;
+    /** Called when the editor loses focus. */
+    onBlur?: () => void;
+    /** Style applied to the native editor view. */
+    style?: StyleProp<ViewStyle>;
+    /** Style applied to the outer React container wrapping the editor and inline toolbar. */
+    containerStyle?: StyleProp<ViewStyle>;
+    /** Optional native content theme applied to rendered blocks and typing attrs. */
+    theme?: EditorTheme;
+    /** Optional addon configuration. */
+    addons?: EditorAddons;
+    /** Remote awareness selections rendered as native overlays. */
+    remoteSelections?: readonly RemoteSelectionDecoration[];
+}
+export interface NativeRichTextEditorRef {
+    /** Programmatically focus the editor. */
+    focus(): void;
+    /** Programmatically blur the editor. */
+    blur(): void;
+    /** Toggle a formatting mark (e.g. 'bold', 'italic'). */
+    toggleMark(markType: string): void;
+    /** Apply or update a hyperlink on the current selection. */
+    setLink(href: string): void;
+    /** Remove a hyperlink from the current selection. */
+    unsetLink(): void;
+    /** Toggle blockquote wrapping around the current block selection. */
+    toggleBlockquote(): void;
+    /** Toggle a list type (bulletList or orderedList). */
+    toggleList(listType: 'bulletList' | 'orderedList'): void;
+    /** Indent the current list item. */
+    indentListItem(): void;
+    /** Outdent the current list item. */
+    outdentListItem(): void;
+    /** Insert a void node (e.g. 'horizontalRule'). */
+    insertNode(nodeType: string): void;
+    /** Insert a block image node with the given source and optional metadata. */
+    insertImage(src: string, attrs?: Omit<ImageNodeAttributes, 'src'>): void;
+    /** Insert text at the current cursor position. */
+    insertText(text: string): void;
+    /** Insert HTML content at the current selection. */
+    insertContentHtml(html: string): void;
+    /** Insert JSON content at the current selection. */
+    insertContentJson(doc: DocumentJSON): void;
+    /** Replace entire document with HTML (preserves undo history). */
+    setContent(html: string): void;
+    /** Replace entire document with JSON (preserves undo history). */
+    setContentJson(doc: DocumentJSON): void;
+    /** Get the current HTML content. */
+    getContent(): string;
+    /** Get the current content as ProseMirror JSON. */
+    getContentJson(): DocumentJSON;
+    /** Get the plain text content (no markup). */
+    getTextContent(): string;
+    /** Undo the last operation. */
+    undo(): void;
+    /** Redo the last undone operation. */
+    redo(): void;
+    /** Check if undo is available. */
+    canUndo(): boolean;
+    /** Check if redo is available. */
+    canRedo(): boolean;
+}
+export declare const NativeRichTextEditor: React.ForwardRefExoticComponent<NativeRichTextEditorProps & React.RefAttributes<NativeRichTextEditorRef>>;