# vue-accordion-menu

[![npm](https://img.shields.io/npm/v/vue-accordion-menu.svg) ![npm](https://img.shields.io/npm/dm/vue-accordion-menu.svg)](https://www.npmjs.com/package/vue-accordion-menu)
[![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)

Simple accordion menu component in Vue 2

![AccordionMenu](https://i.imgur.com/Cefw7Nd.gif)

## Table of contents

- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)

# Installation

```
npm install --save vue-accordion-menu
```

## Default import

Install all the components:

```javascript
import Vue from 'vue'
import VueAccordionMenu from 'vue-accordion-menu'

Vue.use(VueAccordionMenu)
```

Use specific components:

```javascript
import Vue from 'vue'
import { AccordionMenu } from 'vue-accordion-menu'

Vue.component('AccordionMenu', AccordionMenu)
```

**⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.**

**[This docs would be a great help](https://webpack.github.io/docs/stylesheets.html)**

## Distribution import

Install all the components:

```javascript
import 'vue-accordion-menu/dist/vue-accordion-menu.css'
import VueAccordionMenu from 'vue-accordion-menu/dist/vue-accordion-menu.common'

Vue.use(VueAccordionMenu)
```

Use specific components:

```javascript
import 'vue-accordion-menu/dist/vue-accordion-menu.css'
import { AccordionMenu } from 'vue-accordion-menu/dist/vue-accordion-menu.common'

Vue.component('AccordionMenu', AccordionMenu)
```

**⚠️ You may have to setup your bundler to embed the css file in your page.**

## Browser

```html
<link rel="stylesheet" href="vue-accordion-menu/dist/vue-accordion-menu.css"/>

<script src="vue.js"></script>
<script src="vue-accordion-menu/dist/vue-accordion-menu.browser.js"></script>
```

The plugin should be auto-installed. If not, you can install it manually with the instructions below.

Install all the components:

```javascript
Vue.use(VueAccordionMenu)
```

Use specific components:

```javascript
Vue.component('AccordionMenu', VueAccordionMenu.AccordionMenu)
```

## Source import

Install all the components:

```javascript
import Vue from 'vue'
import VueAccordionMenu from 'vue-accordion-menu/src'

Vue.use(VueAccordionMenu)
```

Use specific components:

```javascript
import Vue from 'vue'
import { AccordionMenu } from 'vue-accordion-menu/src'

Vue.component('AccordionMenu', AccordionMenu)
```

**⚠️ You need to configure your bundler to compile `.vue` files.** More info [in the official documentation](https://vuejs.org/v2/guide/single-file-components.html).

# Usage

First of all, after installing successfully then type these command in your `main.js`:

```javascript
import { AccordionMenu } from 'vue-accordion-menu'
Vue.component('AccordionMenu', AccordionMenu)
```

Now you can add some customized contents for your accordion menu (use `App.vue` for example):

```javascript
data () {
  return {
    contents: [
    {
      title: 'How are you?',
      msg: 'Test for fun!',
    },
    {
      title: 'Who let the dog out?',
      msg: 'I do not know, dude.',
    },
    {
      title: '肚子好餓?',
      msg: '吃芭樂啦！',
    },
    {
      title: 'Find hotels?',
      msg: 'Trivago！',
    },
    ],
  }
}
```

Last step, use it in your `App.vue` file!

```javascript
<AccordionMenu :contents="contents"></AccordionMenu>
```

Enjoy your customized AccordionMenu! ![turtle](http://i.imgur.com/879dfXS.gif)

# Example
[Live Demo !](https://weichiachang.github.io/vue-accordion-menu/dist/)

---

# Plugin Development

## Installation

The first time you create or clone your plugin, you need to install the default dependencies:

```
npm install
```

## Watch and compile

This will run webpack in watching mode and output the compiled files in the `dist` folder.

```
npm run dev
```

## Use it in another project

While developping, you can follow the install instructions of your plugin and link it into the project that uses it.

In the plugin folder:

```
npm link
```

In the other project folder:

```
npm link vue-accordion-menu
```

This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.

## Publish to npm

You may have to login to npm before, with `npm adduser`. The plugin will be built in production mode before getting published on npm.

```
npm publish
```

## Manual build

This will build the plugin into the `dist` folder in production mode.

```
npm run build
```

---

## License

[MIT](http://opensource.org/licenses/MIT)