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