0.0.28 • Published 4 years ago
react-universal-markdown v0.0.28
Markdown component for Web and Native powered by CommonMark
npm install react-universal-markdown
Usage
With React DOM
import React, { Component } from 'react'
import Markdown from 'react-universal-markdown/dom'
export default class App extends Component {
render() {
return (
<Markdown>{`
Your markdown text
`}</Markdown>
)
}
}
With React Native
import React, { Component } from 'react'
import Markdown from 'react-universal-markdown/native'
export default class App extends Component {
render() {
return (
<Markdown>{`
Your markdown text
`}</Markdown>
)
}
}
API
DOMMarkdown
Props
...Markdown Props
- className to be added to the Document element. Other elements should be styled by CSS descendent selector.
string
]
DOMComponents
DOMMarkdown default components prop value
NativeMarkdown
Props
...Markdown Props
- styles styles to be applied to each element by type
{
Text : number | Object,
Em : number | Object,
Strong : number | Object,
Link : number | Object,
Image : number | Object,
Code : number | Object,
Paragraph : number | Object,
BlockQuote : number | Object,
Item : number | Object,
List : number | Object,
Heading : number | Object,
CodeBlock : number | Object,
ThematicBreak : number | Object,
Document : number | Object,
}
NativeComponents
NativeComponents default components prop value
Markdown
Props
- customizer a function to modify the parsed elements tree (AST). Executed for each level of the tree.
(children, render) => renderedChildren
- children a markdown
string
- components to be used for rendering markdown.
{ Text : Class<Component> | (props) => ReactElement, Em : Class<Component> | (props) => ReactElement, Strong : Class<Component> | (props) => ReactElement, Link : Class<Component> | (props) => ReactElement, Image : Class<Component> | (props) => ReactElement, Code : Class<Component> | (props) => ReactElement, Paragraph : Class<Component> | (props) => ReactElement, BlockQuote : Class<Component> | (props) => ReactElement, Item : Class<Component> | (props) => ReactElement, List : Class<Component> | (props) => ReactElement, Heading : Class<Component> | (props) => ReactElement, CodeBlock : Class<Component> | (props) => ReactElement, ThematicBreak : Class<Component> | (props) => ReactElement, Document : Class<Component> | (props) => ReactElement, }
0.0.28
4 years ago
0.0.27
6 years ago
0.0.26
7 years ago
0.0.25
7 years ago
0.0.24
7 years ago
0.0.23
7 years ago
0.0.22
7 years ago
0.0.21
7 years ago
0.0.20
7 years ago
0.0.19
7 years ago
0.0.18
7 years ago
0.0.17
7 years ago
0.0.16
7 years ago
0.0.15
7 years ago
0.0.14
7 years ago
0.0.13
7 years ago
0.0.12
7 years ago
0.0.11
7 years ago
0.0.10
7 years ago
0.0.9
7 years ago
0.0.8
7 years ago
0.0.6
7 years ago
0.0.5
7 years ago
0.0.4
7 years ago
0.0.3
7 years ago
0.0.2
7 years ago
0.0.1
7 years ago
0.0.0
7 years ago