Vue使用codemirror

Vue页面使用codemirroe、vue使用代码块

文章共5,084字 · 阅读需要大约17分钟

一键AI生成摘要，助你高效阅读

问答

WishMeLuck*

7304人浏览 · 2022-06-20 09:24:16

WishMeLuck* · 2022-06-20 09:24:16 发布

安装codemirror
创建组件codemirror.vue

<template>
	<div class="in-coder-panel">
		<textarea :ref="textareaRef" v-model="code" autofocus="true"></textarea>
		<el-select v-if="modeFlg" class="code-mode-select" v-model="mode" @change="changeMode">
			<el-option v-for="mode in modes" :key="mode.value" :label="mode.label" :value="mode.value">
			</el-option>
		</el-select>
	</div>
</template>

<script type="text/ecmascript-6">
	// 正常引入实例
	// import _CodeMirror from 'codemirror';

	// 核心样式
	import 'codemirror/lib/codemirror.css';
	// 引入主题后还需要在 options 中指定主题才会生效
	import 'codemirror/theme/cobalt.css';

	// 需要引入具体的语法高亮库才会有对应的语法高亮效果
	// codemirror 官方其实支持通过 /addon/mode/loadmode.js 和 /mode/meta.js 来实现动态加载对应语法高亮库
	// 但 vue 貌似没有无法在实例初始化后再动态加载对应 JS ，所以此处才把对应的 JS 提前引入
	
	import 'codemirror/mode/javascript/javascript.js';
	import 'codemirror/mode/css/css.js';
	import 'codemirror/mode/xml/xml.js';
	import 'codemirror/mode/clike/clike.js';
	import 'codemirror/mode/markdown/markdown.js';
	import 'codemirror/mode/python/python.js';
	import 'codemirror/mode/r/r.js';
	import 'codemirror/mode/shell/shell.js';
	import 'codemirror/mode/sql/sql.js';
	import 'codemirror/mode/swift/swift.js';
	import 'codemirror/mode/vue/vue.js';
	
	// 引入代码块主题  我这边是动态主题，所以引入的有点多
	// 正常下面设置 theme: '3024-day' 就好了
	import 'codemirror/theme/3024-day.css';
	import 'codemirror/theme/3024-night.css';
	import 'codemirror/theme/abbott.css';
	import 'codemirror/theme/abcdef.css';
	import 'codemirror/theme/ambiance.css';
	import 'codemirror/theme/ambiance-mobile.css';
	import 'codemirror/theme/ayu-dark.css';
	import 'codemirror/theme/ayu-mirage.css';
	import 'codemirror/theme/base16-dark.css';
	import 'codemirror/theme/base16-light.css';
	import 'codemirror/theme/bespin.css';
	import 'codemirror/theme/blackboard.css';
	import 'codemirror/theme/cobalt.css';
	import 'codemirror/theme/colorforth.css';
	import 'codemirror/theme/darcula.css';
	import 'codemirror/theme/dracula.css';
	import 'codemirror/theme/duotone-dark.css';
	import 'codemirror/theme/duotone-light.css';
	import 'codemirror/theme/eclipse.css';
	import 'codemirror/theme/elegant.css';
	import 'codemirror/theme/erlang-dark.css';
	import 'codemirror/theme/gruvbox-dark.css';
	import 'codemirror/theme/hopscotch.css';
	import 'codemirror/theme/icecoder.css';
	import 'codemirror/theme/idea.css';
	import 'codemirror/theme/isotope.css';
	import 'codemirror/theme/juejin.css';
	import 'codemirror/theme/lesser-dark.css';
	import 'codemirror/theme/liquibyte.css';
	import 'codemirror/theme/lucario.css';
	import 'codemirror/theme/material.css';
	import 'codemirror/theme/material-darker.css';
	import 'codemirror/theme/material-ocean.css';
	import 'codemirror/theme/material-palenight.css';
	import 'codemirror/theme/mbo.css';
	import 'codemirror/theme/mdn-like.css';
	import 'codemirror/theme/midnight.css';
	import 'codemirror/theme/monokai.css';
	import 'codemirror/theme/moxer.css';
	import 'codemirror/theme/neat.css';
	import 'codemirror/theme/neo.css';
	import 'codemirror/theme/night.css';
	import 'codemirror/theme/nord.css';
	import 'codemirror/theme/oceanic-next.css';
	import 'codemirror/theme/panda-syntax.css';
	import 'codemirror/theme/paraiso-dark.css';
	import 'codemirror/theme/paraiso-light.css';
	import 'codemirror/theme/pastel-on-dark.css';
	import 'codemirror/theme/railscasts.css';
	import 'codemirror/theme/rubyblue.css';
	import 'codemirror/theme/seti.css';
	import 'codemirror/theme/shadowfox.css';
	import 'codemirror/theme/solarized.css';
	import 'codemirror/theme/ssms.css';
	import 'codemirror/theme/the-matrix.css';
	import 'codemirror/theme/tomorrow-night-bright.css';
	import 'codemirror/theme/tomorrow-night-eighties.css';
	import 'codemirror/theme/ttcn.css';
	import 'codemirror/theme/twilight.css';
	import 'codemirror/theme/vibrant-ink.css';
	import 'codemirror/theme/xq-dark.css';
	import 'codemirror/theme/xq-light.css';
	import 'codemirror/theme/yeti.css';
	import 'codemirror/theme/yonce.css'; 
	import 'codemirror/theme/zenburn.css';

	// 尝试获取实例
	// 如果全局组件直接使用就行
	// const CodeMirror = _CodeMirror;

	export default {
		name: 'in-coder',
		props: {
			modeFlg: Boolean,
			//是否只读
			readOnlyFlg:Boolean,
			//是否自动获取焦点
			autofocusFlg: Boolean,
			// 外部传入的内容，用于实现双向绑定
			value: String,
			// 外部传入的语法类型
			language: {
				type: String,
				default: null
			},
			textareaRef: {
				type: String,
				default: ''
			}
		},
		data() {
			return {
				CodeMirror: null,
				// 内部真实的内容
				code: '',
				// 默认的语法类型
				mode: 'Java',
				// 编辑器实例
				coder: null,
				// 默认配置
				options: {
					// 缩进格式
					tabSize: 2,
					// 显示行号
					lineNumbers: true,
					line: true,
					//代码块主题
					theme: this.$store.state.app.systemInfo.codemirrorTheme,
					//是否只读
					readOnly : this.readOnlyFlg,
					lineWrapping: true,
					//是否自动获取焦点
					autofocus: this.autofocusFlg
				},
				// 支持切换的语法高亮类型，对应 JS 已经提前引入
				// 使用的是 MIME-TYPE ，不过作为前缀的 text/ 在后面指定时写死了
				modes: [{
					value: 'x-java',
					label: 'Java'
				},{
					value: 'css',
					label: 'CSS'
				}, {
					value: 'javascript',
					label: 'Javascript'
				}, {
					value: 'html',
					label: 'XML/HTML'
				}, {
					value: 'x-objectivec',
					label: 'Objective-C'
				}, {
					value: 'x-python',
					label: 'Python'
				}, {
					value: 'x-rsrc',
					label: 'R'
				}, {
					value: 'x-sh',
					label: 'Shell'
				}, {
					value: 'x-sql',
					label: 'SQL'
				}, {
					value: 'x-swift',
					label: 'Swift'
				}, {
					value: 'x-vue',
					label: 'Vue'
				}, {
					value: 'markdown',
					label: 'Markdown'
				}]
			};
		},
		mounted() {
			// 初始化
			this._initialize();
		},
		methods: {
			//重设代码块内容
			codemirrorRefresh(text){
				text = text ? text : '';
				this.coder.setValue(text);
				this.code = this.coder.getValue();
				this.coder.refresh();
			},
			// 初始化
			_initialize() {
				// 初始化编辑器实例，传入需要被实例化的文本域对象和默认配置---this.$CodeMirror是全局引入的实例
				this.coder = this.$CodeMirror.fromTextArea(this.$refs[this.textareaRef], this.options);
				// 编辑器赋值
				this.coder.setValue(this.value || this.code);
				// 支持双向绑定
				this.coder.on('change', (coder) => {
					this.code = coder.getValue();
					//组件可以用input事件监听到值的变化
					if (this.$emit) {
						this.$emit('input', this.code);
					}
				});

				// 尝试从父容器获取语法类型
				if (this.language) {
					// 获取具体的语法类型对象
					let modeObj = this._getLanguage(this.language);

					// 判断父容器传入的语法是否被支持
					if (modeObj) {
						this.mode = modeObj.label;
					}
				}
			},
			// 获取当前语法类型
			_getLanguage(language) {
				// 在支持的语法类型列表中寻找传入的语法类型
				return this.modes.find((mode) => {
					// 所有的值都忽略大小写，方便比较
					let currentLanguage = language.toLowerCase();
					let currentLabel = mode.label.toLowerCase();
					let currentValue = mode.value.toLowerCase();

					// 由于真实值可能不规范，例如 java 的真实值是 x-java ，所以讲 value 和 label 同时和传入语法进行比较
					return currentLabel === currentLanguage || currentValue === currentLanguage;
				});
			},
			// 更改模式
			changeMode(val) {
				// 修改编辑器的语法配置
				this.coder.setOption('mode', `text/${val}`);

				// 获取修改后的语法
				let label = this._getLanguage(val).label.toLowerCase();

				// 允许父容器通过以下函数监听当前的语法值
				this.$emit('language-change', label);
			}
		}
	};
</script>

<style>
	.in-coder-panel {
		flex-grow: 1;
		display: flex;
		position: relative;
	}
	.CodeMirror {
		flex-grow: 1;
		z-index: 1;
		height: auto;
	}

	.CodeMirror-code {
		line-height: 22px;
		font-size: 17px;
	}

	.code-mode-select {
		position: absolute;
		z-index: 2;
		right: 10px;
		top: 10px;
		max-width: 130px;
	}
	
</style>

我是全局引入的组件和实例—main.js

	import Codemirror from './components/codemirror.vue';
	Vue.component('Codemirror',Codemirror);

	import _CodeMirror from 'codemirror';
	Vue.prototype.$CodeMirror = _CodeMirror;

局部引入实例—codemirror.vue

	// 正常引入全局实例
	import _CodeMirror from 'codemirror';
	// 获取全局实例
	const CodeMirror = _CodeMirror;

页面使用组件
局部引入的

	//引入
    import Codemirror from '../components/codemirror.vue';
	//注册
	components: {
		Codemirror
	}
	
	//autofocusFlg 是否自动获取焦点
	//readOnlyFlg  是否只读
	//modeFlg      忘了是啥
	//value        代码文本内容
	//@input	   代码文本修改时间，$event就是修改后的代码文本
	
	<Codemirror class="details_centerCode Codemirrors" 
	ref="codemirror"
	:autofocusFlg="false" 
	:readOnlyFlg="false" 
	:modeFlg="false"
	@input="codemirrorCode($event,index)"
	:value="code"></Codemirror>

全局引入的

	<Codemirror class="details_centerCode Codemirrors" 
	ref="codemirror"
	:autofocusFlg="false" 
	:readOnlyFlg="false" 
	:modeFlg="false"
	@input="codemirrorCode($event,index)"
	:value="code"></Codemirror>