Ballmac UI home

Copy Button

A copy-to-clipboard button with a morphing check icon, an optional label, a fallback for blocked clipboards, an error state and a polite announcement.

Installation

$ pnpm dlx shadcn@latest add @ballmac/copy-button

Usage

import { CopyButton, copyText } from "@/components/ballmac/copy-button"

The full example is in the Code tab above.

Examples

Inline with a value

  • Project IDprj_8f3a1c92e7
  • Regioneu-west-1
  • Webhook URLhttps://api.example.com/hooks/in/8f3a

API reference

PropTypeDefault
value

Text to copy.

string—
getValue

Reads the text at click time instead, for content that changes (a selection, a form). May be async.

() => string | Promise<string>—
label

Visible label next to the icon, such as "Copy". Leave out for an icon-only button.

string—
copiedLabel

Label shown after a successful copy.

string—
ariaLabel

Accessible name of an icon-only button.

string—
resetAfter

How long the confirmation stays, in milliseconds.

number1800
onCopied

Called with the copied text.

(text: string) => void—
onError

Called when both clipboard routes fail.

() => void—
variant"ghost" | "outline" | "solid""ghost"
size"sm" | "default" | "lg""default"

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
Enter / SpaceCopies and confirms
Screen readersName changes to 'Copied' and a polite status announces it; failures say 'Copy failed'
Reduced motionThe icon swaps with a fade only

Quality scorecard

7/7

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.

  • 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.

  • Passed: Keyboard

    9 tab stops, each showing a visible change when it takes focus. 3 documented keys.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by copy-button.test.tsx.

  • For information: Footprint

    2.2 KB of source (gzip) in 1 file. Installs motion, lucide-react, class-variance-authority.

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 value (or getValue for content read at click time). label adds visible text, variant is ghost | outline | solid, size sm | default | lg. Falls back to execCommand when navigator.clipboard is blocked and shows 'Copy failed' if both fail. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Copy Button (@ballmac/copy-button) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Any value a developer will paste: keys, URLs, commands, IDs
  • Toolbars on code, logs and config

Not for

  • Copying a whole code block with a header (code-block has its own button)

Registry JSON: https://ui.ballmac.com/r/copy-button.json

Credits

Free to use in personal and commercial projects.

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.