wangEditor 富文本编辑器 图片上传

本文介绍如何在Vue项目中集成wangEditor富文本编辑器,包括安装、配置及自定义上传实现。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.第一步通过yarn或者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.在vue文件里面可以加入模版代码

<template>
    <div style="border: 1px solid #ccc">
      <Toolbar
        style="border-bottom: 1px solid #ccc"
        :editor="editorRef"
        :defaultConfig="toolbarConfig"
        :mode="mode"
      />
      <Editor
        style="height: 500px; overflow-y: hidden;"
        v-model="valueHtml"
        :defaultConfig="editorConfig"
        :mode="mode"
        @onCreated="handleCreated"
      />
    </div>
</template>

3.引入所需要的链接

import { onBeforeUnmount, ref, shallowRef, onMounted, watch } from "vue";
import { Editor, Toolbar } from "@wangeditor/editor-for-vue";

4.直接放入所需要的代码

const toolbarConfig = {
  excludeKeys: ["group-video"], //排除不需要的上传视频
};
// 编辑器实例,必须用 shallowRef
const editorRef = shallowRef();

// 内容 HTML
const valueHtml = ref("");

// 标题
const input1 = ref("");

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

const editorConfig = { placeholder: "请输入内容...", MENU_CONF: {} };

editorConfig.MENU_CONF["uploadImage"] = {
  server: "xxxx", // 服务端地址 写自己项目所上传的地址
  meta: {
     id:xxx,//加入上传时所需要的额外参数
  },
  // form-data fieldName ,默认值 'wangeditor-uploaded-image'
  fieldName: "materialFile",
  // 选择文件时的类型限制,默认为 ['image/*'] 。如不想限制,则设置为 []
  allowedFileTypes: ["image/*"],

  // 单个文件的最大体积限制,默认为 2M
  maxFileSize: 10 * 1024 * 1024, // 1M

  headers: {
        //加入不一样的参数
       },
  // 跨域是否传递 cookie ,默认为 false
  withCredentials: true, // 超时时间,默认为 10 秒
  timeout: 5 * 1000, // 5 秒 // 上传之前触发
  onBeforeUpload(file) {
    // file 选中的文件,格式如 { key: file }
    return file; // 可以 return        // 1. return file 或者 new 一个 file ,接下来将上传        // 2. return false ,不上传这个 file
  },
  customUpload(file, insertFn) {
    let index = file.name.lastIndexOf(".");
    let extension = file.name.substr(index + 1);
    let extensionList = [
      "png",
      "PNG",
      "jpg",
      "JPG",
      "jpeg",
      "JPEG",
      "bmp",
      "BMP",
    ];
    const isLt2M = file.size / 1024 / 1024 < 10;
    if (!isLt2M) {
      ElMessage.error("图片大小请不要超过10MB!");
      return false;
    } else if (extensionList.indexOf(extension) < 0) {
      ElMessage.error("当前文件格式不支持!");
      return false;
    } else {
      const obj = new FormData();
      //上传文件
      obj.append("file", file); // 这里可以修改默认的参数名字

      apiName(obj).then((res) => {
        if (res.errorNo == "0") {
          ElMessage.success("上传成功!");
          insertFn(res.responseData.url); //这里有三个参数,但是个人只需要第一个url
        }
      });
    }
    // insertFn(url, alt, href);
  },
};

// 组件销毁时,也及时销毁编辑器
onBeforeUnmount(() => {
  const editor = editorRef.value;
  if (editor == null) return;
  editor.destroy();
});

const handleCreated = (editor) => {
  editorRef.value = editor; // 记录 editor 实例,重要!
};

const mode = ref("default");

这里的上传没用他自带的上传,根据项目所需要修改了部分。

有啥不好的望大佬指正

### WangEditor 富文本编辑器图片上传实现 #### 安装依赖包 为了在项目中使用WangEditor并实现图片上传功能,需先安装必要的依赖包。对于Vue3环境而言,可以通过如下命令来完成[@wangeditor/editor]以及[@wangeditor/editor-for-vue@next]两个库的引入[^2]: ```bash yarn add @wangeditor/editor yarn add @wangeditor/editor-for-vue@next ``` 或者采用npm方式: ```bash npm install @wangeditor/editor --save npm install @wangeditor/editor-for-vue@next --save ``` #### 初始化编辑器组件 创建一个新的Vue单文件组件用于承载WangEditor实例,在`<template>`标签内声明editor容器节点,并通过`<script setup>`语法糖简化逻辑编写。 ```vue <!-- EditorComponent.vue --> <template> <div id="editor-container"></div> </template> <script setup lang="ts"> import { onMounted } from 'vue'; // Import necessary modules and styles from wangEditor package. import '@wangeditor/editor/dist/css/style.css'; // 引入样式表 import { createEditor, BaseMenuConf } from '@wangeditor/editor'; const editorConfig = { placeholder: "请输入内容...", }; onMounted(() => { const editor = createEditor({ selector: '#editor-container', config: editorConfig, mode: 'default', // or 'simple' }); }); </script> ``` #### 配置图片上传插件 为了让用户能够向文档中插入本地选取或拖拽进入的图像资源,需要进一步定制化配置项中的`menuConfig`属性,指定处理图片上传的具体行为。这里假设已经存在一个可供调用的服务端接口负责接收来自前端发送过来的数据流形式的二进制文件对象。 ```typescript import axios from 'axios'; ... const uploadImagePluginConfig : Partial<BaseMenuConf>['uploadImage'] = { server: '/api/upload-image', // 后端API地址 fieldName: 'file', // 表单字段名,默认为'file' maxFileSizeMb: 5, // 单张图片最大尺寸限制(MB),默认无上限 async customUpload(file: File){ try{ let formData = new FormData(); formData.append('image', file); await axios.post('/api/upload-image', formData,{ headers:{ 'Content-Type': 'multipart/form-data' } }); return true; }catch(error){ console.error(`Failed to upload image ${error}`); throw error; } }, }; ... ``` 最后一步就是把上述定义好的`uploadImagePluginConfig`应用到初始化的参数列表里去: ```javascript const editor = createEditor({ ... menuConfig: { ...otherMenus, ['uploadImage']: uploadImagePluginConfig, }, }) ``` 这样就完成了基于Vue框架下利用WangEditor构建支持自定义图片上传特性的富文本编辑区域的工作流程介绍[^1]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值