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

@imadkurdi/hamburger-menu

v1.0.1

Published

This is a hamburger-menu component. A standard custom web component written in pure vanilla JS. So it could be used in any framework.

Downloads

12

Readme

hamburger-menu component

Example demonstrating the use of the hamburger-menu component

This is a hamburger-menu component. A standard custom web component written in pure vanilla JS, so it could be used in any framework.

With the package you will find a complete functional example (example.html, example.css, example.js) Please note that, as a developer, you do not need to take any action to control the menu itself, it works automatically as expected.

Usage:

Use it like any standard tag:

  • In html: <hamburger-menu></hamburger-menu>
  • In JS: document.createElement("hamburger-menu")

Attributes:

  • close-face: if present <hamburger-menu close-face></hamburger-menu>, the menu shows 2 crossing bars instead of 3 parallel bars.

Styling:

  1. Define in an element's selector block one or more of the following custom properties:

    • --dim: menu dimensions in pixels. Default is 32px.
    • --bg-color: menu's background-color. Default is #ddd.
    • --bars-color: color of the menu's bars. Default is #555.
    • --border-color: color of the menu's borders and its box-shadow. Default is #c1c1c1.
    • --border-radius: radius of the menu's borders. Default is 0.25em.
    • --transition-time: when clicked, the menu transitions between open and close states. This custom property defines the transition time. Default is 200ms.
    hamburger-menu { 
       --dim: 48px;
       --bars-color: blue;
    }
  2. Or you can reach the following parts of the component:

    • ::part(menu): the menu is actually a div element, so style it as you style any div element.
    • ::part(bar): the bars inside the menu. Bars are actually divs elements, so style them as you style any div element.
    ::part(menu) { background-color: lightgray; border-radius: 10px; }

Events:

  • hamburger-menu-clicked: This event enables developers to take actions when a user clicks the menu. To learn about the menu's state after the user clicks it, you should read event.detail which is a boolean value. If true that means the menu (after being clicked) has close-face attribute (which means it shows 2 crossed bars). Otherwise that means the menu has not close-face attribute and it shows 3 parallel bars.
    document.querySelector("hamburger-menu")
       .addEventListener("hamburger-menu-clicked", e => { console.log(e.detail); });