Sheet
A side sheet built on Base UI dialog primitives.
registry/new-york-v4/ui/sheet.tsx
"use client"
import type React from "react"
import { isValidElement } from "react"
import { Dialog as SheetPrimitive } from "@base-ui/react/dialog"
import { mergeProps } from "@base-ui/react/merge-props"
import { useRender } from "@base-ui/react/use-render"
import { cn } from "@/lib/utils"
import { Button } from "@/components/ui/button"
import { ScrollArea } from "@/components/ui/scroll-area"
import { IconPlaceholder } from "@/components/icon-placeholder"
export const Sheet: typeof SheetPrimitive.Root = SheetPrimitive.Root
export const SheetPortal: typeof SheetPrimitive.Portal = SheetPrimitive.Portal
export function SheetTrigger({
asChild,
children,
render,
...props
}: SheetPrimitive.Trigger.Props & {
asChild?: boolean
}): React.ReactElement {
return (
<SheetPrimitive.Trigger
data-slot="sheet-trigger"
render={
render ??
(asChild && isValidElement(children)
? (children as React.ReactElement<Record<string, unknown>>)
: undefined)
}
{...props}
>
{asChild && isValidElement(children) ? undefined : children}
</SheetPrimitive.Trigger>
)
}
export function SheetClose(
props: SheetPrimitive.Close.Props
): React.ReactElement {
return <SheetPrimitive.Close data-slot="sheet-close" {...props} />
}
export function SheetBackdrop({
className,
...props
}: SheetPrimitive.Backdrop.Props): React.ReactElement {
return (
<SheetPrimitive.Backdrop
className={cn(
"fixed inset-0 z-50 bg-black/32 backdrop-blur-sm transition-all duration-200 data-ending-style:opacity-0 data-starting-style:opacity-0",
className
)}
data-slot="sheet-backdrop"
{...props}
/>
)
}
export function SheetViewport({
className,
side,
variant = "default",
...props
}: SheetPrimitive.Viewport.Props & {
side?: "right" | "left" | "top" | "bottom"
variant?: "default" | "inset"
}): React.ReactElement {
return (
<SheetPrimitive.Viewport
className={cn(
"fixed inset-0 z-50 grid",
side === "bottom" && "grid grid-rows-[1fr_auto] pt-12",
side === "top" && "grid grid-rows-[auto_1fr] pb-12",
side === "left" && "flex justify-start",
side === "right" && "flex justify-end",
variant === "inset" && "sm:p-4",
className
)}
data-slot="sheet-viewport"
{...props}
/>
)
}
export function SheetPopup({
className,
children,
showCloseButton = true,
side = "right",
variant = "default",
closeProps,
portalProps,
...props
}: SheetPrimitive.Popup.Props & {
showCloseButton?: boolean
side?: "right" | "left" | "top" | "bottom"
variant?: "default" | "inset"
closeProps?: SheetPrimitive.Close.Props
portalProps?: SheetPrimitive.Portal.Props
}): React.ReactElement {
return (
<SheetPortal {...portalProps}>
<SheetBackdrop />
<SheetViewport side={side} variant={variant}>
<SheetPrimitive.Popup
className={cn(
"relative flex max-h-full min-h-0 w-full min-w-0 flex-col bg-popover text-popover-foreground shadow-lg/5 transition-[opacity,translate] duration-200 ease-in-out will-change-transform not-dark:bg-clip-padding before:pointer-events-none before:absolute before:inset-0 before:shadow-[0_1px_--theme(--color-black/4%)] data-ending-style:opacity-0 data-starting-style:opacity-0 max-sm:before:hidden dark:before:shadow-[0_-1px_--theme(--color-white/6%)]",
side === "bottom" &&
"row-start-2 border-t data-ending-style:translate-y-8 data-starting-style:translate-y-8",
side === "top" &&
"border-b data-ending-style:-translate-y-8 data-starting-style:-translate-y-8",
side === "left" &&
"w-[calc(100%-(--spacing(12)))] max-w-md border-e data-ending-style:-translate-x-8 data-starting-style:-translate-x-8",
side === "right" &&
"col-start-2 w-[calc(100%-(--spacing(12)))] max-w-md border-s data-ending-style:translate-x-8 data-starting-style:translate-x-8",
variant === "inset" &&
"before:hidden sm:rounded-2xl sm:border sm:before:rounded-[calc(var(--radius-2xl)-1px)] sm:**:data-[slot=sheet-footer]:rounded-b-[calc(var(--radius-2xl)-1px)]",
className
)}
data-slot="sheet-popup"
{...props}
>
{children}
{showCloseButton && (
<SheetPrimitive.Close
aria-label="Close"
className="absolute end-2 top-2"
render={<Button size="icon" variant="ghost" />}
{...closeProps}
>
<IconPlaceholder
lucide="X"
tabler="IconX"
hugeicons="Cancel01Icon"
phosphor="XIcon"
remixicon="RiCloseLine"
/>
</SheetPrimitive.Close>
)}
</SheetPrimitive.Popup>
</SheetViewport>
</SheetPortal>
)
}
export function SheetHeader({
className,
render,
...props
}: useRender.ComponentProps<"div">): React.ReactElement {
const defaultProps = {
className: cn(
"flex flex-col gap-2 p-6 in-[[data-slot=sheet-popup]:has([data-slot=sheet-panel])]:pb-3 max-sm:pb-4",
className
),
"data-slot": "sheet-header",
}
return useRender({
defaultTagName: "div",
props: mergeProps<"div">(defaultProps, props),
render,
})
}
export function SheetFooter({
className,
variant = "default",
render,
...props
}: useRender.ComponentProps<"div"> & {
variant?: "default" | "bare"
}): React.ReactElement {
const defaultProps = {
className: cn(
"flex flex-col-reverse gap-2 px-6 sm:flex-row sm:justify-end",
variant === "default" && "border-t bg-muted/72 py-4",
variant === "bare" &&
"pt-4 pb-6 in-[[data-slot=sheet-popup]:has([data-slot=sheet-panel])]:pt-3",
className
),
"data-slot": "sheet-footer",
}
return useRender({
defaultTagName: "div",
props: mergeProps<"div">(defaultProps, props),
render,
})
}
export function SheetTitle({
className,
...props
}: SheetPrimitive.Title.Props): React.ReactElement {
return (
<SheetPrimitive.Title
className={cn(
"font-heading text-xl leading-none font-semibold",
className
)}
data-slot="sheet-title"
{...props}
/>
)
}
export function SheetDescription({
className,
...props
}: SheetPrimitive.Description.Props): React.ReactElement {
return (
<SheetPrimitive.Description
className={cn("text-sm text-muted-foreground", className)}
data-slot="sheet-description"
{...props}
/>
)
}
export function SheetPanel({
className,
scrollFade = true,
render,
...props
}: useRender.ComponentProps<"div"> & {
scrollFade?: boolean
}): React.ReactElement {
const defaultProps = {
className: cn(
"p-6 in-[[data-slot=sheet-popup]:has([data-slot=sheet-footer]:not(.border-t))]:pb-1 in-[[data-slot=sheet-popup]:has([data-slot=sheet-header])]:pt-1",
className
),
"data-slot": "sheet-panel",
}
return (
<ScrollArea scrollFade={scrollFade}>
{useRender({
defaultTagName: "div",
props: mergeProps<"div">(defaultProps, props),
render,
})}
</ScrollArea>
)
}
export {
SheetPrimitive,
SheetBackdrop as SheetOverlay,
SheetPopup as SheetContent,
}
- Interaction
- modal
DependenciesBundle weight · light
- ui-primitives
- @base-ui/react@^1.4.1