React Markdown Editor
npm install react-mde-amir
A simple yet powerful and extensible React Markdown Editor. React-mde has no 3rd party dependencies.
- Check the 10.0.0 breaking changes on how to migrate from 9.*: https://github.com/andrerpena/react-mde/releases/tag/10.0.0
- Check the 9.0.0 breaking changes on how to migrate from 8.*: https://github.com/andrerpena/react-mde/releases/tag/9.0.0.
- Demo
- CodeSandbox Demo JSX
- CodeSandbox Demo TSX
- CodeSandbox Demo TSX - Customized toolbar
- CodeSandbox Demo TSX - Custom command
The goal is to make react-mde to look and behave like the Github's Markdown editor. These are the major remaining features/changes. I plan to tackle them in orde but if you want to help, that would be amazing.
- [ ] Design improvements
- [ ] Image upload support
npm i react-mde
React-mde is agnostic regarding how to preview Markdown. The examples will use Showdown
npm install showdown
It is also possible to return a Promise to React Element from generateMarkdownPreview, which makes
it possible to use ReactMarkdown as a preview. View issue.
React-mde is a completely controlled component.
Minimal example using Showdown. View live on CodeSandBox:
``jsx
import * as React from "react";
import ReactMde from "react-mde";
import * as Showdown from "showdown";
import "react-mde/lib/styles/css/react-mde-all.css";
const converter = new Showdown.Converter({
tables: true,
simplifiedAutoLink: true,
strikethrough: true,
tasklists: true
});
export default function App() {
const [value, setValue] = React.useState("Hello world!!!");
const [selectedTab, setSelectedTab] = React.useState<"write" | "preview">("write");
return (
$3
React-mde comes with SVG icons extracted from FontAwesome.
You can customize the way icons are resolved by passing your own
that will return a ReactNode
given a command name.`jsx
onChange={this.handleValueChange}
// ...
/>
`React-mde Props
The types are described below
- value: string: The Markdown value.
- onChange: (value: string): Event handler for the
event.
- selectedTab: "write" | "preview": The currently selected tab.
- onTabChange: (tab) => void: Function called when the selected tab changes.
- classes?: Object: An object containing the following optional properties: reactMde, toolbar, preview, textArea, grip and suggestionsDropdown.
This allows for passing class names to each of the inner components of React-mde. Classes defined in the classes prop
follow the specification of Jed Watson's classNames project.
- commands?: Record
- toolbarCommands?: string[][]: Array of array of strings, indicating which commands should be displayed. Each outer array is a group. Example: [["code", "bold"], ["italic"]]
- generateMarkdownPreview: (markdown: string) => Promise; : Function that should return a Promise to the generated HTML or a React element for the preview. If this is falsy, then no preview is going to be generated.
- getIcon?: (commandName: string) => React.ReactNode } An optional set of button content options, including an iconProvider to allow custom icon rendering.
options. It is recommended to inspect the layouts source code to see what options can be passed to each
while the documentation is not complete.
- loadingPreview: What to display in the preview while it is loading. Value can be string, React Element or anything React can render.
- readOnly?: boolean: Flag to render the editor in read-only mode.
- textAreaProps?: Extra props to be passed to the textarea component.
- l18n?: A localization option. It contains the strings write, preview and uploadingImage.
- minEditorHeight?: number: The minimum height of the editor.
- maxEditorHeight?: number: The max height of the editor (after that, it will scroll).
- minPreviewHeight?: number: The minimum height of the preview.
- loadSuggestions?: (text: string, triggeredBy: string) => Promise
given text and triggeredBy (character that triggered the suggestions). The result should be an array of {preview: React.ReactNode, value: string}.
The preview is what is going to be displayed in the suggestions box. The value is what is going to be inserted in the textarea on click or enter.
- suggestionTriggerCharacters (string[]): Characters that will trigger mention suggestions to be loaded. This property is useless
without loadSuggestions.
- childProps?: Object: An object containing props to be passed to writeButton, previewButton, commandButtons and textArea.Styling
The following styles from React-mde should be added: (Both .scss and .css files are available. No need to use sass-loader if you don't want)
Easiest way: import
react-mde-all.css: import 'react-mde/lib/styles/css/react-mde-all.css';
If you want to have a more granular control over the styles, you can import each individual file.
If you're using SASS, you can override these variables: https://github.com/andrerpena/react-mde/blob/master/src/styles/variables.scss
XSS concerns
React-mde does not automatically sanitize the HTML preview. If your using Showdown,
this has been taken from their documentation):
> Cross-side scripting is a well known technique to gain access to private information of the users
of a website. The attacker injects spurious HTML content (a script) on the web page which will read
the user’s cookies and do something bad with it (like steal credentials). As a countermeasure,
you should filter any suspicious content coming from user input. Showdown doesn’t include an
XSS filter, so you must provide your own. But be careful in how you do it…
You might want to take a look at showdown-xss-filter.
It is also possible to return a Promise to a React Element from
generateMarkdownPreview`, which makesPlease refer to the commands source code to understand how they
should be implemented.
React-mde is MIT licensed.
In order to make React-mde zero deps, I've embedded two small libraries:
- https://github.com/grassator/insert-text-at-cursor by https://twitter.com/d_kubyshkin
- https://github.com/JedWatson/classnames by https://twitter.com/JedWatson
Made with :heart: by André Pena and other awesome contributors.
