通知
通知显示简短信息,这些信息会从 VS Code 的右下角浮出。
您可以发送三种类型的通知
重要的是要限制发送的通知数量,以尊重用户的注意力。为了帮助指导您决定是否应显示通知,请遵循我们的通知决策树
通知示例
此通知在用户运行“更新版本”命令后出现。请注意,没有额外的操作,纯粹是信息性的。
此示例突出显示了需要用户输入的功能问题,并显示了解决问题的操作。
此示例显示了一个失败通知,其中包含解决问题的操作。
✔️ 建议
- 仅在绝对必要时才发送通知,以尊重用户的注意力
- 为每个通知添加“不再显示”选项
- 一次显示一个通知
❌ 不建议
- 发送重复通知
- 用于促销
- 首次安装时征求反馈
- 如果没有操作,则显示操作
进度通知
当需要显示不确定时间段的进度时(例如,设置环境),您可以使用进度通知。这种全局进度通知应作为最后手段,因为进度最好保持在上下文中(在视图或编辑器中)。
✔️ 建议
- 显示一个链接以查看更多详细信息(如日志)
- 在设置进行时显示信息(初始化、构建等)
- 提供取消操作的选项(如果适用)
- 为超时场景添加计时器
❌ 不建议
- 将通知保持在进行中
此示例使用进度通知来显示远程连接的设置,同时还提供了输出日志(详细信息)的链接。
模态对话框
当您需要立即用户输入以执行某个操作时,可以选择显示模态对话框。应谨慎使用此 UI 元素,因为模态对话框会阻止对话框外部的用户交互,直到它被关闭。
此对话框在移动 JavaScript/TypeScript 文件后出现,要求更新其他文件中的导入语句。
✔️ 建议
- 仅在需要立即用户交互时使用模态对话框
- 在适当的情况下,提供一个操作以避免重复的用户确认(“始终”/“从不”操作)
- 考虑使用复选框来记住用户的选择
❌ 不建议
- 使用模态对话框确认多个步骤
- 使用模态对话框显示不需要用户执行操作的消息
- 为非用户明确启动的操作显示模态对话框