# hotmenu

> A responsive, full-screen jQuery menu.

Latest version **1.1.2** (published 2016-12-02) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install hotmenu
pnpm add hotmenu
yarn add hotmenu
bun add hotmenu
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2016-12-02 |
| First published | 2016-11-29 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Charles Truelson |
| Maintainers | ctruelson |
| Keywords | hotmenu, menu, jquery, javascript, responsive, css, simple |

## Links

- npm: https://www.npmjs.com/package/hotmenu
- Repository: https://github.com/ctruelson/hotmenu
- Homepage: http://ctruelson.github.io/hotmenu
- Issues: https://github.com/ctruelson/hotmenu/issues
- npm.io page: https://npm.io/package/hotmenu

## Dependencies (1)

- [jquery](https://npm.io/package/jquery.md) ^3.1.1

## Alternatives

- [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads
- [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads
- [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads
- [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads
- [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2016-12-02
- 1.1.1 — 2016-12-02
- 1.1.0 — 2016-12-02
- 0.0.1 — 2016-11-29

## README

# hotmenu

A responsive, full-screen jQuery menu.

## Usage

Include `hotmenu.jquery.js` and `hotmenu.css` in your project...

```
<script type="text/javascript" src="hotmenu.jquery.min.js"></script>
<link rel="stylesheet" href="hotmenu.min.css">`
```

...add a toggle...

`<button class='hm-toggle'>Click me</button>`

...and then:

`$(function() { $('nav').hotMenu(); });`

## Options

`toggleSelector`  
The selector for element that should trigger the menu to open. Default: '.hm-toggle'

`mediaQuery`  
Media query string at which hotmenu should be active. Default: null

### Example with options

```
$('nav').hotMenu({ 
  toggleSelector: '.hm-toggle', 
  mediaQuery: '(max-width: 600px)' 
});
```

hotmenu takes care of basic styling, but most of it's up to you. You're responsible for creating the toggle that opens the menu. The default class that hotmenu looks for is `hm-toggle`.

---
_Source: https://npm.io/package/hotmenu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._