react-markdown

Functions

• defaultUrlTransform()
• Markdown()
• MarkdownAsync()
• MarkdownHooks()

Type Aliases

• AllowElement
• Components
• ExtraProps
• HooksOptions
• Options
• UrlTransform

function defaultUrlTransform

defaultUrlTransform: (value: string) => string;

• Make a URL safe.

  {UrlTransform}

  Parameter value

  URL.

  Returns

  {string} Safe URL.

function Markdown

Markdown: (options: Readonly<Options>) => ReactElement;

• Component to render markdown.

  This is a synchronous component. When using async plugins, see or .

  Parameter options

  Props.

  Returns

  {ReactElement} React element.

function MarkdownAsync

MarkdownAsync: (options: Readonly<Options>) => Promise<ReactElement>;

• Component to render markdown with support for async plugins through async/await.

  Components returning promises are supported on the server. For async support on the client, see .

  Parameter options

  Props.

  Returns

  {Promise} Promise to a React element.

function MarkdownHooks

MarkdownHooks: (options: Readonly<HooksOptions>) => ReactNode;

• Component to render markdown with support for async plugins through hooks.

  This uses useEffect and useState hooks. Hooks run on the client and do not immediately render something. For async support on the server, see .

  Parameter options

  Props.

  Returns

  {ReactNode} React node.

type AllowElement

type AllowElement = import('./lib/index.js').AllowElement;

type Components

type Components = import('./lib/index.js').Components;

type ExtraProps

type ExtraProps = import('./lib/index.js').ExtraProps;

type HooksOptions

type HooksOptions = import('./lib/index.js').HooksOptions;

type Options

type Options = import('./lib/index.js').Options;

type UrlTransform

type UrlTransform = import('./lib/index.js').UrlTransform;