@district/react-native-markdown-display

v1.2.0

Published

a year ago

Markdown renderer for react-native, with CommonMark spec support + adds syntax extensions & sugar (URL autolinking, typographer), originally created by Mient-jan Stelling as react-native-markdown-renderer

Downloads

0High
0Medium
0Low

samwyness-district

react react-native native markdown commonmark markdown-it

React Native Markdown Display

It a 100% compatible CommonMark renderer, a react-native markdown renderer done right. This is not a web-view markdown renderer but a renderer that uses native components for all its elements. These components can be overwritten and styled as needed.

Compatibility with react-native-markdown-renderer

This is intended to be a replacement for react-native-markdown-renderer, with a variety of bug fixes and enhancements - Due to how the new style rules work, there may be some tweaking needed, see how to style stuff section below

Install

Yarn

yarn add react-native-markdown-display

NPM

npm install -S react-native-markdown-display

Get Started

import React from 'react';
import {SafeAreaView, ScrollView, StatusBar} from 'react-native';

import Markdown from 'react-native-markdown-display';

const copy = `# h1 Heading 8-)

**This is some bold text!**

This is normal text
`;

const App: () => React$Node = () => {
  return (
    <>
      <StatusBar barStyle="dark-content" />
      <SafeAreaView>
        <ScrollView
          contentInsetAdjustmentBehavior="automatic"
          style={{height: '100%'}}>
          <Markdown>{copy}</Markdown>
        </ScrollView>
      </SafeAreaView>
    </>
  );
};

export default App;

Props and Functions

The <Markdown> object takes the following common props:

| Property | Default | Required | Description | | ---------------- | ----------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | | children | N/A | true | The markdown string to render, or the pre-processed tree | | style | source | false | An object to override the styling for the various rules, see style section below for more info | | mergeStyle | true | false | If true, when a style is supplied, the individual items are merged with the default styles instead of overwriting them | | rules | source | false | An object of rules that specify how to render each markdown item, see rules section below for more info | | onLinkPress | import { Linking } from 'react-native'; and Linking.openURL(url); | false | A handler function to change click behaviour, see handling links section below for more info | | debugPrintTree | false | false | Will print the AST tree to the console to help you see what the markdown is being translated to |

And some additional, less used options:

| Property | Default | Required | Description | | ------------------------- | ----------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | renderer | instanceOf(AstRenderer) | false | Used to specify a custom renderer, you can not use the rules or styles props with a custom renderer. | | markdownit | instanceOf(MarkdownIt) | false | A custom markdownit instance with your configuration, default is MarkdownIt({typographer: true}) | | maxTopLevelChildren | null | false | If defined as a number will only render out first n many top level children, then will try to render out topLevelMaxExceededItem | | topLevelMaxExceededItem | <Text key="dotdotdot">...</Text> | false | Will render when maxTopLevelChildren is hit. Make sure to give it a key! | | allowedImageHandlers | ['data:image/png;base64', 'data:image/gif;base64', 'data:image/jpeg;base64', 'https://', 'http://'] | false | Any image that does not start with one of these will have the defaultImageHandler value prepended to it (unless defaultImageHandler is null in which case it won't try to render anything) | | defaultImageHandler | http:// | false | Will be prepended to an image url if it does not start with something in the allowedImageHandlers array, if this is set to null, it won't try to recover but will just not render anything instead. |

Syntax Support

  # h1 Heading 8-)
  ## h2 Heading
  ### h3 Heading
  #### h4 Heading
  ##### h5 Heading
  ###### h6 Heading

| iOS | Android | | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | | |

  Some text above
  ___

  Some text in the middle

  ---

  Some text below

  **This is bold text**

  __This is bold text__

  *This is italic text*

  _This is italic text_

  ~~Strikethrough~~

  > Blockquotes can also be nested...
  >> ...by using additional greater-than signs right next to each other...
  > > > ...or with spaces between arrows.

  Unordered

  + Create a list by starting a line with `+`, `-`, or `*`
  + Sub-lists are made by indenting 2 spaces:
    - Marker character change forces new list start:
      * Ac tristique libero volutpat at
      + Facilisis in pretium nisl aliquet. This is a very long list item that will surely wrap onto the next line.
      - Nulla volutpat aliquam velit
  + Very easy!

  Ordered

  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit. This is a very long list item that will surely wrap onto the next line.
  3. Integer molestie lorem at massa

  Start numbering with offset:

  57. foo
  58. bar

  Inline \`code\`

Indented code

      // Some comments
      line 1 of code
      line 2 of code
      line 3 of code

Block code "fences"

\`\`\`
Sample text here...
\`\`\`

Syntax highlighting

\`\`\` js
var foo = function (bar) {
return bar++;
};

console.log(foo(5));
\`\`\`