Avatar

Usage

import { Avatar } from "@devvy-ui/react";

<Avatar name="Ada Rivera" />

API reference

Native HTML attributes, className, style and a forwarded ref are supported. Component-specific props:

Prop	Type	Default	Description
name	string	required	Accessible person name and initials source.
src / imageProps	string / native img props	—	Optional image and native image callbacks.
size / shape	sm \| md \| lg / circle \| square	md / circle	Dimensions and shape.

Source ownership

Run npx @devvy-ui/cli init once in your React project, then add the source:

npx @devvy-ui/cli add avatar

Make the source yours.

Start from the canonical implementation used by the package and registry. Change the code, keep the MIT notice, and build the behavior your project needs.

Avatar.tsxREACT / TSX

import { forwardRef, useState, type HTMLAttributes, type ImgHTMLAttributes } from 'react';
import { cx } from '../lib/cx';
export interface AvatarProps extends Omit<HTMLAttributes<HTMLSpanElement>, 'children'> {
  name: string;
  src?: string;
  size?: 'sm' | 'md' | 'lg';
  shape?: 'circle' | 'square';
  imageProps?: Omit<ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt'>;
}
export const Avatar = forwardRef<HTMLSpanElement, AvatarProps>(function Avatar(
  { name, src, size = 'md', shape = 'circle', imageProps, className, ...props },
  ref,
) {
  const [failed, setFailed] = useState<string>();
  const initials =
    name
      .trim()
      .split(/\s+/)
      .filter(Boolean)
      .slice(0, 2)
      .map((part) => Array.from(part)[0])
      .join('')
      .toLocaleUpperCase() || '?';
  return (
    <span
      role="img"
      aria-label={name.trim() || 'Unknown person'}
      {...props}
      ref={ref}
      className={cx('dvy-avatar', className)}
      data-size={size}
      data-shape={shape}
    >
      {src && src !== failed ? (
        <img
          loading="lazy"
          decoding="async"
          {...imageProps}
          src={src}
          alt=""
          onError={(event) => {
            setFailed(src);
            imageProps?.onError?.(event);
          }}
        />
      ) : (
        <span aria-hidden="true">{initials}</span>
      )}
    </span>
  );
});

Edit your own copy. Downloaded source uses your changes; the component preview above uses the shipped version. Run the source installer first to include shared helpers.

Interactive preview

Usage

API reference

Accessibility & behavior

Platform Behavior & Guidelines

Source ownership

Make the source yours.