# libj-vue-comp-sidenav

> This contains a `j-sidenav` hamburger vue component and a `j-sidenav-button` to show in top menu to toggle sidenav. Uses bootstrap 4 for styling

Latest version **1.1.0** (published 2019-08-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install libj-vue-comp-sidenav
pnpm add libj-vue-comp-sidenav
yarn add libj-vue-comp-sidenav
bun add libj-vue-comp-sidenav
```

## 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.1.0 |
| Published | 2019-08-16 |
| First published | 2019-08-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 16.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | saeidfarahi |

## Links

- npm: https://www.npmjs.com/package/libj-vue-comp-sidenav
- Repository: https://saeidfarahi@dev.azure.com/saeidfarahi/libj-vue-comp-sidenav/_git/libj-vue-comp-sidenav
- npm.io page: https://npm.io/package/libj-vue-comp-sidenav

## Dependencies (3)

- [libj-guid](https://npm.io/package/libj-guid.md) ^1.3.0
- [libj-window-scrollbar](https://npm.io/package/libj-window-scrollbar.md) ^1.1.0
- [libj-vue-comp-backdrops](https://npm.io/package/libj-vue-comp-backdrops.md) ^1.1.0

## Recent versions

- 1.1.0 (latest) — 2019-08-16
- 1.0.2 — 2019-08-14
- 1.0.1 — 2019-08-14

## README

# libj-vue-comp-sidenav
### Part of libj tools

This contains a `j-sidenav` hamburger vue component and a `j-sidenav-button` to show in top menu to toggle sidenav.
Uses bootstrap 4 for styling

__Needs jQuery to be available globally__

## Usage (npm)
```
npm install libj-vue-comp-sidenav
```

## With default theme
```
import 'libj-vue-comp-sidenav/dist/libj-vue-comp-sidenav.default.min.css'
import 'libj-vue-comp-sidenav'
// Now, j-sidenav and j-sidenav-button are available globally
```

## Customize theme
You'll need a separate .scss file like (showcase/showcase.scss):
```
// Set variables here
.
.
.
@import 'libj-vue-comp-sidenav/index.scss';
// Now override classes
.
.
.
```

### SCSS Variables:
```
//side nav
$j-sidenav-background: black !default;
//side nav button
$j-sidenav-button-color: white !default;
$j-sidenav-button-active-color: white !default;
```

## Test
- Run this in a separate command line to start node server
```
node server.js
```
- Run one of the following to re-create bundles
```
npm run dev
npm run dev:watch
```
- Navigate to http://localhost:3000

## Build
```
npm run build
npm run build:watch
```

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