bootstrap-drawer
Advanced tools
A Bootstrap add-on to create drawer (off-canvas) styled navigation.
This readme was written assuming the documentation was done. Currently, the documentation is a work-in-progress, but feel free to checkout the example folder and use the quickstart to start using this!
Also, had to change the name from "offcanvas" to drawer, because bootstrap-offcanvas was already taken.
As of Bootstrap 3.2.2, there is no "drawer" element - a drawer-like menu that
goes off screen. This is an add-on to the core Bootstrap framewrk that adds various
.drawer classes to quickly and easily create the drawer component.
This Readme is actually a quick start. Check out the full documentation for detailed usage and style guide.
Version: 0.9.0
bower install bootstrap-drawer / npm install bootstrap-drawer
or you can (download the latest release)[https://github.com/clineamb/bootstrap-drawer/releases] from the release page.
For more detailed use on the bootstrap-drawer framework, check out the style guide documentation.
<html>
<head>
<link rel="stylesheet" type="text/css" href="bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="drawer.min.css">
<link rel="stylesheet" type="text/css" href="YOUR_OTHER_STYLES.css">
</head>
<body class="has-canvas">
<!-- Off Canvas & other HTML here -->
<script src="jquery.min.js"></script>
<script src="bootstrap.min.js"></script>
<script src="drawer.min.js"></script>
<script src="YOUR_CUSTOM_JS.js"></script>
</body>
</html>
I am assuming for this section you are familiar with using less and the Bootstrap less source.
There are files in the less/ directory that are parallel to Bootstrap's less source files.
drawer.less already includes its custom variable package as well as less loop framework.
To include the less in your build files, you can do one of the following:
@import "bootstrap.less";
@import "path/to/drawer.less";
/* Your styles */
@import "variables.less";
@import "mixins.less";
// Bootstrap Core
// ...
// ... etc ...
// Components w/ JavaScript
@import "modals.less";
@import "tooltip.less";
@import "popovers.less";
@import "carousel.less";
@import "path/to/drawer.less";
// Utility Classes
// ... etc ...
The first two lines in less/drawer.less can be removed and moved
Feel free to move drawer-variables.less and drawer-framework.less to appropriate
folders to maintain bootstrap structure. The component's variables rely on a few variables from the core bootstrap framework, likewise for the mixin framework. Be sure to simply include them after the bootstrap core variables/mixins files:
@import "./drawer-variables"; can be put after importing variables.less@import "./mixins/drawer-framework"; can be put after importing mixins.less @import "variables.less";
@import "path/to/drawer-variables.less"
@import "mixins.less";
@import "path/to/drawer-framework.less";
// Bootstrap Core
// ...
// ... etc ...
// Components w/ JavaScript
@import "modals.less";
@import "tooltip.less";
@import "popovers.less";
@import "carousel.less";
@import "path/to/drawer.less";
// Utility Classes
// ... etc ...
The Javascript/jQuery plugin requires the transition.js file from the core Bootstrap
framework in order to work. Usage is nearly the same as the collapse component, but checkout out the documentation for more detailed usage for $('.drawer').drawer(). The events emitted are *.bs.drawer.
Copyright (c) 2014, Caroline Amaba
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
FAQs
A Bootstrap add-on to create drawer (off-canvas) styled navigation
The npm package bootstrap-drawer receives a total of 672 weekly downloads. As such, bootstrap-drawer popularity was classified as not popular.
We found that bootstrap-drawer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.