Avatar Component

Overview

Purpose

The Avatar component user representation (image/initials).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 Avatar from './components/Avatar';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Avatar
        size={props.size || 'medium'}
        src={props.src}
        alt={props.alt || 'Avatar'}
        initials={props.initials}
        status={props.status}
      />
    </div>
  );
}

Open Sandbox

Anatomy

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

Anatomy data not yet defined for this component. Define anatomy in the component contract file (Avatar.contract.json).

Variants & States

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

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Avatar
        size={props.size || 'medium'}
        src={props.src}
        alt={props.alt || 'Avatar'}
        initials={props.initials}
        status={props.status}
      />
    </div>
  );
}

Open Sandbox

API Reference

Props

Name	Type	Required	Default	Description
`src`	`string`	No	`{src`	—
`name`	`string`	Yes	—	—
`size`	`'small' \| 'medium' \| 'large' \| 'extra-large'`	Yes	—	—
`priority`	`boolean`	No	`false`	—

Methods

Name	Parameters	Returns	Description
`initials`	`name: string`	`void`	—

Accessibility

Standards Compliance

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

Common Pitfalls

Missing alt/fallback
low-contrast initials.

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 Avatar from './components/Avatar';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Avatar
        size={props.size || 'medium'}
        src={props.src}
        alt={props.alt || 'Avatar'}
        initials={props.initials}
        status={props.status}
      />
    </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>Avatar - Advanced Patterns</h3>
      <p>Advanced usage patterns for Avatar 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 Avatar component documentation. Found an issue or have suggestions?

Edit this page Report an issue Contribution guidelines

Avatar

Overview

Purpose

When to Use

When Not to Use

Live Example

Anatomy

Variants & States

API Reference

Props

Methods

Accessibility

Standards Compliance

Common Pitfalls

Accessibility Checklist

Usage Guidelines

✓ Do

✗ Don't

Examples

Basic Usage

Advanced Usage

Development Tools

Contribute

Related Components

Card

Chip

Divider

Icon

Image

ListItem