更新记录

1.0.5（2023-05-26）

处理初始化html，异步获取到html时已经初始化过了，导致未设置进编辑器的问题

1.0.4（2023-05-06）

有伙伴反应市场上的示例项目运行不起来，我重新上传一次

1.0.3（2023-04-23）

因app端插入emoji会强制弹出键盘，取消插入emoji不弹出键盘的功能，tab栏增加收起，另外还有一个问题，如果从中间部分删除链接会导致光标指向位置不正确的问题暂未解决，我再想想办法

平台兼容性

lsj-edit

插件地址：https://ext.dcloud.net.cn/plugin?name=lsj-edit

若能帮到你请不要手软点亮5颗星~

使用组件前必读

• 此组件是对editor组件二次封装，增加了类似微信的@谁来看 和 类似微博的插入#话题等功能
• 如插入话题或@后光标未指向当前位置，可以加Q群咨询
• 为了方便大家更换按钮控件，我将控制器按钮和编辑器画布拆分成了两个组件
• 你完全可以自定义编辑器，所有功能都封装到了edit类，方便各位调用,查看Edit详细文档

• 因为比较懒，目前只支持了H5和App端，小程序端solt传参有点问题Class edit实例对象传不进按钮组件去，后面有时间再修复

  划重点！！！

  如果你希望自定义编辑器，Edit类实例的方法和事件机制你需要了解,具体查看示例项目或查看Edit详细文档

基本使用

lsj-edit组件属性与事件绑定

附带的按钮edit-btns组件属性与事件绑定

VUE

<lsj-edit 
ref="lsjEdit" 
placeholder="输入正文"
:maxCount="200"
@onReady="editReady">
    <template v-slot:btns="data">
        <edit-btns 
        :edit="data.edit" 
        @click="onTabClick" 
        @submit="save"></edit-btns>
    </template>
</lsj-edit>

JS

import editBtns from '@/uni_modules/lsj-edit/components/lsj-edit/edit-btns/edit-btns.vue';
export default {
    components:{
        // 富文本基本操作按键，可自行选择是否使用示例的按键
        editBtns
    },
    data() {
        return {
            edit: null
        }
    },
    methods: {
        // 编辑器初始化完毕，返回edit对象
        editReady(edit) {
            // 将富文本对象存放到当前页面，便于后续直接操作
            this.edit = edit;
        },
        // 演示----按钮组件点击事件
        onTabClick({name,index}) {
            switch (index){
                // 插入#话题#
                case 0:
                    this.addLink();
                    break;
                // @某人
                case 1:
                    this.addLink2();
                    break;
                default:
                    break;
            }
        },
        // 演示发布
        async save() {
            // 获取插入的图片列表
            let imgs = await this.edit.getImages()
            // 判断是否允许提交
            if (!this.edit.textCount && !imgs.length) {
                uni.showToast({
                    title: '请录入内容'
                });
            }

            // 将所有未上传的本地图片上传到服务器并替换到编辑器
            this.edit.replaceImage(async(img)=>{
                // 已上传的无需再上传
                // 这里没有放到edit内部去过滤，因为我觉得需不需要上传得你自己决定
                // 比如插入的base64图片是否需要上传
                // img.indexOf('http') = 0说明这个图片已经是网络地址，无需替换就直接跳过
                if(img.indexOf('http') === 0) {return img;}

                // 上传并替换图片
                /* 
                    let {data} = await uni.uploadFile({
                        url: 'https://www.example.com/upload', //仅为示例，非真实的接口地址
                        filePath: img, //本地图片
                        name: 'file',
                        formData: {
                            'user': 'test'
                        }
                    });
                    return data;
                 */

                // 因为演示的时候没有服务器，所以直接换个网络图方便后续演示，
                // 实际项目应使用上方注释内容
                return 'https://t7.baidu.com/it/u=3406125714,2513313326&fm=193&f=GIF'

            }).then(res=>{
                console.log('替换完成,最终内容为',JSON.stringify(res));

                // 示例项目可查看解析富文本演示
                uni.navigateTo({
                    url: '/pages/article/article?data='+escape(res.html)
                });
            }); 

        },
        // 插入话题示例
        addLink() {
            this.edit.addLink({
                prefix: '#',
                suffix: '#',
                name: '有问题欢迎加入LSJ插件交流群',
                data: {
                    name: 'QQ交流群',
                    qqGroupChatID: '667530868',
                }
            })
        },
        // @某人示例
        addLink2() {
            this.edit.addLink({
                prefix: '@',
                name: '马冬梅',
                data: {
                    userId: 10,
                }
            })
        }
    }
}

Edit类实例的方法和事件机制

Edit实例方法

tool

• 调用editorContext对象的事件，如撤销undo,恢复redo,清空内容clear,失焦blur等
• 调用方式：edit.tool('blur')

format

• 修改样式,支持的值可查看editorContext format
• 调用方式：edit.format('color','#999999')

getContents

• 获取编辑器内容,返回Promise.resolve
• 调用方式：await edit.getContents()

upKeyboard

• 使光标进入编辑器并唤起键盘
• 调用方式：edit.upKeyboard()

emoji

• 插入emoji表情
• 调用方式：edit.emoji('😀')

addLink

• 插入带参数的链接，如插入#话题或@谁
• 调用方式：edit.addLink(Object)

getLink

• 获取编辑器内添加的所有链接
• 调用方式：edit.getLink()

addImage

• 通过相册/相机选择图片并添加到编辑器中，此时图片是本地路径，在发布前应将图片上传，具体可查看示例项目index.vue提交事件示例;
• 调用方式：edit.addImage(tempFilePaths)

getImages

• 获取编辑器内添加的所有图片
• 调用方式：edit.getImages()

replaceImage

• 替换图片，编辑器内每个图片都会触发传入的fn,根据需要可自行替换成新的图片地址，用于将本地图片上传到服务器
• 必须传入Function，且必须return一个图片地址
• 调用方式：edit.replaceImage(fn)

// 提交前将所有未上传的本地图片上传到服务器并替换到编辑器
edit.replaceImage(async(img)=>{
    // 已上传的无需再上传
    // 这里没有放到edit内部去过滤，因为我觉得需不需要替换得你自己决定
    // 比如插入的base64图片是否需要上传
    // img.indexOf('http') = 0说明这个图片已经是网络地址，就跳过
    if(img.indexOf('http') === 0) {return img;}

    // 上传并替换图片
    let {data} = await uni.uploadFile({
        url: 'https://www.example.com/upload', //仅为示例，非真实的接口地址
        filePath: img, //本地图片
        name: 'file',
        formData: {
            'user': 'test'
        }
    });
    return data;

}).then(res=>{
    console.log('所有图片替换完成,返回最新的detail',JSON.stringify(res));
}); 

事件机制

• Edit为您设计了观察者模式，您可以在需要的地方注册和发送事件

$fire(eventName,any)

• 发送事件
• 示例：

  edit.$fire('edit:focus', detail);

$on([eventName, callback])

• 注册事件
• 示例：

  edit.$on('edit:focus',(e)=> {
  console.log('监听光标进入',e);
  })

$off([eventName, callback])

• 移除某个注册的事件
• 示例：

  edit.$off('edit:focus', (e)=> {
  console.log('监听光标进入',e);
  });

Edit内置的事件

• 只需在需要的地方注册即会自动在对应的时机触发

温馨提示

0. 如说明表达还不够清楚，不清楚怎么使用可导入完整示例项目运行体验和查看
1. 欢迎加入QQ讨论群：701468256(已满)
2. 欢迎加入QQ讨论群：469580165(已满)
3. 欢迎加入QQ讨论群：667530868
4. 若能帮到你还请点亮5颗小星星以作鼓励哈~
5. 若能帮到你还请点亮5颗小星星以作鼓励哈~
6. 若能帮到你还请点亮5颗小星星以作鼓励哈~