# side-menu

> A React side-menu component.

Latest version **0.4.2** (published 2018-02-23) · 0 weekly downloads

## Install

```sh
npm install side-menu
pnpm add side-menu
yarn add side-menu
bun add side-menu
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.2 |
| Published | 2018-02-23 |
| First published | 2017-08-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 344.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ungp-softplan |

## Links

- npm: https://www.npmjs.com/package/side-menu
- npm.io page: https://npm.io/package/side-menu

## Dependencies (1)

- [react-fontawesome](https://npm.io/package/react-fontawesome.md) 1.6.1

## Recent versions

- 0.4.2 (latest) — 2018-02-23
- 0.4.1 — 2018-02-23
- 0.4.0 — 2018-02-23
- 0.3.12 — 2017-11-07
- 0.3.11 — 2017-11-06
- 0.3.10 — 2017-09-01
- 0.3.9 — 2017-08-30
- 0.3.8 — 2017-08-28
- 0.3.7 — 2017-08-22
- 0.3.6 — 2017-08-22
- 0.3.5 — 2017-08-21
- 0.3.4 — 2017-08-21
- 0.3.3 — 2017-08-21
- 0.3.2 — 2017-08-21
- 0.3.1 — 2017-08-21
- … 7 more at https://npm.io/package/side-menu/versions

## README

A React side-menu component.

[![NPM version](https://img.shields.io/npm/v/side-menu.svg)](https://www.npmjs.com/package/side-menu)

## Usage

Here is a quick example to get you started, it's all you need:

This component uses icons from Font Awesome, but it does not include any of the Font Awesome CSS or fonts, so you'll need to make sure to include those on your end somehow, either by adding them to your build process or linking to [CDN versions](https://www.bootstrapcdn.com/fontawesome/).


```jsx
import React, {Component} from 'react';

import {BrowserRouter as Router} from 'react-router-dom';

import Links from 'path/to/links';
import SideMenu from 'SideMenu';

class App extends Component {

  handleLinkSelect = link =>
    console.log(link); //{id, name, url}

  render() {
    return (
      <Router> //added somewhere on your project
        <div>
          <SideMenu
            links={Links}
            onSelectLink={this.handleLinkSelect}
          />
        </div>
      </Router>
    );
  }
}

export default App;
```

### Props

```
links: PropTypes.arrayOf(PropTypes.shape({
  id: PropTypes.number.isRequired,
  name: PropTypes.string.isRequired,
  url: PropTypes.string.isRequired,
  icon: PropTypes.string.isRequired, //font awesome icon name
  badge: PropTypes.number
})).isRequired,
position: PropTypes.string, //left or right
onSelectLink: PropTypes.func.isRequired
```

### Links array example

```
export default [{
  id: 1,
  name: 'rocket',
  url: '/app/rocket',
  icon: 'rocket'
}, {
  id: 2,
  name: 'bomb',
  url: '/app/bomb',
  icon: 'bomb',
  badge: 2
}, {
  id: 3,
  name: 'coffee',
  url: '/app/coffee',
  icon: 'coffee'
}];
```

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