@uiw/react-markdown-preview/esm/Props.d.ts

React component preview markdown text in web browser. The minimal amount of CSS to replicate the GitHub Markdown style.

import { type Options } from 'react-markdown';
import { type RehypeRewriteOptions } from 'rehype-rewrite';
import { type PluggableList } from 'unified';
export interface MarkdownPreviewProps extends Omit<Options, 'children'> {
    prefixCls?: string;
    className?: string;
    source?: string;
    disableCopy?: boolean;
    style?: React.CSSProperties;
    pluginsFilter?: (type: 'rehype' | 'remark', plugin: PluggableList) => PluggableList;
    wrapperElement?: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement> & {
        'data-color-mode'?: 'light' | 'dark';
    };
    /**
     * Please use wrapperElement, Will be removed in v5 release.
     * @deprecated
     */
    warpperElement?: React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement> & {
        'data-color-mode'?: 'light' | 'dark';
    };
    onScroll?: (e: React.UIEvent<HTMLDivElement>) => void;
    onMouseOver?: (e: React.MouseEvent<HTMLDivElement>) => void;
    rehypeRewrite?: RehypeRewriteOptions['rewrite'];
}
export interface MarkdownPreviewRef extends MarkdownPreviewProps {
    mdp: React.RefObject<HTMLDivElement>;
}