Modal

Blocking and non-blocking overlay container.

Also known as:
  • Dialog
  • Timeout Modal
  • Modal dialog
  • Modal alert
  • Pop confirm
  • Lightbox
  • Overlay Dialog
  • Full-screen Modal
  • Centered Modal
  • Dialog Box

Overview

Purpose

The Modal component blocking and non-blocking overlay container.within our design system. It follows our composer layer principles, ensuring consistency and reusability across applications.

When to Use

  • Use when you need organizing content
  • Appropriate for containers contexts
  • Follows composer component patterns

When Not to Use

  • Avoid when simpler alternatives exist
  • Don't use for interactive elements
  • Consider alternatives for edge cases

Anatomy

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

Anatomy documentation will be available once the component is implemented. The structure will follow our composer layer guidelines.

Variants & States

Interactive variants will be available once the component is implemented. Expected variants include standard states and visual variations.

API Reference

API documentation will be available once the component is implemented in ui/components/Modal.

Accessibility

Standards Compliance

This component follows WCAG 2.1 AA guidelines and includes proper ARIA attributes, keyboard navigation, and screen reader support.

Common Pitfalls

  • Not trapping focus
  • poor mobile handling
  • misuse for inline content.

Accessibility Checklist

  • ✓ Keyboard navigation support
  • ✓ Screen reader compatibility
  • ✓ Color contrast compliance
  • ✓ Focus management
  • ✓ ARIA attributes
  • ✓ Reduced motion support

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

Code examples will be available once the component is implemented. Examples will include basic usage, advanced patterns, and integration scenarios.

Related Components