@novastera-oss/react-native-markdown-display

v8.1.0

Published

a month ago

Markdown renderer for react-native, with CommonMark spec support. Maintained by Novastera.

0High
0Medium
0Low

darksorrow

react react-native native markdown commonmark markdown-it crm erp novastera

React Native Markdown Display

It is a CommonMark-compatible React Native markdown renderer that uses native components rather than a web view. Maintained by Novastera, an open-source CRM/ERP platform, it is designed to be easy to theme and extend.

Install

Yarn

yarn add @novastera-oss/react-native-markdown-display

NPM

npm install -S @novastera-oss/react-native-markdown-display

Breaking Changes

See BREAKING_CHANGE.md for the full migration notes from the legacy version.

Get Started

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

import Markdown from '@novastera-oss/react-native-markdown-display';

const copy = `# h1 Heading 8-)

**This is some bold text!**

This is normal text
`;

const App: () => React.ReactNode = () => {
  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