Component Usage

Markdown is a FlatList wrapper — simplest way to render markdown.

import * as React from "react";
import Markdown from "react-native-marked";

export default function Example() {
  return (
    <Markdown
      value={`# Hello world\n\n- item 1\n- item 2`}
      flatListProps={{ initialNumToRender: 8 }}
      styles={{
        h1: { color: "#111" },
        paragraph: { marginBottom: 12 },
      }}
      theme={{ colors: { text: "#222", background: "#fff" } }}
      baseUrl="https://example.com"
      selectable
    />
  );
}

Props

PropTypeDescription
valuestringMarkdown source (required)
flatListProps`Omit<FlatListProps, 'data''renderItem'
stylesMarkedStylesPer-element View/Text styles
themeUserThemeColors + spacing tokens
baseUrlstringPrefix for relative links
rendererRendererInterfaceCustom renderer (see Custom Renderer)
hooksMarkedHooksmarked hooks
selectablebooleanText selectable (default true; ignored if custom renderer passed — use new Renderer({selectable}))

See src/lib/types.ts:17 for MarkdownProps.