caliper uidocs
DemoSign inGet Pro

Mention inbox

Pro

Everything that asks for you: mentions, replies and assignments grouped by day, filtered by kind, answered in place, and cleared with Done and undo. j, k, r, e and u work from the keyboard.

Installs components/ui/mention-inbox.tsxDepends on @radix-ui/react-slot, lucide-reactMotion shared motion tokens
pnpm dlx shadcn@latest add @caliper/mention-inbox

When to use #

Use it for

  • Collaborative products with comments and assignments.
  • The bell menu grown into a page.

Skip it when

  • System notices like billing or security; use the notification center.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/mention-inbox

Adds its 6 files to components/ui/, each with its own stylesheet, and installs their packages. Pro installs with your access token, set up once per project. See Pro access. The first part also adds Caliper UI’s tokens; import them once as in Installation.

Usage #

Import it from your copy of the source. The example behind the preview comes with the source.

example.tsx
import { MentionInbox } from "@/components/ui/mention-inbox"

The worked example comes with Pro

The 34-line example behind the preview opens here with a Pro or Team licence.

Checking your licence…

API reference #

MentionInbox

component
PropTypeDefaultDescription
items *readonly InboxNotice[]—
onItemsChange *(items: InboxNotice[]) => void—
onOpen((item: InboxNotice) => void)—
onReply((item: InboxNotice, text: string) => void | Promise<void>)—Send a reply. May return a promise; a thrown error keeps the draft.
nownumber—Fix the clock, e.g. in tests.
classNamestring—

Accessibility #

It exposes status, article and alert semantics, with aria-labelledby, aria-hidden, aria-label and aria-keyshortcuts kept in step with state. Changes that matter are announced through a live region.

KeyBehaviour
↓Moves to the next item or value.
↑Moves to the previous item or value.
EnterActivates the focused control.
EscapeCloses or cancels, then returns focus to where it came from.

Motion #

Transitions use the shared duration and easing tokens. Under prefers-reduced-motion those tokens collapse to instant and travel distances go to zero, so state changes still happen without movement.