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 相关文章推荐
关于 byval 与 byref 的区别分析总结
Oct 08 Javascript
JS左右无缝滚动(一般方法+面向对象方法)
Aug 17 Javascript
javascript跨浏览器的属性判断方法
Mar 16 Javascript
Jquery 垂直多级手风琴菜单附源码下载
Nov 17 Javascript
Bootstrap轮播加上css3动画,炫酷到底!
Dec 22 Javascript
JavaScript实现搜索框的自动完成功能(一)
Feb 25 Javascript
Ext JS框架中日期函数的用法及日期选择控件的实现
May 21 Javascript
JS代码实现百度地图 画圆 删除标注
Oct 12 Javascript
JS 终止执行的实现方法
Nov 24 Javascript
JS双击变input框批量修改内容
Dec 12 Javascript
AngularJS 控制器 controller的详解
Oct 17 Javascript
微信小程序云开发如何使用npm安装依赖
May 18 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递归函数中使用return的注意事项
2014/01/17 PHP
thinkphp 中的volist标签在ajax操作中的特殊性(推荐)
2018/01/15 PHP
使用jquery给input和textarea设定ie中的focus
2008/05/29 Javascript
国外的为初学者写的JavaScript教程
2008/06/09 Javascript
过虑特殊字符输入的js代码
2010/08/05 Javascript
JavaScript获取按钮所在form表单id的方法
2015/04/02 Javascript
原生JavaScript编写canvas版的连连看游戏
2016/05/29 Javascript
BootStrapTable 单选及取值的实现方法
2017/01/10 Javascript
JavaScript日期选择功能示例
2017/01/16 Javascript
基于node.js实现爬虫的讲解
2019/02/18 Javascript
详解Vue.directive 自定义指令
2019/03/27 Javascript
Vue 无限滚动加载指令实现方法
2019/05/28 Javascript
VsCode与Node.js知识点详解
2019/09/05 Javascript
JS中自定义事件的使用与触发操作实例分析
2019/11/01 Javascript
jQuery事件模型默认行为执行顺序及trigger()与 triggerHandler()比较实例分析
2020/04/30 jQuery
[49:54]Ti4 循环赛第三日 LGD vs Titan
2014/07/12 DOTA
Python算法应用实战之队列详解
2017/02/04 Python
python+selenium实现登录账户后自动点击的示例
2017/12/22 Python
python实现用户答题功能
2018/01/17 Python
python3监控CentOS磁盘空间脚本
2018/06/21 Python
Python中实例化class的执行顺序示例详解
2018/10/14 Python
使用selenium模拟登录解决滑块验证问题的实现
2019/05/10 Python
python中数组和矩阵乘法及使用总结(推荐)
2019/05/18 Python
python实现自动化上线脚本的示例
2019/07/01 Python
OpenCV 之按位运算举例解析
2020/06/19 Python
俄罗斯运动、健康和美容产品在线商店:Lactomin.ru
2020/07/23 全球购物
越南母婴用品购物网站:Kids Plaza
2020/04/09 全球购物
推荐信格式范文
2014/05/09 职场文书
机电一体化毕业生自荐信
2014/06/19 职场文书
体育专业求职信
2014/07/16 职场文书
爬山的活动方案
2014/08/16 职场文书
个人工作表现评价材料
2014/09/21 职场文书
2014年底个人工作总结
2015/03/10 职场文书
Python 流媒体播放器的实现(基于VLC)
2021/04/28 Python
springboot使用Redis作缓存使用入门教程
2021/07/25 Redis
Python类方法总结讲解
2021/07/26 Python