react-markdown-editor基于 React 的 Markdown 编辑器组件

react-markdown-editor 是 React.js 和 TypeScript 实现的 Markdown 编辑器。

Markdown 编辑器带预览功能

安装

npm i @uiw/react-markdown-editor

文档

文档实例预览：demo preview (🇨🇳中国镜像网站)

使用

import MarkdownEditor from '@uiw/react-markdown-editor';
import React from 'react';
import ReactDOM from 'react-dom';

const Dome = () => (
  <MarkdownEditor
    value={this.state.markdown}
    onChange={this.updateMarkdown}
  />
);

controlled usage

import MarkdownEditor from '@uiw/react-markdown-editor';
import React from 'react';
import ReactDOM from 'react-dom';


class App extends React.Component {
  constructor() {
    super();
    this.state = {
      markdown: '# This is a H1  \n## This is a H2  \n###### This is a H6',
    };
    this.updateMarkdown = this.updateMarkdown.bind(this);
  }

  updateMarkdown(editor, data, value) {
    this.setState({ markdown: value });
  }

  render() {
    return (
      <MarkdownEditor
        value={this.state.markdown}
        onChange={this.updateMarkdown}
      />
    );
  }
}

ReactDOM.render(
  <App />,
  document.getElementById('app')
);

参数

• value (string) - 将转换为 html 的原始 markdown 字符串 (必填参数)
• visble (boolean) - 显示将转换为html的预览。
• toolbars (array) - 工具栏显示设置。
• onChange (function(editor: IInstance, data: CodeMirror.EditorChange, value: string)) - 在进行更改时调用 (必填参数)

更多参数设置查看下面网址

开发模式

npm run dev
npm run type-check:watch
npm run doc