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

import React from 'react';
import Alert from './components/Alert';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Alert {...props}>
        {props.children || 'Example alert content'}
      </Alert>
    </div>
  );
}

Anatomy

Understanding the structure of the Alert component helps ensure proper implementation and customization.

Property Description Type
rootOutermost container that hosts the component.Root
bodyBody region of the component.Slot
containerContainer region of the component.Slot
iconIcon region of the component.Slot
titletitle prop for Alert.Slot
dismissDismiss region of the component.Part

Variants & States

import React from 'react';
import Alert from './components/Alert';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Alert {...props}>
        {props.children || 'Example alert content'}
      </Alert>
    </div>
  );
}

API Reference

Props

NameTypeRequiredDefaultDescription
intentIntentNo'info'—
levelAlertLevelNo'section'—
indexnumberNo0—

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

Do

Your changes have been saved successfully.

Don't

OK

Do

Unable to connect. Please check your internet connection and try again.

Don't

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

Basic Usage

Simple implementation with default props and common configurations.

import React from 'react';
import Alert from './components/Alert';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Alert {...props}>
        {props.children || 'Example alert content'}
      </Alert>
    </div>
  );
}

Advanced Usage

Complex patterns including composition, state management, and real-world scenarios.

import React from 'react';

export default function App() {
  return (
    <div style={{ 
      padding: '2rem', 
      display: 'flex',
      flexDirection: 'column',
      gap: '1.5rem'
    }}>
      <h3>Alert - Advanced Patterns</h3>
      <p>Advanced usage patterns for Alert include:</p>
      <ul>
        <li>Composition with other components</li>
        <li>Custom styling and theming</li>
        <li>Controlled vs uncontrolled patterns</li>
        <li>Form integration</li>
        <li>Accessibility enhancements</li>
      </ul>
      <p style={{ color: '#6b7280', fontStyle: 'italic' }}>
        Full advanced examples coming soon.
      </p>
    </div>
  );
}

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?

Related Components