API 概览

RichText 构造函数

new richtext.RichText("#root", {
    // 配置参数
});

参数：

• 一个 HTML 容器（例如，CSS 选择器或 DOM 元素）
• 一个配置对象（查看属性）

RichText 方法

名称	描述
getValue()	返回 RichText 的值
setValue()	向 RichText 应用新值
insertValue()	在当前光标位置插入文本、Markdown 或 HTML 内容，或替换选中的文本
setConfig()	将新的配置参数应用于 RichText
setLocale()	为 RichText 应用新的语言环境
destructor()	移除 RichText 的所有 HTML 元素，并解除所有相关事件的绑定

Event Bus 方法

名称	描述
api.exec()	允许触发内部事件
api.intercept()	允许拦截并阻止内部事件
api.on()	允许为内部事件附加处理函数
api.detach()	用于移除/解绑事件处理程序
api.setNext()	用于将某个操作添加到 Event Bus 顺序中

State 方法

名称	描述
api.getState()	返回包含 RichText 的 StateStore 属性的对象
api.getReactiveState()	返回包含 RichText 响应式属性的对象

事件

名称	描述
align	当通过菜单栏/工具栏或 Event Bus 方法更改文本对齐方式时触发
clear-text-format	当通过菜单栏/工具栏或 Event Bus 方法清除文本格式时触发
copy	在复制选中文本时触发
create-new	在菜单栏中点击"新建"选项或通过 Event Bus 方法触发时触发
cut	在剪切选中文本时触发
delete-link	删除链接时触发
export	在菜单栏中按下"Export"选项或通过 Event Bus 方法触发后触发
import	在菜单栏中按下"Import"选项或通过 Event Bus 方法触发后触发
indent	当增加块缩进时触发
insert-image	在插入图片时触发（通过工具栏、菜单栏、剪贴板粘贴或拖放操作）
insert-line	在插入水平线时触发
insert-link	在插入链接时触发
insert-list	在插入列表时触发
outdent	当减少块缩进时触发
paste	在粘贴内容时触发
print	在打印文档时触发
redo	当点击菜单栏/工具栏中的"Redo"按钮或通过 Event Bus 方法触发时触发
resize-image	在调整图片大小时触发
set-font-family	在设置字体系列时触发
set-font-size	在设置字体大小时触发
set-line-height	设置行高时触发
set-text-color	设置文本颜色和/或文本背景颜色时触发
set-text-format	在设置文本格式时触发
set-text-style	在设置文本样式时触发
show-popup	当弹出框显示或隐藏时触发
subscript	当在菜单栏/工具栏中按下"下标"按钮或通过 Event Bus 方法触发时触发
superscript	当通过菜单栏/工具栏中的"上标"按钮或 Event Bus 方法触发时触发
toggle-fullscreen-mode	在切换全屏模式时触发
toggle-layout-mode	切换布局模式时触发
toggle-shortcut-info	切换快捷键信息时触发
undo	在菜单栏/工具栏中点击"撤销"按钮或通过 Event Bus 方法触发时触发
update-link	在更新链接时触发

属性

名称	描述
defaultStyles	可选。为特定块类型指定默认样式值
fullscreenMode	可选。启用 RichText 全屏模式
imageUploadUrl	可选。指定用于图片上传（来自工具栏、菜单栏、剪贴板粘贴或拖放操作）的 URL
layoutMode	可选。指定主编辑区域的布局模式
locale	可选。一个包含 RichText 本地化标签的对象
menubar	可选。启用 RichText 顶部菜单栏
toolbar	可选。启用工具栏，并允许用户指定/配置工具栏中显示的按钮
value	可选。指定在 RichText 编辑器区域中显示的初始值（内容）