SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface RichTextEditorProps

    The contract of a rich text editor: text in, edited text out. A host may supply its own in place of the default RichTextEditor.

    interface RichTextEditorProps {
        onChange?: (value: string | JSON) => void;
        onDone?: () => void;
        readOnly?: boolean;
        ref?: Ref<HTMLDivElement>;
        runStyle?: (font: JSON) => CSSProperties | undefined;
        value: string | JSON;
    }

    Hierarchy

    • Omit<React.HTMLAttributes<HTMLDivElement>, "onChange">
      • RichTextEditorProps
    Index
    onChange? onDone? readOnly? ref? runStyle? value
    onChange?: (value: string | JSON) => void

    Called with the edited text when the edit is committed, which is when the editor loses focus. Not called when nothing changed.

    onDone?: () => void

    Called when the person leaves the editor with Escape, after the commit.

    readOnly?: boolean

    If true, the text is shown but cannot be edited.

    false
    ref?: Ref<HTMLDivElement>
    runStyle?: (font: JSON) => CSSProperties | undefined

    The CSS for the font properties a run sets.

    value: string | JSON

    The text: plain, or formatting runs.

    Settings
    Member Visibility

    On This Page
    Properties