Skip to content

Avatar

An image element with a fallback for representing the user.

CNCN

Installation

bash
npx @galaxy-stack/nebula-cli@latest add avatar
bash
pnpm dlx @galaxy-stack/nebula-cli@latest add avatar
bash
yarn dlx @galaxy-stack/nebula-cli@latest add avatar
bash
bunx @galaxy-stack/nebula-cli@latest add avatar
bash
# If you have installed galaxy-design globally
galaxy-design add avatar

Usage

API Reference

Props

PropTypeDefaultDescriptionFrameworks
srcstring-Image source URLAvatarImage (All)
altstring-Alternative text for the imageAvatarImage (All)
classNamestring''CSS class names for the avatar rootAvatar (React, React Native)
classstring''CSS class names for the avatar rootAvatar (Vue, Angular, Flutter)

Subcomponents

Avatar

Root container for the avatar component

AvatarImage

Image element with fallback support

PropTypeDefaultDescriptionFrameworks
srcstring-Image source URLAll
altstring-Alternative textAll
asChildbooleanfalseRender as a child elementReact, Vue, Angular

AvatarFallback

Fallback content when image fails to load

PropTypeDefaultDescriptionFrameworks
delayMsnumber600Delay in milliseconds before showing fallbackReact, Vue
asChildbooleanfalseRender as a child elementReact, Vue, Angular
classNamestring''CSS class namesReact, React Native
classstring''CSS class namesVue, Angular, Flutter

Accessibility

  • Keyboard Navigation: [TODO]
  • Screen Reader: [TODO]
  • Focus Management: [TODO]
  • WCAG Compliance: WCAG 2.1 Level AA compliant

Author

Bùi Trọng Hiếu (kevinbui)

License

MIT © 2025 Bùi Trọng Hiếu (kevinbui)

Released under the MIT License.