npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

offcanvas-menu

v0.1.6

Published

Off-canvas Menu

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

markrabeymarkrabey

Keywords

Readme

Off Canvas Menu

Gitter chat

devDependencies MIT license Issues

Check here for a demo.

Installation

Bower

bower install offcanvas-menu --save

NPM

npm install offcanvas-menu --save

After Bower or NPM install, copy the files from dist/css and dist/js to your project's assets folder.

Without a Package Manager

Clone repo, or download zip.

Usage

A working sample is available in the download, in the 'dist' folder. Eventually I'll have a Bower and/or NPM installation available. For now clone the repo or download the .zip and copy the CSS and JS files from inside the dist folder, to wherever in your project you would like.

Here is the expected HTML structure:

...
<head>
	...
	<link rel="stylesheet" href="path/to/css/offcanvas-nav.min.css">
</head>

<nav class="offcanvas-nav">
	<ul class="offcanvas-nav__list">
		<li class="offcanvas-nav__item">
			<a href="#" class="offcanvas-nav__link">Item 1</a>
		</li>
		<li class="offcanvas-nav__item">
			<a href="#" class="offcanvas-nav__link">Item 2</a>
		</li>
		<li class="offcanvas-nav__item">
			<a href="#" class="offcanvas-nav__link">Item 3</a>
		</li>
		<li class="offcanvas-nav__item">
			<a href="#" class="offcanvas-nav__link">Item 4</a>
		</li>
		<li class="offcanvas-nav__item">
			<a href="#" class="offcanvas-nav__link">Item 5</a>
		</li>
	</ul>
</nav>

<a id="nav-toggle" href="#" class="offcanvas-nav__toggle">Menu</a>
...

	<script src="path/to/js/offcanvas-nav.min.js"></script>
</body>

Development

Feel free to do what you'd like with this. Clone or fork the repo, type npm install and have your way with it. Use grunt build to compile Less to CSS, and lint and minify JS, and update the dist folder. Use grunt default to run the build, and continue to watch the Less and JavaScript files for changes.

Coming soon

  • Fallback CSS for older versions of IE - maybe.
  • ~~Bower and/or NPM packages~~
  • Not much other than that. This thing is pretty basic I think...

Off-canvas Menu © 2014-2015, Mark Rabey. Released under the MIT License. Authored and maintained by Mark Rabey

markrabey.com  ·  GitHub @MarkRabey  ·  Twitter @MarkRabey