Skip to contents

A user avatar with an image and an initials fallback. The fallback is layered under the image and revealed automatically if the image is missing or fails to load (zero JavaScript).

Usage

shad_avatar(
  src = NULL,
  alt = "",
  fallback = NULL,
  size = c("default", "sm", "lg", "xl"),
  class = NULL,
  ...
)

shad_avatar_group(..., max = NULL, class = NULL)

Arguments

src

Image URL. Optional.

alt

Image alt text; also the source of default initials.

fallback

Fallback text (initials). Defaults to initials derived from alt.

size

One of "default", "sm", "lg", "xl".

class

Extra CSS classes.

...

Extra attributes.

max

Maximum avatars to show in a group before collapsing the rest into a "+N" overflow avatar.

Value

A <span class="shad-avatar">.

Examples

shad_avatar(src = "https://github.com/shadcn.png", alt = "@shadcn")
#> <span class="shad-avatar">
#>   <span class="shad-avatar__fallback" aria-hidden="true">S</span>
#>   <img class="shad-avatar__image" src="https://github.com/shadcn.png" alt="@shadcn" onerror="this.hidden=true"/>
#> </span>
shad_avatar(fallback = "JD")
#> <span class="shad-avatar">
#>   <span class="shad-avatar__fallback">JD</span>
#> </span>