odin-simple-mobile-menu/README.md

31 lines
595 B
Markdown

# odin-simple-mobile-menu
Simple mobile menu - click on hamburger button makes the full-screen menu appear :)
My second npm package with the-odin-project :D
## usage
install: `npm i odin-simple-mobile-menu`
import in your project:
`import mobileMenu from "odin-simple-mobile-menu"`
the default style is at `./node_modules/odin-simple-mobile-menu/style.css` and is imported at `index.js` in the same location
### syntax
`mobileMenu(...elements)`
### example
`mobileMenu("Home", "About", "Contact")`
it returns a dom node that you can append using append/appendChild
## license
ISC