基于Draftjs实现的Electron富文本聊天输入框

基于Electron的一个即时通讯PC端软件,输入框是最基本的组件。起初只通过 textarea<img>两标签的动态切换来实现基本的文字或图片输入功能。后续开发中,为实现@和图文输入功能,决定采用Draftjs去构建聊天输入框

第三方库

Draftjs

Draft plugins

引用下别人对Draftjs主要属性的介绍:

EditorState

EditorState 是一个用于表示 Editor 组件的顶级(top-level)状态对象,其内容包括:

  • 当前文本内容状态(ContentState)
  • 当前选中内容状态(SelectionState)
  • 所有的内容修饰器(Decorator)
  • 撤销和重做栈
  • 最后一次变更操作的类型

EditorState 有两个静态的方法用于创建一个新的对象:createEmpty 方法和 createWithContent 方法,其中 createWithContent 会根据传入的 ContentState 来创建对象。

EditorState 和 ContentState 都是 Immutable 的对象,所以 Draft.js 提供 covertToRaw 方法来将 ContentState 对象转换成 plain JavaScript 对象,从而可以以 JSON 的格式进行存取。对应的,convertFromRaw方法可以将 JSON 数据转换成 ContentState 对象。

ContentState

经过 covertToRaw 转换的 JSON 输出有两部分组成:blocksentityMap

blocks 是一个数组,每一项代表当前内容中的一个块级元素(比如标题、段落、列表等)。其中 text 表示该块级元素中的纯文本,type 表示该块级元素的类型(header-one 表示一级标题、unstyled 表示普通段落、atomic 表示多媒体类的块级元素)。

在 Draft.js 中,超链接、图片、视频等多媒体元素的数据通过 Entity 对象来表示,而 Entity 的位置信息存储于 entityRanges 数组中,其元数据可以通过 key 值,可以在 entityMap 中索引到。

Entity

一个 Entity 对象表示一段文本(长度可能为 0)的元数据,所以可以用来表示超链接、图片、视频等需要额外数据项的多媒体内容。该对象有三个属性:

  • 用于表示该 Entity 类型的 type,比如可以取值为 linkimage
  • 根据 Entity 是否可变,mutability 具有三种取值:IMMUTABLEMUTABLESEGMENTED;
  • 用于存储 Entity 元数据的 data 字段,比如对于超链接 Entity,应该有一个 href 值;

下面代码描述了如何创建一个超链接 Entity,并根据生成的 key 更新 EditorState 对象:

const contentState = editorState.getCurrentContent();
const contentStateWithEntity = contentState.createEntity(
  'LINK',
  'MUTABLE',
  {url: 'https://myanbin.github.io/'}
);
const entityKey = contentStateWithEntity.getLastCreatedEntityKey();
const newEditorState = EditorState.set(editorState, { currentContent: contentStateWithEntity });
RichUtils.toggleLink(newEditorState, newEditorState.getSelection(), entityKey);

e.g : 如获取mention插件的Mention对象,raw.entityMap[0].data.mention对应第一个mention的Map对象,通过get(key)可以获取该mention对象的指定key值。

功能点

  1. 群组@功能
  2. 输入框支持图文编辑和发送
  3. 输入框支持emoji表情
  4. 链接识别
  5. 草稿
  6. 输入框支持右击菜单
  7. 自定义快捷键绑定
  8. 文件拖拽的处理
  9. 中文输入(IME)bug解决

几个较为复杂的功能在后续文章一一作了详细介绍

中文输入法bug

这是electron 1.6.x上的bug。https://github.com/electron/electron/issues/9380,作者提到已经在1.7.x中修复

TODO

  1. 图文的复制粘贴问题;
  2. 粘贴gif图片到输入框变为png
  3. @组件在未使用时,也会捕捉up/down arrow事件,导致输入框无法正常表现
  4. 输入框组件移除再切换回来,decorators和plugins不起作用,移除当前会话后重新打开则正常
  5. 为适应草稿,图片需只以路径的形式存储;
  6. focus在输入框时,表情选择框弹出交互问题

Bug 解决

  • 输入框组件移除再切换回来,decorators和plugins不起作用,移除当前会话后重新打开则正常

    分析:受影响的是draft plugins库提供的plugins和decorators两个属性,draftjs提供的功能均正常;因此主要查看draft plugin的issue。

    issue里有很多相关但都没有准确解决方案的问题,https://github.com/draft-js-plugins/draft-js-plugins/issues/251

    draft plugin的Editor是在componentWillMount的方法里去注册decorators,issue里提到注册的时候需要正确的EditorState。修改如下:

    let initialDraft = null;
    
    // 根据issue, 这里需重设editorState,否则出现decorators失效问题
    componentWillMount() {
        if (!!this.props.draft) {
          initialDraft = this.props.draft;
          this.setStateWithDraft(this.props.draft);
        } else {
          this.setEmptyState();
        }
      }
    
    componentWillReceiveProps(nextProps) {
        .......
        
        if (this.props.draft && nextProps.draft && initialDraft !== nextProps.draft) {
          this.setStateWithDraft(nextProps.draft);
        }
      }
    
    

    在自定义的Editor组件里添加了对componentWillMount方法的重写,通过EditorState.push去重设editorState。同时记录了Mount时的draft值,避免在componentWillReceiveProps重复赋值。

    问题是解决了,但原因并不是很清楚

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

推荐阅读更多精彩内容