# Meter (Notchset): prompt.md (v2.1.0)

- id: `meter` · version 2.1.0 · component · free
- category: Charts
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add https://notchset.dev/r/meter.json`
- npm dependencies: none
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json
- docs: https://notchset.dev/components/meter
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

How much of something is used or done, as a thin bar beside the number that says it. Progress fills in ink, or the ok colour for an achievement; usage warns from 75% and turns bad when full..

## Build it
- Stack: React 18.3 or 19, TypeScript, Tailwind CSS v4 utility classes on the foundation's roles, a components.json (imports use its aliases).
- Packages: none beyond React.
- Files: `components/ui/notchset/meter.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `Meter`, and every exported type.
- CSS: the install adds the notchset foundation (its roles, keyframes and motion switch, reading your shadcn tokens for colour) 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.
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- This item reads `--ns-bad`, `--ns-ease`, `--ns-line-soft`, `--ns-ok`, `--ns-series`, `--ns-warn`.
- Retune it (on any ancestor) with the foundation's roles and hooks: `--ns-bad`, `--ns-bad-ink`, `--ns-band`, `--ns-band-edge`, `--ns-band-grade`, `--ns-band-optimal`, `--ns-beat`, `--ns-bezel`, `--ns-canvas`, `--ns-cat-1`, `--ns-cat-2`, `--ns-cat-3`, `--ns-cat-4`, `--ns-cat-5`, `--ns-cat-6`, `--ns-check`, `--ns-chip`, `--ns-control`, `--ns-control-pad`, `--ns-control-sm`, `--ns-deep`, `--ns-deep-ink`, `--ns-deep-ink-2`, `--ns-deep-line`, `--ns-dialog`, `--ns-dialog-lg`, `--ns-dialog-sm`, `--ns-ease`, `--ns-ease-in`, `--ns-ease-panel`, `--ns-ease-pop`, `--ns-field`, `--ns-flood-arc`, `--ns-flood-aurora`, `--ns-flood-behind-1`, `--ns-flood-behind-2`, `--ns-flood-bloom`, `--ns-flood-deep`, `--ns-flood-dial-bloom`, `--ns-flood-glass`, `--ns-flood-grain`, `--ns-flood-image`, `--ns-flood-ink`, `--ns-flood-ink-low`, `--ns-flood-light`, `--ns-flood-mid`, `--ns-flood-pale`, `--ns-flood-pane`, `--ns-flood-pane-edge`, `--ns-flood-pill-ink`, `--ns-flood-ribbon`, `--ns-flood-ribbon-core`, `--ns-flood-shadow`, `--ns-flood-sheen`, `--ns-flood-wash`, `--ns-font-body`, `--ns-font-display`, `--ns-font-mono`, `--ns-font-script`, `--ns-glass`, `--ns-glass-blur`, `--ns-glass-shadow`, `--ns-glow`, `--ns-grain`, `--ns-gutter`, `--ns-header`, `--ns-heat`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-ink-4`, `--ns-leading`, `--ns-lift`, `--ns-light-1`, `--ns-light-2`, `--ns-light-3`, `--ns-light-spread`, `--ns-light-strength`, `--ns-line`, `--ns-line-soft`, `--ns-lit-edge`, `--ns-menu-dy`, `--ns-menu-row`, `--ns-mesh`, `--ns-mesh-frost`, `--ns-ok`, `--ns-ok-ink`, `--ns-orb-body`, `--ns-orb-cool`, `--ns-orb-core`, `--ns-orb-dawn`, `--ns-orb-deep`, `--ns-orb-edge`, `--ns-orb-grain`, `--ns-orb-ground`, `--ns-orb-halo`, `--ns-orb-inner`, `--ns-orb-key`, `--ns-orb-lift`, `--ns-orb-limb`, `--ns-orb-limb-from`, `--ns-orb-rim`, `--ns-orb-skin-hi`, `--ns-orb-skin-lo`, `--ns-orb-skin-mid`, `--ns-orb-warm`, `--ns-panel`, `--ns-panel-w`, `--ns-prism-edge`, `--ns-prism-glint`, `--ns-prism-sheen`, `--ns-prism-tint`, `--ns-pulse`, `--ns-radius`, `--ns-radius-card`, `--ns-radius-full`, `--ns-radius-lg`, `--ns-radius-sm`, `--ns-radius-xl`, `--ns-raised`, `--ns-range`, `--ns-row`, `--ns-row-compact`, `--ns-segment`, `--ns-selected`, `--ns-series`, `--ns-series-core`, `--ns-series-lilac`, `--ns-series-tint`, `--ns-shadow-dialog`, `--ns-shadow-float`, `--ns-shadow-panel`, `--ns-sheet`, `--ns-sheet-bottom`, `--ns-side`, `--ns-signal`, `--ns-sleep-awake`, `--ns-sleep-deep`, `--ns-sleep-light`, `--ns-sleep-rem`, `--ns-space-1`, `--ns-space-2`, `--ns-space-3`, `--ns-space-4`, `--ns-space-5`, `--ns-space-6`, `--ns-space-8`, `--ns-space-section`, `--ns-stack-on`, `--ns-standing-critical`, `--ns-standing-in`, `--ns-standing-out`, `--ns-state-doing`, `--ns-state-done`, `--ns-state-review`, `--ns-state-todo`, `--ns-switch-h`, `--ns-switch-w`, `--ns-text-body`, `--ns-text-control`, `--ns-text-display`, `--ns-text-figure`, `--ns-text-headline`, `--ns-text-hero`, `--ns-text-lede`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-record`, `--ns-text-small`, `--ns-text-strong`, `--ns-text-sub`, `--ns-text-title`, `--ns-tile-shadow`, `--ns-time-born`, `--ns-time-color`, `--ns-time-dialog`, `--ns-time-menu`, `--ns-time-page`, `--ns-time-panel`, `--ns-time-toast`, `--ns-tint`, `--ns-tint-ink`, `--ns-toast-bottom`, `--ns-toast-left`, `--ns-touch`, `--ns-tracking-display`, `--ns-tracking-headline`, `--ns-warn`, `--ns-warn-ink`, `--ns-wash-clay`, `--ns-wash-dusk`, `--ns-wash-graphite`, `--ns-wash-ink`, `--ns-wash-sage`, `--ns-wash-sand`, `--ns-weight-light`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-weight-strong`, `--ns-well`.
- Never add Tailwind colour classes inside the component.

```tsx
import { Button } from "@/components/ui/notchset/button";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/meter.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

### Not when

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import * as React from "react";
import { Button } from "@/components/ui/notchset/button";
import { Meter } from "@/components/ui/notchset/meter";

export default function MeterDemo() {
  const [seats, setSeats] = React.useState(7);
  return (
    <div className="flex flex-col gap-4 text-[var(--ns-ink-2)]">
      <span className="inline-flex items-center gap-2.5">
        <Meter label="Won of target" value={72} max={100} good />
        72% of target
      </span>
      <span className="inline-flex items-center gap-3">
        <Meter kind="usage" size="md" label="Seats used" value={seats} max={10} />
        <b className="font-[number:var(--ns-weight-medium)] text-[var(--ns-ink)] tabular-nums">{seats} of 10 seats</b>
        <Button size="sm" onClick={() => setSeats(seats >= 10 ? 4 : seats + 1)}>
          {seats >= 10 ? "Reset" : "Add a seat"}
        </Button>
      </span>
    </div>
  );
}
```

This example also uses `button` (https://notchset.dev/components/button). Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add https://notchset.dev/r/meter.json https://notchset.dev/r/button.json`.

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `value` | `number` |  | Required. |
| `max` | `number` |  | Required. |
| `label` | `string` |  | What it measures, read out with the value ("Seats used"). |
| `kind` | `"progress" \| "usage"` | `"progress"` |  |
| `good` | `boolean` | `false` | Progress that is good news (won against target) fills in the ok colour. |
| `size` | `"sm" \| "md"` | `"sm"` |  |

Full docs: https://notchset.dev/components/meter

## Customising
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- Dark mode follows the `.dark` class or `data-theme="dark"` on an ancestor (the shadcn and next-themes conventions).
- Update later: Commit or stash local changes first (or copy the files), so the update can be undone. Read https://notchset.dev/r/changelog.json for the new versions: a major version, an entry marked breaking or a merge says what to change. Then re-run the install with `--overwrite`, on a branch. It replaces the component's files, the shared helper files they import, and the item's CSS rules in the global stylesheet, so review the whole diff (components, shared files, CSS), re-apply your own edits, and run the app's typecheck, tests and build.

## Accessibility contract (preserve when editing)

## Install

```bash
npx shadcn@latest add https://notchset.dev/r/meter.json
```

Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/meter`. Every components.json style gets the same files.

## Continue the workflow

- [Cumulative chart and bar list](https://notchset.dev/blocks/cumulative-chart)
- [Forecast bar](https://notchset.dev/blocks/forecast-bar)
- [Waterfall](https://notchset.dev/blocks/waterfall)

## Source

### components/ui/notchset/meter.tsx

```tsx
// Notchset meter 2.1.0 · https://notchset.dev/changelog
import type * as React from "react";
import { cn } from "@/lib/utils";

/*
 * Meter: how much of something is used or done, as a thin bar beside the number that says it. The number is
 * always written next to it; the bar is the glance. kind="progress" fills in ink (or the ok colour when it is
 * an achievement); kind="usage" warns from 75% and turns bad when full, so a limit is seen before it is hit.
 */
type MeterProps = {
  value: number;
  max: number;
  /** What it measures, read out with the value ("Seats used"). */
  label: string;
  kind?: "progress" | "usage" | undefined;
  /** Progress that is good news (won against target) fills in the ok colour. */
  good?: boolean | undefined;
  size?: "sm" | "md" | undefined;
  className?: string | undefined;
};

function Meter({ value, max, label, kind = "progress", good = false, size = "sm", className }: MeterProps) {
  const pct = max === Infinity || max <= 0 ? 0 : Math.min(100, (value / max) * 100);
  const state = kind === "usage" ? (pct >= 100 ? "full" : pct >= 75 ? "near" : "ok") : good ? "good" : "plain";
  /* what it means keeps its colour (full, near, good); a plain amount takes the series violet; every fill has the
     chart family's finish (rounded, fading back toward its start) */
  const fill = { full: "var(--ns-bad)", near: "var(--ns-warn)", ok: "var(--ns-series)", good: "var(--ns-ok)", plain: "var(--ns-series)" }[state];
  return (
    <span
      data-slot="meter"
      data-state={state}
      role="meter"
      aria-label={label}
      aria-valuenow={value}
      aria-valuemin={0}
      aria-valuemax={max === Infinity ? undefined : max}
      className={cn(
        "inline-block shrink-0 rounded-full bg-[var(--ns-line-soft)]",
        size === "sm" ? "h-1 w-14" : "h-1.5 w-[120px] max-[600px]:w-20",
        className,
      )}
    >
      <i data-ns-glide="" data-ns-fill="" className="block h-full rounded-full [transition:width_500ms_var(--ns-ease)]" style={{ width: `${pct}%`, "--ns-fill": fill } as React.CSSProperties} />
    </span>
  );
}

export { Meter, type MeterProps };
```

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