青山依旧

Appearance

Return to top
﹌﹋文章目录﹋﹌

vue3-tinymce 富文本编辑器

vue3-tinymce 是基于 vue@3.x + tinymce@6.1.2 封装的富文本编辑器。

visitors

npm

tinymce


简单示例（掘金富文本编辑器）：

11951650334699_.pic.jpg

为什么

在开发管理台项目的时候有富文本编辑的功能需求，封装为组件方便使用。

个人开发一套完美的富文本编辑器难度大且耗时，在挑选插件中发现 tinymce editor 背景和功能都非常强大，并且文档清晰。基于 tinymce 封装组件是一个非常好的选择。

该组件清晰易懂，可自行修改为 vue2 版本使用。期待你的 Star ，发现问题可以提到 issues 👏

组件特色

开箱即用

组件内置按需加载 tinymce@6.1.2 版本 cdn 资源。使用 v-if 在必要时渲染组件。

组件包含 tinymce@6.1.2, 属性 script-src 可自定义 tinymce 静态资源路径。支持绝对路径和网络地址。

稳定使用：建议将 tinymce 资源包放到项目根目录，使用绝对路径。

拓展图片上传

本组件拓展了 插入图片 的图片上传部分，重写 setting.images_upload_handler，上传成功回填编辑器插入图片数据，关联 toolbar 和 plugins 中的 image。

js
{
  // 开启组件拓展的 上传图片功能，工具栏 图片按钮 弹框中出现 `upload` 选项
  custom_images_upload: true,
  // 复用 图片上传 api 地址
  images_upload_url: 'your_upload_api_url...',
  // 上传成功回调函数，return 图片地址。默认 response.location
  custom_images_upload_callback: response => response.url,
  // 上传 api 请求头
  custom_images_upload_header: { 'X-Token': 'xxxx' }
  // 上传 api 额外的参数。图片默认 file
  custom_images_upload_param: { id: 'xxxx01', age: 18 }
}

快速上手

NPM 使用

下载组件

sh
npm install @jsdawn/vue3-tinymce

在 vue3 中使用

vue
<template>
  <vue3-tinymce v-model="state.content" :setting="state.setting" />
</template>

<script setup>
import { reactive } from 'vue';
// 引入组件
import Vue3Tinymce from '@jsdawn/vue3-tinymce';

const state = reactive({
  content: 'hello vue3-tinymce!',
  // editor 配置项
  setting: {
    height: 400, // editor 高度
  },
});
</script>

稳定使用静态资源包（推荐）：

在 node_modules 目录中找到 @jsdawn/vue3-tinymce，将 @jsdawn/vue3-tinymce/dist/tinymce 目录复制到项目根目录的 public/tinymce， 然后传入 组件的 script-src:

vue
<template>
  <vue3-tinymce
    v-model="state.content"
    :setting="state.setting"
    script-src="/tinymce/tinymce.min.js"
  />
</template>

自定义组件使用

前往 Vue3Tinymce 仓库 获取 packages/Vue3Tinymce 组件文件，Copy 到自己项目中使用。setting 选项配置参照 tinymce 官方文档

组件属性

名称类型描述
modelValueString绑定值/内容，建议以 v-model 的形式使用
script-srcString自定义 tinymce 静态资源，支持绝对路径和网络地址。内置按需加载 tinymce@6.1.2
settingObject设置项，延用官方 tinymce 设置
setupFunction编辑器设置时的回调，回调参数 editor 实例，在此将编辑器事件添加到 TinyMCE 中
disabledBoolean是否禁用编辑器输入操作
@changeFunction编辑器监听到 change input undo redo 时触发，回调参数为编辑器 content
@initFunction编辑器初始化完成后触发，回调参数 editor 实例

使用示例：

简体中文

language - 语言 code， language_url - 语言包路径。

vue 脚手架项目可前往官网 下载语言包 放在 public/tinymce/langs 中，也可使用该组件语言包 cdn https://unpkg.com/@jsdawn/vue3-tinymce@2.0.2/dist/tinymce/langs/zh-Hans.js

js
const setting = {
    // 以中文简体为例
    language: 'zh-Hans',
    language_url: '/tinymce/langs/zh-Hans.js',
    ...
}

注意：如果项目存在多个编辑器存在的情况下，请为每个编辑器配置同样的语言配置。

经典设置

经典设置，包含了大部分可能用到的富文本编辑器功能和插件。

js
const classic_setting = {
  height: 300,
  toolbar:
    'undo redo | fullscreen | blocks alignleft aligncenter alignright alignjustify | link unlink | numlist bullist | image media table | fontsize forecolor backcolor | bold italic underline strikethrough | indent outdent | superscript subscript | removeformat |',
  toolbar_mode: 'sliding',
  quickbars_selection_toolbar:
    'removeformat | bold italic underline strikethrough | fontsize forecolor backcolor',
  plugins: 'link image media table lists fullscreen quickbars',
  font_size_formats: '12px 14px 16px 18px',
  link_default_target: '_blank',
  link_title: false,
  nonbreaking_force_tab: true,
  // 以中文简体为例
  language: 'zh-Hans',
  language_url:
    'https://unpkg.com/@jsdawn/vue3-tinymce@2.0.2/dist/tinymce/langs/zh-Hans.js',
};

类似掘金设置

类似掘金设置服务 简洁的图文写作，仅包含较常用的文字格式，图片上传，与链接功能。

js
const juejin_setting = {
  menubar: false,
  height: 190,
  toolbar:
    'bold italic underline h1 h2 blockquote codesample numlist bullist link image | removeformat fullscreen',
  plugins: 'codesample link image table lists fullscreen',
  toolbar_mode: 'sliding',
  nonbreaking_force_tab: true,
  link_title: false,
  link_default_target: '_blank',
  content_style: 'body{font-size: 16px}',
  // 自定义 图片上传模式
  custom_images_upload: true,
  images_upload_url: 'your_upload_api_url...',
  custom_images_upload_callback: (res) => res.url,
  custom_images_upload_param: { id: 'xxxx01', age: 18 },
};

更新日志

v1.1.7

2020-01-19

Feature

  • 拓展图片上传：自定义图片上传请求头 setting.custom_images_upload_header

v2.0.2

2022-09-23

Feature

  • 升级 tinymce 版本，从 v5.8.x 版本升级到 v6.1.2。新增 tinymce@6.1.2 静态资源包，位置在 dist/tinymce 目录

转载声明： 请注明作者，注明原文链接，有疑问致邮 kingwyh1993@163.com