Skip to content

firstprateek/hamburger-btn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hamburger-btn

A webcomponent for a hamburger menu button developed using LIT

Live Demo

Demo

Installation

npm install hamburger-btn --save

Usage

// In index.js
import HamburgerBtn from 'hamburger-btn';
<!DOCTYPE html>
<head>
    <script src="./index.js"></script>
</head>
<body>
    <main>
        <hamburger-btn></hamburger-btn>
    </main>
</body>
</html>
/**
 * HamburgerButton widget: <hamburger-btn></hamburger-btn>.
 * 
 * This widget is a hamburger button that changes into a cross button upon click.
 * 
 * @property hidden {Boolean}. If false then button is hidden.
 * @property open {Boolean}. If true then the stripes change into a cross.
 * 
 * @fires click - Indicates when the button is clicked. The open property is toggled when button is clicked.
 * 
 * @cssproperty --hamburger-stripe-color - This variable controls the color of the stripes
 */

About

A web component for a hamburger menu button

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published