Avatar

User or entity avatar with image, initials, and fallback rendering.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Avatar } from "@tavojs/ui/avatar";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/avatar.

When to use

Use it when

Use `Avatar` for users, teams, and entities

Choose something else when

Avoid Avatar when replacing interactive controls with content-only components.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Avatar example

TSXCreate: src/components/examples/AvatarExample1.tsx

tsximport { Avatar } from "@tavojs/ui/avatar";

export function AvatarExample1() {
  return (
    <>
      <Avatar src="/user.png" alt="Ari Lane" />
      <Avatar initials="AL" />
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`src`	`string \| null`	—	Configures src for this component.
`alt`	`string`	—	Configures alt for this component.
`size`	`Size`	—	Configures size for this component.
`initials`	`string`	—	Configures initials for this component.

Complete TypeScript API

Import from @tavojs/ui/avatar. Published exports: Avatar, AvatarProps.

`AvatarProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Avatar.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Avatar.
`id`	`string`	No	Inherited id attribute accepted by Avatar.
`role`	`string`	No	Inherited role attribute accepted by Avatar.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Avatar.
`title`	`string`	No	Inherited title attribute accepted by Avatar.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Avatar.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Avatar.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Avatar.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Avatar.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Avatar.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Avatar.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Avatar.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Avatar.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Avatar.
`src`	`string`	No	Configures src for this component.
`alt`	`string`	No	Configures alt for this component.
`size`	`Size`	No	Configures size for this component.
`initials`	`string`	No	Configures initials for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Avatar when replacing interactive controls with content-only components.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Provide meaningful `alt` for real people; use empty `alt` for decorative avatars.

Provide meaningful `alt` for real people; use empty `alt` for decorative avatars.

Component status

Contract	Current value
Maturity	stable
Category	content
Component import	`@tavojs/ui/avatar`
Explicit CSS import	`@tavojs/ui/css/avatar`
Preview	Interactive preview available on this page