VSCODE插件开发:用户输入输出
阅读这篇文章之前,假设你已经具有开发helloworld的插件的能力。
vscode.window 简介
vscode.window
负责当前激活窗口的输入输出,比如展示信息,和用户输入等功能都是用vscode.window实现
代码输出提示信息
简单的输出提示信息
使用vscode.windows.showInformationMessage('Hello World!')可以进行简单输出信息展示。
let disposable = vscode.commands.registerCommand('extension.sayHello', () => {
// Display a message box to the user
vscode.window.showInformationMessage('Hello World!');
});
效果如下:

示例代码在官方文档中也可以找到,Example-hello world:https://code.visualstudio.com/docs/extensions/example-hello-world
带有选择项的输出提示信息
如果提示信息想带回用户的选择怎么办,参考以下代码
let disposable = vscode.commands.registerCommand('extension.sayHello', function () {
vscode.window.showInformationMessage("请问你现在的心情如何",'你说什么','我不知道','再见!')
.then(function(select){
console.log(select);
});
});
在提示信息后面紧跟上给用户的选择项,然后用then接收即可
效果如下:

不同类型的输出
官方提供了三种不同类型的信息输出方法
分别是:
- showInformationMessage()
- showErrorMessage()
- showWarningMessage()
三个的用法基本类似,提示框的样式会有区别
状态栏设置
使用vscode.windows.setStatusBarMessage设置状态栏提示信息
let disposable = vscode.commands.registerCommand('extension.sayHello', function () {
vscode.window.setStatusBarMessage('今天也要快乐鸭!~',3000);
});
额,写这些有什么意义?官方文档很清晰了好吗,不想写了。
官方文档地址:https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.setStatusBarMessage
用户输入
字符串输入
使用vscode.window.showInputBox()打开一个输入框让用户输入信息
let disposable = vscode.commands.registerCommand('extension.sayHello', function () {
vscode.window.showInputBox(
{ // 这个对象中所有参数都是可选参数
password:false, // 输入内容是否是密码
ignoreFocusOut:true, // 默认false,设置为true时鼠标点击别的地方输入框不会消失
placeHolder:'你到底想输入什么?', // 在输入框内的提示信息
prompt:'赶紧输入,不输入就赶紧滚', // 在输入框下方的提示信息
validateInput:function(text){return text;} // 对输入内容进行验证并返回
}).then(function(msg){
console.log("用户输入:"+msg);
});
});
界面效果如下:
选择本地文件
使用vscode.window.showOpenDialog()用来选择本地文件
let disposable = vscode.commands.registerCommand('extension.sayHello', function () {
vscode.window.showOpenDialog(
{ // 可选对象
canSelectFiles:true, // 是否可选文件
canSelectFolders:false, // 是否可选文件夹
canSelectMany:true, // 是否可以选择多个
defaultUri:vscode.Uri.file("/D:/"), // 默认打开本地路径
openLabel:'按钮文字说明'
}).then(function(msg){
console.log(msg.path);
})
});
官方文档:https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.showOpenDialog
打开选择框
let disposable = vscode.commands.registerCommand('extension.sayHello', function () {
vscode.window.showQuickPick(
[
"哈哈哈,你是傻逼吗",
"哈哈哈,你是二逼么",
"你他妈有病吧",
"乖,你是妈的智障"
],
{
canPickMany:true,
ignoreFocusOut:true,
matchOnDescription:true,
matchOnDetail:true,
placeHolder:'温馨提示,请选择你是哪种类型?'
})
.then(function(msg){
console.log(msg);
})
});
官方文档:https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.showQuickPick
总结
官方文档很详细,看官方文档吧。这里只是简单记录下
VSCODE插件开发:用户输入输出的更多相关文章
- VSCode插件开发全攻略(七)WebView
更多文章请戳VSCode插件开发全攻略系列目录导航. 什么是Webview 大家都知道,整个VSCode编辑器就是一张大的网页,其实,我们还可以在Visual Studio Code中创建完全自定义的 ...
- VSCode插件开发全攻略(三)package.json详解
更多文章请戳VSCode插件开发全攻略系列目录导航. package.json 在详细介绍vscode插件开发细节之前,这里我们先详细介绍一下vscode插件的package.json写法,但是建议先 ...
- VSCode插件开发全攻略(二)HelloWord
更多文章请戳VSCode插件开发全攻略系列目录导航. 写着前面 学习一门新的语言或者生态首先肯定是从HelloWord开始. 您可以直接克隆我放在GitHub上vscode-plugin-demo 的 ...
- VSCode插件开发全攻略(九)常用API总结
更多文章请戳VSCode插件开发全攻略系列目录导航. 本文提炼一些常见的API使用场景供参考,本文内容有待完善. 编辑器相关 修改当前激活编辑器内容 替换当前编辑器全部内容: vscode.windo ...
- VSCode插件开发全攻略(十)打包、发布、升级
更多文章请戳VSCode插件开发全攻略系列目录导航. 发布方式 插件开发完了,如何发布出去分享给他人呢?主要有3种方法: 方法一:直接把文件夹发给别人,让别人找到vscode的插件存放目录并放进去,然 ...
- VSCode插件开发全攻略(八)代码片段、设置、自定义欢迎页
更多文章请戳VSCode插件开发全攻略系列目录导航. 代码片段 代码片段,也叫snippets,相信大家都不陌生,就是输入一个很简单的单词然后一回车带出来很多代码.平时大家也可以直接在vscode中创 ...
- VSCode插件开发全攻略(六)开发调试技巧
更多文章请戳VSCode插件开发全攻略系列目录导航. 前言 在介绍完一些比较简单的内容点之后,我觉得有必要先和大家介绍一些开发中遇到的一些细节问题以及技巧,特别是后面一章节将要介绍WebView的知识 ...
- VSCode插件开发全攻略(五)跳转到定义、自动补全、悬停提示
更多文章请戳VSCode插件开发全攻略系列目录导航. 跳转到定义 跳转到定义其实很简单,通过vscode.languages.registerDefinitionProvider注册一个provide ...
- VSCode插件开发全攻略(四)命令、菜单、快捷键
更多文章请戳VSCode插件开发全攻略系列目录导航. 命令 我们在前面HelloWord章节中已经提到了命令写法,这里再重温一下. context.subscriptions.push(vscode. ...
- VSCode插件开发全攻略(一)概览
文章索引 VSCode插件开发全攻略(一)概览 VSCode插件开发全攻略(二)HelloWord VSCode插件开发全攻略(三)package.json详解 VSCode插件开发全攻略(四)命令. ...
随机推荐
- 461. Hamming Distance(汉明距离)
The Hamming distance between two integers is the number of positions at which the corresponding bits ...
- 【原创】Elasticsearch无宕机迁移节点
官方API文档:https://www.elastic.co/guide/en/elasticsearch/reference/current/allocation-filtering.html 参考 ...
- Ruby Encoding类
Encoding类 内部编码 IO对象内部处理时候的编码 外部编码 IO对象对外输出的时候的编码 输入 外部字符与自己的外部编码对比(没设定的默认 ...
- Codeforces 908F - New Year and Rainbow Roads 【脑洞】
题意:在一条数轴上有若干'R','B','G'点,连接两个点的代价是位置差,要求使用最小代价使得除去所有'R'点后剩下的所有点联通,除去所有'B'点后剩下的所有点联通. 还以为会是什么最小生成树,结果 ...
- AOP日志框架实现
AOP日志框架实现 JDK动态代理实现日志框架 首先,在项目包com.ay.test 下创建业务接口类BusinessClassService,具体代码如下: BusinessC lassServic ...
- SpringBoot使用MongoDB
一.什么是MongoDB MongoDB是一个基于分布式文件存储的数据库,由C++语言编写.旨在为WEB应用提供可扩展的高性能数据存储解决方案. MongoDB是一个介于关系数据库和非关系数据库之间的 ...
- postgreSQL 创建user表时引发的表名大写与双引号问题
在postgreSQL里面,user是一个保留字. 如果你想创建user表,你可能会遭遇一些问题! 如图: 可以看到,这里是无法创建user表的. 你可能会说,我只是没有加双引号"" ...
- python的Template使用指南
本文主要讲解了python中Template使用方法以及使用技巧,非常实用,有需要的朋友可以参考下: Template无疑是一个好东西,可以将字符串的格式固定下来,重复利用.同时Template也可以 ...
- Neighbor House LightOJ - 1047
Neighbor House LightOJ - 1047 #include<cstdio> #include<cstring> #include<algorithm&g ...
- 递推DP UVA 607 Scheduling Lectures
题目传送门 题意:教授给学生上课,有n个主题,每个主题有ti时间,上课有两个限制:1. 每个主题只能在一节课内讲完,不能分开在多节课:2. 必须按主题顺序讲,不能打乱.一节课L时间,如果提前下课了,按 ...