# Tick bar (Notchset): prompt.md (v2.1.0)

- id: `tick-bar` · 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/tick-bar.json`
- npm dependencies: none
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json
- docs: https://notchset.dev/components/tick-bar
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

How far toward a target, as a row of thin ticks filled up to the value, with the number written beside it. Done draws its share in the ok colour, and a raised tick marks the target once the scale runs past it..

## 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/tick-bar.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: `TickBar`, 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-ink`, `--ns-ink-3`, `--ns-line`, `--ns-ok`, `--ns-series`, `--ns-text-small`, `--ns-time-color`, `--ns-weight-medium`.
- 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 { TickBar } from "@/components/ui/notchset/tick-bar";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/tick-bar.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 { TickBar } from "@/components/ui/notchset/tick-bar";

export default function TickBarDemo() {
  return (
    <div className="flex w-full max-w-[320px] flex-col gap-5">
      <TickBar label="Won and committed against target" value={1_420_000} done={680_000} max={2_000_000} figure="71%" valueText="$1.42M of $2M" />
      {/* past the target: the scale runs on and a raised tick marks where the goal sat */}
      <TickBar label="Won and committed against target" value={2_300_000} done={1_900_000} max={2_300_000} target={2_000_000} figure="115%" valueText="$2.3M of $2M" />
    </div>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `value` | `number` |  | Required. |
| `max` | `number` |  | Required. |
| `label` | `string` |  | What it measures, read out with the value ("Won and committed against target"). |
| `done` | `number` | `0` | The part of value that is already done, drawn in the ok colour from the start. |
| `target` | `number` |  | Where the goal sits on the scale, when the scale runs past it. |
| `valueText` | `string` |  | How the value is read out ("$1.4M of $2M"); defaults to the percent of max. |
| `figure` | `React.ReactNode` |  | The number, written after the ticks. |
| `ticks` | `number` | `40` |  |

Full docs: https://notchset.dev/components/tick-bar

## 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/tick-bar.json
```

Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/tick-bar`. 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/tick-bar.tsx

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

/*
 * TickBar: how far toward a target, as a row of thin ticks filled up to the value. Calmer than a fat bar, and it
 * reads as "how far, out of how much" at a glance. Filled ticks are the series violet in the chart family's finish
 * (rounded, fading toward the base); `done` draws its share of the fill in the ok colour (won, against won + commit); `target` raises one tick where the goal sits when the bar's scale runs past it. The number is
 * always written: pass `figure` to write it beside the ticks, or write it nearby yourself. The ticks spread across
 * whatever width the bar is given, so it sits in a tile, a table cell or a header alike.
 */
type TickBarProps = {
  value: number;
  max: number;
  /** What it measures, read out with the value ("Won and committed against target"). */
  label: string;
  /** The part of value that is already done, drawn in the ok colour from the start. */
  done?: number | undefined;
  /** Where the goal sits on the scale, when the scale runs past it. */
  target?: number | undefined;
  /** How the value is read out ("$1.4M of $2M"); defaults to the percent of max. */
  valueText?: string | undefined;
  /** The number, written after the ticks. */
  figure?: React.ReactNode;
  ticks?: number | undefined;
  className?: string | undefined;
};

function TickBar({ value, max, label, done = 0, target, valueText, figure, ticks = 40, className }: TickBarProps) {
  const per = max > 0 ? max / ticks : Infinity;
  /* a tick is filled once the value covers half of it; and an endpoint means exactly that: anything above zero fills
     at least one tick, anything short of max leaves at least one empty (1% never shows as nothing, 99% never full) */
  const fill = (v: number) => (ticks < 2 ? Math.min(ticks, Math.round(v / per)) : v <= 0 ? 0 : v >= max ? ticks : Math.min(ticks - 1, Math.max(1, Math.round(v / per))));
  const filled = fill(value);
  const won = Math.min(filled, fill(done));
  const goal = target != null && max > 0 && target < max ? Math.min(ticks - 1, Math.round(target / per) - 1) : -1;
  return (
    <span data-slot="tick-bar" className={cn("flex min-w-0 items-center gap-2.5", className)}>
      <span
        role="meter"
        aria-label={label}
        aria-valuenow={value}
        aria-valuemin={0}
        aria-valuemax={max}
        aria-valuetext={valueText ?? `${max > 0 ? Math.round((value / max) * 100) : 0}%`}
        className="flex h-3 min-w-0 flex-1 items-end justify-between gap-px"
      >
        {Array.from({ length: ticks }, (_, i) => (
          <i
            key={i}
            className={cn(
              "block w-0.5 shrink-0 rounded-full [transition:background-color_var(--ns-time-color)]",
              i === goal ? "h-3" : "h-2.5",
              i < won ? "bg-[var(--ns-ok)]" : i < filled ? "bg-[var(--ns-series)]" : i === goal ? "bg-[var(--ns-ink-3)]" : "bg-[var(--ns-line)]",
            )}
            {...(i < filled ? { "data-ns-veil": "column" } : {})}
          />
        ))}
      </span>
      {figure != null && <span className="shrink-0 text-[length:var(--ns-text-small)] font-[number:var(--ns-weight-medium)] text-[var(--ns-ink)] tabular-nums">{figure}</span>}
    </span>
  );
}

export { TickBar, type TickBarProps };
```

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.
