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