# vue-nprogress

> Slim progress bars is based on nprogress for Ajax'y applications

Latest version **0.2.0** (published 2020-09-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-nprogress
pnpm add vue-nprogress
yarn add vue-nprogress
bun add vue-nprogress
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2020-09-04 |
| First published | 2016-09-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 43.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 181 |
| Author | Fangdun Cai |
| Maintainers | fundon, luventa |
| Keywords | vue, vue-nprogress, nprogress, ajax |

## Links

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

## Dependencies (1)

- [nprogress](https://npm.io/package/nprogress.md) 0.2.0

## Recent versions

- 0.2.0 (latest) — 2020-09-04
- 0.1.5 — 2017-02-21
- 0.1.4 — 2016-12-05
- 0.1.3 — 2016-11-30
- 0.1.2 — 2016-10-23
- 0.1.1 — 2016-10-23
- 0.1.0 — 2016-10-12
- 0.0.0 — 2016-09-02

## README

# nprogress

Slim progress bars is based on [nprogress](https://github.com/rstacruz/nprogress) for Ajax'y applications


## Installation

```console
$ npm install vue-nprogress --save
```

## Examples

```vue
<template>
  <nprogress-container></nprogress-container>
</template>

<script>
import NprogressContainer from 'vue-nprogress/src/NprogressContainer'

export default {
  components: {
    NprogressContainer
  }
}
</script>
```

```js
import Vue from 'vue'
import NProgress from 'vue-nprogress'
import App from './App.vue'

Vue.use(NProgress)

const nprogress = new NProgress()

const app = new Vue({
  nprogress
  ...App
})

// APIs: see https://github.com/rstacruz/nprogress
// app.nprogress
// app.nprogress.start()
// app.nprogress.inc(0.2)
// app.nprogress.done()
// Component:
// this.$nprogress
```


## Configuration

```js
const options = {
  latencyThreshold: 200, // Number of ms before progressbar starts showing, default: 100,
  router: true, // Show progressbar when navigating routes, default: true
  http: false // Show progressbar when doing Vue.http, default: true
};
Vue.use(NProgress, options)
```

In order to overwrite the configuration for certain requests, use showProgressBar parameter in request/route's meta.

Like this:

```js
Vue.http.get('/url', { showProgressBar: false })
```
```js
const router = new VueRouter({
  routes: [
    {
      path: '/foo',
      component: Foo,
      meta: {
        showProgressBar: false
      }
    }
  ]
})
```


## Badges

![](https://img.shields.io/badge/license-MIT-blue.svg)
![](https://img.shields.io/badge/status-stable-green.svg)

---

> [fundon.me](https://fundon.me) &nbsp;&middot;&nbsp;
> GitHub [@fundon](https://github.com/fundon) &nbsp;&middot;&nbsp;
> Twitter [@_fundon](https://twitter.com/_fundon)

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