# Usage Estimator (Notchset): prompt.md (v1.0.0)

- id: `usage-estimator` · version 1.0.0 · block · pro (Pro)
- category: Marketing
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/usage-estimator`
- npm dependencies: class-variance-authority@^0.7
- registry dependencies: utils, @beautiful-ui/segmented-control, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/usage-estimator
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A usage bill estimate that shows when the bigger plan becomes cheaper: runs on a log slider and seats on a linear one, each marking the plan's allowance; a breakdown that rolls; both plans' cost curves across the run range with a marker at your volume and the crossover; and advice to switch when the other plan costs less.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `class-variance-authority@^0.7`.
- Files: `components/ui/notchset/blocks/usage-estimator.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/button-variants.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `segmented-control`, `notchset-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `UsageEstimator`, and every exported type.
- CSS: the install adds the notchset foundation (tokens, keyframes, motion levels) to your global stylesheet once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-glide`, `--notchset-ease-key-down`, `--notchset-ease-key-up`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-grow-to`, `--notchset-key-down`, `--notchset-key-up`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scan-to`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`, `--notchset-travel`). Never add Tailwind colour classes inside the component.

```tsx
import { UsageEstimator } from "@/components/ui/notchset/blocks/usage-estimator";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `UsageEstimator` | `usage-estimator` | Inputs, breakdown, chart and advice. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/blocks/usage-estimator.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- usage pricing, pricing calculator, cost estimator, metered billing, overage, plan crossover, Notchset
- Usage-based pricing with an allowance and overage
- Helping buyers see when to move up a plan

### Not when
- Flat per-seat prices: use Seat Pricing
- A bill that already happened: show the invoice

## Mistakes
- Use your real price book: this is an estimate, so say so where you bill
- Keep the two plans comparable (same units for runs and seats)

## Usage

```tsx
import { UsageEstimator } from "@/components/ui/notchset/blocks/usage-estimator";

export function Estimate() {
  return (
    <UsageEstimator
      plans={[
        { id: "team", name: "Team", base: 199, runs: 50_000, seats: 5, perThousand: 4, perSeat: 24 },
        { id: "scale", name: "Scale", base: 899, runs: 400_000, seats: 20, perThousand: 2, perSeat: 20 },
      ]}
      onSwitch={(plan) => console.log("switch to", plan.id)}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `plans` | `[UsagePlan, UsagePlan]` |  | Two plans, smaller first: { id, name, base, runs, seats, perThousand, perSeat }. |
| `runsRange / seatsRange` | `{ min, max }` |  | The sliders' ranges (runs on a log scale). |
| `defaultRuns / defaultSeats` | `number` |  | Where the sliders start. |
| `onSwitch / currency` | `(plan) => void / (n) => string` |  | The advice's switch action and money formatting. |

Full docs: https://beautiful-ui.dev/components/usage-estimator

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| ← → | Step runs or seats (Shift: ×10) |
| Home / End | The ends of the range |

## Performance

- 49 samples a curve and a 400-step crossover search: well under a millisecond.

## Responsive

- The chart drops under the inputs under 760px (container width).

## Motion inventory

| Interaction | What moves |
|---|---|
| Inputs | Breakdown lines and the total roll |
| Seats | Both curves glide to their new shape (520ms) |
| Marker | Follows your runs; its tag flips past 70% |

## Accessibility contract (preserve when editing)
- Both sliders are real sliders with value text; allowance notes are announced
- The chart is one image with a summary (plans, seats, the crossover); the advice is announced as it changes

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/usage-estimator
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)

The notchset foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/notchset-foundation.json.