Vue Offcanvas Component API
Offcanvas API
Explore the API reference for the Vue Offcanvas component and discover how to effectively utilize its props for customization.
On this page COffcanvas
import { COffcanvas } from '@coreui/vue-pro'
Props
| Property | Default | Type |
|---|
| backdrop | true | boolean, string |
Apply a backdrop on body while offcanvas is open. |
| dark | - | boolean |
Sets a darker color scheme. |
| keyboard | true | boolean |
Closes the offcanvas when escape key is pressed. |
| placement | - | string |
Components placement, there’s no default placement. |
| responsive4.7.0+ | true | boolean, string |
Responsive offcanvas property hide content outside the viewport from a specified breakpoint and down. |
| scroll | false | boolean |
Allow body scrolling while offcanvas is open |
| visible | false | boolean |
Toggle the visibility of offcanvas component. |
Events
| Event name |
|---|
| hide |
Callback fired when the component requests to be hidden. |
| show |
Callback fired when the component requests to be shown. |
COffcanvasTitle
import { COffcanvasTitle } from '@coreui/vue-pro'
| Property | Default | Type |
|---|
| as | 'h5' | string |
Component used for the root node. Either a string to use a HTML element or a component. |