基于Draftjs實(shí)現(xiàn)的Electron富文本聊天輸入框

基于Electron的一個(gè)即時(shí)通訊PC端軟件田柔,輸入框是最基本的組件俐巴。起初只通過 textarea<img>兩標(biāo)簽的動(dòng)態(tài)切換來實(shí)現(xiàn)基本的文字或圖片輸入功能。后續(xù)開發(fā)中硬爆,為實(shí)現(xiàn)@和圖文輸入功能欣舵,決定采用Draftjs去構(gòu)建聊天輸入框

第三方庫

Draftjs

Draft plugins

引用下別人對(duì)Draftjs主要屬性的介紹:

EditorState

EditorState 是一個(gè)用于表示 Editor 組件的頂級(jí)(top-level)狀態(tài)對(duì)象,其內(nèi)容包括:

  • 當(dāng)前文本內(nèi)容狀態(tài)(ContentState)
  • 當(dāng)前選中內(nèi)容狀態(tài)(SelectionState)
  • 所有的內(nèi)容修飾器(Decorator)
  • 撤銷和重做棧
  • 最后一次變更操作的類型

EditorState 有兩個(gè)靜態(tài)的方法用于創(chuàng)建一個(gè)新的對(duì)象:createEmpty 方法和 createWithContent 方法缀磕,其中 createWithContent 會(huì)根據(jù)傳入的 ContentState 來創(chuàng)建對(duì)象缘圈。

EditorState 和 ContentState 都是 Immutable 的對(duì)象,所以 Draft.js 提供 covertToRaw 方法來將 ContentState 對(duì)象轉(zhuǎn)換成 plain JavaScript 對(duì)象袜蚕,從而可以以 JSON 的格式進(jìn)行存取糟把。對(duì)應(yīng)的,convertFromRaw方法可以將 JSON 數(shù)據(jù)轉(zhuǎn)換成 ContentState 對(duì)象牲剃。

ContentState

經(jīng)過 covertToRaw 轉(zhuǎn)換的 JSON 輸出有兩部分組成:blocksentityMap

blocks 是一個(gè)數(shù)組遣疯,每一項(xiàng)代表當(dāng)前內(nèi)容中的一個(gè)塊級(jí)元素(比如標(biāo)題、段落凿傅、列表等)缠犀。其中 text 表示該塊級(jí)元素中的純文本,type 表示該塊級(jí)元素的類型(header-one 表示一級(jí)標(biāo)題狭归、unstyled 表示普通段落、atomic 表示多媒體類的塊級(jí)元素)文判。

在 Draft.js 中过椎,超鏈接、圖片戏仓、視頻等多媒體元素的數(shù)據(jù)通過 Entity 對(duì)象來表示疚宇,而 Entity 的位置信息存儲(chǔ)于 entityRanges 數(shù)組中,其元數(shù)據(jù)可以通過 key 值赏殃,可以在 entityMap 中索引到敷待。

Entity

一個(gè) Entity 對(duì)象表示一段文本(長度可能為 0)的元數(shù)據(jù),所以可以用來表示超鏈接仁热、圖片榜揖、視頻等需要額外數(shù)據(jù)項(xiàng)的多媒體內(nèi)容。該對(duì)象有三個(gè)屬性:

  • 用于表示該 Entity 類型的 type,比如可以取值為 link举哟、image思劳;
  • 根據(jù) Entity 是否可變,mutability 具有三種取值:IMMUTABLE妨猩、MUTABLESEGMENTED;
  • 用于存儲(chǔ) Entity 元數(shù)據(jù)的 data 字段潜叛,比如對(duì)于超鏈接 Entity,應(yīng)該有一個(gè) href 值壶硅;

下面代碼描述了如何創(chuàng)建一個(gè)超鏈接 Entity威兜,并根據(jù)生成的 key 更新 EditorState 對(duì)象:

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對(duì)象,raw.entityMap[0].data.mention對(duì)應(yīng)第一個(gè)mention的Map對(duì)象庐椒,通過get(key)可以獲取該mention對(duì)象的指定key值椒舵。

功能點(diǎn)

  1. 群組@功能
  2. 輸入框支持圖文編輯和發(fā)送
  3. 輸入框支持emoji表情
  4. 鏈接識(shí)別
  5. 草稿
  6. 輸入框支持右擊菜單
  7. 自定義快捷鍵綁定
  8. 文件拖拽的處理
  9. 中文輸入(IME)bug解決

幾個(gè)較為復(fù)雜的功能在后續(xù)文章一一作了詳細(xì)介紹

中文輸入法bug

這是electron 1.6.x上的bug。https://github.com/electron/electron/issues/9380扼睬,作者提到已經(jīng)在1.7.x中修復(fù)

TODO

  1. 圖文的復(fù)制粘貼問題逮栅;
  2. 粘貼gif圖片到輸入框變?yōu)閜ng
  3. @組件在未使用時(shí),也會(huì)捕捉up/down arrow事件窗宇,導(dǎo)致輸入框無法正常表現(xiàn)
  4. 輸入框組件移除再切換回來措伐,decorators和plugins不起作用,移除當(dāng)前會(huì)話后重新打開則正常
  5. 為適應(yīng)草稿军俊,圖片需只以路徑的形式存儲(chǔ)侥加;
  6. focus在輸入框時(shí),表情選擇框彈出交互問題

Bug 解決

  • 輸入框組件移除再切換回來粪躬,decorators和plugins不起作用担败,移除當(dāng)前會(huì)話后重新打開則正常

    分析:受影響的是draft plugins庫提供的plugins和decorators兩個(gè)屬性,draftjs提供的功能均正常镰官;因此主要查看draft plugin的issue提前。

    issue里有很多相關(guān)但都沒有準(zhǔn)確解決方案的問題,https://github.com/draft-js-plugins/draft-js-plugins/issues/251

    draft plugin的Editor是在componentWillMount的方法里去注冊(cè)decorators泳唠,issue里提到注冊(cè)的時(shí)候需要正確的EditorState狈网。修改如下:

    let initialDraft = null;
    
    // 根據(jù)issue, 這里需重設(shè)editorState,否則出現(xiàn)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組件里添加了對(duì)componentWillMount方法的重寫笨腥,通過EditorState.push去重設(shè)editorState拓哺。同時(shí)記錄了Mount時(shí)的draft值,避免在componentWillReceiveProps重復(fù)賦值脖母。

    問題是解決了士鸥,但原因并不是很清楚

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市谆级,隨后出現(xiàn)的幾起案子烤礁,更是在濱河造成了極大的恐慌讼积,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,311評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件鸽凶,死亡現(xiàn)場離奇詭異币砂,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)玻侥,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門决摧,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人凑兰,你說我怎么就攤上這事掌桩。” “怎么了姑食?”我有些...
    開封第一講書人閱讀 152,671評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵波岛,是天一觀的道長。 經(jīng)常有香客問我音半,道長则拷,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,252評(píng)論 1 279
  • 正文 為了忘掉前任曹鸠,我火速辦了婚禮煌茬,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘彻桃。我一直安慰自己坛善,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5 371
  • 文/花漫 我一把揭開白布邻眷。 她就那樣靜靜地躺著眠屎,像睡著了一般。 火紅的嫁衣襯著肌膚如雪肆饶。 梳的紋絲不亂的頭發(fā)上改衩,一...
    開封第一講書人閱讀 49,031評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音驯镊,去河邊找鬼葫督。 笑死,一個(gè)胖子當(dāng)著我的面吹牛阿宅,可吹牛的內(nèi)容都是我干的候衍。 我是一名探鬼主播笼蛛,決...
    沈念sama閱讀 38,340評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼洒放,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼!你這毒婦竟也來了滨砍?” 一聲冷哼從身側(cè)響起往湿,我...
    開封第一講書人閱讀 36,973評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤妖异,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后领追,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體他膳,經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2 323
  • 正文 我和宋清朗相戀三年绒窑,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了棕孙。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡些膨,死狀恐怖蟀俊,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情订雾,我是刑警寧澤肢预,帶...
    沈念sama閱讀 33,701評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站洼哎,受9級(jí)特大地震影響烫映,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜噩峦,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3 307
  • 文/蒙蒙 一锭沟、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧壕探,春花似錦冈钦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至导盅,卻和暖如春较幌,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背白翻。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來泰國打工乍炉, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人滤馍。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2 354
  • 正文 我出身青樓岛琼,卻偏偏與公主長得像,于是被迫代替她去往敵國和親巢株。 傳聞我的和親對(duì)象是個(gè)殘疾皇子槐瑞,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容