Unofficial
Internal
Components
Warning text
A component to warn the user of something important.
Props
| Name | Type | Default | Description |
|---|---|---|---|
| id | other | 'id' attribute to place on the base HTML element | |
| classBlock | other | Block name override in BEM style classes applied to all elements | |
| classModifiers | other | BEM style modifiers to apply to the base HTML element | |
| className | other | Extra classes to apply to the base HTML element | |
| iconFallbackText | other | Hidden text to be read out by a screen-reader prior to the warning |
When to use this component
Use the warning text component when you need to warn users about something important, such as legal consequences of an action, or lack of action, that they might take.
How it works
You might need to rewrite the hidden, assistive, text (‘Warning’ in the example) to make it appropriate for your context.
Stories
Standard
A standard Warning text.
Custom assistive text
Warning text with custom hidden text for users of screen-readers.