Skip to content

afonsopacifer/hamburguer-menu

Repository files navigation

<hamburguer-menu>

<🍔/> A Polymer element for Off-canvas Menu.

demo

Live Demo

Check it live!

Install

Install the component using Bower:

$ bower install hamburguer-menu --save

Usage

  1. Import Web Components' polyfill:
<script src="bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
  1. Import Custom Element:
<link rel="import" href="bower_components/hamburguer-menu/hamburguer-menu.html">
  1. Start using it!
<hamburguer-menu>
  <menu-item text="link 1"></menu-item>
  <menu-item text="link 2"></menu-item>
  <menu-item text="link 3"></menu-item>
</hamburguer-menu>

Attributes

Attribute Type Default Description
text String link Sets the corner text content.
href String # Defines the destination url.
target String _self Defines the hyperlink target.

Example:

<hamburguer-menu>
  <menu-item text="link 1" href="#" target="_blank"></menu-item>
  <menu-item text="link 2" href="#" target="_self"></menu-item>
</hamburguer-menu>

Browser Support

Using the webcomponents.js

IE Chrome Firefox Opera Safari
11+ Latest ✔ Latest ✔ Latest ✔ Latest ✔

Development

  1. Install Bower & Polymer-CLI:
$ [sudo] npm install -g bower polymer-cli
  1. Install local dependencies:
$ bower install
  1. Start the development server on http://localhost:8080/:
$ polyserve

View docs:
http://localhost:8080/components/hamburguer-menu/

View demo:
http://localhost:8080/components/hamburguer-menu/demo/

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our issues the next steps of the project ;)
Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT License © Afonso Pacifer

About

<:hamburger:/> A Polymer element for Off-canvas Menu.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages