Alert
Inline notification banner for important messages. Does not require user interaction to dismiss.
Overview
Purpose
The Alert component inline notification banner for important messages. does not require user interaction to dismiss.within our design system. It follows our compound layer principles, ensuring consistency and reusability across applications.
When to Use
- Use when you need presenting information
- Appropriate for display contexts
- Follows compound component patterns
When Not to Use
- Avoid when simpler alternatives exist
- Don't use for interactive functionality
- Consider alternatives for edge cases
Live Example
Anatomy
Understanding the structure of the Alert component helps ensure proper implementation and customization.
| Property | Description | Type |
|---|---|---|
| root | Outermost container that hosts the component. | Root |
| body | Body region of the component. | Slot |
| container | Container region of the component. | Slot |
| icon | Icon region of the component. | Slot |
| title | title prop for Alert. | Slot |
| dismiss | Dismiss region of the component. | Part |
Variants & States
API Reference
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
intent | Intent | No | 'info' | — |
level | AlertLevel | No | 'section' | — |
index | number | No | 0 | — |
Accessibility
Standards Compliance
This component follows WCAG 2.1 AA guidelines and includes proper ARIA attributes, keyboard navigation, and screen reader support.
Accessibility Checklist
- ○ Keyboard navigation support
- ○ Screen reader compatibility
- ○ Color contrast compliance
- ○ Focus management
- ○ ARIA attributes
- ○ Reduced motion support
Content Guidelines
Voice
Informative and empathetic
Tone
Varies by intent (calm for info, urgent for errors)
Copy Examples
Your changes have been saved successfully.
OK
Unable to connect. Please check your internet connection and try again.
Error occurred
UI Copy Patterns
- Explain what happened
- Suggest next steps when possible
- Use appropriate tone for intent
- Keep messages concise but complete
Usage Guidelines
Do
- Use consistent spacing and sizing
- Follow established patterns
- Provide clear labels and descriptions
- Test with assistive technologies
Don't
- Override core functionality
- Use without proper context
- Ignore accessibility requirements
- Modify without design system approval
Examples
Advanced Usage
Complex patterns including composition, state management, and real-world scenarios.
Development Tools
Use these tools to analyze the component's performance, design tokens, and accessibility during development.
Contribute
Help us improve the Alert component documentation. Found an issue or have suggestions?