Streaming Text
Model output that resolves word by word through a soft blur; works with a growing string from a stream.
- Category: Transitions
- Licence: Charcoal UI Pro
- Built with: React 19, Tailwind CSS 4, Motion
- Dependencies: motion, clsx, tailwind-merge
Examples
Streaming Text
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
text | string | — | |
simulate | boolean | false | Reveal the full text at wordsPerSecond. |
wordsPerSecond | number | 18 | |
onDone | () => void | — |
About Streaming Text
Streaming Text resolves model output word by word through a soft blur, working directly with a growing string from a stream.
Streaming Text is an UI transition for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.
When to use Streaming Text
- AI chat responses.
- Summaries and generations.
- Live transcripts.
- Typing demos.
How it works
New words since the last render animate in, so it never re-animates old text.
The change it animates is also announced to assistive tech, and the motion is short enough never to block what the user wants to do. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.
Customizing Streaming Text
Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.
Style it with className like any other element. It only uses your theme's tokens, so it follows light and dark mode without extra work.
- text (string).
- simulate (boolean, default false): Reveal the full text at wordsPerSecond.
- wordsPerSecond (number, default 18).
Goes well with Streaming Text
Streaming Text is already composed into 2 ready-made sections, so you can see it in context or install the whole block.
- Hero Chat: Hero section
- Features AI Demo: Features section
- Card Resize: A React box that springs to the size of its content
- Notification Badge: A React notification badge that pops in and slides new counts in
- Page Transition: React page transitions: native-feeling push and pop between views
- Error Shake: A React error shake: a decaying head shake for wrong input
- Arrow Link: A React arrow link whose chevron grows a stem on hover, CSS only
Install Streaming Text
npx shadcn@latest add @charcoal/streaming-textStreaming Text is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies streaming-text.tsx into components/ui and installs clsx, tailwind-merge.
You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.
See Charcoal UI Pro pricing · Pro setup
Frequently asked questions
- Does it re-animate the whole text as it streams?
- No. It only animates the words added since the last update, so a long answer streams smoothly without the earlier text flickering.
- How do I install Streaming Text?
- Streaming Text is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/streaming-text. It copies streaming-text.tsx into components/ui and installs motion, clsx, tailwind-merge.
- Is Streaming Text free for commercial use?
- Streaming Text needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
- Does Streaming Text work with Next.js?
- Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
- Can an AI coding agent install Streaming Text?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Streaming Text's props and get_install_command returns the exact command.