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

@stereorepo/burger

v3.2.5

Published

[Alban πŸ”₯] _Burger_ is the easy way to make your ordinary burger navigation optimized for mobile πŸ“±

Downloads

87

Readme

Burger πŸ”

[Alban πŸ”₯] Burger is the easy way to make your ordinary burger navigation optimized for mobile πŸ“±

Installation

npm i -S @stereorepo/burger

Usage

Burger will toggle the activated class on both the burger and your main navigation. aria-expanded is also handled on your main navigation.

This component will take care of browsers compatiblity concerning the scroll when the navigation is active with the %no-scroll scss placeholder.

How it works on paper

For purpose of making a great mobile navigation you only need to elements:

  • The burger element
  • The main navigation of the website

The html example

<!-- ... -->
<header class="main-header">
    <button class="burger js-burger" type="button">
        <!-- The elements you need to make your burger -->
    </button>
</header>
<nav class="main-navigation js-main-navigation">
    <!-- All your navigation elements -->
</nav>
<!-- ... -->

Example

// You can import the vanilla Burger
import { Burger } from '@stereosuper/accordion';
// or the Vue.js version of it
import { BurgerVue } from '@stereosuper/accordion';

// then instanciate it
const burger = new Burger({
    burgerSelector: '.js-burger',
    mainNavigationSelector: '.js-main-navigation'
});

// and finally watch the magic happen
burger.bigMacOrWhopper();

The constructor

In the burger constructor you only need to pass your burgerSelector and your mainNavigationSelector. Then just let it roll.

bigMacOrWhopper

bigMacOrWhopper is the initialization function of the burger component.

The scss placeholder

To easily control browser compatibility with burger navigation you can use the %no-scroll scss placeholder.

@import '~@stereorepo/burger/src/burger';

// It will search for the .no-scroll class added to the html element
html {
    @extend %no-scroll;
}