User.
A face and a name, together.
User pairs an Avatar with a name and an optional description. Initials are derived from a string name. The avatar is aria-hidden because the visible name already identifies the person.
Make it yours
Preparing the example…
Composition
AnatomyUser pairs an Avatar with a name and an optional description. Initials are derived from a string name. The avatar is aria-hidden because the visible name already identifies the person.
User (div)
├── Avatar.Root (aria-hidden)
│ ├── Avatar.Image
│ └── Avatar.Fallback — initials
└── name + descriptionA place to start
UsageImport the stylesheet once at your application root. This complete example reflects the properties selected above.
Loading example…
Details that make a difference
Examples & statesSizes
Compare the three Dixy shirt sizes side by side.
Loading source…
Semantic colors
Semantic color supplements the selected state or measurement.
Loading source…
The finer details
API referenceGenerated from Dixy’s local TypeScript interfaces. Native HTML attributes and refs are forwarded. The table covers Dixy’s own options.
User
| Prop | Type / description | Default |
|---|---|---|
size | "sm" | "md" | "lg"Component proportions. | md |
radius | "none" | "sm" | "md" | "lg" | "full"Inherits the nearest Theme. | — |
as | EOverride the semantic element, e.g. a title heading level. | — |
color | "neutral" | "accent" | "danger" | "success"Avatar color. User passes it to Avatar, so it takes Avatar's colors. | — |
name* | ReactNodeThe person's visible name. | — |
description | ReactNodeA secondary line, such as a role or handle. | — |
src | stringAvatar image URL. | — |
fallback | ReactNodeAvatar fallback while the image loads or when it fails. | initials from a string name |
avatarVariant | "soft" | "solid" | "outline"Avatar surface emphasis. | soft |
Built from the same foundations
Styling tokensChange Theme settings above to compare appearance, accent, neutral, radius, spacing density, motion and direction. Override component aliases on a Theme root so custom properties follow portaled content too. The wrapper merges className, style, refs and render composition with its owning primitive.
| Token | Purpose |
|---|---|
--dixy-color-text-secondary | The component-specific starting point. |
--dixy-font-label-md | Control label font and line height; body roles remain readable in text inputs. |
--dixy-color-background-selected | Selected surfaces use semantic color across appearances. |
--dixy-color-border-focus | Focus indication remains visible independently of shadows. |
--dixy-spacing-inset-sm | Density-aware component padding. |
--dixy-motion-transition-feedback | Short state feedback, reduced by the inherited motion setting. |
Consider everyone
AccessibilityHiding the decorative avatar avoids announcing initials and then the name. Long names truncate visually; provide a title or tooltip when truncation hides meaning. Target WCAG 2.2 AA. Automated axe checks pass in unit tests; screen-reader, forced-colors and contrast verification in real browsers remains pending.
Target: WCAG 2.2 AA. Automated tests cover selected behavior; manual screen-reader, contrast, and zoom validation remain part of the release checklist.
Build it. Then understand it.
Composition over configuration: User reuses Avatar and inherits its size, colour and radius contracts.
--dixy-color-text-secondary