Oros UI

Search documentation

Search Oros UI pages and components.

Avatar

Represents a person or organization with an image or fallback.

CNCNCN
CNCNCN

Installation

Install Avatar from Oros with shadcn CLI 4.13.0.

pnpm dlx shadcn@4.13.0 add @oros/avatar

Usage

import {
  Avatar,
  AvatarImage,
  AvatarFallback,
  AvatarGroup,
  AvatarGroupCount,
  AvatarBadge,
} from "@/components/ui/avatar"

Open the Source tab in the preview for a complete working example.

Anatomy

ExportResponsibility
AvatarThe root component that owns the primary structure and state.
AvatarImageA composable part of the component anatomy.
AvatarFallbackA composable part of the component anatomy.
AvatarGroupGroups related items into one logical set.
AvatarGroupCountA composable part of the component anatomy.
AvatarBadgeA composable part of the component anatomy.

API Reference

Avatar exports 6 named entries. Component exports accept the props of their underlying HTML element or Base UI component, plus an optional className, unless the source defines a more focused type.

  • Avatar Component
  • AvatarImage Component
  • AvatarFallback Component
  • AvatarGroup Component
  • AvatarGroupCount Component
  • AvatarBadge Component

Accessibility

  • Avatar adds no application-specific accessible name by itself; use semantic content and label any interactive descendants.
  • Do not communicate state or meaning through color alone, and verify the composed result at text zoom and with keyboard navigation.

Source

Avatar uses the standard shadcn API and is distributed through Oros. Installing it adds the component source and required dependencies to your app. The Source tab above shows a complete usage example.