# vue-sidebar-component

> Sidebar for Vue 1.x

Latest version **1.0.0** (published 2017-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-sidebar-component
pnpm add vue-sidebar-component
yarn add vue-sidebar-component
bun add vue-sidebar-component
```

## 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.0 |
| Published | 2017-02-28 |
| First published | 2017-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Ken Berkeley |
| Maintainers | kenberkeley |
| Keywords | vue, sidebar, menu |

## Links

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

## 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.0 (latest) — 2017-02-28

## README

# Vue Sidebar Component

[![npm version][npm-v-img]][npm-url]
[![npm download][npm-dl-img]][npm-url]

> Intellectual property of [Oneway.mobi](http://www.oneway.mobi/)

#### Notice
This component is not meant to meet all the business requirements  
so diving into `src/` to make it fits your needs is highly recommended

#### Example
See [here](https://kenberkeley.github.io/vue-sidebar-component/example.html), source in [`example.html`](./example.html)
> Suggest inspecting it with [devtools](https://github.com/vuejs/vue-devtools)

#### Requirement
* Vue 1.x
* Vue Router 0.7.x
* jQuery + BootStrap 3.x + Font Awesome 4.x (available globally)

#### Installation
`npm i vue-sidebar-component -S`

> alternatively: `<script src="dist/vue-sidebar-component.min.js"></script>`  
> which exposes **`VueSidebar`** as a global variable

#### Usage

```
<sidebar main-title="Sidebar" sub-title="Example" :routes="routes"></sidebar>

props: {
  mainTitle: String,
  subTitle: String,
  routes: { type: Object, required: true }
}
```

`routes` configuration example (more in [`example.html`](./example.html)):

```
'/': {
  title: 'Home',
  icon: 'fa fa-home',
  showInSidebar: true,
  component: {
    template: '<div>Home</div>'
  }
}
```

#### Build

`npm run build`

#### LICENSE

MIT

[npm-url]: https://www.npmjs.com/package/vue-sidebar-component
[npm-v-img]: http://img.shields.io/npm/v/vue-sidebar-component.svg
[npm-dl-img]: http://img.shields.io/npm/dm/vue-sidebar-component.svg

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