通知

通知用于显示从 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 文件后出现,询问是否更新其他文件中的 import 语句。

✔️ 建议

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

❌ 不建议

  • 使用模态对话框确认多个步骤
  • 使用模态对话框显示不需要用户操作的信息
  • 针对非用户明确发起的动作显示模态对话框
© . This site is unofficial and not affiliated with Microsoft.