Skip to content

Search documentation

Search guides, examples, and component APIs.

Quick links
↑↓ NavigateEnter OpenEsc Close
Get started

Documentation navigation

Components / Overlays

Sheet

A top-layer edge panel with a stationary header and footer and scrollable body.

Last changed in version 0.13.0: Add avatar groups and chips, expand the block gallery, and improve component colors, spacing, and motion.

Interactive showcase

Filter projects

Narrow 48 projects using the options below.

Status

Install

Run in your project
bunx --bun @getweini/cli@latest add sheet alert progress button

Start with this example

Import the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.

Filters

Narrow the results.

Vue
<script setup lang="ts">
import Sheet from './components/ui/sheet/Sheet.vue'
import SheetBody from './components/ui/sheet/SheetBody.vue'
import SheetClose from './components/ui/sheet/SheetClose.vue'
import SheetContent from './components/ui/sheet/SheetContent.vue'
import SheetDescription from './components/ui/sheet/SheetDescription.vue'
import SheetFooter from './components/ui/sheet/SheetFooter.vue'
import SheetHeader from './components/ui/sheet/SheetHeader.vue'
import SheetTitle from './components/ui/sheet/SheetTitle.vue'
import SheetTrigger from './components/ui/sheet/SheetTrigger.vue'
</script>
<template>
  <Sheet>
    <SheetTrigger>Open filters</SheetTrigger>
    <SheetContent side="right">
      <SheetHeader>
        <SheetTitle>Filters</SheetTitle>
        <SheetDescription>Narrow the results.</SheetDescription>
      </SheetHeader>
      <SheetBody>
        <label><input type="checkbox"> Available only</label>
      </SheetBody>
      <SheetFooter><SheetClose>Apply filters</SheetClose></SheetFooter>
    </SheetContent>
  </Sheet>
</template>

Sheet opens from any viewport edge. Its exposed corners are rounded, including both left corners when it opens from the right.

When to use it

Filters

Present several filters in an edge-attached modal panel.

Details pane

Show a focused detail workflow while retaining the underlying page context.

More examples

Transfer with retry and completion

The bottom sheet keeps its progress, failure or success feedback, and primary action reachable in a narrow viewport. This example fails its first simulated attempt so you can try the recovery path, then completes on retry.

Send project archive

Transfer the latest project backup to your team.

project-backup.zip · 128 MB0%

The transfer stays on this screen so you can follow its progress.

Transfer with retry and completion
<script setup lang="ts">
import { computed, onBeforeUnmount, ref } from 'vue'
import Alert from './components/ui/alert/Alert.vue'
import AlertDescription from './components/ui/alert/AlertDescription.vue'
import AlertTitle from './components/ui/alert/AlertTitle.vue'
import Button from './components/ui/button/Button.vue'
import Progress from './components/ui/progress/Progress.vue'
import Sheet from './components/ui/sheet/Sheet.vue'
import SheetBody from './components/ui/sheet/SheetBody.vue'
import SheetClose from './components/ui/sheet/SheetClose.vue'
import SheetContent from './components/ui/sheet/SheetContent.vue'
import SheetDescription from './components/ui/sheet/SheetDescription.vue'
import SheetFooter from './components/ui/sheet/SheetFooter.vue'
import SheetHeader from './components/ui/sheet/SheetHeader.vue'
import SheetTitle from './components/ui/sheet/SheetTitle.vue'
import SheetTrigger from './components/ui/sheet/SheetTrigger.vue'

type TransferState = 'idle' | 'uploading' | 'failed' | 'complete'

const state = ref<TransferState>('idle')
const progress = ref(0)
const attempt = ref(0)
let timer: ReturnType<typeof setInterval> | undefined

const isUploading = computed(() => state.value === 'uploading')

function stopTimer() {
  if (timer) clearInterval(timer)
  timer = undefined
}

function startTransfer() {
  stopTimer()
  attempt.value += 1
  progress.value = 0
  state.value = 'uploading'

  timer = setInterval(() => {
    progress.value = Math.min(progress.value + 20, 100)

    // The first attempt fails consistently so the example can show recovery.
    if (attempt.value === 1 && progress.value === 60) {
      stopTimer()
      state.value = 'failed'
      return
    }

    if (progress.value === 100) {
      stopTimer()
      state.value = 'complete'
    }
  }, 250)
}

onBeforeUnmount(stopTimer)
</script>

<template>
  <Sheet>
    <SheetTrigger>Send archive</SheetTrigger>
    <SheetContent side="bottom">
      <SheetHeader>
        <SheetTitle>Send project archive</SheetTitle>
        <SheetDescription>Transfer the latest project backup to your team.</SheetDescription>
      </SheetHeader>
      <SheetBody>
        <div class="space-y-4">
          <div class="flex items-center justify-between gap-4 text-sm">
            <span>project-backup.zip · 128 MB</span>
            <span>{{ progress }}%</span>
          </div>
          <Progress :value="progress" :max="100" aria-label="Archive transfer progress" />

          <Alert v-if="state === 'failed'" role="alert" variant="destructive">
            <AlertTitle>Transfer interrupted</AlertTitle>
            <AlertDescription>Your archive is still here. Retry to send it again.</AlertDescription>
          </Alert>
          <Alert v-else-if="state === 'complete'" role="status" variant="success">
            <AlertTitle>Archive sent</AlertTitle>
            <AlertDescription>Your team can now download the latest backup.</AlertDescription>
          </Alert>
          <p v-else-if="isUploading" role="status" class="text-sm text-muted-foreground">
            Sending archive…
          </p>
          <p v-else class="text-sm text-muted-foreground">
            The transfer stays on this screen so you can follow its progress.
          </p>
        </div>
      </SheetBody>
      <SheetFooter class="sm:justify-between">
        <SheetClose v-if="state !== 'complete'">Close</SheetClose>
        <Button
          v-if="state !== 'complete'"
          :loading="isUploading"
          :disabled="isUploading"
          @click="startTransfer"
        >
          {{ state === 'failed' ? 'Retry transfer' : 'Send archive' }}
        </Button>
        <SheetClose v-else>Done</SheetClose>
      </SheetFooter>
    </SheetContent>
  </Sheet>
</template>

Bottom details sheet

Choose the attachment edge explicitly.

Bottom details sheet
<script setup lang="ts">
import Sheet from './components/ui/sheet/Sheet.vue'
import SheetBody from './components/ui/sheet/SheetBody.vue'
import SheetClose from './components/ui/sheet/SheetClose.vue'
import SheetContent from './components/ui/sheet/SheetContent.vue'
import SheetFooter from './components/ui/sheet/SheetFooter.vue'
import SheetHeader from './components/ui/sheet/SheetHeader.vue'
import SheetTitle from './components/ui/sheet/SheetTitle.vue'
import SheetTrigger from './components/ui/sheet/SheetTrigger.vue'
</script>
<template>
  <Sheet>
    <SheetTrigger>Order details</SheetTrigger>
    <SheetContent side="bottom">
      <SheetHeader><SheetTitle>Order details</SheetTitle></SheetHeader>
      <SheetBody><p>Review the items before confirming.</p></SheetBody>
      <SheetFooter><SheetClose>Done</SheetClose></SheetFooter>
    </SheetContent>
  </Sheet>
</template>

Complete API

Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.

Sheet

Complete API for Sheet
NameType or signatureDefaultWhat it does
openmodelboolean | undefinedNot setCurrent open state. Use v-model:open to keep it in sync with your page.
defaultOpenpropboolean | undefinedfalseStarting open state when the parent does not control open.
disabledpropboolean | undefinedfalsePrevent interaction and show the disabled state.
update:openevent[open: boolean]—Requests a new open value from the parent.
openChangeevent[open: boolean]—Emitted after this value or state changes.
defaultslot() => unknownRequiredContent shown inside Sheet.
openexposed() => void | undefined—Open this component from application code.
closeexposed() => void | undefined—Close this component from application code.

SheetBody

Complete API for SheetBody
NameType or signatureDefaultWhat it does
defaultslot{}OptionalContent shown inside SheetBody.

SheetClose

Complete API for SheetClose
NameType or signatureDefaultWhat it does
asChildpropboolean | undefinedNot setUse one child element as the control instead of adding another wrapper.
defaultslot{}OptionalContent shown inside SheetClose.

SheetContent

Complete API for SheetContent
NameType or signatureDefaultWhat it does
sidepropSheetSide | undefined"right"Choose the side on which this content appears.
dismissOnBackdroppropboolean | undefinedtrueAllow a click outside the dialog content to close it.
defaultslot(props: { close: () => void; }) => unknownRequiredContent shown inside SheetContent.

SheetDescription

Complete API for SheetDescription
NameType or signatureDefaultWhat it does
defaultslot{}OptionalContent shown inside SheetDescription.

SheetFooter

Complete API for SheetFooter
NameType or signatureDefaultWhat it does
defaultslot{}OptionalContent shown inside SheetFooter.

SheetHeader

Complete API for SheetHeader
NameType or signatureDefaultWhat it does
defaultslot() => unknownRequiredContent shown inside SheetHeader.
actionsslot(() => unknown) | undefinedOptionalContent for the actions area of SheetHeader.

SheetTitle

Complete API for SheetTitle
NameType or signatureDefaultWhat it does
defaultslot{}OptionalContent shown inside SheetTitle.

SheetTrigger

Complete API for SheetTrigger
NameType or signatureDefaultWhat it does
disabledpropboolean | undefinedfalsePrevent interaction and show the disabled state.
asChildpropboolean | undefinedNot setUse one child element as the control instead of adding another wrapper.
defaultslot{}OptionalContent shown inside SheetTrigger.
Public type definitions
Public types
// packages/frameworks/vue/components/sheet/types.ts
import type { DialogProps, DialogTriggerProps } from '../dialog/types'

// ------- TYPES -------

export type SheetSide = 'top' | 'right' | 'bottom' | 'left'

export interface SheetProps extends DialogProps {}

export interface SheetTriggerProps extends DialogTriggerProps {}

export interface SheetContentProps {
  side?: SheetSide
  dismissOnBackdrop?: boolean
}


// packages/frameworks/vue/components/dialog/types.ts
// ------- TYPES -------

export type DialogSize = 'sm' | 'md' | 'lg' | 'xl'

export interface DialogProps {
  open?: boolean
  defaultOpen?: boolean
  disabled?: boolean
}

export interface DialogContentProps {
  fullscreen?: boolean
  size?: DialogSize
  dismissOnBackdrop?: boolean
  persistent?: boolean
}

export interface DialogTriggerProps {
  disabled?: boolean
  asChild?: boolean
}

export interface DialogCloseProps {
  asChild?: boolean
}

Implementation notes

  • Choose the side in application code; Sheet does not infer a breakpoint or device.
  • SheetBody scrolls independently when content is tall.

Accessibility and localization

  • Sheet inherits native dialog focus management and background scroll locking.
  • Provide a SheetTitle or explicit accessible name, and keep action text localized.

Source contract and editing guidance