# @graffft-waggle/burger

> graffft-waggle: a burger component

Latest version **0.0.4-alpha.8** (published 2022-06-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @graffft-waggle/burger
pnpm add @graffft-waggle/burger
yarn add @graffft-waggle/burger
bun add @graffft-waggle/burger
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4-alpha.8 |
| Published | 2022-06-05 |
| First published | 2020-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dan Kreiger |
| Maintainers | dankreiger |
| Keywords | burger |

## Links

- npm: https://www.npmjs.com/package/@graffft-waggle/burger
- Repository: https://github.com/dankreiger/graffft-waggle
- Homepage: https://github.com/dankreiger/graffft-waggle#readme
- Issues: https://github.com/dankreiger/graffft-waggle/issues
- npm.io page: https://npm.io/package/@graffft-waggle/burger

## Recent versions

- 0.0.4-alpha.8 (latest) — 2022-06-05
- 0.0.4-alpha.3 — 2022-06-04
- 0.0.4-alpha.1 — 2022-06-04
- 0.0.3-alpha.0 — 2020-07-24

## README

---
filename: /packages/atoms/Burger/Burger.tsx
---

# Burger API

The API documentation of the Burger `Graffft Waggle` component.

## Import

```js
import { Burger } from '@graffft-waggle/burger';
```

## Burger

## Required Props

| Name   | Type      | Description                                         |
| :----- | :-------- | :-------------------------------------------------- |
| isOpen | `boolean` | The open state of the burger menu (`true` if open). |

## Optional Props

| Name          | Type         | Default    | Description                                       |
| :------------ | :----------- | :--------- | :------------------------------------------------ |
| `burgerColor` | `string`     | `'#000'`   | The color of the burger menu                      |
| `onClick`     | `() => void` | `() => {}` | Function to be called when burger menu is clicked |

## Demos

- TODO

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