Avatar

An image element with a fallback for representing the user.

Installation

Install the component from your command line.

npm install @tealess/avatar

Anatomy

Import all parts and piece them together.

import * as Avatar from "@tealess/avatar";

export default () => (
  <Avatar.Root>
    <Avatar.Image />
    <Avatar.Fallback />
  </Avatar.Root>
);

API Reference

Root

Contains all the parts of an avatar.

Image

The image to render. By default it will only render when it has loaded. You can use the onLoadingStatusChange handler if you need more control.

Fallback

An element that renders when the image hasn't loaded. This means whilst it's loading, or if there was an error. If you notice a flash during loading, you can provide a delayMs prop to delay its rendering so it only renders for those with slower connections. For more control, use the onLoadingStatusChange handler on Avatar.Image.

Examples

Clickable Avatar with tooltip

You can compose the Avatar with a Tooltip to display extra information.

import * as Avatar from "@tealess/avatar";
import * as Tooltip from "@tealess/tooltip";

export default () => (
  <Tooltip.Root>
    <Tooltip.Trigger>
      <Avatar.Root>…</Avatar.Root>
    </Tooltip.Trigger>

    <Tooltip.Content side="top">
      Tooltip content
      <Tooltip.Arrow />
    </Tooltip.Content>
  </Tooltip.Root>
);