Filters
Present several filters in an edge-attached modal panel.
Components / Overlays
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.
bunx --bun @getweini/cli@latest add sheet alert progress buttonImport 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.
<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.
Present several filters in an edge-attached modal panel.
Show a focused detail workflow while retaining the underlying page context.
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.
<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>Choose the attachment edge explicitly.
<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>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.
| Name | Type or signature | Default | What it does |
|---|---|---|---|
openmodel | boolean | undefined | Not set | Current open state. Use v-model:open to keep it in sync with your page. |
defaultOpenprop | boolean | undefined | false | Starting open state when the parent does not control open. |
disabledprop | boolean | undefined | false | Prevent 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 | () => unknown | Required | Content shown inside Sheet. |
openexposed | () => void | undefined | — | Open this component from application code. |
closeexposed | () => void | undefined | — | Close this component from application code. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | {} | Optional | Content shown inside SheetBody. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
asChildprop | boolean | undefined | Not set | Use one child element as the control instead of adding another wrapper. |
defaultslot | {} | Optional | Content shown inside SheetClose. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
sideprop | SheetSide | undefined | "right" | Choose the side on which this content appears. |
dismissOnBackdropprop | boolean | undefined | true | Allow a click outside the dialog content to close it. |
defaultslot | (props: { close: () => void; }) => unknown | Required | Content shown inside SheetContent. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | {} | Optional | Content shown inside SheetDescription. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | {} | Optional | Content shown inside SheetFooter. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | () => unknown | Required | Content shown inside SheetHeader. |
actionsslot | (() => unknown) | undefined | Optional | Content for the actions area of SheetHeader. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | {} | Optional | Content shown inside SheetTitle. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
disabledprop | boolean | undefined | false | Prevent interaction and show the disabled state. |
asChildprop | boolean | undefined | Not set | Use one child element as the control instead of adding another wrapper. |
defaultslot | {} | Optional | Content shown inside SheetTrigger. |
// 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
}