# vue-sidebar-menu-akahon

> ## Project setup ``` npm install ```

Latest version **1.0.2** (published 2023-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-sidebar-menu-akahon
pnpm add vue-sidebar-menu-akahon
yarn add vue-sidebar-menu-akahon
bun add vue-sidebar-menu-akahon
```

## 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.2 |
| Published | 2023-03-28 |
| First published | 2021-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 31.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 72 |
| Author | Fayzullo Saidakbarov |
| Maintainers | akahon |
| Keywords | sidebar, menu, akahon, vue |

## Links

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

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.6.14
- [core-js](https://npm.io/package/core-js.md) ^3.6.5

## 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.2 (latest) — 2023-03-28
- 0.2.3 — 2023-03-27
- 0.2.2 — 2023-03-26
- 0.2.1 — 2023-03-26
- 0.2.0 — 2023-03-26
- 0.1.4 — 2021-12-27
- 0.1.3 — 2021-12-14
- 0.1.2 — 2021-12-14
- 0.1.0 — 2021-12-14

## README

# vue-sidebar-menu-akahon

[![Vue 2.x](https://img.shields.io/badge/vue-2.x-brightgreen.svg?style=flat-square)](https://vuejs.org)
[![Latest Version on NPM](https://img.shields.io/npm/v/vue-sidebar-menu-akahon.svg?style=flat-square&color)](https://www.npmjs.com/package/vue-sidebar-menu-akahon)
[![npm](https://img.shields.io/npm/dt/vue-sidebar-menu-akahon.svg?style=flat-square)](https://www.npmjs.com/package/vue-sidebar-menu-akahon)
![](https://img.shields.io/github/stars/akahon/vue-sidebar-menu-akahon.svg?style=flat-square&color) 
![](https://img.shields.io/github/forks/akahon/vue-sidebar-menu-akahon.svg?style=flat-square&color)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

> A Vue.js V2 sidebar menu component. 
## Demo
[View demo](https://akahon.github.io/vue-sidebar-menu-akahon/) | [Sandbox](https://codesandbox.io/s/misty-architecture-hyuk5?file=/src/App.vue)

[![demo](https://raw.githubusercontent.com/akahon/vue-sidebar-menu-akahon/demo/src/assets/img/demo.gif)](https://akahon.github.io/vue-sidebar-menu-akahon/)

## Updates

> v1.0.0 
- Added new props `isUsedVueRouter` boolean param by default `false`. If you are using vue-router, set the value to true. 
- Otherwise, when clicking on a menu item the `<a>` tag will be used by default and emitted the `@menu-item-clicked` event with the value of `item-link`. 

Example:
```html
<VueSidebarMenuAkahon
  :isUsedVueRouter="false"
  @menu-item-clicked="fnRouteTo(link)"
/>
```

------------

## Install

```bash
yarn add vue-sidebar-menu-akahon
```

Or

```bash
npm install --save vue-sidebar-menu-akahon
```

## Add to project

#### Global
```js
// main.js
import VueSidebarMenuAkahon from "vue-sidebar-menu-akahon";
Vue.component('vue-sidebar-menu-akahon', VueSidebarMenuAkahon);
```

#### Local Usage

```html
<template>
  <div>
      <VueSidebarMenuAkahon />
  </div>
</template>

<script>
  import VueSidebarMenuAkahon from "vue-sidebar-menu-akahon";
  
  export default {
    name: 'component.vue',
    components: {VueSidebarMenuAkahon},
    data() {
      return {}
    }
  }
</script>
```
<!-- ## Project setup
```
npm install
```

### Compiles and hot-reloads for development
```
npm run serve
```

### Compiles and minifies for production
```
npm run build
```

### Lints and fixes files
```
npm run lint
``` -->

### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).

## Props
You can use icons from [boxicons](https://boxicons.com/)
### Menu settings

Props (Parameter) | Type | Default | Description
--------- | ---- | ------- | -----------
isMenuOpen | `Boolean` | `true` | Open/Close menu
isUsedVueRouter | `Boolean` | `false` | When clicking on a menu item, if "true", "vue-router" is used instead of the "a" tag.
menuTitle | `String` | `'Akahon'` | Menu title 
menuLogo | `String` | - | Logo
menuIcon | `String` | `'bxl-c-plus-plus'` | Icon (boxicons)

### Menu items

Props (Parameter) | Type | Default | Description
--------- | ---- | ------- | -----------
menuItems | `Array` | `[{link: "#",name: "Dashboard", tooltip: "Dashboard", icon: "bx-grid-alt" }]` | Items

### Search

Props (Parameter) | Type | Default | Description
--------- | ---- | ------- | -----------
isSearch | `Boolean` | `true` | Enable/Disable search input
searchPlaceholder | `String` | `'Search...'` | Search input placeholder
searchTooltip | `String` | `'Search'` | Search input tooltip

### Profile detailes

Props (Parameter) | Type | Default | Description
--------- | ---- | ------- | -----------
profileImg | `String` | `''` | Profile avatar
profileName | `String` | `'Fayzullo Saidakbarov'` | Profile full name
profileRole | `String` | `'Frontend vue developer'` | Profile role title
isExitButton | `Boolean` | `true` | Enable/Disable exit button

### Styles

Props (Parameter) | Type | Default | Description
--------- | ---- | ------- | -----------
bgColor | `String` | `'#11101d'` | Background color
secondaryColor | `String` | `'#1d1b31'` | Secondary color
homeSectionColor | `String` | `'#e4e9f7'` | 
logoTitleColor | `String` | `'#fff'` | 
iconsColor | `String` | `'#fff'` | 
itemsTooltipColor | `String` | `'#e4e9f7'` | 
searchInputTextColor | `String` | `'#fff'` | 
menuItemsHoverColor | `String` | `'#fff'` | 
menuItemsTextColor | `String` | `'#fff'` | 
menuFooterTextColor | `String` | `'#fff'` | 

### Events

Event | Output |  Description
--------- | ---- | -----------
@menu-item-clcked | item-link | If isUsedVueRouter=false, emitted when the menu item has been clicked
@button-exit-clicked | - | Emitted when the exit button has been clicked
@search-input-emit | String | Emitted when user types in the search input

#### Thanks for design
[Prem Shahi](https://www.codinglabweb.com/2021/04/responsive-side-navigation-bar-in-html.html)

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

### Vue CLI configuration
See [Configuration Reference](https://cli.vuejs.org/config/).

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