# Bottom sheet (Notchset): prompt.md (v2.0.0)
- id: `bottom-sheet` · version 2.0.0 · component · free
- category: Overlays
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add https://notchset.dev/r/bottom-sheet.json`
- npm dependencies: @base-ui/react@^1
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json
- docs: https://notchset.dev/components/bottom-sheet
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.
A phone's place for a short set of choices or a small form. It rises from the bottom with a grab handle and closes by swiping down, tapping outside or Esc. On a desktop, use a Menu or a Dialog..
## 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: `@base-ui/react@^1`.
- Files: `components/ui/notchset/bottom-sheet.tsx`; shared code: `lib/notchset/portal.ts`.
- 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: `BottomSheet`, `SheetItem`, 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-ink`, `--ns-ease-panel`, `--ns-font-display`, `--ns-hover`, `--ns-ink`, `--ns-ink-3`, `--ns-line`, `--ns-panel`, `--ns-shadow-dialog`, `--ns-text-strong`, `--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 { BottomSheet, SheetItem } from "@/components/ui/notchset/bottom-sheet";
```
## Parts
- A single export that takes props.
## Match the original
- Read `components/ui/notchset/bottom-sheet.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
- Portal (shared helper, ships with it)
## Mistakes
- Recreating the component instead of installing it
## Usage
```tsx
"use client";
import * as React from "react";
import { Home, LogOut, Settings } from "lucide-react";
import { BottomSheet, SheetItem } from "@/components/ui/notchset/bottom-sheet";
import { Button } from "@/components/ui/notchset/button";
export default function BottomSheetDemo() {
const [open, setOpen] = React.useState(false);
return (
<>
} onClick={() => setOpen(false)}>Home
} onClick={() => setOpen(false)}>Settings
} danger onClick={() => setOpen(false)}>Sign out
);
}
```
This example also uses `button` (https://notchset.dev/components/button), the npm package `lucide-react`. Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add https://notchset.dev/r/bottom-sheet.json https://notchset.dev/r/button.json`.
## Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| `open` | `boolean` | | Required. |
| `onOpenChange` | `(open: boolean) => void` | | Required. |
| `title` | `React.ReactNode` | | Required. |
| `hideTitle` | `boolean` | | Hide the title visually when the content already names itself (it is still read out). |
Full docs: https://notchset.dev/components/bottom-sheet
## 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/bottom-sheet.json
```
Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/bottom-sheet`. Every components.json style gets the same files.
## Continue the workflow
- [Command menu](https://notchset.dev/components/command-menu)
- [Dialog](https://notchset.dev/components/dialog)
- [Explain](https://notchset.dev/components/explain)
## Source
### components/ui/notchset/bottom-sheet.tsx
```tsx
// Notchset bottom-sheet 2.0.0 · https://notchset.dev/changelog
"use client";
import * as React from "react";
import { Drawer } from "@base-ui/react/drawer";
import { cn } from "@/lib/utils";
import { usePortalContainer } from "@/lib/notchset/portal";
/*
* Bottom sheet: a phone's place for a short set of choices or a small form (More, account, quick add). It
* rises from the bottom in thumb reach, has a grab handle, and closes by swiping down, tapping outside or Esc.
* On a desktop, use a Menu or Dialog instead: the sheet is a phone shape.
*/
type BottomSheetProps = {
open: boolean;
onOpenChange: (open: boolean) => void;
title: React.ReactNode;
/** Hide the title visually when the content already names itself (it is still read out). */
hideTitle?: boolean | undefined;
children: React.ReactNode;
className?: string | undefined;
};
function BottomSheet({ open, onOpenChange, title, hideTitle, children, className }: BottomSheetProps) {
const portalContainer = usePortalContainer();
return (
onOpenChange(o)} swipeDirection="down">
{title}
{children}
);
}
/** A finger-sized row in a sheet. */
function SheetItem({ icon, children, danger, onClick }: { icon?: React.ReactNode; children: React.ReactNode; danger?: boolean | undefined; onClick: () => void }) {
return (
);
}
export { BottomSheet, SheetItem, type BottomSheetProps };
```
### lib/notchset/portal.ts
```tsx
// Notchset bottom-sheet 2.0.0 · https://notchset.dev/changelog
import * as React from "react";
/*
* Where overlays (dialogs, menus, popovers, tooltips, toasts, sheets) portal to. By default the document body; a
* host that themes or scopes a region (a preview stage, a shadow root, a tile in another theme) wraps it in
* PortalContainer with an element inside that scope, so its overlays keep the region's roles and light or dark.
*/
const PortalContainerContext = React.createContext(null);
const PortalContainer = PortalContainerContext.Provider;
/** The element overlays portal into here, or undefined for the document body. */
function usePortalContainer(): HTMLElement | undefined {
return React.useContext(PortalContainerContext) ?? undefined;
}
export { PortalContainer, PortalContainerContext, usePortalContainer };
```
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.