--- layout: docs title: Offcanvas description: Build hidden sidebars into your project for navigation, shopping carts, and more with a few classes and our JavaScript plugin. group: components toc: true --- ## How it works Offcanvas is a sidebar component that can be toggled via JavaScript to appear from the left, right, top, 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](#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. {{< callout info >}} {{< partial "callout-info-prefersreducedmotion.md" >}} {{< /callout >}} ## 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. {{< example class="bd-example-offcanvas p-0 bg-light overflow-hidden" >}}

Content for the offcanvas goes here. You can place just about any Bootstrap component or custom elements here.

{{< /example >}} ### 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-bs-target` attribute. In both cases, the `data-bs-toggle="offcanvas"` is required. {{< example >}} Link with href

Some text as placeholder. In real life you can have the elements you have chosen. Like, text, images, lists, etc.

{{< /example >}} ### Body scrolling Scrolling the `` element is disabled when an offcanvas and its backdrop are visible. Use the `data-bs-scroll` attribute to enable `` scrolling. {{< example >}}

Try scrolling the rest of the page to see this option in action.

{{< /example >}} ### Body scrolling and backdrop You can also enable `` scrolling with a visible backdrop. {{< example >}}

Try scrolling the rest of the page to see this option in action.

{{< /example >}} ### Static backdrop When backdrop is set to static, the offcanvas will not close when clicking outside of it. {{< example >}}

I will not close if you click outside of me.

{{< /example >}} ## Dark offcanvas {{< added-in "5.2.0" >}} Change the appearance of offcanvases with utilities to better match them to different contexts like dark navbars. Here we add `.text-bg-dark` to the `.offcanvas` and `.btn-close-white` to `.btn-close` for proper styling with a dark offcanvas. If you have dropdowns within, consider also adding `.dropdown-menu-dark` to `.dropdown-menu`. {{< example class="bd-example-offcanvas p-0 bg-light overflow-hidden" >}}

Place offcanvas content here.

{{< /example >}} ## Responsive {{< added-in "5.2.0" >}} Responsive offcanvas classes hide content outside the viewport from a specified breakpoint and down. Above that breakpoint, the contents within will behave as usual. For example, `.offcanvas-lg` hides content in an offcanvas below the `lg` breakpoint, but shows the content above the `lg` breakpoint. {{< example >}}

Resize your browser to show the responsive offcanvas toggle.

This is content within an .offcanvas-lg.

{{< /example >}} Responsive offcanvas classes are available across for each breakpoint. - `.offcanvas` - `.offcanvas-sm` - `.offcanvas-md` - `.offcanvas-lg` - `.offcanvas-xl` - `.offcanvas-xxl` ## 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. {{< example >}}

...

{{< /example >}} ## 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. ## CSS ### Variables {{< added-in "5.2.0" >}} As part of Bootstrap's evolving CSS variables approach, offcanvas now uses local CSS variables on `.offcanvas` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too. {{< scss-docs name="offcanvas-css-vars" file="scss/_offcanvas.scss" >}} ### Sass variables {{< scss-docs name="offcanvas-variables" file="scss/_variables.scss" >}} ## 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-top` hides the offcanvas on the top - `.offcanvas-bottom` hides the offcanvas on the bottom Add a dismiss button with the `data-bs-dismiss="offcanvas"` attribute, which triggers the JavaScript functionality. Be sure to use the `

Offcanvas

Offcanvas

Offcanvas with body scrolling

Backdrop with scrolling

Offcanvas

Offcanvas

Responsive offcanvas

Offcanvas top

Offcanvas right

Offcanvas bottom