# vue-ultra-sidenav

> Vue sidenav, ultra flexible

Latest version **1.1.0** (published 2020-03-15) · 0 weekly downloads

## Install

```sh
npm install vue-ultra-sidenav
pnpm add vue-ultra-sidenav
yarn add vue-ultra-sidenav
bun add vue-ultra-sidenav
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-03-15 |
| First published | 2019-10-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jesus Escamilla |
| Maintainers | jaes_10 |
| Keywords | vue, sidenav |

## Links

- npm: https://www.npmjs.com/package/vue-ultra-sidenav
- Repository: https://github.com/jesus9ias/vue-ultra-sidenav
- Homepage: https://github.com/jesus9ias/vue-ultra-sidenav#readme
- Issues: https://github.com/jesus9ias/vue-ultra-sidenav/issues
- npm.io page: https://npm.io/package/vue-ultra-sidenav

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.6.10
- [core-js](https://npm.io/package/core-js.md) ^2.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.1.0 (latest) — 2020-03-15
- 1.0.2 — 2019-11-17
- 1.0.1 — 2019-10-28
- 1.0.0 — 2019-10-28

## README

# vue-ultra-sidenav

Implement a customizable sidenav component.

## Install
```
npm install --save vue-ultra-sidenav
```

## Import components
```
import {
  Sidenav,
  SidenavLink,
  SidenavOption,
  SidenavGroup
} from 'vue-ultra-sidenav';
```

## Basic usage

A propertie can define if sidenav is open or not.
When Close button or backdrop (is used) is clicked then close event is emitted.

```
<template>
  <sidenav
    :is-open="isOpenSidenav"
    @close="closeSidenav"
  >
    <sidenav-group title="Info Group">
      <sidenav-option
        @click="$router.push('/')"
      >
        Go Home
      </sidenav-option>
    </sidenav-group>

    <sidenav-group title="Links">
      <sidenav-link
        :url="'https://google.com'"
        :target="'blank'"
      >
        Google
      </sidenav-link>
      <sidenav-link
        :url="'https://github.com'"
        :target="'blank'"
      >
        Github
      </sidenav-link>
    </sidenav-group>
  </sidenav>
</template>

<script>
export default {
  name: 'sidenav',
  data() {
    return {
      isOpenSidenav: true
    };
  },
  methods: {
    closeSidenav() {
      this.isOpenSidenav = false;
    }
  }
};
</script>
```


## Props and events definition

#### Sidenav

|Prop       |Type                            |Default                        |Description                               |
|-----------|--------------------------------|-------------------------------|------------------------------------------|
|isOpen     |boolean                         |false                          |Defines if sidenav is open or not         |
|backdrop   |boolean                         |true                           |Defines if backdrop is used or not        |
|transition |string (Name of css transition) |fade (Defined on internal css) |Set css animation to open and close event |
|closeIcon  |string (Path to proyect image)  |null (Internal icon is used)   |Send icon to use on close button          |
|fixLeft    |boolean                         |true                           |Fix to ledt side                          |

## Contribution

All pull requests and suggestions are welcome.

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