vue-codemirror6 + Vue3 代码编辑器

2024-09-03 17:44

本文主要是介绍vue-codemirror6 + Vue3 代码编辑器,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

属性

  • v-model="codeValue":实现双向绑定,codeValue 是用来存储编辑器内容的变量。

  • :disabled="disabled":决定编辑器是否为禁用状态(可读),disabled 是一个布尔值。

  • placeholder="暂无数据...":当编辑器为空时显示的占位符文本。

  • :style="comStyle":自定义样式,通过 comStyle 变量来控制编辑器的外观。

  • :autofocus="true":在组件加载时自动聚焦到编辑器。

  • :indent-with-tab="true":使用 Tab 键进行缩进。

  • :tab-size="2":设置 Tab 键的宽度为 2 个空格。

  • :full-screen="true":是否启用全屏模式。

  • :extensions="extensions":传递给 CodeMirror 的扩展功能,可以是一个数组,包含需要使用的插件。:extensions="extensions":传入编辑器的扩展功能,支持不同语言和主题。

事件

  • @ready="() => {}":当编辑器准备好时触发的事件。可以在这里执行一些初始化操作。

  • @change="handleChange":当编辑器内容发生变化时触发的事件。handleChange 是一个方法,可以在这里处理内容变更。

  • @focus="() => {}":当编辑器获得焦点时触发的事件。

  • @blur="() => {}":当编辑器失去焦点时触发的事件。

 定制编辑器的功能和外观

  1. 语言模式--通过设置 mode 属性,可以指定编辑器支持的编程语言。
    const extensions = [javascript(), oneDark];
  2. 主题--可以通过 theme 属性来设置编辑器的主题
    const extensions = [javascript(), oneDark];
  3. 行号和缩进
    行号:使用 lineNumbers 选项来显示行号。
    缩进:通过 indentWithTab 和 tabSize 选项来设置缩进行为。
    const options = {
      lineNumbers: true,
      indentWithTab: true,
      tabSize: 2,
    };
  4. 自动完成--通过使用 autocomplete 插件,可以实现代码的自动补全功能。
    import { autocomplete } from '@codemirror/autocomplete';
    const extensions = [autocomplete()];
  5. 代码折叠--可以通过设置 foldGutter 选项来启用代码折叠功能
    const options = {
      foldGutter: true,
      gutters: ["CodeMirror-linenumbers", "CodeMirror-foldgutter"],
    };
  6. 关键字高亮--可以通过设置 highlightSelectionMatches 选项来高亮匹配的关键字
    const options = {
      highlightSelectionMatches: { showToken: true },
    };
  7. 自定义快捷键--可以通过 keyMap 选项自定义快捷键
    const options = {
      keyMap: 'sublime', // 或者 'default'
    };
  8. 全屏模式--可以通过设置 fullScreen 选项来启用全屏编辑器
    const options = {
      fullScreen: true,
    };
  9. 其他常用选项
    placeholder:占位符文本。
    readOnly:设置编辑器为只读。
    showCursorWhenSelecting:在选择文本时显示光标。
const options = {mode: 'javascript',theme: 'oneDark',lineNumbers: true,indentWithTab: true,tabSize: 2,foldGutter: true,gutters: ["CodeMirror-linenumbers", "CodeMirror-foldgutter"],highlightSelectionMatches: { showToken: true },keyMap: 'default',placeholder: "请输入代码...",readOnly: false,fullScreen: false,
};const cmOption = {tabSize: 2, // Tab 的宽度设置为 2 个空格styleActiveLine: true, // 高亮当前行lineNumbers: true, // 显示行号styleSelectedText: true, // 高亮选中的文本line: true, // 启用行模式(通常不需要单独设置)foldGutter: true, // 启用代码折叠gutters: ['CodeMirror-linenumbers', 'CodeMirror-foldgutter'], // 显示行号和折叠槽highlightSelectionMatches: {showToken: /\w/, // 高亮当前选中内容的所有实例annotateScrollbar: true // 在滚动条上标注匹配项},mode: { // 设置代码模式name: 'javascript', // 使用 JavaScript 模式json: true // 如果是 JSON 格式,则启用 JSON 解析},// hint.js 选项hintOptions: {completeSingle: false // 当匹配只有一项时,不自动补全},     // 快捷键模式,可选择 sublime、emacs、vimkeyMap: 'sublime', // 使用 Sublime Text 的快捷键matchBrackets: true, // 匹配括号showCursorWhenSelecting: true, // 在选择文本时显示光标theme: 'monokai', // 主题设置为 MonokaiextraKeys: {'Ctrl': 'autocomplete' // 为 Ctrl 键绑定自动完成}
};

自定义主题

import { EditorView } from "@codemirror/view"let myTheme = EditorView.theme({// 输入的字体颜色"&": {color: "#0052D9",backgroundColor: "#FFFFFF"},".cm-content": {caretColor: "#0052D9",},// 激活背景色".cm-activeLine": {backgroundColor: "#FAFAFA"},// 激活序列的背景色".cm-activeLineGutter": {backgroundColor: "#FAFAFA"},//光标的颜色"&.cm-focused .cm-cursor": {borderLeftColor: "#0052D9"},// 选中的状态"&.cm-focused .cm-selectionBackground, ::selection": {backgroundColor: "#0052D9",color:'#FFFFFF'},// 左侧侧边栏的颜色".cm-gutters": {backgroundColor: "#FFFFFF",color: "#ddd", //侧边栏文字颜色border: "none"}
}, { dark: true })const extensions = [javascript(), myTheme];

 组件

<template><Codemirrorref="codeMirrorEditor"v-model="codeValue":disabled="disabled"placeholder="暂无数据...":style="comStyle":autofocus="true":indent-with-tab="true":tab-size="2":full-screen="true":extensions="extensions"@ready="() => {}"@change="handleChange"@focus="() => {}"@blur="() => {}"></Codemirror>
</template>
<script setup>
import { ref, toRefs, computed } from 'vue'
import { Codemirror } from 'vue-codemirror'
import { javascript } from '@codemirror/lang-javascript'
import { python } from '@codemirror/lang-python'
import { oneDark } from '@codemirror/theme-one-dark'const props = defineProps({modelValue: {type: String,required: false,default: ''},language: {type: String,default: 'javascript'},disabled: {type: [String, Boolean],default: false},style: {type: [Object],default: () => ({height: 'unset'})}
})
const emit = defineEmits(['update:modelValue'])
const { modelValue, language, disabled, style } = toRefs(props)
const fullScreen = ref(false)
const lang = { javascript, python }[language.value]
const extensions = [lang(), oneDark]
const codeMirrorEditor = ref(null)
const codeValue = ref(modelValue.value)
const comStyle = computed(() => ({ ...style.value, ...{ height: fullScreen.value ? '100%' : 'unset' } }))
watch(() => modelValue,(newValue) => {if (newValue.value) {codeValue.value = newValue.value}},{ deep: true, immediate: true }
)
const handleChange = (value) => {emit('update:modelValue', value)
}
</script>

const lang = { javascript, python }[language.value] : 

  • language.value 是一个响应式引用,表示当前选择的语言(例如 "javascript" 或 "python")。
  • 使用 language.value 作为对象的键,动态地获取对应的语言扩展。

更多信息看:vue-codemirror代码编辑器使用心得和踩坑总结

这篇关于vue-codemirror6 + Vue3 代码编辑器的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1133610

相关文章

vite搭建vue3项目的搭建步骤

《vite搭建vue3项目的搭建步骤》本文主要介绍了vite搭建vue3项目的搭建步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学... 目录1.确保Nodejs环境2.使用vite-cli工具3.进入项目安装依赖1.确保Nodejs环境

Nginx搭建前端本地预览环境的完整步骤教学

《Nginx搭建前端本地预览环境的完整步骤教学》这篇文章主要为大家详细介绍了Nginx搭建前端本地预览环境的完整步骤教学,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录项目目录结构核心配置文件:nginx.conf脚本化操作:nginx.shnpm 脚本集成总结:对前端的意义很多

前端缓存策略的自解方案全解析

《前端缓存策略的自解方案全解析》缓存从来都是前端的一个痛点,很多前端搞不清楚缓存到底是何物,:本文主要介绍前端缓存的自解方案,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、为什么“清缓存”成了技术圈的梗二、先给缓存“把个脉”:浏览器到底缓存了谁?三、设计思路:把“发版”做成“自愈”四、代码

通过React实现页面的无限滚动效果

《通过React实现页面的无限滚动效果》今天我们来聊聊无限滚动这个现代Web开发中不可或缺的技术,无论你是刷微博、逛知乎还是看脚本,无限滚动都已经渗透到我们日常的浏览体验中,那么,如何优雅地实现它呢?... 目录1. 早期的解决方案2. 交叉观察者:IntersectionObserver2.1 Inter

Vue3视频播放组件 vue3-video-play使用方式

《Vue3视频播放组件vue3-video-play使用方式》vue3-video-play是Vue3的视频播放组件,基于原生video标签开发,支持MP4和HLS流,提供全局/局部引入方式,可监听... 目录一、安装二、全局引入三、局部引入四、基本使用五、事件监听六、播放 HLS 流七、更多功能总结在 v

Java集合之Iterator迭代器实现代码解析

《Java集合之Iterator迭代器实现代码解析》迭代器Iterator是Java集合框架中的一个核心接口,位于java.util包下,它定义了一种标准的元素访问机制,为各种集合类型提供了一种统一的... 目录一、什么是Iterator二、Iterator的核心方法三、基本使用示例四、Iterator的工

Java 线程池+分布式实现代码

《Java线程池+分布式实现代码》在Java开发中,池通过预先创建并管理一定数量的资源,避免频繁创建和销毁资源带来的性能开销,从而提高系统效率,:本文主要介绍Java线程池+分布式实现代码,需要... 目录1. 线程池1.1 自定义线程池实现1.1.1 线程池核心1.1.2 代码示例1.2 总结流程2. J

JS纯前端实现浏览器语音播报、朗读功能的完整代码

《JS纯前端实现浏览器语音播报、朗读功能的完整代码》在现代互联网的发展中,语音技术正逐渐成为改变用户体验的重要一环,下面:本文主要介绍JS纯前端实现浏览器语音播报、朗读功能的相关资料,文中通过代码... 目录一、朗读单条文本:① 语音自选参数,按钮控制语音:② 效果图:二、朗读多条文本:① 语音有默认值:②

vue监听属性watch的用法及使用场景详解

《vue监听属性watch的用法及使用场景详解》watch是vue中常用的监听器,它主要用于侦听数据的变化,在数据发生变化的时候执行一些操作,:本文主要介绍vue监听属性watch的用法及使用场景... 目录1. 监听属性 watch2. 常规用法3. 监听对象和route变化4. 使用场景附Watch 的

前端导出Excel文件出现乱码或文件损坏问题的解决办法

《前端导出Excel文件出现乱码或文件损坏问题的解决办法》在现代网页应用程序中,前端有时需要与后端进行数据交互,包括下载文件,:本文主要介绍前端导出Excel文件出现乱码或文件损坏问题的解决办法,... 目录1. 检查后端返回的数据格式2. 前端正确处理二进制数据方案 1:直接下载(推荐)方案 2:手动构造