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