Skip to main content

Avatar

Displaydisplay

A person or agent mark: an image with initials as the fallback, in the standard sizes.

import { Avatar } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui Avatar component (from @elabs-ai/components-ui) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look Avatar up before writing code: `npx -y @elabs-ai/components-cli docs Avatar` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Examples

5 live examples

Large

Larger avatar via className.

With Image

Image avatar — fallback only shows while image loads or if it fails.

From Name

`name` derives the initials — no per-consumer helper.

Group

An overlapping strip; `max` folds the rest into “+N”, `total` when the children are a sample.

API

Avatar

Also accepts: ComponentPropsWithoutRef<typeof AvatarPrimitive.Root>

AvatarFallback

PropTypeDescription
namestringA person's (or workspace's) display name — the fallback shows its initials (`initialsOf`) when `children` is omitted, so consumers stop carrying their own split/slice helper.

Also accepts: ComponentPropsWithoutRef< typeof AvatarPrimitive.Fallback >

AvatarGroup

PropTypeDescription
maxnumberHow many avatars to show before collapsing the rest into a “+N” tail. Omit to show every child.
totalnumberThe total the group stands for when the children are only a sample (“+1,204”); defaults to the number of children.
childrenReactNodeThe `Avatar`s. Any `className` for size belongs on each child.

Also accepts: HTMLAttributes<HTMLDivElement>

AvatarImage

Also accepts: ComponentPropsWithoutRef<typeof AvatarPrimitive.Image>