# Settings layout (Notchset): prompt.md (v2.1.0) - id: `settings-layout` · version 2.1.0 · block · free - category: Application UI - build: one set of files for every shadcn style - install: `npx shadcn@latest add https://notchset.dev/r/settings-layout.json` - npm dependencies: lucide-react@^1 - registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/search-field, @notchset/tabs - docs: https://notchset.dev/blocks/settings-layout - The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand. A list of sections beside the open one, each made of groups of rows: what the setting does on the left, its control on the right, taking effect as it changes. On a phone the list comes first.. ## 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/settings-layout.tsx`. - Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `search-field`, `tabs`. - Builds: one set of files, the same for every shadcn style. - Exports to keep: `SettingsGroup`, `SettingsLayout`, `SettingsNote`, `SettingsRow`, `SettingsTabs`, `SettingsNavItem`, 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-font-display`, `--ns-gutter`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line-soft`, `--ns-radius`, `--ns-raised`, `--ns-signal`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-small`, `--ns-text-strong`, `--ns-tracking-display`, `--ns-weight-medium`, `--ns-weight-strong`. - 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 { SettingsGroup, SettingsLayout, SettingsNote, SettingsRow, SettingsTabs } from "@/components/ui/notchset/blocks/settings-layout"; ``` ## Parts - A single export that takes props. ## Match the original - Read `components/ui/notchset/blocks/settings-layout.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 - search-field (`search-field`), installed with it: reuse it, don't rebuild it - tabs (`tabs`), 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 { SettingsGroup, SettingsLayout, SettingsNote, SettingsRow, SettingsTabs } from "@/components/ui/notchset/blocks/settings-layout"; import { Meter } from "@/components/ui/notchset/meter"; import { Switch } from "@/components/ui/notchset/switch"; const NAV = [ ["workspace", "Workspace"], ["team", "Team & quotas"], ["billing", "Plan & billing"], ] as const; export default function SettingsLayoutDemo() { const [log, setLog] = React.useState(true); return ( ({ key, label, href: `#${key}` }))} current="billing" picked backHref="#" title="Plan & billing"> Stage names come from the app config, so they stay the same across every page. ); } ``` This example also uses `meter` (https://notchset.dev/components/meter), `switch` (https://notchset.dev/components/switch). Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add https://notchset.dev/r/settings-layout.json https://notchset.dev/r/meter.json https://notchset.dev/r/switch.json`. ## Props | Prop | Type | Default | What it does | |---|---|---|---| | `nav` | `NavItem[]` | | Required. | | `current` | `string` | | Required. | | `picked` | `boolean` | | On a phone: whether a section was chosen (else the list shows). | | `backHref` | `string` | | Required. | | `title` | `React.ReactNode` | | Required. | | `description` | `React.ReactNode` | | One line under the title: what the section holds, or what changed ("8 people · 2 changes this week"). | | `actions` | `React.ReactNode` | | The section's one action at the title's right (Invite people); it wraps under the title on a phone. | | `find` | `SettingsFindItem[]` | | Every setting "Find a setting" reaches; without it there's no search. | Full docs: https://notchset.dev/blocks/settings-layout ## 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/settings-layout.json ``` Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/settings-layout`. Every components.json style gets the same files. ## Continue the workflow - [Sign in and onboarding step](https://notchset.dev/blocks/sign-in) - [API key list](https://notchset.dev/blocks/api-key-list) - [Webhooks](https://notchset.dev/blocks/webhook-list) ## Source ### components/ui/notchset/blocks/settings-layout.tsx ```tsx // Notchset settings-layout 2.1.0 · https://notchset.dev/changelog "use client"; import * as React from "react"; import { ChevronLeft, ChevronRight } from "lucide-react"; import { cn } from "@/lib/utils"; import { SearchField } from "@/components/ui/notchset/search-field"; import { useMoreToRight } from "@/components/ui/notchset/tabs"; /* * Settings (block 40): a list of sections beside the one that's open. Each section is groups of rows: what * the setting is and what it does on the left, its control on the right, taking effect the moment it changes. * The open section is raised in the list (as the sidebar's page is) and reads in a column of about 780px. * On a phone Settings opens as the list of its sections; a section opens on its own, with a way back. Sections * can be grouped (Workspace, Developers): a quiet heading starts each group, on a phone as on a desktop. The * open section's header is its title, an optional line under it and its one action at the right (Invite people): * the same anatomy in every template (APP-RULES 227). With `find`, "Find a setting" tops the list: it matches what * each setting does, and the matches replace the open section until the field is cleared or one is chosen. */ type NavItem = { key: string; label: string; href: string; /** The group it starts or belongs to; a heading shows where it changes. */ group?: string | undefined }; /** One setting "Find a setting" can reach: its name, the section it's in, what it does, and words people search for. */ type SettingsFindItem = { key: string; label: string; where: string; about: string; words?: string | undefined; href: string }; type SettingsLayoutProps = { nav: NavItem[]; current: string; /** On a phone: whether a section was chosen (else the list shows). */ picked: boolean; backHref: string; title: React.ReactNode; /** One line under the title: what the section holds, or what changed ("8 people · 2 changes this week"). */ description?: React.ReactNode; /** The section's one action at the title's right (Invite people); it wraps under the title on a phone. */ actions?: React.ReactNode; /** Every setting "Find a setting" reaches; without it there's no search. */ find?: SettingsFindItem[] | undefined; children: React.ReactNode; className?: string | undefined; }; /** The settings content column's one width (APP-RULES 227): every section, tab and template reads at it. */ const SETTINGS_COLUMN = "max-w-[780px]"; function SettingsLayout({ nav, current, picked, backHref, title, description, actions, find, children, className }: SettingsLayoutProps) { const [q, setQ] = React.useState(""); const needle = q.trim().toLowerCase(); const found = find && needle ? find.filter((x) => `${x.where} ${x.label} ${x.words ?? ""} ${x.about}`.toLowerCase().includes(needle)) : []; const finding = !!needle; return (
{finding && (

{found.length ? `${found.length} ${found.length === 1 ? "setting" : "settings"} for “${q.trim()}”` : `No setting matches “${q.trim()}”.`}

)} {/* kept mounted while searching (display none takes it out of the tab order and the reading order), so a draft in a section survives the search */}
Settings

{title}

{description &&

{description}

}
{actions &&
{actions}
}
{children}
); } /** Sub-sections of one section, as links under its title (Overview · Seats · Invoices). */ type SettingsTabsProps = { items: (NavItem & { count?: number | undefined })[]; current: string; label: string; className?: string | undefined }; function SettingsTabs({ items, current, label, className }: SettingsTabsProps) { const strip = React.useRef(null); const more = useMoreToRight(strip); return ( ); } type SettingsGroupProps = { title?: React.ReactNode; hint?: React.ReactNode; children: React.ReactNode; className?: string | undefined }; function SettingsGroup({ title, hint, children, className }: SettingsGroupProps) { return (
{(title || hint) && (
{title &&

{title}

} {hint &&

{hint}

}
)} {children}
); } type SettingsRowProps = { label: React.ReactNode; hint?: React.ReactNode; lead?: React.ReactNode; children?: React.ReactNode; className?: string | undefined }; /** One setting: what it is and what it does, then its control. The hint says the current effect, not a manual. */ function SettingsRow({ label, hint, lead, children, className }: SettingsRowProps) { return (
{lead}
{label} {hint && {hint}}
{children &&
{children}
}
); } /** A quiet line of context under or above a group ("Stage names come from the app config"). */ function SettingsNote({ icon, children, className }: { icon?: React.ReactNode; children: React.ReactNode; className?: string | undefined }) { return (

svg]:mt-0.5 [&>svg]:size-3.5 [&>svg]:shrink-0", className)}> {icon} {children}

); } export { SettingsGroup, SettingsLayout, SettingsNote, SettingsRow, SettingsTabs, type NavItem as SettingsNavItem, type SettingsFindItem, type SettingsLayoutProps, type SettingsRowProps }; ``` 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.