bootstrap-drawer
Advanced tools
Comparing version 0.9.0 to 0.9.1
{ | ||
"name": "bootstrap-drawer", | ||
"version": "0.9.0", | ||
"version": "0.9.1", | ||
"authors": [ | ||
@@ -5,0 +5,0 @@ "Caroline Amaba <her@carolineamaba.com>" |
@@ -0,0 +0,0 @@ /* ======================================================================== |
@@ -0,0 +0,0 @@ /* ======================================================================== |
@@ -23,3 +23,3 @@ // --- bootstrap.offcanvas gulpfile | ||
gulp.task("less", function() { | ||
gulp.src("./less/bootstrap.drawer.less") | ||
gulp.src("./less/bootstrap-drawer.less") | ||
.pipe(less({ | ||
@@ -31,3 +31,3 @@ paths: ["./less"] | ||
gulp.src("./less/bootstrap.drawer.less") | ||
gulp.src("./less/bootstrap-drawer.less") | ||
.pipe(less({ | ||
@@ -37,3 +37,2 @@ paths: ["./less"], | ||
})) | ||
.pipe(rename({basename: "drawer"})) | ||
.pipe(gulp.dest("./dist/css")) | ||
@@ -44,3 +43,3 @@ ; | ||
gulp.task("less.min", function() { | ||
gulp.src("./less/bootstrap.drawer.less") | ||
gulp.src("./less/bootstrap-drawer.less") | ||
.pipe(less({ | ||
@@ -50,3 +49,3 @@ paths: ["./less"], | ||
})) | ||
.pipe(rename("drawer.min.css")) | ||
.pipe(rename("bootstrap-drawer.min.css")) | ||
.pipe(gulp.dest("./dist/css")) | ||
@@ -53,0 +52,0 @@ ; |
@@ -0,0 +0,0 @@ /* ======================================================================== |
{ | ||
"name": "bootstrap-drawer", | ||
"version": "0.9.0", | ||
"version": "0.9.1", | ||
"description": "A Bootstrap add-on to create drawer (off-canvas) styled navigation", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -20,3 +20,3 @@ # bootstrap-drawer | ||
This Readme is actually a quick start. [Check out the full documentation](http://clineamb.github.io/bootstrap-canvas) for detailed | ||
This Readme is actually a quick start. [Check out the full documentation](http://clineamb.github.io/bootstrap-drawer) for detailed | ||
usage and style guide. | ||
@@ -38,3 +38,3 @@ | ||
or you can (download the latest release)[https://github.com/clineamb/bootstrap-drawer/releases] from the release page. | ||
or you can [download the latest release](https://github.com/clineamb/bootstrap-drawer/releases) from the release page. | ||
@@ -52,3 +52,3 @@ | ||
<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="bootstrap-drawer.min.css"> | ||
<link rel="stylesheet" type="text/css" href="YOUR_OTHER_STYLES.css"> | ||
@@ -66,2 +66,48 @@ </head> | ||
### Basic Usage | ||
You can check out [example/index.html](example/index.html) for a more robust example, | ||
but the basic usage is very similar to using Bootstrap's col-SIZE-# classes, when it comes | ||
to sizing the component. In addition, the inner elements (`.drawer-heading`, `-nav/-navfull`, | ||
`-body`, `-footer`) are similar to how the `.panel` class family works. | ||
The `.fold` class starts the drawer closed. Becomes `.fold.open` when it's opened. | ||
The sizing classes are dictated by the screen size to be responsive. `.dw-SIZE-12` will cover | ||
the whole screen/canvas of that size. If you want to use the drawer in another container | ||
instead of the `<body>`, check out [the full documentation](http://clineamb.github.io/bootstrap-drawer). | ||
```html | ||
<body class="has-drawer"> <!-- add this class to your body for proper sizing --> | ||
<div id="drawerExample" class="drawer dw-xs-10 dw-sm-6 dw-md-4 fold" aria-labelledby="drawerExample"> | ||
<div class="drawer-controls"> | ||
<a href="#drawerExample" data-toggle="drawer" href="#drawerExample" aria-foldedopen="false" aria-controls="drawerExample" class="btn btn-primary btn-sm">Menu</a> | ||
</div> | ||
<div class="drawer-contents"> | ||
<div class="drawer-heading"> | ||
<h2 class="drawer-title">Menu</h2> | ||
</div> | ||
<div class="drawer-body"> | ||
<p> | ||
This is a properly padded container for content in the | ||
drawer that isn't a navigation. | ||
</p> | ||
<a href="#">A Regular Link</a> | ||
</div> | ||
<ul class="drawer-nav"> | ||
<li role="presentation" class="active"><a href="#">Home</a></li> | ||
<li role="presentation"><a href="#">Profile</a></li> | ||
<li role="presentation"><a href="#">Messages</a></li> | ||
</ul> | ||
<div class="drawer-footer"> | ||
<small>© Caroline Amaba</small> | ||
</div> | ||
</div> | ||
</div> | ||
<div class="container"> | ||
<!-- content as per usual --> | ||
</div> | ||
</body> | ||
``` | ||
### Using LESS | ||
@@ -137,2 +183,21 @@ | ||
### Building Your Own Flavor of Drawer | ||
You'll need [gulp](http://gulpjs.com/) and [Node](http://nodejs.org/)/[io.js](https://iojs.org/ if you want to build your own version. | ||
Run `npm install` in order to get all the devDependencies from the `package.json`. | ||
Most of the tasks are outlined in `gulpfile.js`. The `gulp build` will also update | ||
the assets for `example/index.html` so you can see your changes. | ||
To customize bootstrap-drawer, just edit some of the variables in `less/drawer-variables.less` to | ||
the sizes and colors, etc. you want. Then run `gulp build` and a new `dist/css/bootstrap-drawer(.min).css` | ||
should be made just for you! Include the file right after the Bootstrap core file, and you should be | ||
good to go! | ||
Things to keep in mind: | ||
* bootstrap-drawer uses some variables (`@grid-gutter-width`, `@zindex-navbar-fixed`, `@link-color`, to | ||
name most of them), so if you're using a different `varibles.less file`, be sure to replace it in | ||
`less/bootstrap-drawer.less`. | ||
### Javascript | ||
@@ -143,2 +208,9 @@ | ||
## Changelog | ||
#### v 0.9.1 | ||
* Added `.has-inner-drawer` class to allow elements with a set width/height to | ||
have a drawer within it. | ||
* Added in `example/index.html` how to use the `.has-inner-drawer` feature. | ||
---------------------------------------------------- | ||
@@ -145,0 +217,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
351460
20
5459
218
1