Sheet
Slide-in panel (drawer) that overlays the page from an edge. Traps focus until dismissed.
Overview
Purpose
The Sheet component slide-in panel (drawer) that overlays the page from an edge. traps focus until dismissed.within our design system. It follows our composer layer principles, ensuring consistency and reusability across applications.
When to Use
- Use when you need providing system feedback
- Appropriate for feedback contexts
- Follows composer component patterns
When Not to Use
- Avoid when simpler alternatives exist
- Don't use for permanent content
- Consider alternatives for edge cases
Live Example
Anatomy
Understanding the structure of the Sheet component helps ensure proper implementation and customization.
| Property | Description | Type |
|---|---|---|
| root | Slot rendered into [data-slot="sheet"]. | Root |
| body | Slot rendered into [data-slot="sheet-body"]. | Slot |
| close | Slot rendered into [data-slot="sheet-close"]. | Slot |
| content | Slot rendered into [data-slot="sheet-content"]. | Slot |
| description | Slot rendered into [data-slot="sheet-description"]. | Slot |
| footer | Slot rendered into [data-slot="sheet-footer"]. | Slot |
| header | Slot rendered into [data-slot="sheet-header"]. | Slot |
| overlay | Slot rendered into [data-slot="sheet-overlay"]. | Slot |
| portal | Portal region of the component. | Slot |
| title | Slot rendered into [data-slot="sheet-title"]. | Slot |
| trigger | Slot rendered into [data-slot="sheet-trigger"]. | Slot |
| modal | modal prop for Sheet. | boolean | undefined |
Variants & States
API Reference
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
children | React.ReactNode | Yes | — | — |
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
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 Sheet component documentation. Found an issue or have suggestions?