Minimalist CSS3 hamburger animation
JavaScript CSS HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
css
example
js
LICENSE
README.md
bower.json
hamburger-icon-animate.gif
package.json

README.md

hamburger-icon-animate

Minimalist CSS3 hamburger animation

Example GIF

This is a little bit of code to add an animation to the hamburger icon. The bulk of the animation is powered by CSS3 keyframes and raw JavaScript is used to control when each animation is run.

Install

bower

$ bower install hamburger-icon-animate --save

npm

$ npm install hamburger-icon-animate --save

Usage

Now that you've installed the plugin, load the script via whichever method you prefer. If you are using bower you might do something like this:

<link rel="stylesheet" href="/bower_components/hamburger-icon-animate/css/hamburger-icon-animate.css">
<script src="/bower_components/hamburger-icon-animate/js/hamburger-icon-animate.js"></script>

Define the hamburger like this:

<div class="hia-hamburger">
  <div data-bar="1" class="hia-bar"></div>
  <div data-bar="2" class="hia-bar"></div>
  <div data-bar="3" class="hia-bar"></div>
</div>

Activate the hamburger like this:

hamburgerIcon();

Take a look at the example over here.

API

hamburgerIcon([options])

Binds event handlers for animating the hamburger icon to the first element in the document matching the selector .hia-hamburger.

An object of options may be given:

  • showMenu: A callback to be called each time the menu is shown (called at the start of the animation)
  • hideMenu: A callback to be called each time the menu is hidden (called at the start of the animation)
hamburgerIcon({
  showMenu: function() { console.log('showing menu'); },
  hideMenu: function() { console.log('hiding menu'); }
});

Let me know of any issues or simply say hi.