# @feizheng/react-burger-menu

> Burger menu for react.

Latest version **1.0.9** (published 2020-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @feizheng/react-burger-menu
pnpm add @feizheng/react-burger-menu
yarn add @feizheng/react-burger-menu
bun add @feizheng/react-burger-menu
```

## 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.0.9 |
| Published | 2020-11-06 |
| First published | 2020-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 22.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | afei |
| Maintainers | afeiship |
| Keywords | react, burger, menu, sidemenu, drawer, component, components, hamburger, react-component, sidebar, ui, library, pc, web |

## Links

- npm: https://www.npmjs.com/package/@feizheng/react-burger-menu
- Repository: https://github.com/afeiship/react-burger-menu
- Homepage: https://github.com/afeiship/react-burger-menu#readme
- Issues: https://github.com/afeiship/react-burger-menu/issues
- npm.io page: https://npm.io/package/@feizheng/react-burger-menu

## Dependencies (3)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [@feizheng/noop](https://npm.io/package/@feizheng/noop.md) ^1.0.0
- [@feizheng/react-drawer](https://npm.io/package/@feizheng/react-drawer.md) ^1.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.9 (latest) — 2020-11-06
- 1.0.8 — 2020-11-06
- 1.0.7 — 2020-10-27
- 1.0.6 — 2020-10-27
- 1.0.4 — 2020-10-26
- 1.0.3 — 2020-10-26
- 1.0.2 — 2020-10-26
- 1.0.1 — 2020-10-26
- 1.0.0 — 2020-10-26

## README

# react-burger-menu
> Burger menu for react.

[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]

## installation
```shell
npm install -S @feizheng/react-burger-menu
```

## update
```shell
npm update @feizheng/react-burger-menu
```

## properties
| Name      | Type    | Required | Default | Description                           |
| --------- | ------- | -------- | ------- | ------------------------------------- |
| className | string  | false    | -       | The extended className for component. |
| value     | bool    | false    | false   | The changed value.                    |
| onChange  | func    | false    | noop    | The change handler.                   |
| options   | object  | false    | -       | Drawer options.                       |
| trigger   | func    | false    | noop    | The trigger element.                  |
| extra     | element | false    | -       | The extra element.                    |


## usage
1. import css
  ```scss
  @import "~@feizheng/webkit-sassui-backdrop";
  @import "~@feizheng/webkit-sassui-drawer";
  @import "~@feizheng/react-drawer/dist/style.scss";
  @import "~@feizheng/react-burger-menu/dist/style.scss";

  // customize your styles:
  $react-burger-menu-options: ()
  ```
2. import js
  ```js
  import ReactDemokit from '@feizheng/react-demokit';
  import React from 'react';
  import ReactDOM from 'react-dom';
  import ReactBurgerMenu from '@feizheng/react-burger-menu';
  import './assets/style.scss';

  class App extends React.Component {
    render() {
      return (
        <ReactDemokit
          className="p-3 app-container"
          url="https://github.com/afeiship/react-burger-menu">
          <ReactBurgerMenu
            trigger={(props) => {
              return (
                <button className="button" {...props}>
                  CustomizeTrigger
                </button>
              );
            }}
            onChange={(e) => {
              console.log('status changed:', e.target.value);
            }}>
            <p>
              道可道，非常道；名可名，非常名。 无名，天地之始，有名，万物之母。
            </p>
            <p>故常无欲，以观其妙，常有欲，以观其徼。</p>
            <p>此两者，同出而异名，同谓之玄，玄之又玄，众妙之门。</p>
          </ReactBurgerMenu>
        </ReactDemokit>
      );
    }
  }

  ReactDOM.render(<App />, document.getElementById('app'));

  ```

## documentation
- https://afeiship.github.io/react-burger-menu/


## license
Code released under [the MIT license](https://github.com/afeiship/react-burger-menu/blob/master/LICENSE.txt).

[version-image]: https://img.shields.io/npm/v/@feizheng/react-burger-menu
[version-url]: https://npmjs.org/package/@feizheng/react-burger-menu

[license-image]: https://img.shields.io/npm/l/@feizheng/react-burger-menu
[license-url]: https://github.com/afeiship/react-burger-menu/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@feizheng/react-burger-menu
[size-url]: https://github.com/afeiship/react-burger-menu/blob/master/dist/react-burger-menu.min.js

[download-image]: https://img.shields.io/npm/dm/@feizheng/react-burger-menu
[download-url]: https://www.npmjs.com/package/@feizheng/react-burger-menu

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