HDS-3919 Add clarifying comment

hashicorp · Oct 16, 2024 · 9b35f4a · 9b35f4a
1 parent b01b7df
commit 9b35f4a
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/packages/components/src/components/hds/alert/index.ts b/packages/components/src/components/hds/alert/index.ts
@@ -155,6 +155,7 @@ export default class HdsAlert extends Component<HdsAlertSignature> {
       `${CONTENT_ELEMENT_SELECTOR} button, ${CONTENT_ELEMENT_SELECTOR} a`
     );
 
+    // an Alert which actually alerts users (has role="alert" & aria-live="polite") as opposed to an informational or promo "alert"
     const isRealAlert: boolean =
       this.color === 'warning' ||
       this.color === 'critical' ||