Overlays

Slideover

A panel that slides in over the page from a viewport edge, for larger contextual content.

html
<UiSlideover />

Title

header slot — replaces title/description

Description

description is the secondary line under the title, framing what the panel is for before the reader scans its contents.

Side

side sets which edge the panel slides in from.

Inset

inset adds a margin around the panel and rounds all of its corners, instead of sitting flush against the screen edge.

:inset="false" (flush) removes the margin and rounded corners so the panel sits flush against the screen edge — purely visual, doesn't affect dismiss behavior.

Overlay

overlay renders a dimmed backdrop behind the panel.

Non-dismissible needs its own close control

Like Modal, :dismissible="false" disables both Escape and backdrop-click close on Slideover too — you must provide your own way to close it (e.g. a footer button) or it's stuck open.

Dismissible

dismissible is whether Escape and a click on the backdrop close the panel. It's on by default; turn it off for a slideover holding unsaved work, and pair it with closeButton when you want no way out except your own control.

Like Modal, pairs with :dismissible="false" if you need to force an explicit close action.

Close button

closeButton shows the cross in the header. Drop it only when something else in the panel closes it — with dismissible off as well, there'd be no way out at all.

Open

default-open — starts open when uncontrolled

Renders open on mount — used sparingly here to avoid stacking slideovers.

Default open

defaultOpen starts the panel open when uncontrolled. Shown as source only here — a slideover that opened itself would cover this page.

Renders open on mount.

`side="right"` (default)

`side="top"`

`side="bottom"`


API Reference

Generated from the component's source — props, slots and emits as the component actually declares them.

Props

Prop
Type
Default
Description
string
The title displayed in the panel header.
string
The description displayed below the title in the panel header.
"left" | "right" | "top" | "bottom"
'right'
Which edge the panel slides in from.
boolean
true
Adds a margin around the panel and rounds all of its corners, instead of sitting flush against the screen edge.
boolean
true
Renders a dimmed backdrop behind the panel.
boolean
true
Whether clicking the backdrop or pressing Escape closes the panel.
boolean
true
Shows the close button in the header.
boolean
Controls the open state for external `v-model:open` usage.
boolean
false
Initial open state when uncontrolled.

Slots

Slot
header
default
footer

Emits

Event
Payload
Description
update:open
[value: boolean]