caliper uidocs

Typewriter terminal

Pro

A terminal window that types commands and prints their output.

Installs components/ui/typewriter-terminal.tsxDepends on @radix-ui/react-slot, lucide-reactMotion honours reduced motion
pnpm dlx shadcn@latest add @caliper/typewriter-terminal
~/projects/web
$ pnpm dlx caliper add button card dialog
Resolving components…
✔ button  ✔ card  ✔ dialog
$ pnpm dev
ready on http://localhost:3000

When to use #

Use it for

  • Showing a command line in a hero or tutorial.
  • The script is short and loops.

Skip it when

  • Users need to type into it; use a real terminal.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/typewriter-terminal

Adds its 4 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 { TypewriterTerminal } from "@/components/ui/typewriter-terminal"

The worked example comes with Pro

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

Checking your licence…

API reference #

TypewriterTerminal

component
PropTypeDefaultDescription
script *readonly TerminalStep[]—
titlestring"Terminal"
speednumber34Milliseconds per typed character.
promptstring"$"
classNamestring—

Accessibility #

It is built on native elements and keeps aria-label and aria-hidden in step with state.

No custom key handling; Tab and the native activation keys do the work.

Motion #

It checks prefers-reduced-motion itself and settles immediately instead of travelling. Every state is still reachable.