useAccessibleDescriptionWarning
Warns in development when an alert dialog has no accessible description. Call it as useAccessibleDescriptionWarning(node, component, descriptionPart?). Does nothing in production or while node is null.
Use for
- a dev warning when an alert dialog renders without a description
- checking that
aria-describedbypoints at an element with text
Practices
| Guidance | Practice |
|---|---|
| Do | Pass null as node for an ordinary dialog. Only an alert dialog needs a description. |
| Do | Pass descriptionPart when the description comes from a part other than <component>.Description, as Dialog does with Card.Description. |
Examples
Only for an alert dialog
useAccessibleDescriptionWarning(isAlert ? node : null, 'Dialog', 'Card.Description');