vue中实现Monaco Editor自定义提示功能


Posted in Javascript onJuly 05, 2019

这次接到一个需求,要在浏览器的 IDE 中支持自定义提示功能,如下所示:

vue中实现Monaco Editor自定义提示功能

可以看到,它可以根据用户输入的内容来一项一项排除,只显示完全匹配的那一项。

项目的框架是 Vue ,编辑器用的是 Monaco Editor

什么是 Monaco Editor

vscode 是我们经常在用的编辑器,它的前身是微软的一个叫 Monaco Workbench 的项目,而 Monaco Editor 就是从这个项目中成长出来的一个 web 编辑器,他们很大一部分的代码都是共用的,所以 Monaco EditorVSCode 在编辑代码,交互及 UI 上几乎是一摸一样的。不同的是,两者的平台不一样, Monaco Editor 基于浏览器,而 VSCode 基于 electron ,所以功能上 VSCode 更加健全,性能比较强大。

用法

安装

npm install monaco-editor --save

使用

<div id="monaco" class="monaco-editor"></div>
import * as monaco from 'monaco-editor';
this.fileEditor = this.monaco.editor.create(document.getElementById('monaco'), {
 value: null,
 language: 'sql' // 这里以sql为例
})

this.fileEditor.dispose(); // 使用完后销毁

这里引入 monaco 要注意,在 react 中以下面方式引入:

import * as monaco from 'monaco-editor/esm/vs/editor/editor.api';

实现自定义提示功能

查看了资料后,发现在 monaco 中有提供一个提示功能的方法 registerCompletionItemProvider ,具体实现如下:

this.monaco.languages.registerCompletionItemProvider('sql', { // 这里以sql语言为例
 provideCompletionItems () {
  return [{
   label: '${_DB', // 显示的提示内容
   kind: this.monaco.languages.CompletionItemKind['Function'], // 用来显示提示内容后的不同的图标
   insertText: '{_DB', // 选择后粘贴到编辑器中的文字
   detail: '' // 提示内容后的说明
  }];
 },
 triggerCharacters: ['$'] // 触发提示的字符,可以写多个
});

以上的用法,我试了一下之后发现,虽然 triggerCharacters 的值是数组,可以有多个,但是里面的字符串只能识别一个字符。一开始的需求是输入 ${_ 之后提示 ${_DB ,但是由于不能识别多个字符,只能做到出现 $ 就提示。

还有一个问题就是 registerCompletionItemProvider 的第一个参数只能是字符串,如果有多种语言只能叠加重复写,恰巧我的需求是有多种语言,所以只能如下解决,也就是每种语言都写了一遍:

['json', 'yaml', 'php', 'go', 'sql', 'java', 'markdown', 'plaintext'].map(item => {
 this.monaco.languages.registerCompletionItemProvider(item, {
  provideCompletionItems () {
   return [{
    label: '${_DB',
    kind: this.monaco.languages.CompletionItemKind['Function'],
    insertText: '{_DB',
    detail: ''
   }];
  },
  triggerCharacters: ['$']
 });
});

需求是 ${_DB:key:value ,也就是说在输入 ${_DB 后,再输入一个 : 提示出 key ,在 key 之后输入 : 提示 value

这里又碰到一个问题,需要知道当前输入的内容来判断是 $ 还是 : ,而且后面两个触发提示的符号同是 : ,无法区分,只能通过识别 : 的位置来判断是提示 key 还是 value ,所以还要知道当前输入的 : 之前的内容。

那么只有在 provideCompletionItems 这一步判断,但是查遍了资料没有发现这样的参数, provideCompletionItems 只有 modelpositiontoken 这几个参数,后来发现 model 中的 getLineContent 方法可以获取指定行的所有内容,而 position 可以获取当前输入行的行数和列数,于是就有了以下解决方法:

this.monaco.languages.registerCompletionItemProvider(item, {
 provideCompletionItems (model, position) {
  // 获取当前行数
  const line = position.lineNumber
  
  // 获取当前列数
  const column = position.column
  
  // 获取当前输入行的所有内容
  const content = model.getLineContent(line)
  
  // 通过下标来获取当前光标后一个内容,即为刚输入的内容
  const sym = content[column - 2]
  
  if (sym === '$') {
   return [{
    label: '${_DB',
    kind: this.monaco.languages.CompletionItemKind['Function'],
    insertText: '{_DB',
    detail: ''
   }];
  }
  
  return [{
   label: ':abb',
   kind: this.monaco.languages.CompletionItemKind['Function'],
   insertText: 'abb',
   detail: ''
  },
  {
   label: ':bc',
   kind: this.monaco.languages.CompletionItemKind['Function'],
   insertText: 'bc',
   detail: ''
  }];
 },
 triggerCharacters: ['$', ':']
});

能获取光标后的第一个内容,后面的内容就都能获取啦,如果识别到前面的内容是 ${_DB 就提示 key ,否则提示 value

最后总结下来就是一定要多看文档,勤于测试就能解决问题啦~

总结

以上所述是小编给大家介绍的vue中实现Monaco Editor自定义提示功能 ,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

Javascript 相关文章推荐
24款热门实用的jQuery插件推荐
Dec 24 Javascript
JQuery日期插件datepicker的使用方法
Mar 03 Javascript
Web前端开发工具——bower依赖包管理工具
Mar 29 Javascript
jquery判断对象是否为空并遍历对象的简单实例
Jul 26 Javascript
js HTML5手机刮刮乐代码
Sep 29 Javascript
基于JS实现翻书效果的页面切换样式
Feb 16 Javascript
微信小程序利用co处理异步流程的方法教程
May 20 Javascript
js移动端图片压缩上传功能
Aug 18 Javascript
jQuery中将json数据显示到页面表格的方法
May 27 jQuery
从0到1搭建Element的后台框架的方法步骤
Apr 10 Javascript
JavaScript的Proxy可以做哪些有意思的事儿
Jun 15 Javascript
JavaScript中变量提升和函数提升的详解
Aug 07 Javascript
VueCli3.0中集成MockApi的方法示例
Jul 05 #Javascript
Electron vue的使用教程图文详解
Jul 05 #Javascript
监控微信小程序中的慢HTTP请求过程详解
Jul 05 #Javascript
JS实现求字符串中出现最多次数的字符和次数示例
Jul 05 #Javascript
JS Math对象与Math方法实例小结
Jul 05 #Javascript
js字符串类型String常用操作实例总结
Jul 05 #Javascript
JS前端知识点总结之内置对象,日期对象和定时器相关操作
Jul 05 #Javascript
You might like
php的日期处理函数及uchome的function_coomon中日期处理函数的研究
2011/01/12 PHP
PHP闭包(Closure)使用详解
2013/05/02 PHP
php 获取本地IP代码
2013/06/23 PHP
浅析php变量修饰符static的使用
2013/06/28 PHP
ThinkPHP表单自动验证实例
2014/10/13 PHP
Yii2简单实现多语言配置的方法
2016/07/23 PHP
Yii全局函数用法示例
2017/01/22 PHP
使用composer 安装 laravel框架的方法图文详解
2019/08/02 PHP
控制打印时页眉角的代码
2007/02/08 Javascript
JS网络游戏-(模拟城市webgame)提供的一些例子下载
2007/10/14 Javascript
jQuery示例收集
2010/11/05 Javascript
Firefox和IE兼容性问题及解决方法总结
2013/10/08 Javascript
javascript中数组的定义及使用实例
2015/01/21 Javascript
jQuery+PHP实现动态数字展示特效
2015/03/14 Javascript
jQuery制作效果超棒的手风琴折叠菜单
2015/04/03 Javascript
jQuery实现复选框批量选择与反选的方法
2015/06/17 Javascript
javascript判断复选框是否选中的方法
2015/10/16 Javascript
浅谈Javascript中的12种DOM节点类型
2016/08/19 Javascript
React复制到剪贴板的示例代码
2017/08/22 Javascript
浅谈angular4实际项目搭建总结
2017/12/01 Javascript
layui获取选中行数据的实例讲解
2018/08/19 Javascript
微信小程序实现文字无限轮播效果
2018/12/28 Javascript
如何在Vue.js中实现标签页组件详解
2019/01/02 Javascript
原生JavaScript之es6中Class的用法分析
2020/02/23 Javascript
vue ssr+koa2构建服务端渲染的示例代码
2020/03/23 Javascript
原生js实现九宫格拖拽换位
2021/01/26 Javascript
python开发之字符串string操作方法实例详解
2015/11/12 Python
Python正则表达式指南 推荐
2018/10/09 Python
python中logging模块的一些简单用法的使用
2019/02/22 Python
基于pycharm实现批量修改变量名
2020/06/02 Python
使用CSS3设计地图上的雷达定位提示效果
2016/04/05 HTML / CSS
浅谈关于html5中图片抛物线运动的一些心得
2018/01/09 HTML / CSS
智利最大的网上商店:Linio智利
2016/11/24 全球购物
政府班子四风问题整改措施
2014/10/04 职场文书
2014年精神文明建设工作总结
2014/11/19 职场文书
简爱电影观后感
2015/06/10 职场文书