1.1.4 • Published 10 months ago

@matheuswr89/react-native-markdown-editor v1.1.4

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

React Native Markdown Editor Known Vulnerabilities

This is a library for rendering a markdown editor for the markdown with helper buttons to easily write markdown. With live preview markdown as well (thanks to https://github.com/Benjamin-Dobell/react-native-markdown-view)

Index

Getting Started

Install the node module:

yarn add @matheuswr89/react-native-markdown-editor

or with npm:

npm install --save @matheuswr89/react-native-markdown-editor

Then see Usage for futher details

Screenshots

Screenshot:

  • Multiline textinput for writing markdown
  • Live preview of the markdown written (can be hidden)
  • Helper buttons to write the syntax for the markdown (like github)

Bold Text

Italic Text

Underline text

Strikethrough

Inline code

  • Item 1
  • Item 2
  1. Item 1
  2. Item 2

Url Links:

GitHub

Images:

GitHub

function codeExample(arg) {
}

This is an < h1 > tag

Usage

Import the editor through

import { MarkdownEditor } from '@matheuswr89/react-native-markdown-editor';

And use like this this in the jsx

<MarkdownEditor />

And pass a function onMarkdownChange which will be callback when markdown is changed

 <MarkdownEditor onMarkdownChange={onTextChange} />

It can be used with a toolbar and have a submit menu option there!

To set a content in the editor, just pass the content in the props markdown like this:

 <MarkdownEditor onMarkdownChange={onTextChange} markdown={yourVariable} />

Customizing

Customize the styles

You can customize the styles of the following elements:

  • Placeholder color | placeholderTextColor
  • Text input | textInputStyles
  • Helper buttons | buttonStyles
  • Container of helper buttons | buttonContainerStyles
  • Container of preview | markdownViewStyles

And you can do this by passing a props as below:

 <MarkdownEditor placeholderTextColor={yourVariableStylesHere} />

or:

 <MarkdownEditor placeholderTextColor={{yourStylesHere}} />

Props

NameTypeDefaultDescriptionRequired
onMarkdownChangefunctionCallback function, calls when markdown is typedTrue
placeholderstring"Type here"Text of placeholder of the inputFalse
markdownstring""Content of editorFalse
placeholderTextColorstring"#000"Color of the placeholderFalse
buttonStylesStyleSheetAction button stylesFalse
buttonContainerStylesStyleSheetAction button container stylesFalse
textInputStylesStyleSheetText input styleFalse
markdownViewStylesStyleSheetMarkdown preview style (limited)False

Contributing

PR's/Issues/Bugs or suggestions are welcomed. Please post them at https://github.com/matheuswr89/react-native-markdown-editor/issues.

License

The MIT License.

See LICENSE

1.1.1

10 months ago

1.1.4

10 months ago

1.1.3

10 months ago

1.1.2

10 months ago

1.1.0

11 months ago

1.0.9

11 months ago

1.0.8

12 months ago

1.0.7

12 months ago

1.0.6

12 months ago

1.0.5

12 months ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago