前言
tinyMCE中的API分为六大类,分别是tinymce、tinymce.dom、tinymce.editor.ui、tinymce.geom、tinymce.html、tinymce.util,顾名思义,分类依据是其作用以及其从属。
tinymce是国外的富文本编辑器,所以文档是英文的,有国内伙伴已经翻译为中文,但API部分未做翻译,挂的是原英文部分的链接,当然,开发的小伙伴们,这一点点英文不成问题,写这篇的目的主要是为了记录自己的使用过程,顺便分享。
所有API太多,我将每部分写成一篇文档,所有文章可从以下链接跳转
tinymce
tinymce.dom
tinymce.editor.ui
tinymce.geom
tinymce.html
tinymce.util
插曲
tinymce的使用过程在我另一篇文章中有介绍,链接如下
本篇只记录所有API中的method,相关属性可以查看原文档,链接
tinymce API英文文档
目前有一些内容是照搬翻译原文档的内容,有一下我自己使用过的我会在其中加详细的注解,持续更新ing…
tinymce API
这部分api主要用来操作编辑器实例
tinymce部分
add
将编辑器实例添加到编辑器集合中。这也会将其设置为活动编辑器。
addI18n
添加一个语言包,这会被加载的语言文件(如en.js)调用。
create
创建类、子类或静态单例。
TinyMCE 5.10中已弃用,TinyMCE 6.0中已标记为删除。
createEditor
创建编辑器实例并将其添加到EditorManager集合中。
createNS
在特定对象上创建命名空间。
TinyMCE 5.10中已弃用,TinyMCE 6.0中已标记为删除。
each
对集合中的所有项(如对象或数组)执行迭代。此方法将为集合中的每个项执行回调函数,如果回调返回false,则迭代将终止。回调的格式如下:cb(value,key_or_index)。
execCommand
在当前活动的编辑器上执行特定命令。
explode
拆分字符串,但删除每个值前后的空白。
// Split a string into an array with a,b,c
var arr = tinymce.explode('a, b, c');
get
返回给定id的编辑器实例。
// Adds an onclick event to an editor by id
tinymce.get('mytextbox').on('click', function(e) {
ed.windowManager.alert('Hello world!');
});
// Adds an onclick event to an editor by index
tinymce.get(0).on('click', function(e) {
ed.windowManager.alert('Hello world!');
});
// Adds an onclick event to an editor by id (longer version)
tinymce.EditorManager.get('mytextbox').on('click', function(e) {
ed.windowManager.alert('Hello world!');
});
grep
返回给定id的编辑器实例。通过为每个项调用指定的函数,从输入数组中筛选出项。如果函数返回false,则该项将被排除;如果函数返回true,则该项目将被包括在内。
// Filter out some items, this will return an array with 4 and 5
var items = tinymce.grep([1,2,3,4,5], function(v) {return v > 3;});
hasOwnProperty
JavaScript不保护hasOwnProperty方法,因此可以覆盖它。这是一个独立于对象的版本。检查输入对象“obj”是否具有属性“prop”。
inArray
inArray(item:any, arr:Array):Number
返回项的索引,如果数组中不存在项,则返回-1。
init
初始化一组编辑器。此方法将基于各种设置创建编辑器。
// Initializes a editor using the longer method
tinymce.EditorManager.init({
some_settings : 'some value'
});
// Initializes a editor instance using the shorter version and with a promise
tinymce.init({
some_settings : 'some value'
}).then(function(editors) {
...
});
is
is(obj:Object, type:string):Boolean
检查对象是否为特定类型,例如数组。
sArray
如果对象是否为数组,则返回true/false。
makeMap
makeMap(items:Array, delim:String, map:Object):Object
从具有名称的数组中生成名称/对象映射。
map
map(array:Array, callback:function):Array
通过每次迭代函数调用的返回值创建一个新数组。这使您能够将一个数组列表转换为另一个。
overrideDefaults
overrideDefaults(defaultSettings:Object)
覆盖编辑器实例的默认设置。
remove
删除一个或多个编辑器表单页。
// Remove all editors bound to divs
tinymce.remove('div');
// Remove all editors bound to textareas
tinymce.remove('textarea');
// Remove all editors
tinymce.remove();
// Remove specific instance by id
tinymce.remove('#id');
resolve
解析字符串并返回特定结构中的对象。
// Resolve a path into an object reference
var obj = tinymce.resolve('a.b.c.d');
setActive
设置活动编辑器实例并激发停用/激活事件。
toArray
将指定的对象转换为实际的JavaScript数组。
translate
translate(text:String):String
使用语言包项翻译指定的字符串。
triggerSave
对集合中的所有编辑器实例调用save方法。当要提交表格时,这可能很有用。
// Saves all contents
tinyMCE.triggerSave();
trim
删除字符串开头和结尾的空白。
walk
walk(o:Object, f:function, n:String, s:String)
为对象树中的每个项执行指定的函数。
AddOnManager部分
待更新文章来源地址https://uudwc.com/A/rZzV6
Annotator部分
待更新文章来源:https://uudwc.com/A/rZzV6
Editor部分
待更新
EditorMode部分
待更新
Env部分
待更新
Event部分
待更新
Formatter部分
待更新
NotificationManager部分
待更新
Plugin部分
待更新
Shortcuts部分
待更新
Theme部分
待更新
UndoManager部分
待更新
WindowManager部分
待更新