Table of Contents

Usage

Using Hamburgers for your site is easy (well, that was my intention anyway).

Download and include the CSS in the <head> of your site: <link href= "dist/hamburgers.css" rel= "stylesheet" > Add the base hamburger markup: <button class= "hamburger" type= "button" > <span class= "hamburger-box" > <span class= "hamburger-inner" ></span> </span> </button> You can use <div> s (if you insist), but they’re not accessible as a menu button. <div class= "hamburger" > <div class= "hamburger-box" > <div class= "hamburger-inner" ></div> </div> </div> Append the class name of the type of hamburger you’re craving: <button class= "hamburger hamburger--collapse" type= "button" > <span class= "hamburger-box" > <span class= "hamburger-inner" ></span> </span> </button> Here’s the list of hamburger-type classes you can choose from: hamburger--3dx

hamburger--3dx-r

hamburger--3dy

hamburger--3dy-r

hamburger--3dxy

hamburger--3dxy-r

hamburger--arrow

hamburger--arrow-r

hamburger--arrowalt

hamburger--arrowalt-r

hamburger--arrowturn

hamburger--arrowturn-r

hamburger--boring

hamburger--collapse

hamburger--collapse-r

hamburger--elastic

hamburger--elastic-r

hamburger--emphatic

hamburger--emphatic-r

hamburger--minus

hamburger--slider

hamburger--slider-r

hamburger--spin

hamburger--spin-r

hamburger--spring

hamburger--spring-r

hamburger--stand

hamburger--stand-r

hamburger--squeeze

hamburger--vortex

hamburger--vortex-r Note: -r classes are reverse variants (e.g. hamburger--spin spins clockwise whereas hamburger--spin-r spins counterclockwise. Trigger the active state by appending class name is-active : <button class= "hamburger hamburger--collapse is-active" type= "button" > <span class= "hamburger-box" > <span class= "hamburger-inner" ></span> </span> </button> Since the class name would have to be toggled via JavaScript and implementation would differ based on the context of how you plan on using the hamburger, I’m going to leave the rest up to you. Stuck? Here‘s a hint.

Here’s a snippet of how to toggle a class name on click with JavaScript: < script > // Look for .hamburger var hamburger = document . querySelector ( ".hamburger" ); // On click hamburger . addEventListener ( "click" , function () { // Toggle class "is-active" hamburger . classList . toggle ( "is-active" ); // Do something else, like open/close menu }); < /script > ...or jQuery: < script > var $hamburger = $ ( ".hamburger" ); $hamburger . on ( "click" , function ( e ) { $hamburger . toggleClass ( "is-active" ); // Do something else, like open/close menu }); < /script >

Sass

.scss source files are available if you use Sass as your CSS precompiler. It’s customizable and modular.

Hamburgers is available via npm, yarn and Bower. npm install hamburgers yarn get hamburgers bower install css-hamburgers Also available as a Ruby gem to use within your Rails application—see below for more information.

Or to manually install it, download and unzip the source code from Github. Then copy the files from the _sass/hamburgers directory into your project. Import the hamburgers.scss file in your Sass manifest file: @import "path/to/hamburgers" ; Customize your hamburger and/or remove any types you don’t want in hamburgers.scss . Compile your Sass*, and voila!

* Be sure to run the CSS through Autoprefixer since the Sass doesn’t account for vendor prefixes.

Install for Ruby on Rails

Add Hamburgers to your Gemfile. gem 'hamburgers' Run bundle install . Include Hamburgers by using Sass’s native !import **: // application.scss @import " hamburgers ";

** More information on why Sass’s native @import + why you should ditch Sprockets directives altogether.

Customization

To override default settings, declare them before importing Hamburgers:

$hamburger-padding-x : 20px ; $hamburger-padding-y : 15px ; $hamburger-types : ( collapse ); @import "hamburgers" ;

You can also create a separate file (e.g. hamburgers-settings.scss ) with those declarations, then import it along with Hamburgers:

@import "hamburgers-settings" @import "hamburgers" ;

Here is the full list of default settings (found in _sass/hamburgers/hamburgers.scss );

$hamburger-padding-x : 15px ! default ; $hamburger-padding-y : 15px ! default ; $hamburger-layer-width : 40px ! default ; $hamburger-layer-height : 4px ! default ; $hamburger-layer-spacing : 6px ! default ; $hamburger-layer-color : #000 ! default ; $hamburger-layer-border-radius : 4px ! default ; $hamburger-hover-opacity : 0 .7 ! default ; $hamburger-active-layer-color : $hamburger-layer-color ! default ; $hamburger-active-hover-opacity : $hamburger-hover-opacity ! default ; // To use CSS filters as the hover effect instead of opacity, // set $hamburger-hover-use-filter as true and // change the value of $hamburger-hover-filter accordingly. $hamburger-hover-use-filter : false ! default ; $hamburger-hover-filter : opacity ( 50% ) ! default ; $hamburger-active-hover-filter : $hamburger-hover-filter ! default ; // Types (Remove or comment out what you don’t need) $hamburger-types : ( 3dx , 3dx-r , 3dy , 3dy-r , 3dxy , 3dxy-r , arrow , arrow-r , arrowalt , arrowalt-r , arrowturn , arrowturn-r , boring , collapse , collapse-r , elastic , elastic-r , emphatic , emphatic-r , minus , slider , slider-r , spring , spring-r , stand , stand-r , spin , spin-r , squeeze , vortex , vortex-r ) ! default ;

ems or rems

Wanna work with ems or rems instead of px ? Just change all the px values to the unit of your choice. Note: Be consistent (all px or all ems ), otherwise it may break—the math behind the customization will fail if it attempts to perform operations with values of different units.

Not satisfied?

Dig into _base.scss or types/ and customize to your heart’s content. Fair warning: It‘s pretty delicate and may break, especially if you tweak the animations themselves.

Accessibility

Hamburger menu icons can be useful in the right context, but they’re not the most accessible.

ARIA will help make it accessible to people with disabilities.

<button class= "hamburger hamburger--elastic" type= "button" aria-label= "Menu" aria-controls= "navigation" > <span class= "hamburger-box" > <span class= "hamburger-inner" ></span> </span> </button> <nav id= "navigation" > <!--navigation goes here--> </nav>

If you insist on using <div> s, by default they’re not focusable (i.e. via keyboard or assistive technology). Add the tabindex attribute alongside ARIA.

<div class= "hamburger hamburger--elastic" tabindex= "0" aria-label= "Menu" role= "button" aria-controls= "navigation" > <div class= "hamburger-box" > <div class= "hamburger-inner" ></div> </div> </div> <nav id= "navigation" > <!--navigation goes here--> </nav>

A label can help make it more obvious that it toggles a menu.

Menu

Here are some resources on web accessibility and ARIA.

Browser Support