# Sidebar (Notchset): prompt.md (v2.2.0)

- id: `sidebar` · version 2.2.0 · block · pro (Pro)
- category: Layout
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add @notchset-pro/sidebar`
- npm dependencies: lucide-react@^1
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/avatar, @notchset/keyboard-hint
- docs: https://notchset.dev/blocks/sidebar
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

The workspace, search, the sections with their counts, pinned records and you. The section you're on is raised with the Signature at its edge; collapsed, it is a rail of icons named on hover. A pinned record can carry its own remove button, shown on hover and focus and always on touch..

## 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/blocks/sidebar.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `avatar`, `keyboard-hint`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `Sidebar`, 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-bezel`, `--ns-canvas`, `--ns-ease`, `--ns-header`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-radius`, `--ns-raised`, `--ns-side`, `--ns-signal`, `--ns-text-body`, `--ns-text-meta`, `--ns-time-color`, `--ns-weight-medium`, `--ns-weight-strong`, `--ns-well`.
- 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 { Sidebar } from "@/components/ui/notchset/blocks/sidebar";
```

## Parts
- A single export that takes props.

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

## Built from
- avatar (`avatar`), installed with it: reuse it, don't rebuild it
- keyboard-hint (`keyboard-hint`), installed with it: reuse it, don't rebuild it

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import * as React from "react";
import { CalendarClock, CalendarDays, LayoutDashboard, Mail } from "lucide-react";
import { Sidebar } from "@/components/ui/notchset/blocks/sidebar";
import { TopBar } from "@/components/ui/notchset/blocks/top-bar";
import { Button } from "@/components/ui/notchset/button";
import { CompanyMark } from "@/components/ui/notchset/company-mark";

/* the companies' own marks, 24×24 paths as the CRM seed draws them */
const GLYPH: Record<string, string> = {
  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",
  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",
};

export default function SidebarDemo() {
  const [pinsFolded, setPinsFolded] = React.useState(false);
  return (
    <div className="grid h-[520px] w-full grid-cols-[236px_minmax(0,1fr)] overflow-hidden rounded-[var(--ns-radius-lg)] shadow-[inset_0_0_0_1px_var(--ns-line-soft)] max-[600px]:grid-cols-1">
      <Sidebar
        className="max-[600px]:hidden"
        workspace={{ name: "Notchset", logo: <span className="text-[11px] font-bold">N</span> }}
        notifications={{ unread: 2, menu: (b) => b }}
        onSearch={() => {}}
        items={[
          { key: "home", icon: <LayoutDashboard />, label: "Home", href: "#home" },
          { key: "inbox", icon: <Mail />, label: "Inbox", count: 4, href: "#inbox" },
          { key: "pipeline", icon: <CalendarClock />, label: "Pipeline", count: 13, href: "#pipeline", active: true },
          { key: "calendar", icon: <CalendarDays />, label: "Calendar", count: 3, href: "#calendar" },
        ]}
        pins={{
          folded: pinsFolded,
          onToggle: () => setPinsFolded(!pinsFolded),
          items: [
            { key: "f", label: "Stripe", mark: <CompanyMark name="Stripe" color="#635bff" glyph={GLYPH.stripe} size={16} />, href: "#stripe" },
            { key: "t", label: "Webflow", mark: <CompanyMark name="Webflow" color="#146ef5" glyph={GLYPH.webflow} size={16} />, href: "#webflow" },
          ],
        }}
        me={{ name: "Ana Ruiz", role: "Account Executive" }}
      />
      <div className="flex min-w-0 flex-col">
        <TopBar title="Pipeline">
          <Button variant="primary" size="sm">
            New deal
          </Button>
        </TopBar>
        <div className="p-5 text-[length:var(--ns-text-small)] text-[var(--ns-ink-3)]">The page goes here.</div>
      </div>
    </div>
  );
}
```

This example also uses `button` (https://notchset.dev/components/button), `company-mark` (https://notchset.dev/components/company-mark), `top-bar` (https://notchset.dev/blocks/top-bar). Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add @notchset-pro/sidebar @notchset/button @notchset/company-mark @notchset-pro/top-bar`. The `@notchset-pro` items are Pro: they need the registries in components.json and the key (Setup).

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `workspace` | `{ name: string; logo?: React.ReactNode; /** The product's own brand (BrandLockup) in place of the tile and the name. */ brand?: React.ReactNode }` |  | Required. |
| `workspaceMenu` | `(trigger: React.ReactElement) => React.ReactNode` |  | Wrap the workspace button in its menu: (button) => <Menu trigger={button}>…</Menu>. |
| `notifications` | `{ unread: number; menu: (trigger: React.ReactElement) => React.ReactNode }` |  |  |
| `onSearch` | `() => void` |  | Required. |
| `onCollapse` | `() => void` |  |  |
| `collapsed` | `boolean` | `false` | A rail of icons; the collapse button expands it again. |
| `items` | `SidebarItem[]` |  | Required. |
| `pins` | `{ items: SidebarPin[]; folded: boolean; onToggle: () => void; empty?: string; label?: string \| undefined; first?: boolean \| undefined }` |  | label: the group's name ("Pinned" by default, "Favorites"); first: it comes before the sections |
| `sections` | `{ key: string; label: string; folded: boolean; onToggle: () => void; items: SidebarItem[]; action?: { label: string; icon: React.ReactNode; onClick: () => void } \| undefined }[]` |  | Further groups of sections that fold (a connected app's pages: Revenue). |
| `me` | `{ name: string; role: string; src?: string \| undefined; active?: boolean \| undefined }` |  | active: a page reached from the account menu (Settings) is on screen; the account row lights as a page would |
| `accountMenu` | `(trigger: React.ReactElement) => React.ReactNode` |  |  |
| `extra` | `React.ReactNode` |  | Rendered after the main sections (a connected app's own section). |

Full docs: https://notchset.dev/blocks/sidebar

## 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 @notchset-pro/sidebar
```

Pro item: needs the `@notchset-pro` registry in `components.json` and `NOTCHSET_TOKEN` in `.env.local` (https://notchset.dev/account). Setup: https://notchset.dev/docs/pro. Every components.json `style` gets the same files.

## Continue the workflow

- [Keyboard hint](https://notchset.dev/components/keyboard-hint)
- [Command menu](https://notchset.dev/components/command-menu)
- [Top bar](https://notchset.dev/blocks/top-bar)

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.