通知
通知は、VS Codeの右下に表示される簡潔な情報です。
3種類の通知を送信できます
ユーザーの注意を尊重するため、送信する通知の数を制限することが重要です。通知を表示すべきかどうかを判断する際は、私たちの通知意思決定ツリーに従ってください。
通知の例
この通知は、ユーザーが Update version コマンドを実行した後に表示されます。追加のアクションはなく、純粋に情報提供のみを目的としていることに注目してください。
この例では、ユーザーの入力を必要とする機能の問題を取り上げ、問題を解決するためのアクションを表示しています。
この例では、問題を解決するためのアクションを伴うエラー通知を表示しています。
✔️ するべきこと
- 通知は絶対に必要な場合にのみ送信し、ユーザーの注意を尊重してください
- すべての通知に 再表示しない オプションを追加してください
- 一度に表示する通知は1つにしてください
❌ すべきでないこと
- 繰り返し通知を送信する
- プロモーションに使用する
- 初回インストール時にフィードバックを求める
- アクションがない場合にアクションを表示する
進行状況の通知
終了までの時間が不確定な処理（環境のセットアップなど）で進行状況を表示する必要がある場合は、進行状況通知を使用できます。このタイプのグローバルな進行状況通知は、コンテキスト内（ビューやエディター内）に進行状況を表示するのが難しい場合の最終手段として使用してください。
✔️ するべきこと
- 詳細（ログなど）を確認するためのリンクを表示する
- セットアップの進行に合わせて情報（初期化中、ビルド中など）を表示する
- 操作をキャンセルするためのアクションを提供する（該当する場合）
- タイムアウト時のタイマーを追加する
❌ すべきでないこと
- 通知の進行状況を実行したまま放置する
この例では、進行状況通知を使用してリモート接続のセットアップ状況を表示しつつ、出力ログ（詳細）へのリンクも提供しています。
モーダルダイアログ
アクションに対して即座にユーザーの入力が必要な場合は、モーダルダイアログを表示する選択肢があります。モーダルダイアログは閉じられるまでユーザーの操作をブロックするため、慎重に使用する必要があります。
このダイアログは、JavaScript/TypeScriptファイルを移動した後に表示され、他のファイル内のインポート文を更新するかどうかを尋ねます。
✔️ するべきこと
- 即座のユーザー操作が必要な場合にのみ、モーダルダイアログを使用してください
- 適切な場合は、繰り返し確認を避けるためのアクション（常に/しない アクション）を提供してください
- ユーザーの選択を記憶するためのチェックボックスの使用を検討してください
❌ すべきでないこと
- 複数の手順を確認するためにモーダルダイアログを使用する
- ユーザーによる操作を必要としないメッセージの表示にモーダルダイアログを使用する
- ユーザーが明示的に開始していないアクションに対してモーダルダイアログを表示する