Tinymce - 宇宙第一富文本编辑器？[1]

时间  2019-11-05
标签 tinymce 宇宙 第一 文本编辑器 繁體版
原文   原文链接

Tinymce

tinymce是一款基础组件十分丰富，不断维护更新的富文本编辑器。在它的Github项目简介中如此描述本身：javascript

The world's #1 JavaScript library for rich text editing. Available for React, Vue and Angularcss

简而言之: 我是宇宙第一的编辑器，我支持当前最流行的三个框架。html

我会分红3篇文章介绍：java

  1. 编辑器的基本使用和一些简单插件的配置
  2. 一些复杂插件的配置，和集成Vue
  3. 编写自定义插件

Why Tinymce

  • 基础组件丰富，简单配置便可使用；
  • 自己有收费版和免费版，可盈利性保证了其持续维护和创新，开发版其实也彻底够用；
  • 提供的开发拓展API也比较简单，适合持续集成；
  • 开发文档虽然是英文版，但言简意赅，示例丰富，而且跟随版本实时更新，对比市面上其余编辑器好太多了

开始使用

本文使用的版本是 5.0.13jquery

安装

Tinymce的核心文件和插件、皮肤、主题样式等文件都是分离的，使用时，只需在HTML中引入核心文件（tinymce.js）便可。git

<script src="https://fe.120yibao.com/common/tinymce/5.0.13/tinymce.min.js"></script>
复制代码

在生成新的编辑器实例时，须要传入配置文件，tinymce会根据配置自动引入对应的插件、皮肤、主题文件，默认使用相对路径（相对于与tinymce.js）的方式。github

const editor = Tinymce.init({
    //会自动引入link插件
    // https://fe.120yibao.com/common/tinymce/5.0.13/plugins/link/plugin.min.js
    plugins: ['link'],  
    //会自动引入silver主题
    // https://fe.120yibao.com/common/tinymce/5.0.13/themes/silver/theme.min.js
    theme: 'silver',
    //会自动引入oxide皮肤
    // https://fe.120yibao.com/common/tinymce/5.0.13/skins/ui/oxide/skin.min.css
    skin: "oxide"
})
复制代码

而这些相对路径的关系，跟npm包的对应关系是同样的。npm

npm i tinymce
复制代码

咱们看下npm包的目录结构bash

.
├── jquery.tinymce.js
├── jquery.tinymce.min.js
├── plugins
│   ├── advlist
│   │   ├── index.js
│   │   ├── plugin.js
│   │   └── plugin.min.js
│   ├── anchor
│   │   ├── index.js
│   │   ├── plugin.js
│   │   └── plugin.min.js
│   ├── autolink
│   │   ├── index.js
│   │   ├── plugin.js
│   │   └── plugin.min.js
├── skins
│   ├── content
│   │   ├── default
│   │   │   ├── content.css
│   │   │   └── content.min.css
│   │   ├── document
│   │   │   ├── content.css
│   │   │   └── content.min.css
│   │   └── writer
│   │       ├── content.css
│   │       └── content.min.css
│   └── ui
│       ├── oxide
│       │   ├── content.css
│       │   ├── content.inline.css
│       │   ├── content.inline.min.css
│       │   ├── content.min.css
│       │   ├── content.mobile.css
│       │   ├── content.mobile.min.css
│       │   ├── fonts
│       │   │   └── tinymce-mobile.woff
│       │   ├── skin.css
│       │   ├── skin.min.css
│       │   ├── skin.mobile.css
│       │   └── skin.mobile.min.css
│       └── oxide-dark
│           ├── content.css
│           ├── content.inline.css
│           ├── content.inline.min.css
│           ├── content.min.css
│           ├── content.mobile.css
│           ├── content.mobile.min.css
│           ├── fonts
│           │   └── tinymce-mobile.woff
│           ├── skin.css
│           ├── skin.min.css
│           ├── skin.mobile.css
│           └── skin.mobile.min.css
├── themes
│   ├── mobile
│   │   ├── index.js
│   │   ├── theme.js
│   │   └── theme.min.js
│   └── silver
│       ├── index.js
│       ├── theme.js
│       └── theme.min.js
├── tinymce.js
└── tinymce.min.js

复制代码

CDN

因此，若是要使用CDN的方式使用tinymce的话，直接安装这个目录格式上传便可。app

npm

也可使用npm进行引入，可是每一个插件、主题、皮肤都要单独引入，比较麻烦，不建议使用。

// Import TinyMCE
import tinymce from 'tinymce/tinymce';

// A theme is also required
import 'tinymce/themes/silver';

// Any plugins you want to use has to be imported
import 'tinymce/plugins/paste';
import 'tinymce/plugins/link';

// Initialize the app
tinymce.init({
  selector: '#tiny',
  plugins: ['paste', 'link']
});
复制代码

快速开始

<template>
	<div class="default-tinymce">
		<textarea id="editor"></textarea>
	</div>
</template>
<script> import Tinymce from 'tinymce' export default { name: 'DefaultTinymce', mounted () { Tinymce.init({ selector: '#editor' }) } } </script>
复制代码

  • 此示例只配置了惟一的必填配置selector，即textarta元素的标识，此参数值支持相似于CSS选择器的参数格式。

  • 此示例除了使用了入口文件(tinymce.js)，也会引入默认的主题和皮肤文件。

  • 初始化成功后，textarea的值会与一个iframe绑定，在富文本编辑区域的操做，其实都是在iframe中的操做，而内容则会自动同步到textarea里。

三种模式

tinymce 有三种模式可选：经典模式(classic，默认)、行内模式(inline)、清爽模式(Distraction-free)。

经典模式是最多见的，也就是工具栏搭配输入区域，经过工具栏的按钮插入、修改、格式化内容，咱们也选用这种模式做为业务的主要模式。

后两种模式也各有特色，可是与咱们实际的应用场景不太匹配，故再次很少作介绍。有兴趣能够自行了解。

多个编辑器

若是一个页面中须要多个编辑器，有两种方法：

一个是结合className选择器，使用一次 tinymce 的 init 方法，生成多个实例，多个实例会共用一套配置；

示例代码：

<template>
	<div class="default-tinymce">
        <h2>编辑器1</h2>
		<textarea class="editor"></textarea>
        <h2>编辑器2</h2>
		<textarea class="editor"></textarea>
	</div>
</template>
<script> import Tinymce from 'tinymce' export default { mounted () { Tinymce.init({ selector: '.editor' }) } } </script>

复制代码

另外一种是，须要几个编辑器，便使用tinymce 的 init 方法生成几种实例，生成的实例彼此无关

示例代码：

<template>
	<div class="default-tinymce">
        <h2>编辑器1</h2>
		<textarea class="editor1"></textarea>
        <h2>编辑器2</h2>
		<textarea class="editor2"></textarea>
	</div>
</template>
<script> import Tinymce from 'tinymce' export default { mounted () { Tinymce.init({ selector: '.editor1' }) Tinymce.init({ selector: '.editor2' }) } } </script>

复制代码

编辑器配置

配置语言

能够将编辑器的语言配置为中文

tinymce.init({
    selector: '#myTextarea',
    language: 'zh_CN'
})

复制代码
  • 能够设置language_url，覆盖默认地址。
tinymce.init({
    selector: '#myTextarea',
    language_url: 'https://fe.120yibao.com/common/tinymce/5.0.13/langs/zh_CN_01.js'
})
复制代码
  • 也能够在项目中配置语言文件：
import Language from './language'
Tinymce.addI18n('zh_CN_01', Language)

tinymce.init({
    selector: '#myTextarea',
    language: 'zh_CN_01'
})
复制代码

附：官方多语言文件下载地址

基础配置

如下配置大体涵盖了tinymce的基础配置，具体我会分章节在下面说明

tinymce.init({
    selector: '#myTextarea',
    // 编辑器的皮肤，有 oxide oxide-dark
    skin: 'dark',
    // 编辑器宽高
    width: 600,
    height: 300,
    // 用到的插件
    plugins: [
      'advlist autolink link image lists charmap print preview hr anchor pagebreak spellchecker',
      'searchreplace wordcount visualblocks visualchars code fullscreen insertdatetime media nonbreaking',
      'save table contextmenu directionality emoticons template paste textcolor'
    ],
    // 编辑区域内容样式
    content_css: 'css/content.css',
    // 工具栏的配置项
    toolbar: 'insertfile undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image | print preview media fullpage | forecolor backcolor emoticons'
  });
复制代码

使用插件

除了默认的配置，若是想拓展编辑器的功能，tinymce提供的方式就是插件。

官方的插件很丰富，文档也很详细，大多数状况下，我只须要官方提供的插件便可。

激活插件也很简单，只须要作了相应配置便可。

好比，咱们想要拓展一个查看编辑器内容HTML源码的功能，只须要以下配置：

tinymce.init({
  selector: '#editor',
  plugins: 'code'
})

复制代码

在menubar的位置，多了一个Tool的分组，分组里有一个source code的项，点击便可查看源码

若是咱们不习惯使用menubar，而是习惯使用toolbar,咱们只须要以下配置：

tinymce.init({
  selector: '#editor',
  toolbar: 'code',
  plugins: 'code'
})

复制代码

toolbar位置上多了一个查看源码的图标，点击是相同的功能

有时候，这些基础的功能可能知足不了咱们的需求，咱们可能对这些插件进行配置。

tinymce.init({
  selector: '#editor',
   toolbar: "numlist bullist",
  plugins: 'lists'
})

复制代码

示例中，咱们配置了list组件，它支持无序(ul)列表和有序列表的功能，可是列表样式是固定的，咱们能够引入新的插件advlist，并配置

tinymce.init({
  selector: '#editor',
  toolbar: 'bullist numlist',
  plugins: 'lists advlist'
})
复制代码

此时，咱们发现咱们能够选择样式了，有多种样式供咱们选择，若是咱们想固定某种样式，咱们能够这样配置：

tinymce.init({
  selector: '#editor',
  toolbar: 'bullist numlist',
  plugins: 'lists advlist',
  advlist_number_styles: 'lower-alpha'
})
复制代码

咱们发现可选项只有一个了

每一个插件有哪些配置项、配置参数和配置值，官方文档中都有详细的描述

自定义编辑器UI

theme 和 skin 咱们直接使用默认的便可，无需折腾。

从上面的示例中，咱们也知道基本上全部东西咱们均可以去自定义的，好比隐藏不使用的menubar、调整按钮在toolbar中的位置等。

tinymce.init({
  selector: '#editor',
  // 隐藏menubar
  menubar: false,
  // 隐藏 statusbar
  statusbar: false,
  // 隐藏品牌标识
  branding: false,
  // 设置最大宽高
  max_height: 500,
  max_width: 500,
  // 设置最小宽高
  min_height: 100,
  min_width: 400
})

复制代码

这些配置不过重要，通常一次配置以后就不会有改动。

插件配置

这里会写一下编辑器用到的插件的介绍、配置、和使用，太简单的插件和没用到的插件不在此说明。

Advanced Code Editor

此插件为付费插件

此插件可美化代码预览时候的视图，而且还有收起/展开标签的功能。配置此插件后，须要移除code插件。

tinymce.init({
  selector: "textarea",  // change this value according to your HTML
  plugins: "advcode",
  toolbar: "code"
});
复制代码

AutoLink

此插件可在输入形如「www.qq.com」的连接时，自动将文本转化为超连接，空格和换行键均可以触发

tinymce.init({
  selector: "textarea",  // change this value according to your HTML
  plugins: "autolink"
});
复制代码

nonbreaking

键盘的Tab键，默认是切换到下一个元素的focus。此能够改变这个默认行为。

须要注意的是，table插件中也有改变改默认行为的代码，因此要在table插件以后引用该插件。

tinymce.init({
  selector: "textarea",  // change this value according to your HTML
  plugins: "nonbreaking",
  // 此配置会改变默认行为，会在光标以后添加三个空格。
  nonbreaking_force_tab: true
});
复制代码

autosave

此插件会自动保存编辑器的内容到localStorage。会同时存储两个字段，一个是内容，一个是存储时间。

能够配置自动保存的时间间隔，通常以秒为单位；也能够配置内容存储的过时时间，通常以分钟为单位，超过这个时间段，数据会从localStorage中被清除。

tinymce.init({
  selector: "textarea",  // change this value according to your HTML
  plugins: "autosave",
  // 自动保存的时间间隔
  autosave_interval: '30s',
  // 自动保存的数据存储的最大时间
  autosave_retention: '30m'
});
复制代码

powerpaste

此插件为付费插件

此插件能够保留剪切板内容的样式、文档结构。

tinymce.init({
  selector: "textarea",  // change this value according to your HTML
  plugins: "powerpaste",
  /** * 粘贴前是否保留文本样式 * @param 'clean' 不保留 * @parma 'merge' 保留 * @parma 'prompt' 询问用户 */
  powerpaste_word_import: 'prompt',
  powerpaste_html_import: 'prompt',
  /** * 在粘贴到富文本以前,能够修改粘贴的内容。内容已经DOM格式化 * @param plugin * @param args * @returns {Promise<void>} */
  paste_postprocess (plugin, args) {}
});
复制代码

下一篇：Tinymce - 宇宙第一富文本编辑器？[2]

参考

  1. tinymce官方文档
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程