Ballmac UI home

Artifact PanelPRO

A side panel for things an assistant generates: Preview and Code tabs, version stepping, copy and download, a streaming state and a close button, with the rendered result in your own slot.

Counter button

React component

v3 of 3
Clicked 0 times

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/artifact-panel

Usage

import { ArtifactPanel } from "@/components/ballmac/artifact-panel"

The full example is in the Code tab above.

Examples

Writing and versions

Release notes

Writing…

release-notes.mdmd

API reference

PropTypeDefault
title*

Name of the generated thing, such as "Pricing table".

string—
kind

Kind of artifact, shown under the title, such as "React component".

string—
icon

Icon in the header tile.

React.ReactNode—
code

Source text. Shown in the Code tab and used for Copy and Download.

string—
filename

File name for Download and the code header, such as "pricing-table.tsx".

string—
language

Language label for the code, such as "tsx".

string—
children

The rendered result. Put an iframe, a component or a document here.

React.ReactNode—
versions

How many versions exist. With more than one, arrows to step through them appear.

number1
version

Which version is shown, starting at 1 (controlled).

number—
onVersionChange

Called when the version changes.

(version: number) => void—
streaming

True while the model is still writing. Shows a progress edge and disables copy and download.

booleanfalse
defaultTab

Tab shown first.

"preview" | "code""preview"
onClose

Adds a close button.

() => void—
onCopy

Called after the code was copied.

() => void—
actions

Extra header actions, placed before Copy.

React.ReactNode—
previewClassName

Classes for the preview canvas.

string—

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
ArrowLeft / ArrowRightSwitches between Preview and Code when the tabs have focus
TabReaches version arrows, copy, download, close, and the scrollable content
Screen readersRegion named by the title; version changes are announced politely

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

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

  • Passed: Right to left

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

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    8 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 artifact-panel.test.tsx.

  • For information: Footprint

    3.2 KB of source (gzip) in 1 file. Installs motion, lucide-react, radix-ui.

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

title, kind, icon, code, filename, language and children as the preview. versions > 1 adds steppers (version/onVersionChange). streaming shows a progress edge and disables copy and download. onClose adds a close button. With the shadcn MCP server set up (guide), ask your agent:

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

Use it for

  • Code, documents or designs a model produced next to the chat
  • Anything users iterate on in versions

Not for

  • Showing code in the chat; use code-block
  • Generic tabs; use tabs

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

Credits

Covered by the Ballmac UI Pro license.