仅用1行核心JS代码实现一个轻量级富文本编辑器

欢迎光临我的博客拓跋的前端客栈,这个是原文地址。如果您发现我文章中存在错误,请尽情向我吐槽,大家一起学习一起进步φ(>ω<*)

引子


富文本编辑器是我们在生活中非常常用到的编辑工具,现在有很多功能完备且强大的编辑器,比如Quill Rich Text Editorueditor等,都是很优秀的富文本编辑器。甚至说我们每个人都会用到的word,才是最优秀、国民度最高的富文本编辑器。

今天我们要实现一个轻量级的编辑器,主要利用的是document.execCommand

当一个HTML文档切换到设计模式(designMode)时,文档对象暴露 execCommand方法,该方法允许运行命令来操纵可编辑区域的内容。大多数命令影响文档的选择(粗体,斜体等),而其他命令插入新元素(添加链接)或影响整行(缩进)。当使用 contentEditable时,调用 execCommand() 将影响当前活动的可编辑元素。

用document.execCommand和contentEditable相互配合,就可以实现我们想要实现的功能。

在查阅了execCommand的文档后,我们决定实现以下功能

  1. 选中文字样式调整
    • 斜体
    • 粗体
    • 下划线
    • 删除线
  2. 对齐方式调整
    • 左对齐
    • 右对齐
    • 居中
    • 两端对齐
  3. 缩进调整
    • 右缩进
    • 左缩进
  4. 列表操作
    • 有序列表
    • 无序列表
  5. 上下标
  6. 文字操作
    • 全选
    • 复制
    • 粘贴
  7. 基本的字号调整
  8. 基本的颜色调整
  9. 基本的字体调整
  10. undo&redo

实现


说到编辑器,最基本的会分为上下两部分

  • 上部分为控制区域,用于对文本进行各种控制修改
  • 下部分为文本区域,用于输入和展示文本的样式

因此我们可以先在HTML里把两部分简单画出来

<div id="wrapper">
    <div id="control-area"></div>
    <div id="text-area" contenteditable></div>
</div>

注意,既然文本区域要可编辑,要加上contenteditable属性,这样就可以自如的在文本区域输入文字了。OK,编辑器雏形已经出来了~

接下来要对两部分分别进行操作,在控制区域,应该就是各种按钮。参考document.execCommand的语法:


execCommand.png

主要控制到样式的有两个api:aCommandName和aValueArgument。同时,命令名aCommandName每条execCommand都会有,aCommandName和aValueArgument。因此我们需要在每个按钮上传递两个变量。第一个是必填项aCommandName,第二个是选填项aValueArgument。我们考虑采用HTML5的新属性data-*传递这两个参数:

    <!--调整为斜体-->
    <a href="#" data-command='italic' onclick="changeStyle(this.dataset)">斜体</a>
    <!--调整字号为1号-->
    <a href="#" data-command='fontSize' data-value="1" onclick="changeStyle(this.dataset)">1号</a>

上面是两个基本按钮示例,一个是不传参的,一个是传参的,然后在js端做一个判断即可实现功能:

    const changeStyle = (data) => {
        //一行核心代码即可实现基本编辑器功能
        data.value? document.execCommand(data.command, false, data.value):document.execCommand(data.command, false, null)
    }

是不是很简单呢?

最后,只有两个按钮肯定是不够的,我们要把按钮数和编辑器的功能扩充丰富起来。我们就按照第一节整理的决定要实现的功能列表列出来的功能,按照分类,一一来实现。最后,再把按钮和文本区域的样式美化一下,即可实现我们这个轻量级富文本编辑器啦~

这是我们的预览图:


zEditor.png

大家可以访问我的博客尝试一下这个小小富文本编辑器,也希望能去我的github项目上点颗star,谢谢啦~

结语


实际上,我们这个富文本编辑器是一种最最简单的实现,仅仅是对contentEditable和document.execCommand进行了一层封装,所有的样式实现都是调用的这同一条api。

在当前流行的真正功能强大的富文本编辑器中,基本都是实现了自己的contentEditable,抛弃了对浏览器原生的contentEditable特性的依赖。大家都说富文本编辑器是个天坑,事实也正是如此,原生的document.execCommand实现的功能太少,BUG太多,如果使用自己写的功能来编辑文字,又会破坏contentEditable的undo/redo栈。总之,contentEditable最大的特点就是样式、html语意环境跟调用页面混合在一起,非常容易出现覆盖现象,而牛逼的富文本编辑器基本上都会使用一套自己的事件监听机制来实现类似contentEditable的功能,这些东西太繁琐太复杂,不在这里的讨论范围之内了~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容