Sheet
---import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";---
<Sheet> <SheetTrigger asChild> <Button>Open Sheet</Button> </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-2"> <Label for="name">Name</Label> <Input id="name" value="Pedro Duarte" /> </div> <div class="grid gap-2"> <Label for="username">Username</Label> <Input id="username" value="@peduarte" /> </div> </div> <SheetFooter> <SheetClose asChild> <Button type="submit">Save changes</Button> </SheetClose> </SheetFooter> </SheetContent></Sheet>import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";
export function Example() { return ( <> <Sheet> <SheetTrigger asChild> <Button>Open Sheet</Button> </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div className="grid gap-4 px-4"> <div className="grid gap-2"> <Label htmlFor="name">Name</Label> <Input id="name" defaultValue="Pedro Duarte" /> </div> <div className="grid gap-2"> <Label htmlFor="username">Username</Label> <Input id="username" defaultValue="@peduarte" /> </div> </div> <SheetFooter> <SheetClose asChild> <Button type="submit">Save changes</Button> </SheetClose> </SheetFooter> </SheetContent> </Sheet> </> );}<script setup lang="ts">import { ButtonVariants } from "@/components/starwind/button";import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";</script>
<template> <Sheet> <SheetTrigger asChild> <button type="button" :class="ButtonVariants.button({})">Open Sheet</button> </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-2"> <Label for="name">Name</Label> <Input id="name" default-value="Pedro Duarte" /> </div> <div class="grid gap-2"> <Label for="username">Username</Label> <Input id="username" default-value="@peduarte" /> </div> </div> <SheetFooter> <SheetClose asChild> <button type="submit" :class="ButtonVariants.button({})">Save changes</button> </SheetClose> </SheetFooter> </SheetContent> </Sheet></template><script lang="ts"> import { Button } from "@/components/starwind/button"; import { Input } from "@/components/starwind/input"; import { Label } from "@/components/starwind/label"; import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger, } from "@/components/starwind/sheet";</script>
<div> <Sheet> <SheetTrigger> {#snippet child({ props, children })} <Button {...props}>{@render children?.()}</Button> {/snippet} Open Sheet </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-2"> <Label for="docs-sheet-name">Name</Label> <Input id="docs-sheet-name" value="Pedro Duarte" /> </div> <div class="grid gap-2"> <Label for="docs-sheet-username">Username</Label> <Input id="docs-sheet-username" value="@peduarte" /> </div> </div> <SheetFooter> <SheetClose> {#snippet child({ props, children })} <Button {...props} type="submit">{@render children?.()}</Button> {/snippet} Save changes </SheetClose> </SheetFooter> </SheetContent> </Sheet></div>Installation
pnpx starwind@latest add sheet --framework astronpx starwind@latest add sheet --framework astroyarn dlx starwind@latest add sheet --framework astropnpx starwind@latest add sheet --framework reactnpx starwind@latest add sheet --framework reactyarn dlx starwind@latest add sheet --framework reactpnpx starwind@latest add sheet --framework vuenpx starwind@latest add sheet --framework vueyarn dlx starwind@latest add sheet --framework vuepnpx starwind@latest add sheet --framework sveltenpx starwind@latest add sheet --framework svelteyarn dlx starwind@latest add sheet --framework svelteUsage
---import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";---
<Sheet> <SheetTrigger asChild> <Button>Open Sheet</Button> </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-2"> <Label for="name">Name</Label> <Input id="name" value="Pedro Duarte" /> </div> <div class="grid gap-2"> <Label for="username">Username</Label> <Input id="username" value="@peduarte" /> </div> </div> <SheetFooter> <SheetClose asChild> <Button type="submit">Save changes</Button> </SheetClose> </SheetFooter> </SheetContent></Sheet>import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";
export function Example() { return ( <> <Sheet> <SheetTrigger asChild> <Button>Open Sheet</Button> </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div className="grid gap-4 px-4"> <div className="grid gap-2"> <Label htmlFor="name">Name</Label> <Input id="name" defaultValue="Pedro Duarte" /> </div> <div className="grid gap-2"> <Label htmlFor="username">Username</Label> <Input id="username" defaultValue="@peduarte" /> </div> </div> <SheetFooter> <SheetClose asChild> <Button type="submit">Save changes</Button> </SheetClose> </SheetFooter> </SheetContent> </Sheet> </> );}<script setup lang="ts">import { ButtonVariants } from "@/components/starwind/button";import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";</script>
<template> <Sheet> <SheetTrigger asChild> <button type="button" :class="ButtonVariants.button({})">Open Sheet</button> </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-2"> <Label for="name">Name</Label> <Input id="name" default-value="Pedro Duarte" /> </div> <div class="grid gap-2"> <Label for="username">Username</Label> <Input id="username" default-value="@peduarte" /> </div> </div> <SheetFooter> <SheetClose asChild> <button type="submit" :class="ButtonVariants.button({})">Save changes</button> </SheetClose> </SheetFooter> </SheetContent> </Sheet></template><script lang="ts"> import { ButtonVariants } from "@/components/starwind/button"; import { Button } from "@/components/starwind/button"; import { Input } from "@/components/starwind/input"; import { Label } from "@/components/starwind/label"; import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger, } from "@/components/starwind/sheet";</script>
<Sheet> <SheetTrigger> {#snippet child({ props })} <button {...props} type="button" class={ButtonVariants.button({})}> Open Sheet </button> {/snippet} </SheetTrigger> <SheetContent> <SheetHeader> <SheetTitle>Edit Profile</SheetTitle> <SheetDescription> Make changes to your profile here. Click save when you're done. </SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-2"> <Label for="name">Name</Label> <Input id="name" defaultValue="Pedro Duarte" /> </div> <div class="grid gap-2"> <Label for="username">Username</Label> <Input id="username" defaultValue="@peduarte" /> </div> </div> <SheetFooter> <SheetClose> {#snippet child({ props })} <button {...props} type="submit" class={ButtonVariants.button({})}> Save changes </button> {/snippet} </SheetClose> </SheetFooter> </SheetContent></Sheet>Composition
Use this structure for a sheet:
Sheet├── SheetTrigger└── SheetContent ├── SheetHeader │ ├── SheetTitle │ └── SheetDescription └── SheetFooterSheetContent includes a close button. Use SheetClose when another control also needs to close the sheet.
When to Use
Use Sheet for supporting content that slides in from an edge, such as a form or mobile navigation.
Side
Sheets can slide out from any side of the screen using the side prop.
---import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";---
<!-- Top Sheet --><Sheet> <SheetTrigger asChild> <Button variant="outline">Open Top Sheet</Button> </SheetTrigger> <SheetContent side="top"> <SheetHeader> <SheetTitle>Top Sheet</SheetTitle> <SheetDescription>This sheet opens from the top of the screen.</SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-3"> <Label for="top-sheet-name">Name</Label> <Input id="top-sheet-name" value="Pedro Duarte" /> </div> <div class="grid gap-3"> <Label for="top-sheet-username">Username</Label> <Input id="top-sheet-username" value="@peduarte" /> </div> </div> <SheetFooter> <Button variant="default">Save changes</Button> <SheetClose asChild> <Button variant="outline">Close</Button> </SheetClose> </SheetFooter> </SheetContent></Sheet>
<!-- Use side="right", "bottom", or "left" for the other edges. -->import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";
export function Example() { return ( <> {/* Top Sheet */} <Sheet> <SheetTrigger asChild> <Button variant="outline">Open Top Sheet</Button> </SheetTrigger> <SheetContent side="top"> <SheetHeader> <SheetTitle>Top Sheet</SheetTitle> <SheetDescription>This sheet opens from the top of the screen.</SheetDescription> </SheetHeader> <div className="grid gap-4 px-4"> <div className="grid gap-3"> <Label htmlFor="top-sheet-name">Name</Label> <Input id="top-sheet-name" value="Pedro Duarte" /> </div> <div className="grid gap-3"> <Label htmlFor="top-sheet-username">Username</Label> <Input id="top-sheet-username" value="@peduarte" /> </div> </div> <SheetFooter> <Button variant="default">Save changes</Button> <SheetClose asChild> <Button variant="outline">Close</Button> </SheetClose> </SheetFooter> </SheetContent> </Sheet>
{/* Use side="right", "bottom", or "left" for the other edges. */} </> );}<script setup lang="ts">import { ButtonVariants } from "@/components/starwind/button";import { Button } from "@/components/starwind/button";import { Input } from "@/components/starwind/input";import { Label } from "@/components/starwind/label";import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger,} from "@/components/starwind/sheet";</script>
<template> <!-- Top Sheet --> <Sheet> <SheetTrigger asChild> <button type="button" :class="ButtonVariants.button({ variant: 'outline' })"> Open Top Sheet </button> </SheetTrigger> <SheetContent side="top"> <SheetHeader> <SheetTitle>Top Sheet</SheetTitle> <SheetDescription>This sheet opens from the top of the screen.</SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-3"> <Label for="top-sheet-name">Name</Label> <Input id="top-sheet-name" default-value="Pedro Duarte" /> </div> <div class="grid gap-3"> <Label for="top-sheet-username">Username</Label> <Input id="top-sheet-username" default-value="@peduarte" /> </div> </div> <SheetFooter> <Button variant="default">Save changes</Button> <SheetClose asChild> <button type="button" :class="ButtonVariants.button({ variant: 'outline' })"> Close </button> </SheetClose> </SheetFooter> </SheetContent> </Sheet>
<!-- Use side="right", "bottom", or "left" for the other edges. --></template><script lang="ts"> import { ButtonVariants } from "@/components/starwind/button"; import { Button } from "@/components/starwind/button"; import { Input } from "@/components/starwind/input"; import { Label } from "@/components/starwind/label"; import { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger, } from "@/components/starwind/sheet";</script>
<!-- Top Sheet --><Sheet> <SheetTrigger> {#snippet child({ props })} <button {...props} type="button" class={ButtonVariants.button({ variant: "outline" })} > Open Top Sheet </button> {/snippet} </SheetTrigger> <SheetContent side="top"> <SheetHeader> <SheetTitle>Top Sheet</SheetTitle> <SheetDescription>This sheet opens from the top of the screen.</SheetDescription> </SheetHeader> <div class="grid gap-4 px-4"> <div class="grid gap-3"> <Label for="top-sheet-name">Name</Label> <Input id="top-sheet-name" defaultValue="Pedro Duarte" /> </div> <div class="grid gap-3"> <Label for="top-sheet-username">Username</Label> <Input id="top-sheet-username" defaultValue="@peduarte" /> </div> </div> <SheetFooter> <Button variant="default">Save changes</Button> <SheetClose> {#snippet child({ props })} <button {...props} type="button" class={ButtonVariants.button({ variant: "outline" })} > Close </button> {/snippet} </SheetClose> </SheetFooter> </SheetContent></Sheet><!-- Use side="right", "bottom", or "left" for the other edges. -->API Reference
Styled Component API
These props are added or materially changed by the installed styled component. Standard HTML attributes remain available through the inherited interfaces noted below. Expand a prop to see named type definitions and framework-specific imports. Follow the Primitive and Runtime links for lower-level behavior props.
Sheet Trigger
Inherits button attributes.
Contains the following additional props:
asChild boolean false
- Description
- Merges the component behavior and props into its child element.
- Classification
- Primitive override
- Primitive prop
- drawer.Trigger.asChild
Sheet Close
Inherits button attributes.
Contains the following additional props:
asChild boolean false
- Description
- Merges the component behavior and props into its child element.
- Classification
- Primitive override
- Primitive prop
- drawer.Close.asChild
Primitive And Runtime API
Use these references when you need the lower-level behavior APIs behind Sheet.
Primitive API
Runtime API
- Drawer primitive
createDrawerfrom@starwind-ui/runtime/drawer
Changelog
View version history v2.1.0 4 releases
v2.1.0
- In Astro,
SheetTriggerandSheetClosewithasChildnow make your own element a working control. Before, a button child gave a control that did nothing. - In Astro, an attribute that you set on
SheetHeaderandSheetFooternow wins over the component’s own default for the same attribute, such asroleoraria-label. - In Svelte, a defined
openthat you pass when Sheet mounts now stays under your control, as in React and Vue. To change it, usebind:or update your state in the change callback. A form reset keeps it. If you passundefinedat mount, Sheet keeps its own state.
v2.0.3
- Vue Drawer keeps its current open state when a change is canceled and responds to later open or close requests from your app.
- Trigger and close buttons added after the drawer mounts now work without reopening it.
- Reduced background work when a React page uses multiple menus, tooltips, or other portals.
- Fixed React 18 retaining removed popup elements when the parent component stays mounted.
v2.0.2
- The default export in
index.tsnow has a name,SheetParts, so framework tools show a clear name.
v2.0.0
- Sheet now gets its behavior from the Drawer in Starwind Runtime. Its styled props stay the same.
- See the Drawer Primitive for the unstyled parts and the behavior API.