Vue3中使用Monaco-editor的教程詳解

更新時間：2023年11月01日 13:58:40 作者：會說法語的豬

Monaco-editor,一個vs?code?編輯器,需要將其繼承到項目,這篇文章主要為大家詳細介紹了如何在vue中安裝和使用Monaco-editor,有需要的小伙伴可以參考下

安裝

pnpm add monaco-editor -S
pnpm add vite-plugin-monaco-editor -D

配置

vite.config.ts

import { defineConfig} from 'vite'
 
// vs code 編輯器配置
import monacoEditorPlugin from 'vite-plugin-monaco-editor'
 
// https://vitejs.dev/config/
export default ({ mode }) => {
  return defineConfig({
    plugins: [
      monacoEditorPlugin({
        languageWorkers: ['editorWorkerService', 'typescript', 'json', 'html']
      })
    ]
  })
}

封裝

首先先封裝個hook如下：

@/hooks/useMonacoEditor.hook.ts

import * as monaco from 'monaco-editor'
import useCommonStore from '@/store/common'
import { ref, nextTick, onBeforeUnmount } from 'vue'
 
export function useMonacoEditor(language: string = 'javascript') {
  // 編輯器示例
  let monacoEditor: monaco.editor.IStandaloneCodeEditor | null = null
  // 目標元素
  const monacoEditorRef = ref<HTMLElement | null>(null)
 
  // 創(chuàng)建實例
  function createEditor(editorOption: monaco.editor.IStandaloneEditorConstructionOptions = {}) {
    if(!monacoEditorRef.value) return
    monacoEditor = monaco.editor.create(monacoEditorRef.value, {
      // 初始模型
      model: monaco.editor.createModel('', language),
      // 是否啟用預覽圖
      minimap: { enabled: true },
      // 圓角
      roundedSelection: true,
      // 主題
      theme: useCommonStore().mode == 'dark' ? 'vs-dark' : 'vs',
      // 主鍵
      multiCursorModifier: 'ctrlCmd',
      // 滾動條
      scrollbar: {
        verticalScrollbarSize: 8,
        horizontalScrollbarSize: 8
      },
      // 行號
      lineNumbers: 'on',
      // tab大小
      tabSize: 2,
      //字體大小
      fontSize: 16,
      // 控制編輯器在用戶鍵入、粘貼、移動或縮進行時是否應自動調(diào)整縮進
      autoIndent: 'advanced',
      // 自動布局
      automaticLayout: true,
      ...editorOption
    })
    return monacoEditor
  }
 
  // 格式化
  async function formatDoc() {
    await monacoEditor?.getAction('editor.action.formatDocument')?.run()
  }
 
  // 數(shù)據(jù)更新
  function updateVal(val: string) {
    nextTick(() => {
      if(getOption(monaco.editor.EditorOption.readOnly)) {
        updateOptions({ readOnly: false })
      }
      monacoEditor?.setValue(val)
      setTimeout(async () => {
        await formatDoc()
      }, 10)
    })
  }
 
  // 配置更新
  function updateOptions(opt: monaco.editor.IStandaloneEditorConstructionOptions) {
    monacoEditor?.updateOptions(opt)
  }
 
  // 獲取配置
  function getOption(name: monaco.editor.EditorOption) {
    return monacoEditor?.getOption(name)
  }
 
  // 獲取實例
  function getEditor() {
    return monacoEditor
  }
 
  // 頁面離開 銷毀
  onBeforeUnmount(() => {
    if(monacoEditor) {
      monacoEditor.dispose()
    }
  })
 
  return {
    monacoEditorRef,
    createEditor,
    getEditor,
    updateVal,
    updateOptions,
    getOption,
    formatDoc
  }
}

然后調(diào)用上面 useMonacoEditor 封裝editor編輯器組件

@/components/MonacoEditor/index.vue

<template>
  <div ref="monacoEditorRef" :style="monacoEditorStyle"></div>
</template>
<script setup lang="ts">
import { useMonacoEditor } from '@/hooks'
import { onMounted, computed, watch } from 'vue'
 
const props = withDefaults(defineProps<{
  width?: string | number,
  height?: string | number,
  language?: string,
  editorOption?: Object,
  modelValue: string
}>(), {
  width: '100%',
  height: '100%',
  language: 'javascript',
  editorOption: () => ({}),
  modelValue: ''
})
 
const emits = defineEmits<{
  (e: 'blue'): void,
  (e: 'update:modelValue', val: string): void
}>()
 
const monacoEditorStyle = computed(() => {
  return { 
    width: typeof props.width === 'string' ? props.width : props.width + 'px', 
    height: typeof props.height === 'string' ? props.height : props.height + 'px'
  }
})
 
const { monacoEditorRef, createEditor, updateVal, updateOptions, getEditor } = useMonacoEditor(props.language)
 
onMounted(() => {
  const monacoEditor = createEditor(props.editorOption)
  updateMonacoVal(props.modelValue)
  monacoEditor?.onDidChangeModelContent(() => {
    emits('update:modelValue', monacoEditor!.getValue())
  })
  monacoEditor?.onDidBlurEditorText(() => {
    emits('blue')
  })
})
 
watch(() => props.modelValue, () => {
  updateMonacoVal(props.modelValue)
})
 
function updateMonacoVal(val: string) {
  if(val !== getEditor()?.getValue()) {
    updateVal(val)
  }
}
 
defineExpose({ updateOptions })
</script>

組件使用：

<div class="edit-container">
  <MonacoEditor ref="MonacoEditRef" v-model="editJson" language="json" />
</div>
<script setup lang="ts">
import MonacoEditor from '@/components/MonacoEditor/index.vue'
import { ref } from 'vue'
 
let editJson = ref('')
 
const MonacoEditRef = ref<InstanceType<typeof MonacoEditor>>()
 
//MonacoEditRef.value!.updateOptions({ theme: 'vs' }) 調(diào)用子組件方法修改配置
</script>

到此這篇關(guān)于Vue3中使用Monaco-editor的教程詳解的文章就介紹到這了,更多相關(guān)Vue3使用Monaco-editor內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: