Details Component

Overview

Purpose

The Details component disclosure widget revealing additional content on demand. semantically equivalent to <details>/<summary>.within our design system. It follows our composer layer principles, ensuring consistency and reusability across applications.

When to Use

Use when you need component functionality
Appropriate for textual contexts
Follows composer component patterns

When Not to Use

Avoid when simpler alternatives exist
Don't use for inappropriate contexts
Consider alternatives for edge cases

Live Example

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

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

Open Sandbox

Anatomy

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

Property	Description	Type
root	Slot rendered into [data-slot="details"].	Root
compact	Compact region of the component.	Slot
inline	Inline region of the component.	Slot
summary	Slot rendered into [data-slot="details-summary"].	Slot (required)
summaryContent	Summary content region of the component.	Part
icon	Icon configuration - replaces showIcon + iconPosition booleans	"left" \| "right" \| "none" \| undefined
summaryText	Summary text region of the component.	Part
content	Slot rendered into [data-slot="details-content"].	Slot (required)

Variants & States

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

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

Open Sandbox

API Reference

Props

Name	Type	Required	Default	Description
`summary`	`string`	Yes	—	—
`children`	`React.ReactNode`	Yes	—	—
`className`	`string`	No	`''`	—
`variant`	`'default' \| 'inline' \| 'compact'`	No	`'default'`	—
`icon`	`'left' \| 'right' \| 'none'`	No	`'left'`	—
`onKeyDown`	`(e: React.KeyboardEvent) => void`	No	`{handleKeyDown`	—

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

Basic Usage

Simple implementation with default props and common configurations.

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

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

Open Sandbox

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>Details - Advanced Patterns</h3>
      <p>Advanced usage patterns for Details 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>
  );
}

Open Sandbox

Development Tools

Use these tools to analyze the component's performance, design tokens, and accessibility during development.

Contribute

Help us improve the Details component documentation. Found an issue or have suggestions?

Edit this page Report an issue Contribution guidelines

Details

Overview

Purpose

When to Use

When Not to Use

Live Example

Anatomy

Variants & States

API Reference

Props

Accessibility

Standards Compliance

Accessibility Checklist

Usage Guidelines

Do

Don't

Examples

Basic Usage

Advanced Usage

Development Tools

Contribute

Related Components

Blockquote

Heading

Postcard

ShowMore

Text

Accordion