Component
Sheet
A panel that slides in from an edge.
stablev0.3.0 Chromium 103 ui-scale safe
Install
Copies the file into
components/ds/, with its registry dependencies and npm packages. See Installation for the one-time setup.bunx shadcn@3 add @fastrp/sheetExamples
Default
API
<Sheet />Takes the props of what it wrapsRadix's dialog as a side panel, sounding `open` and `close` as `Dialog` does.
<SheetContent />A panel that slides in from an edge: navigation on a phone, a filter drawer, a detail pane.
| Prop | Type | Default | Notes |
|---|---|---|---|
| showClose | boolean | true | |
| side | "top" | "right" | "bottom" | "left" | right |
Dependencies
npm
- @radix-ui/react-dialog@^1.1.4
- class-variance-authority@^0.7.1
- lucide-react@^0.469.0
Registry
- @fastrp/ui-sounds
- @fastrp/utils
Source
components/ds/sheet.tsxShowHide
'use client';
import * as SheetPrimitive from '@radix-ui/react-dialog';
import { cva, type VariantProps } from 'class-variance-authority';
import { X } from 'lucide-react';
import type * as React from 'react';
import { useSoundedOpen } from '@/components/ds/ui-sounds';
import { cn } from '@/lib/utils';
// @fast-ds [email protected]
/**
* Radix's dialog as a side panel, sounding `open` and `close` as `Dialog` does.
*/
function Sheet({
open,
defaultOpen,
onOpenChange,
...props
}: React.ComponentProps<typeof SheetPrimitive.Root>) {
return (
<SheetPrimitive.Root {...props} {...useSoundedOpen({ open, defaultOpen, onOpenChange })} />
);
}
const SheetTrigger = SheetPrimitive.Trigger;
const SheetClose = SheetPrimitive.Close;
const SheetPortal = SheetPrimitive.Portal;
function SheetOverlay({
className,
...props
}: React.ComponentProps<typeof SheetPrimitive.Overlay>) {
return (
<SheetPrimitive.Overlay
data-slot="sheet-overlay"
className={cn(
'fixed inset-0 z-overlay bg-ink/60 backdrop-blur-sm data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:animate-in data-[state=open]:fade-in-0',
className,
)}
{...props}
/>
);
}
const sheetVariants = cva(
'panel fixed z-modal flex flex-col gap-4 rounded-none transition ease-brand data-[state=closed]:animate-out data-[state=closed]:duration-base data-[state=open]:animate-in data-[state=open]:duration-slow',
{
variants: {
side: {
top: 'inset-x-0 top-0 border-b border-line data-[state=closed]:slide-out-to-top data-[state=open]:slide-in-from-top',
bottom:
'inset-x-0 bottom-0 border-t border-line data-[state=closed]:slide-out-to-bottom data-[state=open]:slide-in-from-bottom',
left: 'inset-y-0 left-0 h-full w-3/4 border-r border-line data-[state=closed]:slide-out-to-left data-[state=open]:slide-in-from-left sm:max-w-sm',
right:
'inset-y-0 right-0 h-full w-3/4 border-l border-line data-[state=closed]:slide-out-to-right data-[state=open]:slide-in-from-right sm:max-w-sm',
},
},
defaultVariants: { side: 'right' },
},
);
export type SheetContentProps = React.ComponentProps<typeof SheetPrimitive.Content> &
VariantProps<typeof sheetVariants> & { showClose?: boolean };
/** A panel that slides in from an edge: navigation on a phone, a filter drawer, a detail pane. */
function SheetContent({
side = 'right',
className,
children,
showClose = true,
...props
}: SheetContentProps) {
return (
<SheetPortal>
<SheetOverlay />
<SheetPrimitive.Content
data-slot="sheet-content"
className={cn(sheetVariants({ side }), className)}
{...props}
>
{children}
{showClose && (
<SheetPrimitive.Close
data-slot="sheet-close"
className="absolute right-3 top-3 flex size-8 items-center justify-center text-muted-foreground transition-colors duration-fast hover:bg-surface hover:text-foreground focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-ring [&_svg]:size-4"
>
<X />
<span className="sr-only">Close</span>
</SheetPrimitive.Close>
)}
</SheetPrimitive.Content>
</SheetPortal>
);
}
function SheetHeader({ className, ...props }: React.ComponentProps<'div'>) {
return (
<div
data-slot="sheet-header"
className={cn('flex flex-col gap-1.5 border-b border-foreground/10 p-6 pr-12', className)}
{...props}
/>
);
}
function SheetFooter({ className, ...props }: React.ComponentProps<'div'>) {
return (
<div
data-slot="sheet-footer"
className={cn(
'mt-auto flex flex-col gap-2 border-t border-foreground/10 bg-black/15 p-6',
className,
)}
{...props}
/>
);
}
function SheetTitle({ className, ...props }: React.ComponentProps<typeof SheetPrimitive.Title>) {
return (
<SheetPrimitive.Title
data-slot="sheet-title"
className={cn('font-display text-3xl leading-none text-foreground', className)}
{...props}
/>
);
}
function SheetDescription({
className,
...props
}: React.ComponentProps<typeof SheetPrimitive.Description>) {
return (
<SheetPrimitive.Description
data-slot="sheet-description"
className={cn('text-sm text-muted-foreground', className)}
{...props}
/>
);
}
export {
Sheet,
SheetClose,
SheetContent,
SheetDescription,
SheetFooter,
SheetHeader,
SheetOverlay,
SheetPortal,
SheetTitle,
SheetTrigger,
};