TinyMCE富文本编辑器的使用及自定义按钮

486 阅读4分钟

一、安装

#yarn
yarn add tinymce
yarn add @tinymce/tinymce-vue
#npm
npm install tinymce -S 
npm install @tinymce/tinymce-vue -S

二、使用

  1. 引入插件:在项目的公共资源文件夹public中建立tinymce文件夹,把从官网下的中文语言包放到文件夹中,编辑器皮肤也可放到此处
  2. 封装组件:在src/components下新建TEditor.vue,并写入以下代码
<template>
  <div style="height: 100%; overflow: hidden">
    <editor ref="editorRef" v-model="myValue" :init="init" :inline="inline" :enabled="enabled" :id="tinymceId"></editor>
  </div>
</template>

<script setup>
import { computed, reactive, watch, ref, nextTick, onMounted } from 'vue' // 全屏

import tinymce from 'tinymce/tinymce'
// import "tinymce/skins/content/default/content.css";
import Editor from '@tinymce/tinymce-vue'
import 'tinymce/icons/default/icons'
import 'tinymce/models/dom' // 一定要引入
import 'tinymce/themes/silver' // 界面UI主题
import 'tinymce/plugins/image'
import 'tinymce/plugins/table'
import 'tinymce/plugins/lists' // 列表插件
import 'tinymce/plugins/wordcount' // 文字计数
import 'tinymce/plugins/preview' // 预览
import 'tinymce/plugins/emoticons' // emoji表情
import 'tinymce/plugins/emoticons/js/emojis.js' // 必须引入这个文件才有表情图库
import 'tinymce/plugins/code' // 编辑源码
import 'tinymce/plugins/link' // 链接插件
import 'tinymce/plugins/advlist' // 高级列表
import 'tinymce/plugins/codesample' // 代码示例
import 'tinymce/plugins/autoresize' // 自动调整编辑器大小
import 'tinymce/plugins/quickbars' // 光标处快捷提示
import 'tinymce/plugins/nonbreaking' // 插入不间断空格
import 'tinymce/plugins/searchreplace' // 查找替换
import 'tinymce/plugins/autolink' // 自动链接
import 'tinymce/plugins/directionality' // 文字方向
import 'tinymce/plugins/visualblocks' // 显示元素范围
import 'tinymce/plugins/visualchars' // 显示不可见字符
import 'tinymce/plugins/charmap' // 特殊符号
import 'tinymce/plugins/insertdatetime' // 插入日期时间
import 'tinymce/plugins/importcss' // 引入自定义样式的css文件
import 'tinymce/plugins/accordion' // 可折叠数据手风琴模式
import 'tinymce/plugins/anchor' // 锚点
import 'tinymce/plugins/fullscreen'
import Http from '@/support/http'
import Message from '@/support/message'
import { env } from '@/support/helper'

const emits = defineEmits(['update:modelValue', 'setHtml', 'addFill'])
// 这里我选择将数据定义在props里面,方便在不同的页面也可以配置出不同的编辑器,当然也可以直接在组件中直接定义
const props = defineProps({
  modelValue: {
    type: String,
    default: () => {
      return ''
    }
  },
  placeholder: {
    type: String,
    default: '在这里输入内容'
  },
  baseUrl: {
    type: String,
    default: ''
  },
  enabled: {
    type: Boolean,
    default: true
  },
  // 编辑器初始可编辑状态
  editable_root: {
    type: Boolean,
    default: true
  },
  inline: {
    type: Boolean,
    default: false
  },
  plugins: {
    type: [String, Array],
    default:
      'importcss autoresize searchreplace autolink directionality code visualblocks visualchars fullscreen image link codesample table charmap nonbreaking anchor insertdatetime advlist lists wordcount charmap quickbars emoticons accordion'
  },
  knwlgId: {
    type: String
  },
  toolbar: {
    type: [String, Array, Boolean],
    default:
      'fillButton |undo redo | accordion accordionremove | blocks fontfamily fontsize| bold italic underline strikethrough ltr rtl  | align numlist bullist | link image | table | lineheight outdent indent| forecolor backcolor removeformat | charmap emoticons | anchor codesample'
  },// fillButton为自定义按钮
  readonly: {
    type: Boolean,
    default: false
  },
  minHeight: {
    type: Number,
    default: 200
  },
  paste_data_images: {
    type: Boolean,
    default: false
  }
})

const tinymceId = ref('vue-tinymce-' + +new Date() + ((Math.random() * 1000).toFixed(0) + ''))

// 定义一个对象 init初始化
const init = reactive({
  placeholder: props.placeholder,
  selector: '#' + tinymceId.value, // 富文本编辑器的id,
  language_url: '/static/tinymce7/langs/zh_CN.js', // 语言包的路径,具体路径看自己的项目
  language: 'zh_CN',
  skin_url: '/static/tinymce7/skins/ui/oxide', // skin路径,具体路径看自己的项目
  editable_root: props.editable_root,
  height: 600,
  branding: false, // 是否禁用“Powered by TinyMCE”
  promotion: false, // 去掉 upgrade
  // toolbar_sticky: true,
  // toolbar_sticky_offset: 100,
  //   menubar: 'edit view insert format tools table',// 菜单栏 编辑 插入 格式 工具 表格
  menubar: false, // 隐藏了菜单栏
  paste_data_images: props.paste_data_images, // 允许粘贴图像
  image_dimensions: false, // 去除宽高属性
  plugins: props.plugins, // 这里的数据是在props里面就定义好了的
  toolbar: props.toolbar, // 这里的数据是在props里面就定义好了的
  // 取消图片资源路径转换
  convert_urls: false,
  // table边框位0是否展示网格线
  // visual: false,
  // 超链接默认打开方式
  link_default_target: '_blank',
  link_context_toolbar: true,
  // 默认快捷菜单
  quickbars_insert_toolbar: false,
  //   quickbars_insert_toolbar: 'image codesample table',
  // 选中图片的快捷提示
  quickbars_image_toolbar: 'alignleft aligncenter alignright | rotateleft rotateright | imageoptions',
  editimage_toolbar: 'rotateleft rotateright | flipv fliph | editimage imageoptions',
  // 文字样式
  font_family_formats: 'Arial=arial,helvetica,sans-serif; 宋体=SimSun; 微软雅黑=Microsoft Yahei; Impact=impact,chicago;', // 字体
  font_size_formats: '11px 12px 14px 16px 18px 24px 36px 48px 64px 72px', // 文字大小
  image_caption: true,
  editimage_cors_hosts: ['picsum.photos'],
  noneditable_class: 'mceNonEditable',
  toolbar_mode: 'scrolling', // 工具栏模式 floating / sliding / scrolling / wrap
  // 默认样式
  content_style: 'body { font-family:Helvetica,Arial,sans-serif; font-size:16px }p {margin:3px; line-height:24px;}',
  image_advtab: true,
  importcss_append: true,
  paste_webkit_styles: 'all',
  paste_merge_formats: true,
  nonbreaking_force_tab: false,
  paste_auto_cleanup_on_paste: false,
  file_picker_types: 'file',
  // 选中文字的快捷提示
  quickbars_selection_toolbar: 'bold italic quicklink quickimage quicktable',
  // 编辑器高度自适应
  autoresize_bottom_margin: 20,
  // autoresize_overflow_padding: 16,
  min_height: props.minHeight,
  content_css: '/tinymce/skins/content/default/content.css', // 以css文件方式自定义可编辑区域的css样式,css文件需自己创建并引入
  // setup: function (editor) {
  // },
  // 图片上传  -实列 具体请根据官网补充-
  images_upload_handler: (blobInfo, progress) =>
    new Promise((resolve, reject) => {
      if (blobInfo.blob().size / 1024 / 1024 > 10) {
        Message.error('上传失败,图片大小请控制在 10M 以内')
      } else {
        const params = new FormData()
        params.append('image', blobInfo.blob())
        Http.post(env('VITE_BASE_URL') + '/upload/image', params)
          .then(res => {
            if (res.data.code === 10000) {
              resolve(res.data.data.full_path)
            } else {
              Message.error(res.data.message)
            }
          })
          .catch(() => {
            Message.error('Server Error!')
          })
      }
    }),
    //这里是自定义按钮
  setup: function (editor) {
    editor.ui.registry.addButton('fillButton', {
      text: '自定义按钮',
      tooltip: '给填空题增加一个空',
      onAction: () => {
        editor.insertContent(' ____ ')
      }
    })
  }
})
const editorRef = ref(null)
// 外部传递进来的数据变化
const myValue = computed({
  get() {
    return props.modelValue
  },
  set(val) {
    emits('update:modelValue', val)
  }
})

// 监听富文本中的数据变化
watch(
  () => myValue.value,
  v => {
    // 获取富文本框的内容 window系统下 tinymce富文本编辑器在搜狗输入法下placeholder不消失现象
    if (window.tinymce?.Env.os.isWindows()) {
      if (v && editorRef) {
        editorRef.value.getEditor()?.contentDocument?.body.removeAttribute('data-mce-placeholder')
      } else {
        editorRef.value.getEditor()?.contentDocument?.body.setAttribute('data-mce-placeholder', props.placeholder)
      }
    }
    emits('setHtml', tinymce.activeEditor.getContent({ format: 'text' }), myValue.value)
  }
)

// 设置编辑器只读模式
watch(
  () => props.readonly,
  (newValue, oldValue) => {
    nextTick(() => {
      tinymce.activeEditor.mode.set(newValue ? 'readonly' : 'design')
      const iframeDom = document.querySelector('iframe')
      iframeDom && (iframeDom.contentWindow.document.body.style.margin = newValue ? 0 : '16px')
    })
  },
  { immediate: true }
)

// 初始化编辑器
onMounted(() => {
  tinymce.init({})
})

// 设置值
const handleSetContent = content => {
  tinymce.activeEditor.setContent(content)
}

// 获取值
const handleGetContent = () => {
  return tinymce.activeEditor.getContent()
}

defineExpose({
  handleSetContent,
  handleGetContent
})
</script>

<style lang="scss" scoped>
:deep(.tox-tinymce) {
  border: 1px solid #dcdfe6;
  border-radius: 4px;

  .tox-statusbar {
    display: none;
  }
}
</style>