Editor
富文本编辑器,可以对图片、文字进行编辑。
编辑器导出内容支持带标签的 html和纯文本的 text,编辑器内部采用 delta 格式进行存储。
通过 setContents 接口设置内容时,解析插入的 html 可能会由于一些非法标签导致解析错误,建议开发者在小程序内使用时通过 delta 进行插入。
富文本组件内部引入了一些基本的样式使得内容可以正确的展示,开发时可以进行覆盖。需要注意的是,在其它组件或环境中使用富文本组件导出的 html 时,需要额外引入 这段样式,并维护 <ql-container><ql-editor></ql-editor></ql-container>
的结构。
图片控件仅初始化时设置有效。
*编辑器内支持部分 HTML 标签和内联样式,不支持 class 和 id*
支持情况:
类型
ComponentType<EditorProps>
示例代码
- React
- Vue
class App extends Components {
state = {
placeholder: '来,输入隔壁的名字试试...'
}
editorReady = e => {
Taro.createSelectorQuery().select('#editor').context((res) => {
this.editorCtx = res.context
}).exec()
}
undo = e => {
this.editorCtx.undo()
}
render () {
return (
<View>
<Editor id='editor' className='editor' placeholder={this.state.placeholder} onReady={this.editorReady}></Editor>
<Button type='warn' onClick={this.undo}>撤销</Button>
</View>
)
}
}
<template>
<view class="container">
<editor id="editor" class="editor" :placeholder="placeholder" @ready="editorReady"></editor>
<button type="warn" @tap="undo">撤销</button>
</view>
</template>
<script>
import Taro from '@tarojs/taro'
export default {
data() {
return {
placeholder: '来,输入隔壁的名字试试...'
}
},
methods: {
editorReady() {
Taro.createSelectorQuery().select('#editor').context((res) => {
this.editorCtx = res.context
}).exec()
},
undo() {
this.editorCtx.undo()
}
}
}
</script>
EditorProps
参数 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
readOnly | boolean | false | 否 | 设置编辑器为只读 |
placeholder | string | 否 | 提示信息 | |
showImgSize | boolean | false | 否 | 点击图片时显示图片大小控件 |
showImgToolbar | boolean | false | 否 | 点击图片时显示工具栏控件 |
showImgResize | boolean | false | 否 | 点击图片时显示修改尺寸控件 |
onReady | CommonEventFunction | 否 | 编辑器初始化完成时触发 | |
onFocus | CommonEventFunction<editorEventDetail> | 否 | 编辑器聚焦时触发 | |
onBlur | CommonEventFunction<editorEventDetail> | 否 | 编辑器失去焦点时触发 detail = { html, text, delta } | |
onInput | CommonEventFunction<editorEventDetail> | 否 | 编辑器内容改变时触发 detail = { html, text, delta } | |
onStatusChange | CommonEventFunction | 否 | 通过 Context 方法改变编辑器内样式时触发,返回选区已设置的样式 |
API 支持度
API | 微信小程序 | H5 | React Native | Harmony |
---|---|---|---|---|
EditorProps.readOnly | ✔️ | |||
EditorProps.placeholder | ✔️ | |||
EditorProps.showImgSize | ✔️ | |||
EditorProps.showImgToolbar | ✔️ | |||
EditorProps.showImgResize | ✔️ | |||
EditorProps.onReady | ✔️ | |||
EditorProps.onFocus | ✔️ | |||
EditorProps.onBlur | ✔️ | |||
EditorProps.onInput | ✔️ | |||
EditorProps.onStatusChange | ✔️ |