vue-rich-editor

！！！从 V0.7.x 开始，API 有更新，请注意

定制 vue 富文本编辑器，基于 Quill

介绍

1. 基于 quill 封装
2. 可配置模块
   • 行内样式（inline style）
   • 图片缩放（image resize）
   • 拖拽上传（image drop）
   • 链接上传图片（support via the url to upload pictures）
   • 剪贴板粘贴图片（support the clipboard to paste pictures）
   • 支持 @(at)（support @(at) function）
     • 这一版只是实现了 最基础的 @(at) 功能
     • 这个功能，简单了来说，只需要：
       1. 识别键入 @，响应事件
       2. 呼出对应备选列表
       3. 点击某项之后插入
       4. 稍好一点，点击抛出事件
     • 复杂了说：
       1. @的元素是个整体
          • 鼠标指针不可侵入
          • 要么都删，要么都不删
          • 要么都选，要么都不选
          • ...
       2. 应该对应有颜色标识
       3. 样式不受富文本编辑格式的控制
       4. ...【其他】

示例

静态示例

codesandbox 示例[不定期更新]

使用

实例

配置

属性值	必须	默认值	类型	备注
value	-	''	string	富文本内容
id	是	'quill-container'	string	唯一标识组件，单页面多实例情况下必填
keepPasteFormat	-	true	boolean	粘贴保留文本格式
disabled	-	false	boolean	禁用
editorContainer	-	[]	array	自定义操作栏功能，参照config.js#L16
useCustomImageHandler	-	false	boolean	使用自定义的图片上传【默认是 insert base64】
quillRegisterKeys	-	null	array	需要注册的模块，默认参照config.js#L38
placeholder	-	''	string	富文本区域默认占位符
linkPlaceholder	-	'请输入链接'	string	链接输入框占位符
imageLinkTitle	-	'请输入图片地址：'	string	图片地址输入框标题
imageLinkPlaceholder	-	'https://'	string	图片地址输入框占位符
customProtocol	-	null	array	自定义链接需要额外支持的协议
customLinkHref	-	''	string	自定义链接内容；有值：显示按钮，空，表示不显示
toolbarTips	-	false	boolean	显示操作栏按钮文字提示
toolbarTipsText	-	null	object	自定义操作栏提示文字内容 { link: 'this is link' } 所有支持key参照config.js#L106
atList	-	false	array-object	@呼出选择列表数据，如开启@功能，此项必须，具体格式参见下述：【开启 @-at 功能】
atHooks	-	false	object	@功能的钩子，具体格式参见下述：【开启 @-at 功能】

customLink 图标样式自定义

• 默认是文字风格，可自由修改，下面的例子是采用图片[按钮内区域大小为：18*18]

.ql-custom-link {
    .ql-custom-link-inner {
        // 图片
        background-image: url(https://dwz.cn/H9EkfLih);
        background-size: 100% 100%;
        // 重置掉文字
        &::before {
            content: '';
        }
    }
}

开启 @-at 功能

@ 默认不开启，需要开启的话，请先配置 quillRegisterKeys【如果之前使用了默认配置，即没有显式配置，需要将默认 key 显式注册一下】

配置参数

atList

const atList = [
    atListItem,
    atListItem,
    ...
];

const atListItem = {
    label: '',  // 【*】 显式的文字
    ...,        // 其他需要的数据
};

atHooks

const atHooks = {
    click(opts) {
        //
    }
};

const opts = {
    list, // 当前 list，即 atList，为便利取值
    item, // 点击的项，即 list[clickIndex]
    index // 点击项的索引
};

方法

示例

Emit - 主动抛出

编辑器状态相关

// focus
reFocus(options)
options = {
    Editor,
    source,
    range,
    oldRange,
    cursorLocation
}

// 内容高亮
reHighlighted(options)
options = {
    Editor,
    source,
    range,
    oldRange,
    cursorLocation,
    text
}

// blur
reBlur(options)
options = {
    Editor,
    source
}

// cursor move evt
reCursorMove(options)
options = {
    range,
    oldRange
}

图片相关

// 文件 上传图片
/**
 * 此处注意，更新到 V0.7.0 之后，参数格式变了
 */
reImageAdded(options)
options = {
    file,           // 文件
    Editor,         // 当前编辑器
    range,
    cursorLocation
}

// 链接上传图片
reImageLink(type, options)
type            // string：'ok':点击确定，'cancel':点击取消
options = {
    url,            // 输入路径
    Editor,         // 当前编辑器
    range,
    cursorLocation
}

自定义链接

// 自定义链接回调
reCustomLink(opts)
opts = {
    code,           // 状态码：0 成功；1 失败
    msg,            // 状态描述
}

RefCall - 被动调用

获取移动端可使用富文本

⚠️🖍只可作为快捷函数使用，此函数输出的值，不能作为下次回填编辑器的文本

_$getTagFillHtml()
return = `${transedHtml}` | String

获取当前富文本有效内容

• 解决填完内容再删除后含有空标签，导致判断错误问题

_$getEffectiveValue()
return = `${effectiveValue}` | String

待完善

1. 行内样式（inline-style）
2. 图片缩放（image-resize）
3. link and style conflict
4. link placeholder
5. use the url to upload image
6. image drop

issues

• clipboard formats about
• matchvisual
• link placeholder