🚀 在 VS Code 中

通知

通知 在 VS Code 的右下方显示简短信息。

Example of a notification

您可以发送三种类型的通知

重要的是限制发送的通知数量,以尊重用户的注意力。为了帮助您决定是否应该显示通知,请遵循我们的通知决策树

Show a multi-step quick pick if multi step user input is immediately needed. If user input is immediately needed but it is not multi-step show a modal dialog. If you need to show progress that is low priority show the progress in the status bar. If the interaction is triggered by the user find the right moment to show the notification and only then show it. If you need to show multiple notifications try to combine them into one. If the user does not really need to be notified consider to not show anything and relax.

通知示例

Information notification

此通知在用户运行更新版本命令后出现。请注意,没有其他操作,并且纯粹是信息性的。

Warning notification

此示例突出显示了需要用户输入的功能问题,并显示了解决问题的操作。

Error notification

此示例显示了一个失败通知,其中包含解决问题的操作。

✔️ 建议

  • 仅在绝对必要时发送通知,尊重用户的注意力
  • 为每个通知添加“不再显示”选项
  • 一次显示一个通知

❌ 不建议

  • 发送重复通知
  • 用于促销
  • 在首次安装时请求反馈
  • 如果没有操作,则显示操作

进度通知

当需要显示不确定时间范围的进度时(例如,设置环境),可以使用进度通知。这种类型的全局进度通知应作为最后的手段使用,因为进度最好保持在上下文中(在视图或编辑器中)。

✔️ 建议

  • 显示链接以查看更多详细信息(如日志)
  • 在设置过程中显示信息(初始化、构建等)
  • 提供取消操作的动作(如果适用)
  • 为超时场景添加计时器

❌ 不建议

  • 让通知在进度中运行

Progress notification

此示例使用进度通知来显示远程连接的设置过程,同时还提供指向输出日志的链接(详细信息)。

当您需要立即用户输入以执行操作时,可以选择显示模态对话框。此 UI 元素应谨慎使用,因为模态对话框会阻止对话框外部的用户交互,直到它被关闭。

Modal dialog

此对话框在移动 JavaScript/TypeScript 文件后出现,要求更新其他文件中的导入语句。

✔️ 建议

  • 仅在需要立即用户交互时使用模态对话框
  • 在适当的情况下,提供一个操作以避免重复的用户确认(“始终”/“从不”操作)
  • 考虑使用复选框记住用户的选择

❌ 不建议

  • 使用模态对话框确认多个步骤
  • 使用模态对话框显示不需要用户操作的消息
  • 对于非用户显式启动的操作,显示模态对话框