0.1.0 • Published 6 years ago

rechextor v0.1.0

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

Rechextor

一个基于 slate 封装的轻量级 React 富文本编辑器

安装

npm install rechextor --save

使用

import Rechextor from 'rechextor';

class App extends React.Component {
  state = { value: '' };

  handleChange = value => {
    this.setState({ value });
  };

  handleSuccess = (result, insertImage) => {
    // result 为上传图片的 http response body
    // insertImage 为一个回调函数,接受一个 url 作为参数,只有调用此函数才能插入图片
    insertImage(result.data.url);
  };

  render() {
    return (
      <Rechextor
        tools={[
          'bold',
          'strong',
          'italic',
          'underline',
          'strikethrough',
          'image',
          'tag',
          'blockquote',
          'line'
        ]}
        initialValue={this.state.value}
        placeholder="To be continued..."
        onChange={this.handleChange}
        uploadPath="/upload"
        onUploadSuccess={this.handleSuccess}
      />
    );
  }
}

API

组件接受以下参数

参数名描述类型默认值
tools工具栏列表,目前支持的工具见使用string[]
initialValue编辑器渲染的初始内容,此值只在第一次 Boolean(initialValue) 为 true 时生效,后续的更新会被忽略string
placeholder编辑器无内容时显示的 placeholderstring
onChange用于同步编辑器的更改,接受一个 html 字符串作为参数function
uploadPath图片上传服务器地址,需要配合 onUploadSuccess 一起使用string
onUploadSuccess图片上传成功的回调,说明见使用function
beforeUpload图片上传之前的回调,详见 rc-uploadfunction
onUploadError图片上传失败的回调function
onBlur编辑器失去焦点的回调function
onFocus编辑器获得焦点的回调function