基于Draftjs实现的Electron富文本聊天输入框(三) —— Emoji

Emoji

在Draftjs plugins中,emoji plugin是基于EmojiOne这个库。本项目中是使用的本地图片,通过中文含义与图片一一映射实现。因此,之前emoji在输入框是显示对应的文本。

_emojiMap为存储emoji id和中文名称映射关系的对象,

onAddEmoji为添加emoji表情到输入框的方法,根据id返回[name];改为getEmojiById直接返回对于html字符串

// 添加emoji对应文本
  appendEmoji(emojiText) {
    console.log('emoji', emojiText);
    const editorState = this.state.editorState;
    const selection = editorState.getSelection();
    const contentState = editorState.getCurrentContent();
    const ncs = Modifier.insertText(contentState, selection, emojiText);
    const newEditorState = EditorState.push(editorState, ncs, 'insert-fragment');
    this.onChange(newEditorState);
  }

通过Modifier的insertText方法将emoji文本插入输入框,但到这里效果也和之前一样,只是显示了表情对应的中文,如[开心]

Draftjs提供了修饰器Decorators这个概念,根据自定义正则去扫描文本快中的内容,然后根据自定义的样式去渲染,可用来高亮文本等。

// 针对emoji的修饰器
const findWithRegex = (regex, contentBlock, callback) => {
  const text = contentBlock.getText();
  let matchArr;
  let start;
  while ((matchArr = regex.exec(text)) !== null) {
    start = matchArr.index;
    callback(start, start + matchArr[0].length);
  }
};

const draftDecorator = new CompositeDecorator([
  {
    strategy: (contentBlock, callback, contentState) => {
      const emojiRegex = /\[[^\[\]]+\]/g;
      findWithRegex(emojiRegex, contentBlock, callback);
    },
    component: (props) => {
      const text = props.decoratedText.trim();
      console.log('decorated text', text);
      return <span data-offset-key={props.offsetKey}>{props.children}</span>;
    },
  },
]);
  • 坑1:实际将改decorators传进去报错了,因为Editor组件是引用的draft-js-plugins-editor,这是它们的一个bug,issue里给出的解决方案是:

    import { CompositeDecorator } from 'draft-js';
    import MultiDecorator from 'draft-js-plugins-editor/lib/Editor/MultiDecorator';
    
    ....
    const createDecorator = (...) => {
        const decorators = ...;
        return new MultiDecorator([new CompositeDecorator(decorators)]);
    };
    

  • 坑2:decorators虽然帮助扫描文本中的表情字符并替换了样式,但替换后不会自动Focus,且无法作为一个字符去选择,不同于标准emoji的做法,都有对应的unicode...

  • 坑3:当选中一段文本再调用Modifier.insertText()方法去插入文本时,会报Target range must be collapsed for insertText错误;

  • 坑4:自定义的decorators注册到输入框后,与mention插件冲突,导致mention失效...

    issue: https://github.com/draft-js-plugins/draft-js-plugins/issues/395

    const customDecorators = [
      {
        strategy: findLinkEntities,
        component: Link,
      },
    ];
    
    // Editor accepts a prop called decorators. 
    const MyEditor = ({ editorState, onChange }) => (
      <Editor
        editorState={editorState}
        onChange={onChange}
        decorators={customDecorators}
        plugins={[plugin1, plugin2]}
      />
    );
    

emoji优化

  1. 因decorator只是替换了block中对应文本的样式,实际仍未对应字符的占位,而项目目前采用[xx]的格式表示一个emoji表情,可以考虑再设计一层map映射,对应一个标准emoji的unicode,这样在插入到输入框时,emoji对应的文本只占一个字符。

    /**
     * 映射的emoji unicode范围为\u1f600 - \u1f64f
     */
    module.exports.getEmojiUnicode = function(id) {
      const i = parseInt(id);
      const emojiInt = 0x1f600 + i - 1;
      const code16 = emojiInt.toString(16);
      const emojiUnicode = unescape('%u' + code16);
      return emojiUnicode;
    };
    
    module.exports.getIdByUnicode = function(unicode) {
      const codeStr = escape(unicode);
      const code16 = codeStr.split('%u')[1];
      const id = parseInt('0x'+ code16) - parseInt(0x1f600);
      return id + 1;
    };
    

    首先在网上查找了unicode中emoji主要存在的范围,这里限定了\u1f600 - \u1f64f大概80个unicode,

    对16进制int进行计算(0x),再通过toString(16)转为16进制的字符串。一开始直接用'\u'.concat(code16)的方法会报错,因为\u是转义符,不能直接作为字符串使用。其对应%u的反转义结果;

  2. 参考企业微信PC的做法,在检测到输入框有emoji时,改变了行高,字体大小不变,行高适应emoji大小(TODO)

  3. 实际做下来,优化1并不适用,最终还是选择再建立一层emoji id和uniocde的映射。

    修改emoji的decorator中的正则:

    const emojiRegex = /[\u2600-\u2665]/g;
    

    到这里已经基本解决了emoji在Draftjs中的显示问题。但实际输出的文本里,emoji是其对应的unicode,因此还需要在获取输入框内容时,添加对文本的转换:

    // 对文本进行正则匹配,替换unicode为对应emoji
      parseContentWithEmoji(content) {
        const regex = /[\u2600-\u2665]+/g;
        const unicodeArr = content.match(regex);
        if (unicodeArr === null) {
          return content;
        }
        unicodeArr.forEach((unicode) => {
          const id = emoji.getIdByUnicode(unicode);
          if (!!id) {
            const text = emoji.getEmojiText(id);
            const replaceReg = new RegExp(unicode+ ' ', 'g');
            content = content.replace(replaceReg, text);
            console.log('replace '+ unicode+ 'by '+ text);
          }
        });
        return content;
      }
    

    先对文本进行match匹配,获取文本中所有需要转换的unicode数组,对数组进行遍历,获取unicode对应的emoji文本,同时使用replace将unicode替换之;

  4. 实现上述优化后,emoji已能够正常显示到输入框和发送出去,但仍忽略了复制粘贴带有emoji文本的情况, 因为复制得到的emoji对应的是[xx]格式,需要在输入框的handlePastedText事件中添加对包含emoji文本的处理:

     // 替换emojiText为对应unicode
      parseContentWithEmojiText(text) {
        const regex = /\[[^\[\]]+\]+/g;
        const emojiTextArr = text.match(regex);
        if (emojiTextArr === null) {
          return text;
        }
        text = text.replace(/\[+/g, '');
        text = text.replace(/\]+/g, '');
        emojiTextArr.forEach((emojiText) => {
          const id = emoji.getEmojiIdByText(emojiText);
          if (!!id) {
            const unicode = emoji.getEmojiUnicode(id);
            const replaceText = emojiText.substr(1, emojiText.length-2);
            const replaceReg = new RegExp(replaceText, 'g');
            text = text.replace(replaceReg, unicode +' ');
          }
        });
        return text;
      }
    
  5. 在实现4时,发现新的问题,当选中输入框中部分文本后再粘贴,Modifier.insertText()方法会报错:

    Target range must be collapsed for `insertText`
    

    查看Api得知这种情况下需使用Modifier.replaceText(), 封装输入框添加文本方法如下:

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

推荐阅读更多精彩内容