AvatarGroup

Usage

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

<AvatarGroup label="Project contributors" max={2}>
  <Avatar name="Ada Rivera" /><Avatar name="Bea Cruz" /><Avatar name="Cal Lee" />
</AvatarGroup>

API reference

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

Prop	Type	Default	Description
label	string	required	Name of the group.
max	number	all children	Maximum displayed children; remaining count is shown.

Source ownership

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

npx @devvy-ui/cli add avatar-group

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.

AvatarGroup.tsxREACT / TSX

import { Children, forwardRef, type HTMLAttributes } from 'react';
import { cx } from '../lib/cx';
export interface AvatarGroupProps extends HTMLAttributes<HTMLDivElement> {
  label: string;
  max?: number;
}
export const AvatarGroup = forwardRef<HTMLDivElement, AvatarGroupProps>(function AvatarGroup(
  { label, max, className, children, ...props },
  ref,
) {
  const items = Children.toArray(children);
  const limit =
    max === undefined || !Number.isFinite(max) ? items.length : Math.max(0, Math.floor(max));
  const remaining = Math.max(0, items.length - limit);
  return (
    <div
      role="group"
      aria-label={label}
      {...props}
      ref={ref}
      className={cx('dvy-avatar-group', className)}
    >
      {items.slice(0, limit)}
      {remaining > 0 && (
        <span className="dvy-avatar-overflow" role="img" aria-label={remaining + ' more people'}>
          +{remaining}
        </span>
      )}
    </div>
  );
});

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.