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

react-burger-nav

v2.0.2

Published

A hamburger icon triggered, off-canvas sidebar React component, using CSS transitions to show/hide the sidebar content.

Downloads

7

Readme

react-burger-nav

A hamburger icon triggered, off-canvas sidebar React component, using CSS transitions to show/hide the sidebar content.

Original implementation by Negomi at negomi.github.io/react-burger-nav. This pseudo fork was created to provide a single effect implementation for a specific project. Many thanks to Negomi for the hard work :)

Installation

Install via npm and include it in your own React build process (using Browserify, Webpack, etc).

npm install react-burger-nav --save

Usage

Items for the sidebar should be passed as child elements of the component using JSX.

var RBN = require('react-burger-nav');

var Example = React.createClass({
  render: function() {
    return (
      <RBN>
        <a className="external-link" href="https://github.com/">GitHub</a>
        <Link className="react-router-link" to="/">Home</Link>
        <img src="https://assets-cdn.github.com/images/modules/dashboard/bootcamp/octocat_setup.png"/>
      </RBN>
    );
  }
});

Properties

There is an optional id prop, which will simply add an ID to the rendered menu's outermost element. This is not required for any functionality.

<RBN id={ "sidebar" }/>

Styling

All the animations are handled internally by the component. However, the visual styles (colors, fonts etc.) are not, and need to be included with CSS.

The component has the following helper classes:

// Colour of the overlay
.rbn-overlay {
    background: rgba(50, 50, 50, .5);
}

// Colour of burger icon
.rbn-burger-button {
  background: #373a47;
}

// Colour of burger bars
.rbn-burger-bars {
  background: #444;
}

// Color of close button cross
.rbn-cross {
  background: #bdc3c7;
}

// General menu styles
.rbn-menu {
    background: #444;
    font-size: 1.15em;
    padding: 2.5em 1.5em 0;
}

// Wrapper for item list
.rbn-item-list {
  color: #b8b7ad;
  padding: 0.8em;
}

Browser Support

Because this project uses CSS3 features, it's only meant for modern browsers. It also relies on React's implementation of inline styles.

Chrome and Firefox have full support.

License

ICS

Release History

  • 1.0.0 Intial Release
  • 1.0.1 Added left assignment to fixed position elements
  • 1.0.2 Fixed stupid typo
  • 2.0.0 Upgrade core React components, plus all related components, methods, etc.
  • 2.0.1 Removed default overlay colour style so it can be set with CSS