Sheet
A simplified wrapper for Shadcn Sheet with flexible option handling and automatic type conversion
Installation
npx shadcn@latest add @glrk-ui/sheetIf you haven't set up the prerequisites yet, check out Prerequest section.
Copy and paste the following code into shadcn sheet component.
type SheetFooterWrapperProps = {
cancel?: React.ReactNode
action?: React.ReactNode
footerCls?: string
actionCls?: string
cancelCls?: string
onAction?: () => void
onCancel?: () => void
}
function SheetFooterWrapper({
cancel,
action,
footerCls,
actionCls,
cancelCls,
onAction = () => { },
onCancel = () => { },
}: SheetFooterWrapperProps) {
return (
<SheetFooter className={footerCls}>
{
cancel &&
<SheetClose asChild>
<Button
variant="secondary"
onClick={onCancel}
className={cn("border", cancelCls)}
asChild={typeof cancel !== "string"}
>
{cancel}
</Button>
</SheetClose>
}
{
action &&
<Button
onClick={onAction}
className={actionCls}
asChild={typeof action !== "string"}
>
{action}
</Button>
}
</SheetFooter>
)
}
type SheetWrapperProps = {
title?: React.ReactNode
trigger?: React.ReactNode
children?: React.ReactNode
description?: React.ReactNode
descriptionCls?: string
contentCls?: string
headerCls?: string
titleCls?: string
side?: "top" | "bottom" | "right" | "left"
} & SheetFooterWrapperProps
function SheetWrapper({
trigger,
title,
description,
children,
contentCls,
headerCls,
titleCls,
descriptionCls,
cancel = "Cancel",
action,
footerCls,
actionCls,
cancelCls,
onAction,
onCancel,
side = "right",
...props
}: React.ComponentProps<typeof SheetPrimitive.Root> & SheetWrapperProps) {
return (
<Sheet {...props}>
{trigger &&
<SheetTrigger asChild={typeof trigger !== "string"}>{trigger}</SheetTrigger>
}
<SheetContent side={side} className={contentCls}>
<SheetHeader className={headerCls}>
<SheetTitle className={titleCls}>{title}</SheetTitle>
{description && (
<SheetDescription className={descriptionCls}>
{description}
</SheetDescription>
)}
</SheetHeader>
{children}
{
(!!cancel || !!action) &&
<SheetFooterWrapper
cancel={cancel}
action={action}
footerCls={footerCls}
actionCls={actionCls}
cancelCls={cancelCls}
onAction={onAction}
onCancel={onCancel}
/>
}
</SheetContent>
</Sheet>
)
}Add SheetWrapper and SheetFooterWrapper at the export block.
export {
Sheet,
SheetPortal,
SheetOverlay,
SheetTrigger,
SheetContent,
SheetHeader,
SheetFooter,
SheetTitle,
SheetDescription,
SheetAction,
SheetClose,
SheetWrapper,
SheetFooterWrapper,
}Installation
npm install @radix-ui/react-dialogsheet.tsx
Copy and paste the following code into your project.
"use client"
import * as React from "react"
import * as SheetPrimitive from "@radix-ui/react-dialog"
import { XIcon } from "lucide-react"
import { cn } from "@/lib/utils"
import { Button } from "@/components/ui/button"
function Sheet({ ...props }: React.ComponentProps<typeof SheetPrimitive.Root>) {
return <SheetPrimitive.Root data-slot="sheet" {...props} />
}
function SheetTrigger({
...props
}: React.ComponentProps<typeof SheetPrimitive.Trigger>) {
return <SheetPrimitive.Trigger data-slot="sheet-trigger" {...props} />
}
function SheetClose({
...props
}: React.ComponentProps<typeof SheetPrimitive.Close>) {
return <SheetPrimitive.Close data-slot="sheet-close" {...props} />
}
function SheetPortal({
...props
}: React.ComponentProps<typeof SheetPrimitive.Portal>) {
return <SheetPrimitive.Portal data-slot="sheet-portal" {...props} />
}
function SheetOverlay({
className,
...props
}: React.ComponentProps<typeof SheetPrimitive.Overlay>) {
return (
<SheetPrimitive.Overlay
data-slot="sheet-overlay"
className={cn(
"data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 fixed inset-0 z-50 bg-black/50",
className
)}
{...props}
/>
)
}
function SheetContent({
className,
children,
side = "right",
...props
}: React.ComponentProps<typeof SheetPrimitive.Content> & {
side?: "top" | "right" | "bottom" | "left"
}) {
return (
<SheetPortal>
<SheetOverlay />
<SheetPrimitive.Content
data-slot="sheet-content"
className={cn(
"bg-background data-[state=open]:animate-in data-[state=closed]:animate-out fixed z-50 flex flex-col gap-4 shadow-lg transition ease-in-out data-[state=closed]:duration-300 data-[state=open]:duration-500",
side === "right" &&
"data-[state=closed]:slide-out-to-right data-[state=open]:slide-in-from-right inset-y-0 right-0 h-full w-3/4 border-l sm:max-w-sm",
side === "left" &&
"data-[state=closed]:slide-out-to-left data-[state=open]:slide-in-from-left inset-y-0 left-0 h-full w-3/4 border-r sm:max-w-sm",
side === "top" &&
"data-[state=closed]:slide-out-to-top data-[state=open]:slide-in-from-top inset-x-0 top-0 h-auto border-b",
side === "bottom" &&
"data-[state=closed]:slide-out-to-bottom data-[state=open]:slide-in-from-bottom inset-x-0 bottom-0 h-auto border-t",
className
)}
{...props}
>
{children}
<SheetPrimitive.Close className="ring-offset-background focus:ring-ring data-[state=open]:bg-secondary absolute top-4 right-4 rounded-xs opacity-70 transition-opacity hover:opacity-100 focus:ring-2 focus:ring-offset-2 focus:outline-hidden disabled:pointer-events-none">
<XIcon className="size-4" />
<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 p-4", className)}
{...props}
/>
)
}
function SheetFooter({ className, ...props }: React.ComponentProps<"div">) {
return (
<div
data-slot="sheet-footer"
className={cn("mt-auto flex flex-col gap-2 p-4", className)}
{...props}
/>
)
}
function SheetTitle({
className,
...props
}: React.ComponentProps<typeof SheetPrimitive.Title>) {
return (
<SheetPrimitive.Title
data-slot="sheet-title"
className={cn("text-foreground font-semibold", className)}
{...props}
/>
)
}
function SheetDescription({
className,
...props
}: React.ComponentProps<typeof SheetPrimitive.Description>) {
return (
<SheetPrimitive.Description
data-slot="sheet-description"
className={cn("text-muted-foreground text-sm", className)}
{...props}
/>
)
}
type SheetFooterWrapperProps = {
cancel?: React.ReactNode
action?: React.ReactNode
footerCls?: string
actionCls?: string
cancelCls?: string
onAction?: () => void
onCancel?: () => void
}
function SheetFooterWrapper({
cancel,
action,
footerCls,
actionCls,
cancelCls,
onAction = () => { },
onCancel = () => { },
}: SheetFooterWrapperProps) {
return (
<SheetFooter className={footerCls}>
{
cancel &&
<SheetClose asChild>
<Button
variant="secondary"
onClick={onCancel}
className={cn("border", cancelCls)}
asChild={typeof cancel !== "string"}
>
{cancel}
</Button>
</SheetClose>
}
{
action &&
<Button
onClick={onAction}
className={actionCls}
asChild={typeof action !== "string"}
>
{action}
</Button>
}
</SheetFooter>
)
}
type SheetWrapperProps = {
title?: React.ReactNode
trigger?: React.ReactNode
children?: React.ReactNode
description?: React.ReactNode
descriptionCls?: string
contentCls?: string
headerCls?: string
titleCls?: string
side?: "top" | "bottom" | "right" | "left"
} & SheetFooterWrapperProps
function SheetWrapper({
trigger,
title,
description,
children,
contentCls,
headerCls,
titleCls,
descriptionCls,
cancel = "Cancel",
action,
footerCls,
actionCls,
cancelCls,
onAction,
onCancel,
side = "right",
...props
}: React.ComponentProps<typeof SheetPrimitive.Root> & SheetWrapperProps) {
return (
<Sheet {...props}>
{trigger &&
<SheetTrigger asChild={typeof trigger !== "string"}>{trigger}</SheetTrigger>
}
<SheetContent side={side} className={contentCls}>
<SheetHeader className={headerCls}>
<SheetTitle className={titleCls}>{title}</SheetTitle>
{description && (
<SheetDescription className={descriptionCls}>
{description}
</SheetDescription>
)}
</SheetHeader>
{children}
{
(!!cancel || !!action) &&
<SheetFooterWrapper
cancel={cancel}
action={action}
footerCls={footerCls}
actionCls={actionCls}
cancelCls={cancelCls}
onAction={onAction}
onCancel={onCancel}
/>
}
</SheetContent>
</Sheet>
)
}
export {
Sheet,
SheetTrigger,
SheetClose,
SheetContent,
SheetHeader,
SheetFooter,
SheetTitle,
SheetDescription,
SheetWrapper,
SheetFooterWrapper,
}Done
You can now use SheetWrapper
Usage
Basic
import { SheetWrapper } from "@/components/ui/sheet";
import { Button } from "@/components/ui/button";
export function Basic() {
return (
<>
<SheetWrapper
trigger={<Button>Delete</Button>}
title="Are you absolutely sure?"
description="This action cannot be undone. This will permanently delete your account and remove your data from our servers."
/>
</>
)
}Controlled
import { useState } from "react"
import { SheetWrapper } from "@/components/ui/sheet";
import { Button } from "@/components/ui/button";
export function Controlled() {
const [open, setOpen] = useState(false)
return (
<>
<SheetWrapper
open={open}
onOpenChange={setOpen}
trigger={<Button>Controlled</Button>}
onAction={() => setOpen(false)}
title="Are you absolutely sure?"
description="This action cannot be undone. This will permanently delete your account and remove your data from our servers."
/>
</>
)
}
// Programaticaly open model without trigger
export function Controlled2() {
const [open, setOpen] = useState(false)
const updateOpen = () => setOpen(p => !p)
return (
<>
<Button onClick={updateOpen}>Controlled 2</Button>
<SheetWrapper
open={open}
onOpenChange={updateOpen}
onAction={updateOpen}
title="Are you absolutely sure?"
description="This action cannot be undone. This will permanently delete your account and remove your data from our servers."
/>
</>
)
}Custom
export function Custom() {
return (
<SheetWrapper
trigger={<Button>Delete</Button>}
title="Some Custom Modal"
// to remove footer make cancel empty
cancel=""
>
<div>...</div>
</SheetWrapper>
)
}Reference
SheetFooterWrapper
Prop
Type
SheetWrapper
Prop
Type
Properties of SheetFooterWrapper can be passed directly.