# ng2-menu

> Angular2 Menu Directive

Latest version **0.5.1** (published 2016-12-12) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2016-12-12 |
| First published | 2016-07-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Allen Kim |
| Maintainers | allenkim |

## Links

- npm: https://www.npmjs.com/package/ng2-menu
- Repository: https://github.com/ng2-ui/ng2-menu
- Homepage: https://github.com/ng2-ui/ng2-menu#readme
- Issues: https://github.com/ng2-ui/ng2-menu/issues
- npm.io page: https://npm.io/package/ng2-menu

## Recent versions

- 0.5.1 (latest) — 2016-12-12
- 0.5.0 — 2016-12-12
- 0.4.2 — 2016-10-14
- 0.4.1 — 2016-09-16
- 0.4.0 — 2016-09-11
- 0.3.0 — 2016-08-27
- 0.2.0 — 2016-07-15
- 0.1.2 — 2016-07-10
- 0.1.1 — 2016-07-10
- 0.1.0 — 2016-07-02

## README

# ng2-menu
Angular2 menu directive

<a href="https://rawgit.com/ng2-ui/ng2-menu/master/app/index.html">
  <img src="http://i.imgur.com/w6yJBua.png" width="50% border="1" />
</a>

Plunker Example: https://plnkr.co/edit/u6sihV?p=preview

## Install

1. install ng2-menu

        $ npm install ng2-menu --save

2. add `map` and `packages` to your `systemjs.config.js`. `ng2-menu` reuires `ng2-overlay`

        map['ng2-menu'] = 'node_modules/ng2-menu/dist';
        packages['ng2-menu'] = { main: 'ng2-menu.umd.js', defaultExtension: 'js' }

3. import Ng2MenuModule to your AppModule
        import { NgModule } from '@angular/core';
        import { FormsModule } from "@angular/forms";
        import { BrowserModule  } from '@angular/platform-browser';
        import { AppComponent } from './app.component';
        import { Ng2MenuModule } from 'ng2-Menu';
        
        @NgModule({
          imports: [BrowserModule, FormsModule, Ng2MenuModule],
          declarations: [AppComponent],
          bootstrap: [ AppComponent ]
        })
        export class AppModule { }

For full example, please check out `test` directory to see the example of;

  - `systemjs.config.js`
  - `app.module.ts`
  -  and `app.component.ts`.

3.  add ng2-menu.css into your html

        <link rel="stylesheet" href="https://unpkg.com/ng2-menu/dist/ng2-menu.css" />

## Use it in your code
 You are ready. use it in your template

       <ul ng2-menu>
         <li> Menu Item 1 </li>
         <li> Menu Item 2
           <ul ng2-menu>
             <li> Menu Item 2-1 </li>
             <li> Menu Item 2-2 
               <ul ng2-menu>
                 <li> Menu Item 2-2-1 </li>
                 <li> Menu Item 2-2-2 </li>
                 <li> Menu Item 2-2-3 </li>
               </ul>
             </li>
             <li> Menu Item 2-2 </li>
           </ul>
         </li>
         <li> Menu Item 3 </li>
       </ul>

## **ng2-ui** welcomes new members and contributors

This module is only improved and maintained by contributors like you.

As a contributor, it's NOT required to be skilled in Javascript nor Angular2. 
You are only to be open-minded and interested in helping others.
As a contributor, you do following;

  * Updating README.md
  * Improving code comments
  * Answering issues and building FAQ
  * Documentation
  * Translation

In result of your active contribution, you will be listed as a core contributor
on https://ng2-ui.github.io, and a member of ng2-ui too.

If you are interested in becoming a contributor and/or a member of ng-ui,
please send me email to `allenhwkim AT gmail.com` with your github id.

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