# Shield

An isometric shadcn/ui all-clear state for security pages: a line-drawn shield that lifts while a check draws on, copy and button as props.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available for the docs, pricing and about pages: append `.md` to the URL or send an `Accept: text/markdown` header (the home page answers the header too). An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).

## At a glance

- **Good for:** Security settings pages with nothing to fix; A finished account or device security scan; Compliance or audit checks with no issues; Protection status cards on a dashboard
- **Category:** Security · **Type:** Empty states, Objects · **Style:** Line, Flat, Dark mode
- **See it:** [Live preview](https://www.craftui.space/docs/isometrics/shield) · [Screenshot](https://www.craftui.space/llms.md/preview/shield.b8eb707b.jpg)

![Shield](https://www.craftui.space/llms.md/preview/shield.b8eb707b.jpg)

## Install

```bash
pnpm dlx shadcn@latest add https://www.craftui.space/r/shield.json
```

This is a paid item (ISO-V24SAR): the install needs a craftUI plan or a purchase of it. Signed in, the docs page gives your personal install command. Plans: https://www.craftui.space/pricing

## Usage

```tsx
import Shield from "@/components/isometric/shield";

export default function Page() {
  return <Shield />;
}
```

With no props it renders with demo content; pass your own through the props below.

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `heading` | `string` | `"You're protected"` | Heading under the art, up to about 28 characters. An empty string hides it. |
| `description` | `string` | `"We'll let you know if anything needs your attention."` | The line under the heading: one or two short sentences. An empty string hides it. |
| `actionLabel` | `string` | `"Security settings"` | Label of the button, up to about 22 characters. An empty string hides the button. |
| `onAction` | `() => void` | — | Called when the button is clicked. |
| `children` | `ReactNode` | — | Your own actions under the copy, in place of the built-in button. |
| `tone` | `IsoTone` | `"primary"` | Brand colour: a theme token name (primary, chart-2…) or any CSS colour. Shows on the one brand mark only. |
| `variant` | `IsoVariant` | `"ink"` | "ink" (default): a 1 px outline over paper walls. "line": the outline alone, faces the page colour. |
| `strokeWidth` | `number` | `0.23` | Line weight: the default 0.23 is a 1 px outline at any size. |
| `active` | `boolean` | — | Plays the beat each time it turns true (hover, focus, an upload finishing…). Left out, the beat plays once when the art scrolls into view. Pass false to keep it still until you say. |
| `onPlayEnd` | `() => void` | — | Called each time the beat has played and settled. |
| `loop` | `boolean` | `false` | Plays it again after a long hold (while `active`, or always when `active` is left out). Off (default) suits a state people sit in front of. |
| `title` | `string` | — | Accessible description of the art. Without it the art is decorative and the copy speaks for it. |
| `artClassName` | `string` | — | Classes for the art alone; size it with width (it keeps its aspect ratio). |
| `className` | `string` | — | Classes for the wrapper of the whole state (a centred column, `max-w-sm`). |

## Files

The install adds:

- `components/isometric/shield.tsx`
- `components/isometric/iso-line.tsx`
- `components/isometric/iso-core.tsx`

npm dependencies (installed for you): `motion`.

shadcn/ui components it uses (the shadcn CLI adds any that are missing): `button`.