Skip to content

Sheet ​

Side panel

A panel from the edge of the screen that keeps the page's context — a cart, filters, a detail pane, navigation on phones. From the bottom on phones, see Drawer.

Basic

Filters

Native <dialog> side panel. Esc / backdrop / × close it.

  • A native <dialog> like Modal: inert page, Tab trapped, Esc closes, focus returns. title or #title names it.
  • dismissible (default) lets Esc, the backdrop and (with handle) a swipe down close it; off, only your own control does.
  • side picks the edge; size its width or height.

Usage ​

ts
import { BlessSheet } from "blessing-ui";

API ​

Props

NameTypeDefaultDescription
side"top" | "bottom" | "left" | "right""right"
titlestring—
sizestring—
dismissiblebooleantrue
closeLabelstring"Close"
handleboolean—bottom drawer: show drag handle and allow swipe-down to close
modelValuebooleanfalse

Events

NamePayloadDescription
update:modelValue[value: boolean]
close[]

Slots

NameScopeDescription
title—
default—
footer—

Released under the MIT License. Character names and artwork belong to their owners.