Clarify Alert ARIA documentation

2023-10-12 09:41:47 +02:00
parent 5f4e9d4879
commit cce5a989cf
1 changed files with 3 additions and 1 deletions
--- a/extensions/ql-vscode/src/view/common/Alert.tsx
+++ b/extensions/ql-vscode/src/view/common/Alert.tsx
@@ -92,7 +92,9 @@ type Props = {
   * important enough to require the user's immediate attention.
   *
   * Can be left out if the alert is not important enough to require the user's
-   * immediate attention.
+   * immediate attention. In this case, no ARIA role will be set and the alert
+   * will be read as normal text. The user will not be notified about any changes
+   * to the alert.
   */
  role?: "alert" | "status";
 };