react-monaco-editor 的使用

react-monaco-editor官方git地址

这是我写的一个demo(最新版)

https://github.com/ysk1991/react-monaco-editor

  • 支持光标处插入
  • 支持提示语 输入 sin cos tan 会出现提示语 输入冒号 : 会出现支持的所有提示语

bug描述

  • 遇到一个坑,解决了很久,结果用最蠢的方式,sessionStorage解决的,如果有好的方式请留言

  • 寻找过的解决方案,但是未果,比如在组件componentWillUnmount的时候销毁这个editor,比如react-monaco-editor的api里,源码里寻找editor自带的销毁的方法,销毁的方法有,但是react-monaco-editor并没有封装提供,给我的感觉就是react-monaco-editor 提供的api太少,可能也是我源码看得不够彻底,希望有大神可以指导一下

  • 以下是bug的截图,在使用react-monaco-editor 的自定义按键代码提示时,出现了重复的数据,每一次路由变动,再次进入这个页面时,我的自定义按键提示就会多push一次,数据重复两次


  • 每一次路由变动,我的按键提示就会多push一次,数据重复三次


  • 实现自定义按键提示的方法 以及 bug的解决方式

editorDidMountHandle = async (editor, monaco) => {
    // sessionStorage记录当前我是否来过这个页面 也就是说 是否加载执行过  monaco.languages.registerCompletionItemProvider 
   // 执行过就不再执行 当页面关闭就重新记录 因为多次执行了这个方法导致重复数据
    const isLoadDEditor = sessionStorage.getItem('isLoadDEditor');
    if (!isLoadDEditor) {
      sessionStorage.setItem('isLoadDEditor', true);
      await this.requestList();
      const { suggestions, tipList } = this.state;
      if (suggestions.length) {
        monaco.languages.registerCompletionItemProvider('plaintext', {
          provideCompletionItems() {
           console.log('这个地方,每一次路由变动,就会多执行一次,导致我的按键提示重复展示')
            return {
              suggestions: suggestions.map(item => ({ ...item, kind: monaco.languages.CompletionItemKind.Variable }))
            };
          },
          triggerCharacters: tipList
        });
      }
      this.timeouter = setTimeout(() => {
        editor.getAction('editor.action.formatDocument').run();
      }, 300);
    }
  };
  • 提供以下完整代码
import React from 'react';
import MonacoEditor from 'react-monaco-editor';
import { get_rule_function } from '../../services/api.js';


class DEditor extends React.Component {
  constructor(props) {
    super(props);
    this.state = {
      tipList: [],     // 储存计算框提示语的首字母
      suggestions: [], // 储存提示语
      calculateValue: '',
    };
  }

  componentWillMount() {
    // 拦截判断是否离开当前页面
    window.addEventListener('beforeunload', this.beforeunload);
  }

  componentDidMount() {
    this.setState({
      calculateValue: this.props.calculateValue
    })
  }

  componentWillReceiveProps(nextProps) {
    if (this.state.calculateValue !== nextProps.calculateValue) {
      this.setState({
        calculateValue: nextProps.calculateValue,
      })
    }
  }

  beforeunload() {
    // 如果是刷新页面 清空sessionStorage
    sessionStorage.removeItem('isLoadDEditor');
  }

  // 自定义按键提示的数据请求
  requestList = async () => {
    const list = [];
    const tipList = [':'];
    const res = await get_rule_function()
    if (res.data.responseCode) return
    const responseData = res.data.responseData;
    responseData.map(item => {
      const obj = {};
      obj.label = item.content;
      obj.insertText = item.content;
      obj.detail = item.symbolName;
      list.push(obj);
      tipList.push(item.content.substring(0, 1));
      return null;
    })
    this.setState({
      suggestions: list,
      tipList: tipList
    }) 
  }

  onBlur = () => {
    const { calculateValue } = this.state;
    this.props.value(calculateValue);
    if (calculateValue) {
      this.props.isEditorErrFn(false);
    }
  };

  onChangeHandle = (value, e) => {
    this.setState({
      calculateValue: value
    });
  }

  editorDidMountHandle = async (editor, monaco) => {
    // sessionStorage记录当前我是否来过这个页面 也就是说 是否加载执行过  monaco.languages.registerCompletionItemProvider 
    // 执行过就不再执行 当页面关闭就重新记录 因为多次执行了这个方法导致重复数据
    const isLoadDEditor = sessionStorage.getItem('isLoadDEditor');
    // console.log(isLoadDEditor)
    if (isLoadDEditor !== '1') {
      // console.log('如果没有加载过,就执行一次,加载过就不会再进入')
      sessionStorage.setItem('isLoadDEditor', '1');
      await this.requestList();
      const { suggestions, tipList } = this.state;
      if (suggestions.length) {
        monaco.languages.registerCompletionItemProvider('plaintext', {
          provideCompletionItems() {
            // console.log('这个地方,每一次路由变动,就会多执行一次,导致我的按键提示重复展示')
            return {
              suggestions: suggestions.map(item => ({ ...item, kind: monaco.languages.CompletionItemKind.Variable }))
            };
          },
          triggerCharacters: tipList
        });
      }
      this.timeouter = setTimeout(() => {
        editor.getAction('editor.action.formatDocument').run();
      }, 300);
    }
  };

  options = {
    selectOnLineNumbers: true,
    renderSideBySide: false
  };

  render() {
    return (
      <div onBlur={this.onBlur}>
        <MonacoEditor
          ref="monaco"
          width="900"
          height="200"
          language="plaintext"
          theme="vs-dark"
          value={this.state.calculateValue}
          options={this.options}
          onChange={this.onChangeHandle}
          editorDidMount={this.editorDidMountHandle}
        />
      </div>
    )
  }
}

export default DEditor;

以下是react-monaco-editor 代码高亮配置 webpack配置:

  • 安装monaco-editor-webpack-plugin依赖

const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');
module.exports = {
  plugins: [
       new MonacoWebpackPlugin(['apex', 'azcli', 'bat', 'clojure', 'coffee', 'cpp', 'csharp', 'csp', 'css', 'dockerfile', 'fsharp', 'go', 'handlebars', 'html', 'ini', 'java', 'javascript', 'json', 'less', 'lua', 'markdown', 'msdax', 'mysql', 'objective', 'perl', 'pgsql', 'php', 'postiats', 'powerquery', 'powershell', 'pug', 'python', 'r', 'razor', 'redis', 'redshift', 'ruby', 'rust', 'sb', 'scheme', 'scss', 'shell', 'solidity', 'sql', 'st', 'swift', 'typescript', 'vb', 'xml', 'yaml']),
  ]
};

一个坑

  • 与antd冲突 不得进行如下配置


  • package.json里面的scripts配置不得改动:

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

推荐阅读更多精彩内容