yj-minimce

v0.1.1

Published

9 months ago

Rich text editor, offline TinyMCE Vue 2.6/2.7/3 wrapper.

Downloads

0High
0Medium
0Low

tinymce offline vue richtext rich-text rte editor word wps doc docx office WYSIWYG vue-demi microsoft-office nuxt nuxtjs ssr

对比 tinymce-vue

是的，TinyMCE 已经有官方的 Vue 封装 tinymce-vue 了，但它：

需要加载至少 380kB 的网络资源 (开启插件全家桶将达到 563kB，还没算上付费插件)，外网会很慢，甚至超时
有域名检测，会弹窗警告
用不同的版本号来适配不同的 Vue 版本，升级成本较高
默认功能最小化，需要繁杂的配置，还不支持全局传参

tinymce-vue

minimce

特性

基于 TinyMCE 6
Vue 2.6/2.7/3 通用
支持 SSR，Nuxt 2/3 通用
支持微前端 (wujie，qiankun，single-spa……)
可离线使用，零网络延迟
无域名检测，无弹窗困扰
插件全家桶开箱即用
提供常用自定义插件示例
- 插入 Word 文档 (.docx)，兼容 Microsoft Office、WPS
- 插入本地图片
- 插入本地视频
- 插入本地音频
- 插入电话链接
- 插入小程序页面链接
支持浅色模式 & 深色模式，主题、图标、内容样式均可自定义
支持将 HTML 输出为普通文本
局部注册并传参，或全局注册并传参 (vue-global-config 提供技术支持)

安装

外置依赖

vue
tinymce
~~@vue/composition-api~~：仅 Vue 2.6 或更早版本需要

Vue 3

npm i minimce tinymce

局部注册

<template>
  <MiniMCE
    :options="{
      language: 'zh-Hans',
    }"
  />
</template>

<script setup>
import MiniMCE from 'minimce'

// 在组件外部引入静态资源的目的是方便用户对其进行更换
import 'tinymce/skins/ui/oxide/skin.min.css' // 皮肤
import 'tinymce/themes/silver/theme' // 主题
import 'tinymce/icons/default/icons' // 图标
import './langs/zh-Hans' // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
</script>

全局注册

import MiniMCE from 'minimce'

// 在组件外部引入静态资源的目的是方便用户对其进行更换
import 'tinymce/skins/ui/oxide/skin.min.css' // 皮肤
import 'tinymce/themes/silver/theme' // 主题
import 'tinymce/icons/default/icons' // 图标
import './langs/zh-Hans' // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）

app.use(MiniMCE, {
  // 全局 props & attrs (单向数据流)
  options: {
    language: 'zh-Hans',
  },
})

CDN + ESM

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <!-- 皮肤 -->
  <link
    rel="stylesheet"
    href="https://unpkg.com/tinymce/skins/ui/oxide/skin.min.css"
  >
</head>

<body>
  <div id="app">
    <minimce :options="options"></minimce>
  </div>
  <script type="importmap">
    {
      "imports": {
        "vue": "https://unpkg.com/vue/dist/vue.esm-browser.prod.js",
        "vue-demi": "https://unpkg.com/vue-demi/lib/v3/index.mjs",
        "tinymce": "https://unpkg.com/tinymce",
        "minimce": "https://unpkg.com/[email protected]/dist/minimce.mjs"
      }
    }
  </script>
  <script type="module">
    import { createApp } from 'vue'
    import MiniMCE from 'minimce'

    createApp({
      setup: () => ({
        options: {
          // 主题
          theme_url: 'https://unpkg.com/tinymce/themes/silver/theme',
          // 图标
          icons_url: 'https://unpkg.com/tinymce/icons/default/icons',
          // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
          // language_url: 'https://xxx',
        },
      }),
    }).component('minimce', MiniMCE)
      .mount('#app')
  </script>
</body>

</html>

CDN + IIFE

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <!-- 皮肤 -->
  <link
    rel="stylesheet"
    href="https://unpkg.com/tinymce/skins/ui/oxide/skin.min.css"
  >
</head>

<body>
  <div id="app">
    <minimce :options="options"></minimce>
  </div>

  <script src="https://unpkg.com/vue"></script>
  <script src="https://unpkg.com/vue-demi"></script>
  <script src="https://unpkg.com/tinymce"></script>
  <script src="https://unpkg.com/[email protected]/dist/minimce.umd.js"></script>
  <script>
    const { createApp } = Vue

    createApp({
      setup: () => ({
        options: {
          // 主题
          theme_url: 'https://unpkg.com/tinymce/themes/silver/theme',
          // 图标
          icons_url: 'https://unpkg.com/tinymce/icons/default/icons',
          // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
          // language_url: 'https://xxx',
        },
      }),
    }).component('minimce', MiniMCE)
      .mount('#app')
  </script>
</body>

</html>

Vue 2.7

npm i minimce tinymce

局部注册

<template>
  <MiniMCE
    :options="{
      language: 'zh-Hans',
    }"
  />
</template>

<script setup>
import MiniMCE from 'minimce'

// 在组件外部引入静态资源的目的是方便用户对其进行更换
import 'tinymce/skins/ui/oxide/skin.min.css' // 皮肤
import 'tinymce/themes/silver/theme' // 主题
import 'tinymce/icons/default/icons' // 图标
import './langs/zh-Hans' // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
</script>

全局注册

import MiniMCE from 'minimce'

// 在组件外部引入静态资源的目的是方便用户对其进行更换
import 'tinymce/skins/ui/oxide/skin.min.css' // 皮肤
import 'tinymce/themes/silver/theme' // 主题
import 'tinymce/icons/default/icons' // 图标
import './langs/zh-Hans' // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）

Vue.use(MiniMCE, {
  // 全局 props & attrs (单向数据流)
  options: {
    language: 'zh-Hans',
  },
})

CDN + ESM

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <!-- 皮肤 -->
  <link
    rel="stylesheet"
    href="https://unpkg.com/tinymce/skins/ui/oxide/skin.min.css"
  >
</head>

<body>
  <div id="app">
    <minimce :options="options"></minimce>
  </div>
  <script type="importmap">
    {
      "imports": {
        "vue": "https://unpkg.com/vue@2/dist/vue.esm.browser.min.js",
        "vue-demi": "https://unpkg.com/vue-demi/lib/v2.7/index.mjs",
        "tinymce": "https://unpkg.com/tinymce",
        "minimce": "https://unpkg.com/[email protected]/dist/minimce.mjs"
      }
    }
  </script>
  <script type="module">
    import Vue from 'vue'
    import MiniMCE from 'minimce'

    new Vue({
      components: { minimce: MiniMCE },
      data() {
        return {
          options: {
            // 主题
            theme_url: 'https://unpkg.com/tinymce/themes/silver/theme',
            // 图标
            icons_url: 'https://unpkg.com/tinymce/icons/default/icons',
            // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
            // language_url: 'https://xxx',
          },
        }
      },
    }).$mount('#app')
  </script>
</body>

</html>

CDN + IIFE

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <!-- 皮肤 -->
  <link
    rel="stylesheet"
    href="https://unpkg.com/tinymce/skins/ui/oxide/skin.min.css"
  >
</head>

<body>
  <div id="app">
    <minimce :options="options"></minimce>
  </div>

  <script src="https://unpkg.com/vue@2"></script>
  <script src="https://unpkg.com/vue-demi"></script>
  <script src="https://unpkg.com/tinymce"></script>
  <script src="https://unpkg.com/[email protected]/dist/minimce.umd.js"></script>
  <script>
    new Vue({
      components: { minimce: MiniMCE },
      data() {
        return {
          options: {
            // 主题
            theme_url: 'https://unpkg.com/tinymce/themes/silver/theme',
            // 图标
            icons_url: 'https://unpkg.com/tinymce/icons/default/icons',
            // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
            // language_url: 'https://xxx',
          },
        }
      },
    }).$mount('#app')
  </script>
</body>

</html>

Vue 2.6 或更早版本

npm i minimce tinymce @vue/composition-api

局部注册

<template>
  <MiniMCE
    :options="{
      language: 'zh-Hans',
    }"
  />
</template>

<script>
import VCA from '@vue/composition-api'
import MiniMCE from 'minimce'

// 在组件外部引入静态资源的目的是方便用户对其进行更换
import 'tinymce/skins/ui/oxide/skin.min.css' // 皮肤
import 'tinymce/themes/silver/theme' // 主题
import 'tinymce/icons/default/icons' // 图标
import './langs/zh-Hans' // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）

Vue.use(VCA)

export default {
  components: { MiniMCE },
}
</script>

全局注册

import VCA from '@vue/composition-api'
import MiniMCE from 'minimce'

// 在组件外部引入静态资源的目的是方便用户对其进行更换
import 'tinymce/skins/ui/oxide/skin.min.css' // 皮肤
import 'tinymce/themes/silver/theme' // 主题
import 'tinymce/icons/default/icons' // 图标
import './langs/zh-Hans' // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）

Vue.use(VCA)

Vue.use(MiniMCE, {
  // 全局 props & attrs (单向数据流)
  options: {
    language: 'zh-Hans',
  },
})

CDN + ESM

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <!-- 皮肤 -->
  <link
    rel="stylesheet"
    href="https://unpkg.com/tinymce/skins/ui/oxide/skin.min.css"
  >
</head>

<body>
  <div id="app">
    <minimce :options="options"></minimce>
  </div>
  <script>
    window.process = { env: { NODE_ENV: 'production' } }
  </script>
  <script type="importmap">
    {
      "imports": {
        "vue": "https://unpkg.com/[email protected]/dist/vue.esm.browser.min.js",
        "@vue/composition-api": "https://unpkg.com/@vue/composition-api/dist/vue-composition-api.mjs",
        "@vue/composition-api/dist/vue-composition-api.mjs": "https://unpkg.com/@vue/composition-api/dist/vue-composition-api.mjs",
        "vue-demi": "https://unpkg.com/vue-demi/lib/v2/index.mjs",
        "tinymce": "https://unpkg.com/tinymce",
        "minimce": "https://unpkg.com/[email protected]/dist/minimce.mjs"
      }
    }
  </script>
  <script type="module">
    import { createApp } from '@vue/composition-api'
    import MiniMCE from 'minimce'

    const app = createApp({
      setup: () => ({
        options: {
          // 主题
          theme_url: 'https://unpkg.com/tinymce/themes/silver/theme',
          // 图标
          icons_url: 'https://unpkg.com/tinymce/icons/default/icons',
          // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
          // language_url: 'https://xxx',
        },
      }),
    })

    app.component('minimce', MiniMCE)
    app.mount('#app')
  </script>
</body>

</html>

CDN + IIFE

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8" />
  <!-- 皮肤 -->
  <link
    rel="stylesheet"
    href="https://unpkg.com/tinymce/skins/ui/oxide/skin.min.css"
  >
</head>

<body>
  <div id="app">
    <minimce :options="options"></minimce>
  </div>

  <script src="https://unpkg.com/[email protected]"></script>
  <script src="https://unpkg.com/@vue/composition-api"></script>
  <script src="https://unpkg.com/vue-demi"></script>
  <script src="https://unpkg.com/tinymce"></script>
  <script src="https://unpkg.com/[email protected]/dist/minimce.umd.js"></script>
  <script>
    const { createApp } = VueCompositionAPI

    const app = createApp({
      setup: () => ({
        options: {
          // 主题
          theme_url: 'https://unpkg.com/tinymce/themes/silver/theme',
          // 图标
          icons_url: 'https://unpkg.com/tinymce/icons/default/icons',
          // 语言（非必须，默认英文，下载地址: https://www.tiny.cloud/get-tiny/language-packages）
          // language_url: 'https://xxx',
        },
      }),
    })

    app.component('minimce', MiniMCE)
    app.mount('#app')
  </script>
</body>

</html>

Nuxt 3

npm i minimce tinymce

局部注册

<!-- ~/components/MiniMCE.client.vue -->

<template>
  <MiniMCE v-bind="attrs" />
</template>

<script setup>
import MiniMCE from 'minimce'

const attrs = useAttrs()
</script>

<template>
  <client-only>
    <MiniMCE v-model="value" v-bind="{/* 局部 props & attrs */}" />
  </client-only>
</template>

<script setup>
const value = ref()
</script>

全局注册

// ~/plugins/MiniMCE.client.ts

import MiniMCE from 'minimce'

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.use(MiniMCE, {
    // 全局 props & attrs（单向数据流）
  })
})

<template>
  <client-only>
    <MiniMCE v-model="value" />
  </client-only>
</template>

<script setup>
const value = ref()
</script>

Nuxt 2 + Vue 2.7

npm i minimce tinymce

局部注册

// nuxt.config.js

export default {
  build: {
    extend(config) {
      config.module.rules.push({
        test: /\.mjs$/,
        include: /node_modules/,
        type: 'javascript/auto',
      })
    },
  },
}

<template>
  <client-only>
    <MiniMCE v-model="value" v-bind="{/* 局部 props & attrs */}" />
  </client-only>
</template>

<script setup>
import { ref } from 'vue'

const MiniMCE = () => process.client
  ? import('minimce')
  : Promise.resolve({ render: h => h('div') })

const value = ref()
</script>

全局注册

// nuxt.config.js

export default {
  plugins: ['~/plugins/MiniMCE.client'],
  build: {
    extend(config) {
      config.module.rules.push({
        test: /\.mjs$/,
        include: /node_modules/,
        type: 'javascript/auto',
      })
    },
  },
}

// ~/plugins/MiniMCE.client.js

import Vue from 'vue'
import MiniMCE from 'minimce'

Vue.use(MiniMCE, {
  // 全局 props & attrs（单向数据流）
})

<template>
  <client-only>
    <MiniMCE v-model="value" />
  </client-only>
</template>

<script setup>
import { ref } from 'vue'

const value = ref()
</script>

Nuxt 2 + Vue 2.6 或更早版本

npm i minimce tinymce @vue/composition-api

局部注册

// nuxt.config.js

export default {
  build: {
    extend(config) {
      config.module.rules.push({
        test: /\.mjs$/,
        include: /node_modules/,
        type: 'javascript/auto',
      })
    },
  },
}

<template>
  <client-only>
    <MiniMCE v-model="value" v-bind="{/* 局部 props & attrs */}" />
  </client-only>
</template>

<script>
import Vue from 'vue'
import VCA from '@vue/composition-api'
Vue.use(VCA)

export default {
  components: {
    MiniMCE: () => process.client
      ? import('minimce')
      : Promise.resolve({ render: h => h('div') }),
  },
  data() {
    return {
      value: undefined,
    }
  },
}
</script>

全局注册

// nuxt.config.js

export default {
  plugins: ['~/plugins/MiniMCE.client'],
  build: {
    extend(config) {
      config.module.rules.push({
        test: /\.mjs$/,
        include: /node_modules/,
        type: 'javascript/auto',
      })
    },
  },
}

// ~/plugins/MiniMCE.client.js

import Vue from 'vue'
import VCA from '@vue/composition-api'
import MiniMCE from 'minimce'

Vue.use(VCA)
Vue.use(MiniMCE, {
  // 全局 props & attrs（单向数据流）
})

<template>
  <client-only>
    <MiniMCE v-model="value" />
  </client-only>
</template>

<script>
export default {
  data() {
    return {
      value: undefined,
    }
  },
}
</script>

属性

| 名称 | 说明 | 类型 | 默认值 | | ----------------------------------------------- | ------------------------------------------------------ | ------- | ------------------------------------------------------------------------------ | | modelValue (Vue 3) /value (Vue 2) / v-model | 绑定值 | string | | | disabled | 禁用状态 | boolean | false | | outputFormat | 输出格式，'html' 或 'text' | string | 'html' | | options | TinyMCE 配置 | object | 查看代码 |

外部属性

| 名称 | 说明 | 类型 | | ---- | ------- | ------ | | id | 元素 ID | string |

获取 TinyMCE Editor 实例

<!-- 示例: 监听 TinyMCE 的事件 -->

<template>
  <MiniMCE
    ref="miniMCERef"
    :options="options"
  />
</template>

<script setup>
import { reactive, ref } from 'vue'
import tinymce from 'tinymce/tinymce'

const miniMCERef = ref()
const options = reactive({
  setup(editor) {
    // 方式1
    editor.on('init', (e) => {
      console.log('init', e)

      // 方式2
      tinymce.get(miniMCERef.value.id).on('Change', (e) => {
        console.log('Change', e)
      })

      // 方式3
      tinymce.activeEditor.on('Change', (e) => {
        console.log('Change', e)
      })
    })
  },
  // 方式4
  init_instance_callback(editor) {
    editor.on('Change', (e) => {
      console.log('Change', e)
    })
  },
})
</script>

显隐控制

请使用 v-if 控制显隐。

由于实际的富文本元素并没有挂载在 options.selector 上面，所以使用 v-show 切换显隐会有问题。

内容样式

富文本的内容样式建议在展示侧自行添加，而不是在富文本的生产侧添加，因为：

富文本的生产侧无法满足展示侧各自的定制化需求
展示侧可能包含小程序，小程序不支持 style 标签

域名检测

TinyMCE 有四种价格计划：

Core (免费)
Essential
Professional
Flexible

如果没有注册 Tiny 账号、或者没有在账号设置中登记域名，界面上会有警告弹出 (即使你使用的是免费的 Core 计划)

当然，你可以用 CSS 来屏蔽弹窗，只是不推荐这种方式

TinyMCE 提供了两种加载方式：

CDN (tinymce-vue 采用的方式)：需要注册账号以提供 api-key，并在账号设置中登记所有用到 TinyMCE 的项目域名
NPM (MiniMCE 采用的方式)：没有 api-key 参数，所以不需要注册账号、不需要登记域名，参考 Tiny 官方解释

插件示例

插入 Word 文档 (`.docx`)，兼容 Microsoft Office、WPS

插入电话链接

插入小程序页面链接

粘贴 Word 文档

TinyMCE 提供了 premium 插件 PowerPaste，可用于粘贴 Word 文档，但兼容性一般，尤其是不支持 WPS

MiniMCE 提供了插入 Word 文档的插件示例，兼容 Microsoft Office、WPS，可在一定程度上替代 PowerPaste

注意：粘贴可以片段粘贴，插入只能整个文档插入

PowerPaste 插件

// PowerPaste 配置示例

import MiniMCE from 'minimce'
import axios from 'axios'
import createAxiosShortcut from 'axios-shortcut'

const { POST } = createAxiosShortcut(axios)

app.use(MiniMCE, {
  options: {
    images_upload_handler(blobInfo, success, failure) {
      const blob = blobInfo.blob()
      const file = new File(
        [blob],
        blobInfo.filename(),
        { type: blob.type }
      )

      POST.upload(process.env.VUE_APP_UPLOAD_API, {
        file
      }).then((res) => {
        if (typeof res.data?.data === 'string')
          success(res.data.data)

        else
          failure(res.data?.message)

      }).catch((err) => {
        failure(String(err))
      })
    },
  }
})

兼容性
受浏览器限制，PowerPaste 插件无法支持微软 Word 和 Excel 文档所支持的所有图片类型 。举个例子，浏览器禁止以编程方式访问文件系统，所以无法解析文档中使用 file:// 协议的图片 (WPS 使用的就是此协议)。
粘贴微软 Word 文档 (Windows 系统、≥ 2013 版本) 中受保护视图的内容，将仅得到无格式的普通文本，这是受保护视图与剪贴板的交互机制决定的。
受微软 Excel 网页版限制，粘贴微软 Excel 网页版的内容将仅得到无格式的普通文本。

粘贴网页内容 (HTML)

格式

粘贴的网页内容默认会保留一定的源格式，启用 PowerPaste 插件后，对格式的处理将会更加完善。详见 Improved HTML Cleaning

如需获取纯文本，选中编辑-粘贴为文本再进行粘贴

清除格式按钮得到的不是纯文本，可以自定义清除效果： Removing a format

图片

如果用户复制第三方网站的内容到编辑框内，静态资源 (如图片) 可能无法正常显示，这是因为：

第三方网站没有开启静态资源的跨域访问
第三方网站对静态资源做了 Referer 校验

TinyMCE 的 urlconverter_callback、paste_postprocess API 不支持异步操作，所以批量转存图片可行性低

技术上是可以解决的，可以通过 NGINX 动态代理配合这两个 API 来处理

请自行评估相关风险

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

对比 tinymce-vue

特性

安装

外置依赖

Vue 3

局部注册

全局注册

CDN + ESM

CDN + IIFE

Vue 2.7

局部注册

全局注册

CDN + ESM

CDN + IIFE

Vue 2.6 或更早版本

局部注册

全局注册

CDN + ESM

CDN + IIFE

Nuxt 3

局部注册

全局注册

Nuxt 2 + Vue 2.7

局部注册

全局注册

Nuxt 2 + Vue 2.6 或更早版本

局部注册

全局注册

属性

外部属性

获取 TinyMCE Editor 实例

显隐控制

内容样式

域名检测

插件示例

插入 Word 文档 (.docx)，兼容 Microsoft Office、WPS

插入本地图片

插入本地视频

插入本地音频

插入电话链接

插入小程序页面链接

粘贴 Word 文档

PowerPaste 插件

粘贴网页内容 (HTML)

格式

图片

插入 Word 文档 (`.docx`)，兼容 Microsoft Office、WPS