Skip to content

Offcanvas ​

te-offcanvas slides a panel in from the side. Like te-modal, it is a native <dialog> opened with showModal(), so it comes with Esc, a focus trap, focus restored on close, and an inert page behind it. Clicking the backdrop closes it too.

Usage ​

Not shown inline — it is fixed to the viewport edge.

Filters
Panel content.
vue
<te-button @click="open = true">Open panel</te-button>

<te-offcanvas v-model="open" title="Filters">
  Panel content.
</te-offcanvas>

Props ​

PropTypeDefaultDescription
modelValuebooleanfalseSupports v-model.
titlestring''Header text, and the accessible name.
position'left' | 'right''left'Edge it slides from.

Events ​

EventPayloadDescription
update:modelValuebooleanVisibility changed.
close—The panel closed, by any route: the button, the backdrop, Esc, or the model.

Slots ​

SlotPropsDescription
default—Panel body.