mui-tiptap/dist/cjs/RichTextReadOnly.d.ts

A Material-UI (MUI) styled WYSIWYG rich text editor, using Tiptap

import { type RichTextContentProps } from "./RichTextContent";
import type { UseEditorOptions } from "./RichTextEditor";
export type RichTextReadOnlyProps = Partial<Omit<UseEditorOptions, "editable">> & {
    /**
     * Extensions to use for the editor, which determine what functionality to
     * enable.
     */
    extensions: NonNullable<UseEditorOptions["extensions"]>;
    /**
     * Override the props for the RichTextContent component.
     */
    RichTextContentProps?: RichTextContentProps;
    /**
     * A convenience prop alternative to `RichTextContentProps.sx` for applying
     * styles to the rich text content.
     */
    sx?: RichTextContentProps["sx"];
};
/**
 * An all-in-one component to directly render read-only Tiptap editor content.
 *
 * When to use this component:
 * - You just want to render editor HTML/JSON content directly, without any
 *   outlined field styling, menu bar, extra setup, etc.
 * - You want a convenient way to render content that re-renders as the
 *   `content` prop changes.
 *
 * Though RichtextEditor (or useEditor, RichTextEditorProvider, and
 * RichTextContent) can be used as read-only via the editor's `editable` prop,
 * this is a simpler and more efficient version that only renders content and
 * nothing more (e.g., skips instantiating the editor at all if there's no
 * content to display, and does not contain additional rendering logic related
 * to controls, outlined field UI state, etc.).
 *
 * Example:
 * <RichTextReadOnly content="<p>Hello world</p>" extensions={[StarterKit]} />
 */
export default function RichTextReadOnly(props: RichTextReadOnlyProps): import("react/jsx-runtime").JSX.Element | null;