monaco-editor 開發(fā) —— 萬金油編輯器

百花齊放,終歸還是要統(tǒng)一

前序:

碎碎念:

  • 此文個人筆記份名,官網(wǎng)文檔搬運
  • monaco 版本:0.30.0
  • monaco-editor-webpack-plugin 版本:6.0.0 (僅適合模塊引入方式)
  • vue 版本:2.6.11

一:步驟:

1 —— 創(chuàng)建vue2項目:詳情請看 vue開發(fā) —— CLI(開發(fā)環(huán)境)搭建

2 —— 引入開發(fā)組件【monaco】

1 —— 模塊引入monaco(非推薦模式掸屡,編譯慢折磨人):

npm install monaco-editor
npm install monaco-editor-webpack-plugin --dev
1.1 —— 編輯vue.config.js:
const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin')

module.exports = {
// 省略N多個設置寸莫,請勿直接復制使用状蜗,僅展示Monaco需要的以及基本結構
    configureWebpack: {
        plugins: [
            new MonacoWebpackPlugin({
                languages: ['javascript', 'yaml', 'json', 'xml']
            })
        ],
    }
}
1.2 —— 創(chuàng)建editor組件:
<template>
    <div ref="CodeEditor"></div>
</template>

<script>
import * as monaco from 'monaco-editor'

export default {
    props: {
        editable: { type: Boolean, default: true },
        language: { type: String, default: 'plaintext' },
        value: { type: String, required: true, default: '' },
    },

    data() {
        return {
            codeEditor: null,
        }
    },

    mounted() {
        this.updateEditor(this.value)
    },

    methods: {
        updateEditor(content) {
            if (!this.codeEditor) {
                monaco.editor.defineTheme('myTheme', {
                    base: 'vs',
                    inherit: true,
                    rules: [{ background: 'EDF9FA' }],
                    colors: {
                        'editor.foreground': '#000000',
                        'editor.background': '#EDF9FA',
                        'editorCursor.foreground': '#8B0000',
                        'editor.lineHighlightBackground': '#0000FF20',
                        'editorLineNumber.foreground': '#008800',
                        'editor.selectionBackground': '#88000030',
                        'editor.inactiveSelectionBackground': '#88000015',
                    },
                })
                monaco.editor.setTheme('myTheme')
                this.codeEditor = monaco.editor.create(this.$refs.CodeEditor, {
                    value: '',
                    language: this.language,
                    lineNumbers: 'off',
                    roundedSelection: false,
                    scrollBeyondLastLine: false,
                    readOnly: !this.editable,
                    theme: 'vs-dark',
                    automaticLayout: true,

                    wordWrap: 'wordWrapColumn',
                    wordWrapColumn: 40,

                    // Set this to false to not auto word wrap minified files
                    wordWrapMinified: true,
                    // try "same", "indent" or "none"
                    wrappingIndent: 'indent',

                    scrollbar: {
                        // Subtle shadows to the left & top. Defaults to true.
                        useShadows: false,

                        // Render vertical arrows. Defaults to false.
                        verticalHasArrows: false,
                        // Render horizontal arrows. Defaults to false.
                        horizontalHasArrows: false,

                        // Render vertical scrollbar.
                        // Accepted values: 'auto', 'visible', 'hidden'.
                        // Defaults to 'auto'
                        vertical: 'auto',
                        // Render horizontal scrollbar.
                        // Accepted values: 'auto', 'visible', 'hidden'.
                        // Defaults to 'auto'
                        horizontal: 'auto',

                        verticalScrollbarSize: 10,
                        horizontalScrollbarSize: 10,
                        arrowSize: 10,
                    },

                    //小地圖
                    minimap: {
                        enabled: false,
                    },
                })
                this.codeEditor.onDidChangeModelContent(() => {
                    this.$emit('input', this.codeEditor.getValue())
                })
            }
            if (content != this.codeEditor.getValue())
                this.codeEditor.setValue(content)

            this.codeEditor.updateOptions({
                readOnly: !this.editable,
            })
        },
    },

    watch: {
        value: function (val) {
            this.updateEditor(val)
        },
    },

    beforeDestroy() {
        this.codeEditor.dispose()
    },
}
</script>
1.3 —— 組件調用:
<template>
        <CodeEditor
            v-model="content"
            :language="language"
        />
</template>

<script>
import CodeEditor from '@/components/CodeEditor.vue'

export default {
    components: { CodeEditor },

    data() {
        return {
            content: '瀟風劍易水',
            language: '',
        }
    },
}
</script>

2 —— 靜態(tài)引入monaco(首選模式):

2.1 —— 創(chuàng)建editor組件:

<template>
  <div style="width: 100%; height: 300px" ref="editor"></div>
</template>

<script>
export default {
  props: {
    editable: { type: Boolean, default: true },
    language: { type: String, default: "plaintext" },
    value: { type: String, default: "" },
  },

  data() {
    return {
      editor: null,
    };
  },

  created() {
    // CDN引入(鏈接源自官方demo)
    let src =
      "https://microsoft.github.io/monaco-editor/node_modules/monaco-editor/min/vs/loader.js";
    // public 引入
    // let src = 'monaco-editor/min/vs/loader.js';
    this.toCreateScript(src);
  },

  mounted() {
    this.updateEditor(this.value);
  },

  watch: {
    value: function (val) {
      this.updateEditor(val);
    },
  },

  methods: {
    loader() {
      // 需要使用的是requirejs去加載AMD格式的monaco丧裁,而非node的require模塊
      // loader.js負責裝載window.require掉蔬,也可以單獨使用requirejs而非自帶的loader.js去加載
      // 不要修改monaco-editor/min/vs路徑,除非改源碼浓瞪,該版本的MonacoEnvironment不起作用懈玻,worker.main.js里面自維護的變量取的不是外面的
      let require = window.require;

      // CDN引入(鏈接源自官方demo)
      let vsPath =
        "https://microsoft.github.io/monaco-editor/node_modules/monaco-editor/min/vs";
      // public 引入
      // let vsPath = "monaco-editor/min/vs"
      require.config({ paths: { vs: vsPath } });

      require(["vs/editor/editor.main"], () => this.toCreate());
    },

    toCreate() {
      if (!this.editor) {
        monaco.editor.defineTheme("myTheme", {
          base: "vs",
          inherit: true,
          rules: [{ background: "EDF9FA" }],
          colors: {
            "editor.foreground": "#000000",
            "editor.background": "#EDF9FA",
            "editorCursor.foreground": "#8B0000",
            "editor.lineHighlightBackground": "#0000FF20",
            "editorLineNumber.foreground": "#008800",
            "editor.selectionBackground": "#88000030",
            "editor.inactiveSelectionBackground": "#88000015",
          },
        });
        monaco.editor.setTheme("myTheme");
        this.editor = monaco.editor.create(this.$refs.editor, {
          value: "",
          language: this.language,
          lineNumbers: "off",
          roundedSelection: false,
          scrollBeyondLastLine: false,
          readOnly: !this.editable,
          theme: "vs-dark",
          automaticLayout: true,

          wordWrap: "wordWrapColumn",
          wordWrapColumn: 40,

          // Set this to false to not auto word wrap minified files
          wordWrapMinified: true,
          // try "same", "indent" or "none"
          wrappingIndent: "indent",

          scrollbar: {
            // Subtle shadows to the left & top. Defaults to true.
            useShadows: false,

            // Render vertical arrows. Defaults to false.
            verticalHasArrows: false,
            // Render horizontal arrows. Defaults to false.
            horizontalHasArrows: false,

            // Render vertical scrollbar.
            // Accepted values: 'auto', 'visible', 'hidden'.
            // Defaults to 'auto'
            vertical: "auto",
            // Render horizontal scrollbar.
            // Accepted values: 'auto', 'visible', 'hidden'.
            // Defaults to 'auto'
            horizontal: "auto",

            verticalScrollbarSize: 10,
            horizontalScrollbarSize: 10,
            arrowSize: 10,
          },

          //小地圖
          minimap: {
            enabled: false,
          },
        });
        this.editor.onDidChangeModelContent(() => {
          this.$emit("input", this.editor.getValue());
        });
      }
    },

    toCreateScript(src) {
      let head = document.querySelector("head");
      let script = document.createElement("script");
      script.onload = () => this.loader();
      script.onerror = () => {
        head.removeChild(script);
      };
      script.src = src;
      head.appendChild(script);
    },

    updateEditor(content) {
      if (this.editor) {
        if (content != this.editor.getValue()) this.editor.setValue(content);

        this.editor.updateOptions({
          readOnly: !this.editable,
        });
      }
    },
  },
};
</script>

2.1.1 —— 若public引入請先下載對應的資源:

  • 官網(wǎng)下載鏈接
  • npm 引入monaco包追逮,對應的位置是node_modules/monaco-editor/min/vs
  • 下載官網(wǎng)demo鏈接那些js(麻煩酪刀,不夠全)

2.2 —— 組件調用:

<template>
        <CodeEditor
            v-model="content"
            :language="language"
        />
</template>

<script>
import CodeEditor from '@/components/CodeEditor.vue'

export default {
    components: { CodeEditor },

    data() {
        return {
            content: '瀟風劍易水',
            language: '',
        }
    },
}
</script>

二:常見問題:

1 —— 待更:

三:吹水:

1 官網(wǎng)的文檔并不是很好粹舵,例子多钮孵,但是有些是提及又缺少一些指引,然后就是api文檔眼滤,這個很多沒有具體的東西巴席,有些深的自定義需要自己去看代碼才知曉,不同版本的配置有點大诅需,網(wǎng)上的案例涉及的配置也很多不適用漾唉,本文也僅僅針對這個版本的,但是相對來說還是可用

2 模塊引入需要大幅度調整按需引入堰塌,否則即使webpack那個插件排除一些語言赵刑,還是編譯過久,目前僅推薦靜態(tài)引入场刑,非模塊引入般此,且這種不太涉及業(yè)務的不該由業(yè)務所在的模塊管理里面,應該獨立出去

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末牵现,一起剝皮案震驚了整個濱河市铐懊,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌瞎疼,老刑警劉巖科乎,帶你破解...
    沈念sama閱讀 219,539評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異贼急,居然都是意外死亡茅茂,警方通過查閱死者的電腦和手機捏萍,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,594評論 3 396
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來空闲,“玉大人照弥,你說我怎么就攤上這事〗保” “怎么了这揣?”我有些...
    開封第一講書人閱讀 165,871評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長影斑。 經(jīng)常有香客問我给赞,道長,這世上最難降的妖魔是什么矫户? 我笑而不...
    開封第一講書人閱讀 58,963評論 1 295
  • 正文 為了忘掉前任片迅,我火速辦了婚禮,結果婚禮上皆辽,老公的妹妹穿的比我還像新娘柑蛇。我一直安慰自己,他們只是感情好驱闷,可當我...
    茶點故事閱讀 67,984評論 6 393
  • 文/花漫 我一把揭開白布耻台。 她就那樣靜靜地躺著,像睡著了一般空另。 火紅的嫁衣襯著肌膚如雪盆耽。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,763評論 1 307
  • 那天扼菠,我揣著相機與錄音摄杂,去河邊找鬼。 笑死循榆,一個胖子當著我的面吹牛析恢,可吹牛的內容都是我干的。 我是一名探鬼主播秧饮,決...
    沈念sama閱讀 40,468評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼映挂,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了浦楣?” 一聲冷哼從身側響起袖肥,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎振劳,沒想到半個月后椎组,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,850評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡历恐,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 38,002評論 3 338
  • 正文 我和宋清朗相戀三年寸癌,在試婚紗的時候發(fā)現(xiàn)自己被綠了专筷。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,144評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡蒸苇,死狀恐怖磷蛹,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情溪烤,我是刑警寧澤味咳,帶...
    沈念sama閱讀 35,823評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站檬嘀,受9級特大地震影響槽驶,放射性物質發(fā)生泄漏。R本人自食惡果不足惜鸳兽,卻給世界環(huán)境...
    茶點故事閱讀 41,483評論 3 331
  • 文/蒙蒙 一掂铐、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧揍异,春花似錦全陨、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,026評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至棍鳖,卻和暖如春炮叶,著一層夾襖步出監(jiān)牢的瞬間碗旅,已是汗流浹背渡处。 一陣腳步聲響...
    開封第一講書人閱讀 33,150評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留祟辟,地道東北人医瘫。 一個月前我還...
    沈念sama閱讀 48,415評論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像旧困,于是被迫代替她去往敵國和親醇份。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,092評論 2 355