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 相关文章推荐
Firefox中autocomplete=&quot;off&quot; 设置不起作用Bug的解决方法
Mar 25 Javascript
javascript中onclick(this)用法介绍
Apr 19 Javascript
ParseInt函数参数设置介绍
Jan 02 Javascript
JS根据年月获得当月天数的实现代码
Jul 03 Javascript
javaScript的函数对象的声明详解
Feb 06 Javascript
深入理解jQuery 事件处理
Jun 14 Javascript
HTML Table 空白单元格补全的简单实现
Oct 13 Javascript
jQuery中$.ajax()方法参数解析
Oct 22 Javascript
微信小程序 检查接口状态实例详解
Jun 23 Javascript
vue嵌套路由与404重定向实现方法分析
May 04 Javascript
javascript中的相等操作符(==与===区别)
Dec 21 Javascript
在项目vue中使用echarts的操作步骤
Sep 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
模仿OSO的论坛(四)
2006/10/09 PHP
php中explode函数用法分析
2014/11/15 PHP
php字符比较函数similar_text、strnatcmp与strcasecmp用法分析
2014/11/18 PHP
php使用Image Magick将PDF文件转换为JPG文件的方法
2015/04/01 PHP
PHP实现的简单分页类及用法示例
2016/05/06 PHP
laravel多条件查询方法(and,or嵌套查询)
2019/10/09 PHP
PHP+MySql实现一个简单的留言板
2020/07/19 PHP
判断目标是否是window,document,和拥有tagName的Element的代码
2010/05/31 Javascript
根据表格中的某一列进行排序的javascript代码
2013/11/29 Javascript
jQuery 回车事件enter使用示例
2014/02/18 Javascript
Java  Spring 事务回滚详解
2016/10/17 Javascript
使用jQuery的ajax方法向服务器发出get和post请求的方法
2017/01/13 Javascript
Vue Transition实现类原生组件跳转过渡动画的示例
2017/08/19 Javascript
微信小程序实现分享到朋友圈功能
2018/07/19 Javascript
vue开发环境配置跨域的方法步骤
2019/01/16 Javascript
微信小程序调用微信支付接口的实现方法
2019/04/29 Javascript
Vue通过WebSocket建立长连接的实现代码
2019/11/05 Javascript
python socket多线程通讯实例分析(聊天室)
2016/04/06 Python
Python模拟三级菜单效果
2017/09/11 Python
python3大文件解压和基本操作
2017/12/15 Python
python 字符串和整数的转换方法
2018/06/25 Python
Python实现图像的垂直投影示例
2020/01/17 Python
基于python3实现倒叙字符串
2020/02/18 Python
Python如何将模块打包并发布
2020/08/30 Python
Pycharm的Available Packages为空的解决方法
2020/09/18 Python
CSS3悬停效果案例应用
2012/11/21 HTML / CSS
英国家喻户晓的高街品牌:River Island
2017/11/28 全球购物
GOOD AMERICAN官网:为曲线性感而设计
2017/12/28 全球购物
物流专业大学的自我评价
2014/01/11 职场文书
房屋出售协议书
2014/04/10 职场文书
食品工程专业求职信
2014/06/15 职场文书
教师三严三实学习心得体会
2014/10/11 职场文书
委托书格式范文
2015/01/28 职场文书
会计求职简历自我评价
2015/03/10 职场文书
2019年年中工作总结讲话稿模板
2019/03/25 职场文书
nginx如何将http访问的网站改成https访问
2021/03/31 Servers