在Vue中使用wangeditor创建富文本编辑器的完整指南

已于 2024-03-16 20:14:05 修改
阅读量4.7k 收藏 20
点赞数 23
分类专栏： 前端专栏 文章标签： vue.js 前端 javascript
于 2024-03-16 16:01:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/interest_ing_/article/details/136764275
版权

🌟 前言

欢迎来到我的技术小宇宙！🌌 这里不仅是我记录技术点滴的后花园，也是我分享学习心得和项目经验的乐园。📚 无论你是技术小白还是资深大牛，这里总有一些内容能触动你的好奇心。🔍

在这里插入图片描述

文章目录

在Vue中使用wangeditor创建富文本编辑器的完整指南

效果图

wangeditor 官网指南

在这里插入图片描述

在Vue项目中使用wangeditor构建富文本编辑器，您需要遵循以下步骤来集成和使用这个流行的编辑器：

步骤 1: 安装 wangeditor

首先，您需要在Vue项目中安装wangeditor。可以通过npm来完成安装：

yarn add @wangeditor/editor
# 或者 npm install @wangeditor/editor --save

yarn add @wangeditor/editor-for-vue@next
# 或者 npm install @wangeditor/editor-for-vue@next --save

步骤 2: 引入 wangeditor 到您的组件

在您希望使用富文本编辑器的Vue组件中，引入wangeditor：

import '@wangeditor/editor/dist/css/style.css';// 引入编辑器的CSS样式
import { onBeforeUnmount, ref, shallowRef, onMounted } from 'vue';
import { Editor, Toolbar } from '@wangeditor/editor-for-vue';

步骤 3: 创建编辑器实例和响应式数据

在Vue组件的mounted生命周期钩子中，创建wangeditor的实例，并将其绑定到指定的DOM元素上：

export default {
  components: { Editor, Toolbar },
  setup() {
    // 编辑器实例，必须用 shallowRef，重要！
    const editorRef = shallowRef();

    // 内容 HTML
    const valueHtml = ref('<p>hello</p>');

    // 模拟 ajax 异步获取内容
    onMounted(() => {
      setTimeout(() => {
        valueHtml.value = '<p>模拟 Ajax 异步设置内容</p>';
      }, 1500);
    });

    const toolbarConfig = {};
    const editorConfig = { placeholder: '请输入内容...' };

    // 组件销毁时，也及时销毁编辑器，重要！
    onBeforeUnmount(() => {
      const editor = editorRef.value;
      if (editor == null) return;

      editor.destroy();
    });

    // 编辑器回调函数
    const handleCreated = (editor) => {
      console.log('created', editor);
      editorRef.value = editor; // 记录 editor 实例，重要！
    };
    const handleChange = (editor) => {
      console.log('change:', editor.getHtml());
    };
    const handleDestroyed = (editor) => {
      console.log('destroyed', editor);
    };
    const handleFocus = (editor) => {
      console.log('focus', editor);
    };
    const handleBlur = (editor) => {
      console.log('blur', editor);
    };
    const customAlert = (info, type) => {
      alert(`【自定义提示】${type} - ${info}`);
    };
    const customPaste = (editor, event, callback) => {
      console.log('ClipboardEvent 粘贴事件对象', event);

      // 自定义插入内容
      editor.insertText('xxx');

      // 返回值（注意，vue 事件的返回值，不能用 return）
      callback(false); // 返回 false ，阻止默认粘贴行为
      // callback(true) // 返回 true ，继续默认的粘贴行为
    };

    const insertText = () => {
      const editor = editorRef.value;
      if (editor == null) return;

      editor.insertText('hello world');
    };

    const printHtml = () => {
      const editor = editorRef.value;
      if (editor == null) return;
      console.log(editor.getHtml());
    };

    const disable = () => {
      const editor = editorRef.value;
      if (editor == null) return;
      editor.disable()
    };

    return {
      editorRef,
      mode: 'default',
      valueHtml,
      toolbarConfig,
      editorConfig,
      handleCreated,
      handleChange,
      handleDestroyed,
      handleFocus,
      handleBlur,
      customAlert,
      customPaste,
      insertText,
      printHtml,
      disable
    };
  },
};

步骤 4: 在模板中添加编辑器容器

在Vue组件的模板中，添加一个容器元素来承载wangeditor：

    <div style="border: 1px solid #ccc; margin-top: 10px">
      <Toolbar
        :editor="editorRef"
        :defaultConfig="toolbarConfig"
        :mode="mode"
        style="border-bottom: 1px solid #ccc"
      />
      <Editor
        :defaultConfig="editorConfig"
        :mode="mode"
        v-model="valueHtml"
        style="height: 400px; overflow-y: hidden"
        @onCreated="handleCreated"
        @onChange="handleChange"
        @onDestroyed="handleDestroyed"
        @onFocus="handleFocus"
        @onBlur="handleBlur"
        @customAlert="customAlert"
        @customPaste="customPaste"
      />
    </div>

步骤 5: 配置 wangeditor（可选）

wangeditor提供了多种配置选项，您可以根据需要进行配置。例如，设置编辑器的自定义菜单、上传图片的接口等：

// const editorConfig = { placeholder: '请输入内容...' };
    // 初始化 MENU_CONF 属性
    const editorConfig = {                       // JS 语法
      MENU_CONF: {},
      placeholder: '请输入内容...'
      // 其他属性...
    }

    // 修改 uploadImage 菜单配置
    editorConfig.MENU_CONF['uploadImage'] = {
      server: '/api/upload-image',
      fieldName: 'custom-field-name'
      // 继续写其他配置...

      //【注意】不需要修改的不用写，wangEditor 会去 merge 当前其他配置
    }

在这里插入图片描述

步骤 6: 获取编辑器内容（可选）

您可以通过editor.txt.html()方法获取编辑器的HTML内容，或者通过editor.txt.text()获取纯文本内容：

    const printHtml = () => {
      const editor = editorRef.value;
      if (editor == null) return;
      console.log(editor.getHtml());
    };

步骤 7: 清理资源

当组件销毁时，确保释放编辑器资源，避免内存泄漏：

    // 组件销毁时，也及时销毁编辑器，重要！
    onBeforeUnmount(() => {
      const editor = editorRef.value;
      if (editor == null) return;

      editor.destroy();
    });

全部代码

<template>
  <div>
    <div>
      <button @click="insertText">insert text</button>
      <button @click="printHtml">print html</button>
      <button @click="disable">disable</button>
    </div>
    <div style="border: 1px solid #ccc; margin-top: 10px">
      <Toolbar :editor="editorRef" :defaultConfig="toolbarConfig" :mode="mode" style="border-bottom: 1px solid #ccc" />
      <Editor :defaultConfig="editorConfig" :mode="mode" v-model="valueHtml" style="height: 400px; overflow-y: hidden"
        @onCreated="handleCreated" @onChange="handleChange" @onDestroyed="handleDestroyed" @onFocus="handleFocus"
        @onBlur="handleBlur" @customAlert="customAlert" @customPaste="customPaste" />
    </div>
    <div style="margin-top: 10px">
      <textarea v-model="valueHtml" readonly style="width: 100%; height: 200px; outline: none"></textarea>
    </div>
  </div>
</template>

<script>
import '@wangeditor/editor/dist/css/style.css';
import { onBeforeUnmount, ref, shallowRef, onMounted } from 'vue';
import { Editor, Toolbar } from '@wangeditor/editor-for-vue';

export default {
  components: { Editor, Toolbar },
  setup() {
    // 编辑器实例，必须用 shallowRef，重要！
    const editorRef = shallowRef();

    // 内容 HTML
    const valueHtml = ref('<p>hello</p>');

    // 模拟 ajax 异步获取内容
    onMounted(() => {
      setTimeout(() => {
        valueHtml.value = '<p>模拟 Ajax 异步设置内容</p>';
      }, 1500);
    });

    const toolbarConfig = {};
    // const editorConfig = { placeholder: '请输入内容...' };
    // 初始化 MENU_CONF 属性
    const editorConfig = {                       // JS 语法
      MENU_CONF: {},
      placeholder: '请输入内容...'
      // 其他属性...
    }

    // 修改 uploadImage 菜单配置
    editorConfig.MENU_CONF['uploadImage'] = {
      server: '/api/upload-image',
      fieldName: 'custom-field-name'
      // 继续写其他配置...

      //【注意】不需要修改的不用写，wangEditor 会去 merge 当前其他配置
    }


    // 组件销毁时，也及时销毁编辑器，重要！
    onBeforeUnmount(() => {
      const editor = editorRef.value;
      if (editor == null) return;

      editor.destroy();
    });

    // 编辑器回调函数
    const handleCreated = (editor) => {
      console.log('created', editor);
      editorRef.value = editor; // 记录 editor 实例，重要！
    };
    const handleChange = (editor) => {
      console.log('change:', editor.getHtml());
    };
    const handleDestroyed = (editor) => {
      console.log('destroyed', editor);
    };
    const handleFocus = (editor) => {
      console.log('focus', editor);
    };
    const handleBlur = (editor) => {
      console.log('blur', editor);
    };
    const customAlert = (info, type) => {
      alert(`【自定义提示】${type} - ${info}`);
    };
    const customPaste = (editor, event, callback) => {
      console.log('ClipboardEvent 粘贴事件对象', event);

      // 自定义插入内容
      editor.insertText('xxx');

      // 返回值（注意，vue 事件的返回值，不能用 return）
      callback(false); // 返回 false ，阻止默认粘贴行为
      // callback(true) // 返回 true ，继续默认的粘贴行为
    };

    const insertText = () => {
      const editor = editorRef.value;
      if (editor == null) return;

      editor.insertText('hello world');
    };

    const printHtml = () => {
      const editor = editorRef.value;
      if (editor == null) return;
      console.log(editor.getHtml());
    };

    const disable = () => {
      const editor = editorRef.value;
      if (editor == null) return;
      editor.disable()
    };

    return {
      editorRef,
      mode: 'default',
      valueHtml,
      toolbarConfig,
      editorConfig,
      handleCreated,
      handleChange,
      handleDestroyed,
      handleFocus,
      handleBlur,
      customAlert,
      customPaste,
      insertText,
      printHtml,
      disable
    };
  },
};
</script>

通过以上步骤，您可以在Vue项目中轻松地集成和使用wangeditor作为富文本编辑器。wangeditor提供了丰富的功能和良好的定制性，可以满足大多数富文本编辑的需求。

🎉 往期精彩回顾

Vue项目中使用ECharts构建交互式中国地图的详细指南

  • 598阅读 · 12点赞 · 6收藏

米哈游一面前端开发岗面试题，你会做几道?

  • 887阅读 · 21点赞 · 15收藏

程序员必备开发工具、程序员必备集成开发环境（IDE）

  • 635阅读 · 14点赞 · 8收藏

Linux常用操作命令和服务器硬件基础知识

  • 841阅读 · 28点赞 · 9收藏

C语言中大小写字母如何转化

  • 681阅读 · 25点赞 · 27收藏

主流开发语言和开发环境、程序员如何选择职业赛道？

  • 1015阅读 · 34点赞 · 16收藏

Spring Boot+Vue前后端分离项目如何部署到服务器

  • 1048阅读 · 30点赞 · 25收藏

Spring Cloud原理详解、Spring Cloud发展历程

  • 1036阅读 · 32点赞 · 9收藏

爬虫基本原理介绍、实现及问题解决、爬虫实战、爬取经典moba游戏英雄列表

  • 799阅读 · 22点赞 · 21收藏

前端开发的发展史：框架与技术栈的演变

  • 980阅读 · 18点赞 · 12收藏

打字通小游戏制作教程：用HTML5和JavaScript提升打字速度

  • 1196阅读 · 31点赞 · 25收藏

扫雷小游戏制作教程：用HTML5和JavaScript打造经典游戏

  • 1040阅读 · 19点赞 · 27收藏

拼图小游戏制作教程：用HTML5和JavaScript打造经典游戏

  • 762阅读 · 10点赞 · 19收藏
洛可可白
关注
  • 23
    点赞
  • 踩
  • 20
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
vue3-wangeditor:基于Wangeditor富文本编辑器，用于Vue3.x的组件
04-02
vue3-wangeditor :open_book:项目介绍 vue3-wangeditor是一种基于wangEditor二次封装的Vue3.x的Web富文本编辑器，轻量，简洁，易用，开源免费。 兼容常见的PC浏览器：Chrome，Firefox，Safar，Edge，QQ浏览器，IE11。 不支持移动端。 wangEditor当前是v4版本。 内置了代码高亮插件highlight.js ，使用的主题是Lioshi :light_bulb:注意 基于wangeditor默认配置，修改了我自己的替代配置 focus: false // 是否自动聚焦到编辑器，默认是 true ，我改成 false emotions: [ ] // 添加了大部分常见的 emoji 表情 languageTab: ' ' // 编辑器中按下 tab 键默认添加 4 个空格，我的习惯是 2 格 menuTooltipPosition: 'do
HTML前端wangEditor富文本编辑器demo（jQuery）
02-14
jQuery案例，功能丰富图片可拖拽大小，Vue可无缝嵌入，解压打开后index.html直接使用
vue引入富文本框编辑器-@wangeditor/editor库
weixin_52830464的博客
06-02 424
在src目录下定义 components/editor/index.vueindex.vue<template></div>// 定义父组件传过来的值// 是否禁用disable: {},// 内容框默认 placeholder},// 模式，可选 <default|simple>，默认 defaultmode: {},// 高度height: {},// 宽度width: {},// 双向绑定，用于获取 editor.getHtml()
vue使用富文本编辑器wangEditor
sinat_36141399的博客
12-23 3929
wangEditor是一个轻量级 web 富文本编辑器，配置方便，使用简单。官方文档：Introduction · wangEditor 用户文档 本文简单介绍vue如何使用wangEditor，进行这些操作（编辑富文本内容/上传图片/删除图片/显示内容）。...
vue集成百度UEditor富文本编辑器使用教程
10-17
主要为大家详细介绍了vue集成百度UEditor富文本编辑器的使用教程，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
vue2中wangeditor富文本编辑器使用方法
weixin_45859470的博客
01-30 737
vue2使用wangeditor富文本 包括：【标题设置、字体加粗、斜体、下划线、删除、文字颜色、背景颜色、链接、列表（有序、无序）、表情、图片（网络图片、本地上传）、表格、视频、代码块、返回上一步、返回下一步（但其实ctrl+z快捷键也可以）】3、wangEditor文件夹下面index的内容如下，直接复制粘贴上去就可以。2、安装好之后在components下面新建一个wangEditor文件夹。
Vue3使用WangEditor富文本编辑器并自定义Toolbar工具栏
Smart_J_King的博客
06-20 3086
更多配置参考使用库说明文档。
在 Vue 项目中引入 tinymce 富文本编辑器的完整代码
08-27
在 Vue 项目中引入 tinymce 富文本编辑器的完整代码 在 Vue 项目中引入 tinymce 富文本编辑器需要完成以下几个步骤：资源下载、初始化、扩展插件。 资源下载 首先，需要下载 tinymce 的 Vue 组件 tinymce-vue，...
一款纯VUE3 开发的富文本编辑器 editor
10-18
Vue3 Ts Editor是一款基于Vue3框架完全独立开发的富文本编辑器，专为现代Web应用设计，无需依赖任何第三方库或图片JS组件。这个编辑器的亮点在于其轻量化和易用性，使得开发者能够快速集成到自己的项目中，极大地...
vue中使用ueditor富文本编辑器
08-28
总结来说，要在Vue中使用ueditor富文本编辑器，你需要完成以下步骤： 1. 下载ueditor并将其放入`static`目录。 2. 配置ueditor.config.js，特别是服务器URL。 3. 创建Vue子组件，引入ueditor相关脚本并初始化编辑器...
Vue中使用wangEditor富文本框
lfyyyyy的博客
03-22 1261
在这个示例中，我们首先引入Vue 3的ref函数用于创建响应式数据。然后引入了WangEditor，并在setup函数中初始化了富文本编辑器。在初始化过程中，我们可以配置一些选项，比如图片上传的服务器地址。接着定义了保存内容的方法saveContent，在这个方法中，我们可以获取编辑器的HTML内容并进行保存或其他操作。最后，在组件的mounted钩子函数中调用initEditor方法来初始化编辑器。
wangeditor 富文本编辑器使用
sunshine641的博客
10-25 669
vue3 + ts环境下使用wangeditor 富文本编辑器，设置字数限制
vue中使用wangeditor富文本编辑器
云霸屏CSDN官方博客
11-19 6110
需要知道富文本编辑器是所见即所得的文本编辑器，简单来说就是文本上面写的行内样式，那我们该怎样保存这些行内样式呢，在这里我是写成了组件的形式。return中写上如下代码，需要注意的时上传图片后，后端必须返回url图片的链接，否则编辑器中不会显示图片。研究一番发现弱国想要怎加或者修改编辑器的功能首先要获取这个功能的key。到这里其实基本功能已经实现了，那我们怎么保存，编辑器中的内容呢。这个时候编辑器的功能已经实现了 如下图。这个时候就可以看到每个功能的key了。就可以实现你想要的功能了，如下图。
wangEditor5在vue中的基本使用
热门推荐
qq_45799465的博客
08-29 1万+
一、@wangEditor5的基本使用及配置 二、@wangEditor5上传图片 三、Module parse failed: Unexpected token (12828:18)You may need an appropriate loader to handle this file type.报错解决。 四、@wangEditor5有序列表无需列表样式消失。......
vue3——利用自定义指令实现下拉框分页懒加载
zmy967131的博客
07-24 467
vue3——利用自定义指令实现下拉框分页懒加载
通过不同方式在 Vue 3 中传递路由参数
最新发布
点点滴滴
07-25 654
通过path参数传递：在路由路径中定义动态参数，并使用将其作为 props 传递。通过query参数传递：在路由跳转时通过query参数传递数据，并在组件中使用useRoute获取。通过props选项传递：在路由配置中使用props选项传递静态或动态参数。
vue字段判断是否可以鼠标悬浮或者点击跳转
qq_58307541的博客
07-24 351
通过字段判断是否可以鼠标悬浮展示颜色 + 是否点击。
vue3如何安装并使用wangEditor富文本编辑器
06-03
首先，你需要在你的 Vue 3 项目中安装 wangEditor，可以通过以下命令进行安装： ``` npm install wangeditor --save ``` 安装完成后，在你的 Vue 3 项目中引入 wangEditor 并进行配置，可以参考以下代码： ```html <template> <div> <div id="editor"></div> </div> </template> <script> import WangEditor from 'wangeditor' export default { mounted() { const editor = new WangEditor('#editor') editor.config.uploadImgServer = '上传图片的接口地址' editor.config.uploadImgMaxLength = 5 // 限制一次最多上传 5 张图片 editor.create() } } </script> ``` 在以上代码中，我们在 mounted 钩子函数中创建了一个 wangEditor 实例，并将其绑定到一个 id 为 "editor" 的 div 元素上。同时，我们还对 wangEditor 进行了一些配置，如设置上传图片的接口地址，以及限制一次最多上传 5 张图片。 最后，我们需要在组件的 style 中引入 wangEditor 的样式： ```css @import 'wangeditor/release/wangEditor.min.css'; ``` 完成以上步骤后，你就可以在 Vue 3 项目中使用 wangEditor 富文本编辑器了。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

洛可可白

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值