Ballmac UI home

Streaming TextPRO

Text that arrives progressively, with a blinking caret while streaming, preserved whitespace, aria-busy for screen readers and an optional typewriter reveal for demos.

Installation

  1. Get a Pro licence key.

    The source is part of Ballmac UI Pro.

    Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.

    $49 once regular price $99for this and every other Pro item. Tax included.Money back if it does not work.

  2. Once per project: add the Pro registry and your licence key.

    components.json
    {
      "registries": {
        "@ballmac": "https://ui.ballmac.com/r/{name}.json",
        "@ballmac-pro": {
          "url": "https://ui.ballmac.com/r/pro/{name}.json",
          "headers": { "Authorization": "Bearer ${BALLMAC_LICENSE_KEY}" }
        }
      }
    }
    .env.local
    BALLMAC_LICENSE_KEY=your-licence-key
  3. Add it.

    $ pnpm dlx shadcn@latest add @ballmac-pro/streaming-text

Usage

import { StreamingText, StreamingCaret } from "@/components/ballmac/streaming-text"

The full example is in the Code tab above.

API reference

PropTypeDefault
text*

The text received so far. Append to it as chunks arrive; whitespace and newlines are preserved.

string—
streaming

True while more text is expected. Shows the caret and sets aria-busy.

booleanfalse
animate

Reveal text that is already complete at `speed` characters per second (for demos and replays). Skipped under reduced motion.

booleanfalse
speed

Characters per second when `animate` is on.

number80
caret

Show the caret while streaming or revealing.

booleantrue
onAnimationComplete

Called once `animate` has revealed the whole text.

() => void—

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
—aria-live=polite region; aria-busy is true while streaming so screen readers read the finished text instead of every chunk

Quality scorecard

6/6

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 1 example.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    Every endless animation stops when the visitor asks for less motion.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Not applicable: Keyboard

    Static content: nothing to focus.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by streaming-text.test.tsx.

  • For information: Footprint

    1.4 KB of source (gzip) in 1 file. Installs motion.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

Pass the accumulated text and streaming={true} while chunks arrive; it shows a caret and sets aria-busy until you set streaming={false}. Use animate + speed to type out text you already have. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Streaming Text (@ballmac-pro/streaming-text) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Assistant replies that arrive token by token from a model
  • Replaying a saved answer with a typewriter effect in a demo or onboarding
  • Any plain-text live output where a caret shows that more is coming

Not for

  • Rendered markdown (render your markdown in ai-message's MessageContent and show StreamingCaret at the end)
  • Headline text effects (use text-reveal)

Registry JSON (needs your licence key): https://ui.ballmac.com/r/pro/streaming-text.json

Credits

Covered by the Ballmac UI Pro license.