通知
通知用於顯示從 VS Code 右下角彈出的簡要資訊。
您可以傳送三種類型的通知:
為了尊重使用者的注意力,限制傳送通知的數量非常重要。為了幫助您決定是否應該顯示通知,請遵循我們的通知決策樹。
通知示例
此通知在使用者執行更新版本命令後出現。請注意,它沒有額外的操作,純粹是資訊性的。
此示例突出了功能中需要使用者輸入的問題,並顯示瞭解決問題的操作。
此示例顯示了一個失敗通知,其中包含解決問題的操作。
✔️ 建議
- 僅在絕對必要時才傳送通知,以尊重使用者的注意力。
- 為每個通知新增“不再顯示”選項。
- 一次顯示一個通知。
❌ 不建議
- 傳送重複通知。
- 用於推廣。
- 首次安裝時徵求反饋。
- 如果沒有操作,則顯示操作。
進度通知
當需要顯示不確定時間段的進度(例如,設定環境)時,可以使用進度通知。這種全域性進度通知應作為最後手段,因為進度最好保持在上下文中(在檢視或編輯器中)。
✔️ 建議
- 顯示一個連結以檢視更多詳細資訊(如日誌)。
- 在設定過程中顯示資訊(初始化、構建等)。
- 提供一個取消操作的動作(如果適用)。
- 為超時場景新增計時器。
❌ 不建議
- 讓通知一直處於進行中。
此示例使用進度通知顯示遠端連線的設定過程,同時還提供了輸出日誌(詳細資訊)的連結。
模態對話方塊
當您需要立即使用者輸入才能執行操作時,可以選擇顯示模態對話方塊。此 UI 元素應謹慎使用,因為模態對話方塊會阻止對話方塊之外的使用者互動,直到其被關閉。
此對話方塊在移動 JavaScript/TypeScript 檔案後出現,要求更新其他檔案中的匯入語句。
✔️ 建議
- 僅在需要立即使用者互動時才使用模態對話方塊。
- 在適當的情況下,提供一個避免重複使用者確認的操作(“始終”/“從不”操作)。
- 考慮使用複選框來記住使用者的選擇。
❌ 不建議
- 使用模態對話方塊來確認多個步驟。
- 使用模態對話方塊顯示不需要使用者執行操作的訊息。
- 為非使用者明確發起的操作顯示模態對話方塊。