Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mdbootstrap/bootstrap-offcanvas

Hidden sidebar built with the latest Bootstrap 5, perfect for use in the form of additional navigation, for example in ecommerce projects or dashboards.
https://github.com/mdbootstrap/bootstrap-offcanvas

bootstrap bootstrap-dashboard bootstrap-offcanvas bootstrap-offcanvas-menu bootstrap-template bootstrap5 ecommerce navigation offcanvas responsive responsive-design

Last synced: 20 days ago
JSON representation

Hidden sidebar built with the latest Bootstrap 5, perfect for use in the form of additional navigation, for example in ecommerce projects or dashboards.

Awesome Lists containing this project

README 

        

Hidden sidebar, perfect for use in the form of additional navigation, for example in ecommerce projects or dashboards.



Check out [Bootstrap Offcanvas Documentation](https://mdbootstrap.com/docs/standard/extended/offcanvas/) for detailed instructions & even more examples.



## 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](https://mdbootstrap.com/docs/standard/extended/offcanvas/#section-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.



## Basic example



![Bootstrap 5 Offcanvas](https://mdbootstrap.com/img/Marketing/github/offcanvas/basic.png)



```html



  


    
Offcanvas


    

  


  


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

  




```



## How to use?



1. Download MDB 5 - free UI KIT



2. Choose your favourite customized component and click on the image



3. Copy & paste the code into your MDB project



[▶️ Subscribe to YouTube channel for web development tutorials & resources](https://www.youtube.com/MDBootstrap?sub_confirmation=1)



## More examples



[Bootstrap Offcanvas Placement:

![Bootstrap 5 Offcanvass](https://mdbootstrap.com/img/Marketing/github/offcanvas/section-2.png)](https://mdbootstrap.com/docs/standard/extended/offcanvas/#section-placement)



[Bootstrap Offcanvas Backdrop:

![Bootstrap 5 Offcanvas](https://mdbootstrap.com/img/Marketing/github/offcanvas/section-3.png)](https://mdbootstrap.com/docs/standard/extended/offcanvas/#section-backdrop)



[Bootstrap Offcanvas Sass:

![Bootstrap 5 Offcanvas](https://mdbootstrap.com/img/Marketing/github/offcanvas/section-4.png)](https://mdbootstrap.com/docs/standard/extended/offcanvas/#section-sass)



___



## More extended Bootstrap documentation