# Sortable header (Notchset): prompt.md (v2.0.0)

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

A table column you can sort by: press to sort, again to flip. Each column has a natural first direction (names A to Z, money high to low), so the first press gives the useful order. The th carries aria-sort..

## 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: `lucide-react@^1`.
- Files: `components/ui/notchset/sortable-header.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: `SortableHeader`, 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-signal`, `--ns-time-color`.
- 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 { CompanyMark } from "@/components/ui/notchset/company-mark";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/sortable-header.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 { CompanyMark } from "@/components/ui/notchset/company-mark";
import { SortableHeader } from "@/components/ui/notchset/sortable-header";

/* the companies' own marks, 24×24 paths as the CRM seed draws them */
const GLYPH: Record<string, string> = {
  airtable: "M11.992 1.966c-.434 0-.87.086-1.28.257L1.779 5.917c-.503.208-.49.908.012 1.116l8.982 3.558a3.266 3.266 0 0 0 2.454 0l8.982-3.558c.503-.196.503-.908.012-1.116l-8.957-3.694a3.255 3.255 0 0 0-1.272-.257zM23.4 8.056a.589.589 0 0 0-.222.045l-10.012 3.877a.612.612 0 0 0-.38.564v8.896a.6.6 0 0 0 .821.552L23.62 18.1a.583.583 0 0 0 .38-.551V8.653a.6.6 0 0 0-.6-.596zM.676 8.095a.644.644 0 0 0-.48.19C.086 8.396 0 8.53 0 8.69v8.355c0 .442.515.737.908.54l6.27-3.006.307-.147 2.969-1.436c.466-.22.43-.908-.061-1.092L.883 8.138a.57.57 0 0 0-.207-.044z",
  stripe: "M13.976 9.15c-2.172-.806-3.356-1.426-3.356-2.409 0-.831.683-1.305 1.901-1.305 2.227 0 4.515.858 6.09 1.631l.89-5.494C18.252.975 15.697 0 12.165 0 9.667 0 7.589.654 6.104 1.872 4.56 3.147 3.757 4.992 3.757 7.218c0 4.039 2.467 5.76 6.476 7.219 2.585.92 3.445 1.574 3.445 2.583 0 .98-.84 1.545-2.354 1.545-1.875 0-4.965-.921-6.99-2.109l-.9 5.555C5.175 22.99 8.385 24 11.714 24c2.641 0 4.843-.624 6.328-1.813 1.664-1.305 2.525-3.236 2.525-5.732 0-4.128-2.524-5.851-6.594-7.305h.003z",
  revolut: "M20.9133 6.9566C20.9133 3.1208 17.7898 0 13.9503 0H2.424v3.8605h10.9782c1.7376 0 3.177 1.3651 3.2087 3.043.016.84-.2994 1.633-.8878 2.2324-.5886.5998-1.375.9303-2.2144.9303H9.2322a.2756.2756 0 0 0-.2755.2752v3.431c0 .0585.018.1142.052.1612L16.2646 24h5.3114l-7.2727-10.094c3.6625-.1838 6.61-3.2612 6.61-6.9494zM6.8943 5.9229H2.424V24h4.4704z",
  webflow: "m24 4.515-7.658 14.97H9.149l3.205-6.204h-.144C9.566 16.713 5.621 18.973 0 19.485v-6.118s3.596-.213 5.71-2.435H0V4.515h6.417v5.278l.144-.001 2.622-5.277h4.854v5.244h.144l2.72-5.244H24Z",
};

const DEALS = [
  { name: "Airtable", value: 48000, close: "2026-11-07", color: "#18bfff" },
  { name: "Stripe", value: 152000, close: "2026-12-12", color: "#635bff" },
  { name: "Revolut", value: 97500, close: "2026-11-14", color: "#191c1f" },
  { name: "Webflow", value: 214500, close: "2027-01-30", color: "#146ef5" },
];
type Key = "name" | "value" | "close";
/* each column's useful order comes first: names A to Z, money high to low, dates soonest */
const NATURAL: Record<Key, "ascending" | "descending"> = { name: "ascending", value: "descending", close: "ascending" };

export default function SortableHeaderDemo() {
  const [sort, setSort] = React.useState<{ key: Key; flip: boolean }>({ key: "value", flip: false });
  const dir = (k: Key) => (sort.key !== k ? null : sort.flip ? (NATURAL[k] === "ascending" ? "descending" : "ascending") : NATURAL[k]);
  const onSort = (k: Key) => setSort(sort.key === k ? { key: k, flip: !sort.flip } : { key: k, flip: false });
  const rows = [...DEALS].sort((a, b) => (dir(sort.key) === "ascending" ? 1 : -1) * (sort.key === "value" ? a.value - b.value : String(a[sort.key]).localeCompare(String(b[sort.key]))));
  return (
    <table className="w-full max-w-[560px] border-separate border-spacing-0 text-[length:var(--ns-text-body)]">
      <thead className="text-left text-[length:var(--ns-text-meta)] text-[var(--ns-ink-3)] [&_th]:h-10 [&_th]:border-b [&_th]:border-[var(--ns-line)] [&_th]:px-3">
        <tr>
          <SortableHeader label="Company" direction={dir("name")} onSort={() => onSort("name")} />
          <SortableHeader label="Value" align="end" direction={dir("value")} onSort={() => onSort("value")} />
          <SortableHeader label="Close" direction={dir("close")} onSort={() => onSort("close")} />
        </tr>
      </thead>
      <tbody className="[&_td]:h-11 [&_td]:border-b [&_td]:border-[var(--ns-line-soft)] [&_td]:px-3">
        {rows.map((r) => (
          <tr key={r.name}>
            <td>
              <span className="inline-flex items-center gap-2.5">
                <CompanyMark name={r.name} color={r.color} glyph={GLYPH[r.name.toLowerCase()]} />
                {r.name}
              </span>
            </td>
            <td className="text-right tabular-nums">${r.value.toLocaleString("en-US")}</td>
            <td className="text-[var(--ns-ink-2)] tabular-nums">{r.close}</td>
          </tr>
        ))}
      </tbody>
    </table>
  );
}
```

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

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `label` | `string` |  | Required. |
| `direction` | `"ascending" \| "descending" \| null` |  | This column's current sort, or null when the table is sorted by another column. |
| `onSort` | `() => void` |  | Required. |
| `align` | `"start" \| "end"` | `"start"` |  |

Full docs: https://notchset.dev/components/sortable-header

## 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/sortable-header.json
```

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

## Continue the workflow

- [Data table](https://notchset.dev/blocks/data-table)
- [View tabs](https://notchset.dev/blocks/view-tabs)
- [Record header](https://notchset.dev/blocks/record-header)

## Source

### components/ui/notchset/sortable-header.tsx

```tsx
// Notchset sortable-header 2.0.0 · https://notchset.dev/changelog
"use client";
import * as React from "react";
import { ArrowDown, ArrowDownUp, ArrowUp } from "lucide-react";
import { cn } from "@/lib/utils";

/*
 * Sortable header: a table column you can sort by. Press to sort by it; press again to flip. Each column has a
 * natural first direction (names A to Z, money high to low), so the first press gives the useful order. The
 * arrow shows on the sorted column, and on others only on hover or focus. The th carries aria-sort.
 */
type SortableHeaderProps = Omit<React.ComponentPropsWithoutRef<"th">, "onClick" | "align"> & {
  label: string;
  /** This column's current sort, or null when the table is sorted by another column. */
  direction: "ascending" | "descending" | null;
  onSort: () => void;
  align?: "start" | "end" | undefined;
};

function SortableHeader({ label, direction, onSort, align = "start", className, ...props }: SortableHeaderProps) {
  const Arrow = direction === "ascending" ? ArrowUp : direction === "descending" ? ArrowDown : ArrowDownUp;
  return (
    <th aria-sort={direction ?? "none"} data-slot="sortable-header" className={cn(align === "end" && "text-end!", className)} {...props}>
      <button
        type="button"
        onClick={onSort}
        className={cn(
          "group -mx-1 -my-0.5 inline-flex cursor-pointer items-center gap-1 align-middle rounded-[6px] px-1 py-0.5 [font:inherit] text-inherit outline-hidden hover:text-[var(--ns-ink)] focus-visible:outline-2 focus-visible:outline-[var(--ns-signal)]",
          direction && "text-[var(--ns-ink)]",
          align === "end" && "flex-row-reverse",
        )}
      >
        {label}
        <Arrow
          aria-hidden
          className={cn("size-3 text-[var(--ns-ink-3)] [transition:opacity_var(--ns-time-color)]", direction ? "opacity-100" : "opacity-0 group-hover:opacity-100 group-focus-visible:opacity-100")}
        />
      </button>
    </th>
  );
}

export { SortableHeader, type SortableHeaderProps };
```

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.