Offcanvas
Bootstrap Offcanvas - free examples, templates & tutorial
Responsive Offcanvas sidebar built with Bootstrap 5. Examples include offcanvas width customization, double offcanvas example, left and right hidden menu & more
If you need a more advanced Offcanvas and more options, see our main SideNav documentation. This component is sometimes also referred to as Side Navbar, Sidebar or Drawer navigation.
How it works
Offcanvas is a sidebar component that can be toggled via JavaScript to appear from the left,
right, or bottom edge of the viewport. Buttons or anchors are used as triggers that are
attached to specific elements you toggle, and
data
attributes are used to invoke our JavaScript.
- Offcanvas shares some of the same JavaScript code as modals. Conceptually, they are quite similar, but they are separate plugins.
- Similarly, some source Sass variables for offcanvas’s styles and dimensions are inherited from the modal’s variables.
- When shown, offcanvas includes a default backdrop that can be clicked to hide the offcanvas.
- Similar to modals, only one offcanvas can be shown at a time.
Heads up! Given how CSS handles animations, you cannot use
margin
or translate
on an .offcanvas
element. Instead,
use the class as an independent wrapping element.
Examples
Offcanvas components
Below is an offcanvas example that is shown by default (via
.show
on .offcanvas
). Offcanvas includes support for a header with
a close button and an optional body class for some initial padding
. We suggest
that you include offcanvas headers with dismiss actions whenever possible, or provide an
explicit dismiss action.
Offcanvas
<div class="offcanvas offcanvas-start show" tabindex="-1" id="offcanvas" aria-labelledby="offcanvasLabel"
data-mdb-backdrop="false" data-mdb-scroll="true">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="offcanvasLabel">Offcanvas</h5>
<button type="button" data-mdb-button-init data-mdb-ripple-init class="btn-close text-reset" data-mdb-dismiss="offcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
Content for the offcanvas goes here. You can place just about any Bootstrap component or custom elements here.
</div>
</div>
Live demo
Use the buttons below to show and hide an offcanvas element via JavaScript that toggles the
.show
class on an element with the .offcanvas
class.
.offcanvas
hides content (default).offcanvas.show
shows content
You can use a link with the href
attribute, or a button with the
data-mdb-target
attribute. In both cases, the
data-mdb-toggle="offcanvas"
is required.
Offcanvas
<a data-mdb-ripple-init class="btn btn-primary" data-mdb-toggle="offcanvas" href="#offcanvasExample" role="button"
aria-controls="offcanvasExample">
Link with href
</a>
<button data-mdb-button-init data-mdb-ripple-init class="btn btn-primary" type="button" data-mdb-toggle="offcanvas" data-mdb-target="#offcanvasExample"
aria-controls="offcanvasExample">
Button with data-mdb-target
</button>
<div class="offcanvas offcanvas-start" tabindex="-1" id="offcanvasExample" aria-labelledby="offcanvasExampleLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="offcanvasExampleLabel">Offcanvas</h5>
<button type="button" data-mdb-button-init data-mdb-ripple-init class="btn-close text-reset" data-mdb-dismiss="offcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<div>
Some text as placeholder. In real life you can have the elements you have chosen. Like, text, images,
lists, etc.
</div>
<div class="dropdown mt-3">
<button data-mdb-button-init data-mdb-ripple-init data-mdb-dropdown-init class="btn btn-secondary dropdown-toggle" type="button" id="dropdownMenuButton"
data-mdb-toggle="dropdown">
Dropdown button
</button>
<ul class="dropdown-menu" aria-labelledby="dropdownMenuButton">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
</div>
</div>
</div>
Placement
There’s no default placement for offcanvas components, so you must add one of the modifier classes below:
.offcanvas-start
places offcanvas on the left of the viewport (shown above).offcanvas-end
places offcanvas on the right of the viewport.offcanvas-top
places offcanvas on the top of the viewport.offcanvas-bottom
places offcanvas on the bottom of the viewport
Try the top, right, and bottom examples out below.
Offcanvas top
<button data-mdb-button-init data-mdb-ripple-init class="btn btn-primary" type="button" data-mdb-toggle="offcanvas" data-mdb-target="#offcanvasTop"
aria-controls="offcanvasTop">Toggle top offcanvas</button>
<div class="offcanvas offcanvas-top" tabindex="-1" id="offcanvasTop" aria-labelledby="offcanvasTopLabel">
<div class="offcanvas-header">
<h5 id="offcanvasTopLabel">Offcanvas top</h5>
<button type="button" data-mdb-button-init data-mdb-ripple-init class="btn-close text-reset" data-mdb-dismiss="offcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
...
</div>
</div>
Offcanvas right
<button data-mdb-button-init
data-mdb-ripple-init class="btn btn-primary"
type="button"
data-mdb-toggle="offcanvas"
data-mdb-target="#offcanvasRight"
aria-controls="offcanvasRight"
>
Toggle right offcanvas
</button>
<div
class="offcanvas offcanvas-end"
tabindex="-1"
id="offcanvasRight"
aria-labelledby="offcanvasRightLabel"
>
<div class="offcanvas-header">
<h5 id="offcanvasRightLabel">Offcanvas right</h5>
<button data-mdb-button-init
type="button"
data-mdb-ripple-init class="btn-close text-reset"
data-mdb-dismiss="offcanvas"
aria-label="Close"
></button>
</div>
<div class="offcanvas-body">...</div>
</div>
Offcanvas bottom
<button data-mdb-button-init
data-mdb-ripple-init class="btn btn-primary"
type="button"
data-mdb-toggle="offcanvas"
data-mdb-target="#offcanvasBottom"
aria-controls="offcanvasBottom"
>
Toggle bottom offcanvas
</button>
<div
class="offcanvas offcanvas-bottom"
tabindex="-1"
id="offcanvasBottom"
aria-labelledby="offcanvasBottomLabel"
>
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="offcanvasBottomLabel">
Offcanvas bottom
</h5>
<button data-mdb-button-init
type="button"
data-mdb-ripple-init class="btn-close text-reset"
data-mdb-dismiss="offcanvas"
aria-label="Close"
></button>
</div>
<div class="offcanvas-body small">...</div>
</div>
Backdrop
Scrolling the <body>
element is disabled when an offcanvas and its backdrop
are visible. Use the data-mdb-scroll
attribute to toggle
<body>
scrolling and data-mdb-backdrop
to toggle the backdrop.
Colored with scrolling
Try scrolling the rest of the page to see this option in action.
Offcanvas with backdrop
.....
Backdrop with scrolling
Try scrolling the rest of the page to see this option in action.
<button data-mdb-button-init
data-mdb-ripple-init class="btn btn-primary"
type="button"
data-mdb-toggle="offcanvas"
data-mdb-target="#offcanvasScrolling"
aria-controls="offcanvasScrolling"
>
Enable body scrolling
</button>
<button data-mdb-button-init
data-mdb-ripple-init class="btn btn-primary"
type="button"
data-mdb-toggle="offcanvas"
data-mdb-target="#offcanvasWithBackdrop"
aria-controls="offcanvasWithBackdrop"
>
Enable backdrop (default)
</button>
<button data-mdb-button-init
data-mdb-ripple-init class="btn btn-primary"
type="button"
data-mdb-toggle="offcanvas"
data-mdb-target="#offcanvasWithBothOptions"
aria-controls="offcanvasWithBothOptions"
>
Enable both scrolling & backdrop
</button>
<div
class="offcanvas offcanvas-start"
data-mdb-scroll="true"
data-mdb-backdrop="false"
tabindex="-1"
id="offcanvasScrolling"
aria-labelledby="offcanvasScrollingLabel"
>
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="offcanvasScrollingLabel">
Colored with scrolling
</h5>
<button data-mdb-button-init
type="button"
data-mdb-ripple-init class="btn-close text-reset"
data-mdb-dismiss="offcanvas"
aria-label="Close"
></button>
</div>
<div class="offcanvas-body">
<p>
Try scrolling the rest of the page to see this option in action.
</p>
</div>
</div>
<div
class="offcanvas offcanvas-start"
tabindex="-1"
id="offcanvasWithBackdrop"
aria-labelledby="offcanvasWithBackdropLabel"
>
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="offcanvasWithBackdropLabel">
Offcanvas with backdrop
</h5>
<button data-mdb-button-init
type="button"
data-mdb-ripple-init class="btn-close text-reset"
data-mdb-dismiss="offcanvas"
aria-label="Close"
></button>
</div>
<div class="offcanvas-body">
<p>.....</p>
</div>
</div>
<div
class="offcanvas offcanvas-start"
data-mdb-scroll="true"
tabindex="-1"
id="offcanvasWithBothOptions"
aria-labelledby="offcanvasWithBothOptionsLabel"
>
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="offcanvasWithBothOptionsLabel">
Backdrop with scrolling
</h5>
<button data-mdb-button-init
type="button"
data-mdb-ripple-init class="btn-close text-reset"
data-mdb-dismiss="offcanvas"
aria-label="Close"
></button>
</div>
<div class="offcanvas-body">
<p>
Try scrolling the rest of the page to see this option in action.
</p>
</div>
</div>
Accessibility
Since the offcanvas panel is conceptually a modal dialog, be sure to add
aria-labelledby="..."
—referencing the offcanvas title—to .offcanvas
.
Note that you don’t need to add role="dialog"
since we already add it via
JavaScript.
Sass
Variables
$offcanvas-padding-y: $modal-inner-padding;
$offcanvas-padding-x: $modal-inner-padding;
$offcanvas-horizontal-width: 400px;
$offcanvas-vertical-height: 30vh;
$offcanvas-transition-duration: .3s;
$offcanvas-border-color: $modal-content-border-color;
$offcanvas-border-width: $modal-content-border-width;
$offcanvas-title-line-height: $modal-title-line-height;
$offcanvas-bg-color: $modal-content-bg;
$offcanvas-color: $modal-content-color;
$offcanvas-body-backdrop-color: rgba($modal-backdrop-bg, $modal-backdrop-opacity);
$offcanvas-box-shadow: $modal-content-box-shadow-xs;
Usage
The offcanvas plugin utilizes a few classes and attributes to handle the heavy lifting:
.offcanvas
hides the content.offcanvas.show
shows the content.offcanvas-start
hides the offcanvas on the left.offcanvas-end
hides the offcanvas on the right.offcanvas-bottom
hides the offcanvas on the bottom
Add a dismiss button with the
data-mdb-dismiss="offcanvas"
attribute, which triggers the JavaScript
functionality. Be sure to use the <button>
element with it for proper
behavior across all devices.
Via data attributes
Add data-mdb-toggle="offcanvas"
and a data-mdb-target
or
href
to the element to automatically assign control of one offcanvas element.
The data-mdb-target
attribute accepts a CSS selector to apply the offcanvas to.
Be sure to add the class offcanvas
to the offcanvas element. If you’d like it
to default open, add the additional class show
.
Dismiss
Dismissal can be achieved with data attributes on a button within the offcanvas as demonstrated below:
<button type="button" data-mdb-button-init data-mdb-ripple-init class="btn-close" data-mdb-dismiss="offcanvas" aria-label="Close"></button>
or on a button outside the offcanvas using the data-mdb-target
as demonstrated below:
<button type="button" data-mdb-button-init data-mdb-ripple-init class="btn-close" data-mdb-dismiss="offcanvas" data-mdb-target="#my-offcanvas" aria-label="Close"></button>
While both ways to dismiss an offcanvas are supported, keep in mind that dismissing from outside a modal does not match the WAI-ARIA modal dialog design pattern. Do this at your own risk.
Via JavaScript
Enable manually with:
var offcanvasElementList = [].slice.call(document.querySelectorAll('.offcanvas'))
var offcanvasList = offcanvasElementList.map(function (offcanvasEl) {
return new mdb.Offcanvas(offcanvasEl)
})
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the
option name to
data-mdb-
, as in data-mdb-backdrop=""
.
Name | Type | Default | Description |
---|---|---|---|
backdrop |
boolean or the string 'static' |
true |
Apply a backdrop on body while offcanvas is open |
keyboard |
boolean | true |
Closes the offcanvas when escape key is pressed |
scroll |
boolean | false |
Allow body scrolling while offcanvas is open |
Methods
Asynchronous methods and transitions: All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Activates your content as an offcanvas element. Accepts an optional options
object
.
You can create an offcanvas instance with the constructor, for example:
var myOffcanvas = document.getElementById('myOffcanvas')
var bsOffcanvas = new mdb.Offcanvas(myOffcanvas)
Method | Description |
---|---|
toggle |
Toggles an offcanvas element to shown or hidden.
Returns to the caller before the offcanvas element has actually been shown or
hidden
(i.e. before the shown.bs.offcanvas or
hidden.bs.offcanvas event occurs).
|
show |
Shows an offcanvas element.
Returns to the caller before the offcanvas element has actually been shown
(i.e. before the shown.bs.offcanvas event occurs).
|
hide |
Hides an offcanvas element.
Returns to the caller before the offcanvas element has actually been hidden
(i.e. before the
hidden.bs.offcanvas event occurs).
|
getInstance |
Static method which allows you to get the offcanvas instance associated with a DOM element |
Events
Bootstrap’s offcanvas class exposes a few events for hooking into offcanvas functionality.
Event type | Description |
---|---|
show.bs.offcanvas |
This event fires immediately when the
show instance method is called.
|
shown.bs.offcanvas |
This event is fired when an offcanvas element has been made visible to the user (will wait for CSS transitions to complete). |
hide.bs.offcanvas |
This event is fired immediately when the
hide method has been called.
|
hidden.bs.offcanvas |
This event is fired when an offcanvas element has been hidden from the user (will wait for CSS transitions to complete). |
var myOffcanvas = document.getElementById('myOffcanvas')
myOffcanvas.addEventListener('hidden.bs.offcanvas', function () {
// do something...
})