# bootstrap-off-canvas-nav
**Repository Path**: doswhy/bootstrap-off-canvas-nav
## Basic Information
- **Project Name**: bootstrap-off-canvas-nav
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-01-29
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Bootstrap Off-Canvas Nav
Super simple, super easy off-canvas nav for Bootstrap, requiring no additional markup to default Bootstrap navbar semantics.
## Features
* compatible with fixed and static navbars
* compatible with dropdowns
* slide animation
* animated ```navbar-toggle``` button
* closes when escape key is pressed
## Installation
Add ```bootstrap-off-canvas-nav.css``` from the [src](https://github.com/marcandrews/bootstrap-off-canvas-nav/tree/master/src) folder to your HTML document after your ```bootstrap.css```:
```html
```
Add ```bootstrap-off-canvas-nav.js``` from the [src](https://github.com/marcandrews/bootstrap-off-canvas-nav/tree/master/src) folder to your HTML document after your ```jquery.js``` and ```bootstrap.js```:
```html
```
*That's it!*
## Options
For a left-side off-canvas nav, add ```off-canvas-nav-left``` class to your `````` tag:
```html
```
## Examples
* [static top nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-static-top.htm)
* [static top left-side nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-static-top-left.htm)
* [fixed top nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-fixed-top.htm)
* [fixed top left-side nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-fixed-top-left.htm)
See the [test](https://github.com/marcandrews/bootstrap-off-canvas-nav/tree/master/test) folder for more information.
Super simple, super easy off-canvas nav for Bootstrap, requiring no additional markup to default Bootstrap navbar semantics.
## Features
* compatible with fixed and static navbars
* compatible with dropdowns
* slide animation
* animated ```navbar-toggle``` button
* closes when escape key is pressed
## Installation
Add ```bootstrap-off-canvas-nav.css``` from the [src](https://github.com/marcandrews/bootstrap-off-canvas-nav/tree/master/src) folder to your HTML document after your ```bootstrap.css```:
```html
```
Add ```bootstrap-off-canvas-nav.js``` from the [src](https://github.com/marcandrews/bootstrap-off-canvas-nav/tree/master/src) folder to your HTML document after your ```jquery.js``` and ```bootstrap.js```:
```html
```
*That's it!*
## Options
For a left-side off-canvas nav, add ```off-canvas-nav-left``` class to your `````` tag:
```html
```
## Examples
* [static top nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-static-top.htm)
* [static top left-side nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-static-top-left.htm)
* [fixed top nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-fixed-top.htm)
* [fixed top left-side nav](http://htmlpreview.github.io/?https://github.com/marcandrews/bootstrap-off-canvas-nav/blob/master/test/navbar-fixed-top-left.htm)
See the [test](https://github.com/marcandrews/bootstrap-off-canvas-nav/tree/master/test) folder for more information.