@amrn/react-simplemde
v1.0.0
Published
Produce universal library with webpack and es6
Downloads
3
Maintainers
Readme
React SimpleMDE Markdown Editor
React component wrapper for SimpleMDE.
Based on react-simplemde-editor This one uses my custom Simplemde Editor
Only two dependencies, React and SimpleMDE.
Install
npm install --save react-simplemde
Demo
http://www.benrlodge.com/projects/react-simplemde
or view it locally:
git clone https://github.com/amrn/react-simplemde.git
cd react-simplemde
npm install && npm run dev
cd example
npm install && npm start
Usage
View the demo code for a full example.
Not required, but useless without it, the onChange
callback is the only option you need to set.
import React from 'react'
import SimpleMDE from '@amrn/react-simplemde'
<SimpleMDE
onChange={this.handleChange}
/>
Options
Set additional SimpleMDE options with an options prop.
Note - while SimpleMDE options has an initialValue
option, this component only takes a value
prop which is set as the initialValue
on first render.
import React from 'react'
import SimpleMDE from '@amrn/react-simplemde'
<SimpleMDE
onChange={this.handleChange}
value={this.state.textValue}
options={{
autofocus: true,
spellChecker: false,
// etc.
}}
/>
You can include key maps using the extraKeys
prop.
Read more at https://codemirror.net/doc/manual.html#option_extraKeys
extraKeys = {
Up: function(cm) {
cm.replaceSelection(" surprise. ");
},
Down: function(cm) {
cm.replaceSelection(" surprise again! ");
}
};
<SimpleMDE
onChange={this.handleChange}
extraKeys={extraKeys}
/>