Avatar

DisplayCompoundBuilt

User representation (image/initials).

Also known as:

Profile image
User Icon
User Image
Profile Picture
User Avatar
Profile Avatar
User Thumbnail

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

Initializing sandbox...

Anatomy

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

Component anatomy diagram will be generated based on the actual component structure.

Variants & States

Disabled

Open Sandbox

Initializing sandbox...

API Reference

Props

Props documentation will be auto-generated from the component implementation.

Methods

Method documentation will be extracted from the component interface.

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

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

Initializing sandbox...

Advanced Usage

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>
  );
}