GlassKit UI
Primitives

Avatar

A contact / sender avatar: a photo when you have one, else initials on a gradient plate. The building block for notifications, chats, and calls.

SO

Installation

npx @glasskit-ui/cli add avatar

Install the SDK (it provides GlassViewport, useDpad and the stylesheet), then copy these files into your project:

npm install @glasskit-ui/react
// components/lib/utils.tsimport { clsx, type ClassValue } from "clsx";import { twMerge } from "tailwind-merge";export type { ClassValue };/** * Merge class names the shadcn way: clsx joins conditionals, tailwind-merge * de-dupes conflicting Tailwind utilities so a consumer's `className` override * wins (e.g. passing `px-2` beats the component's `px-6`). Lens components are * Tailwind utilities + `--gk-*` tokens, so this de-dupe matters. */export function cn(...inputs: ClassValue[]): string {  return twMerge(clsx(inputs));}/** * Accessible name from a free-form `label` prop: the label itself when it's a * plain string, otherwise undefined (a ReactNode can't become an aria-label). */export function stringLabel(label: unknown): string | undefined {  return typeof label === "string" ? label : undefined;}
// components/glasskit/avatar.tsximport type { ReactNode } from "react";import { cn } from "../lib/utils";const SIZE = {  sm: "size-[46px] text-[17px]",  md: "size-[62px] text-[23px]",  lg: "size-[92px] text-[34px]",} as const;export type AvatarTone =  | "blue"  | "green"  | "peach"  | "violet"  | "cyan"  | "amber";/** * <Avatar> — a contact / sender avatar: shows a photo when you have one, else an * icon, else initials on a gradient plate. Used by NotificationCard, ChatBubble, * CallCard. RTL-safe. */export function Avatar({  name,  src,  icon,  tone = "blue",  size = "md",  className,}: {  /** Display name — used for initials + the a11y label. */  name: string;  /** Optional image URL. */  src?: string;  /** Optional icon shown instead of initials (e.g. a group / bot glyph). */  icon?: ReactNode;  /** Gradient tone when showing initials. */  tone?: AvatarTone;  size?: "sm" | "md" | "lg";  className?: string;}) {  const initials = name    .split(/\s+/)    .map((w) => w[0])    .filter(Boolean)    .slice(0, 2)    .join("")    .toUpperCase();  return (    <span      className={cn(        "inline-grid shrink-0 place-items-center overflow-hidden rounded-full font-bold text-white [box-shadow:inset_0_1px_0_rgba(255,255,255,0.3),0_6px_14px_-8px_rgba(0,0,0,0.6)]",        SIZE[size],        !src && `gk-grad-${tone}`,        className,      )}      role="img"      aria-label={name}    >      {src ? (        // eslint-disable-next-line @next/next/no-img-element        <img className="size-full object-cover" src={src} alt="" />      ) : icon ? (        <span className="grid size-full place-items-center [&_svg]:size-[45%] [&>*]:size-[45%]">          {icon}        </span>      ) : (        <span>{initials}</span>      )}    </span>  );}

Usage

<Avatar name="Mara Lin" tone="violet" /><Avatar name="Sam Ortiz" src={photoUrl} />

Props

PropTypeDefaultDescription
namestringDisplay name → initials + a11y label.
srcstringOptional photo URL.
iconReactNodeGlyph shown instead of initials (groups, bots).
tone"blue" | "green" | "peach" | "violet" | "cyan" | "amber""blue"Gradient tone for the initials plate.
size"sm" | "md" | "lg""md"46 / 62 / 92px.

On this page