Sabil UI

Search documentation

Search for a command to run...

Components

Avatar

An image element with a fallback for representing the user.

CNER
CNLRER
+3

Installation#

  1. Install the dependencies

    npm install cn radix-ui
  2. Copy the source into your project

    components/ui/avatar.tsx
    "use client"import * as React from "react"import { cn } from "cn"import { Avatar as AvatarPrimitive } from "radix-ui"function Avatar({  className,  size = "default",  ...props}: React.ComponentProps<typeof AvatarPrimitive.Root> & {  size?: "default" | "sm" | "lg"}) {  return (    <AvatarPrimitive.Root      data-slot="avatar"      data-size={size}      className={cn(        "group/avatar relative flex size-8 shrink-0 rounded-full select-none after:absolute after:inset-0 after:rounded-full after:border after:border-border after:mix-blend-darken data-[size=lg]:size-10 data-[size=sm]:size-6 dark:after:mix-blend-lighten",        className      )}      {...props}    />  )}function AvatarImage({  className,  ...props}: React.ComponentProps<typeof AvatarPrimitive.Image>) {  return (    <AvatarPrimitive.Image      data-slot="avatar-image"      className={cn(        "aspect-square size-full rounded-full object-cover",        className      )}      {...props}    />  )}function AvatarFallback({  className,  ...props}: React.ComponentProps<typeof AvatarPrimitive.Fallback>) {  return (    <AvatarPrimitive.Fallback      data-slot="avatar-fallback"      className={cn(        "flex size-full items-center justify-center rounded-full bg-muted text-sm text-muted-foreground group-data-[size=sm]/avatar:text-xs",        className      )}      {...props}    />  )}function AvatarBadge({ className, ...props }: React.ComponentProps<"span">) {  return (    <span      data-slot="avatar-badge"      className={cn(        "absolute right-0 bottom-0 z-10 inline-flex items-center justify-center rounded-full bg-primary text-primary-foreground bg-blend-color ring-2 ring-background select-none",        "group-data-[size=sm]/avatar:size-2 group-data-[size=sm]/avatar:[&>svg]:hidden",        "group-data-[size=default]/avatar:size-2.5 group-data-[size=default]/avatar:[&>svg]:size-2",        "group-data-[size=lg]/avatar:size-3 group-data-[size=lg]/avatar:[&>svg]:size-2",        className      )}      {...props}    />  )}function AvatarGroup({ className, ...props }: React.ComponentProps<"div">) {  return (    <div      data-slot="avatar-group"      className={cn(        "group/avatar-group flex -space-x-2 *:data-[slot=avatar]:ring-2 *:data-[slot=avatar]:ring-background",        className      )}      {...props}    />  )}function AvatarGroupCount({  className,  ...props}: React.ComponentProps<"div">) {  return (    <div      data-slot="avatar-group-count"      className={cn(        "relative flex size-8 shrink-0 items-center justify-center rounded-full bg-muted text-sm text-muted-foreground ring-2 ring-background group-has-data-[size=lg]/avatar-group:size-10 group-has-data-[size=sm]/avatar-group:size-6 [&>svg]:size-4 group-has-data-[size=lg]/avatar-group:[&>svg]:size-5 group-has-data-[size=sm]/avatar-group:[&>svg]:size-3",        className      )}      {...props}    />  )}export {  Avatar,  AvatarImage,  AvatarFallback,  AvatarGroup,  AvatarGroupCount,  AvatarBadge,}
  3. Make sure the foundation is in place

    Components read their colors, radius and surfaces from the tokens in app/globals.css. See Theming.

Usage#

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

Examples#

Badge

CN

Badge Icon

PP

Basic

CN

Dropdown

Group

CNLRER

Group Count

CNLRER
+3

Group Count Icon

CNLRER

Size

CNCNCN