Ballmac UI home

HighlighterPRO

Hand-drawn marks around inline text: highlight, underline, box, circle, strike-through and brackets, drawn in when the phrase scrolls into view.

The fastest way to ship a good interface is to start from components that already handle keyboard and screen readers, then change only what you must.

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/highlighter

Usage

import { Highlighter } from "@/components/ballmac/highlighter"

The full example is in the Code tab above.

Examples

All six marks

  • highlight
  • underline
  • box
  • circle
  • strike
  • bracket

API reference

PropTypeDefault
children*

The phrase to mark. Short phrases work best because the mark is drawn around one box.

React.ReactNode—
action

The kind of mark.

HighlighterAction"highlight"
tone

Mark color.

HighlighterTone"chart-3"
strokeWidth

Stroke width in pixels (not used by "highlight").

number2.5
padding

Extra space around the text in pixels, so the mark does not touch the letters.

number4
duration

Seconds the drawing takes.

number0.7
delay

Seconds before it starts.

number0
inView

Wait until the phrase scrolls into view.

booleantrue

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
Screen readersThe mark is decorative (aria-hidden); the text is unchanged
ContrastText keeps the foreground color on a translucent highlight
Reduced motionMarks are drawn instantly

Quality scorecard

5/5

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

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

    No endless animation to begin with.

  • Not applicable: Right to left

    Not mirrored by design: Animated highlight drawn over text.

  • 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 highlighter.test.tsx.

  • For information: Footprint

    2.1 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

<Highlighter action='highlight|underline|box|circle|strike|bracket' tone padding duration delay>phrase</Highlighter>. Short phrases only: the mark is drawn around one box. With the shadcn MCP server set up (guide), ask your agent:

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

Use it for

  • Drawing attention to a key phrase in copy
  • Editorial and tutorial text

Not for

  • Multi-line passages
  • Search-result highlighting (use a plain mark element)

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

Credits

Covered by the Ballmac UI Pro license.

Registry
shadcn/utils