# vtril-progress

> This package adds an [NProgress](https://ricostacruz.com/nprogress/) page loading indicator to your Inertia.js app.

Latest version **2.0.0** (published 2021-05-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install vtril-progress
pnpm add vtril-progress
yarn add vtril-progress
bun add vtril-progress
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-05-03 |
| First published | 2021-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 36.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | anubra266 |
| Maintainers | anubra266 |

## Links

- npm: https://www.npmjs.com/package/vtril-progress
- npm.io page: https://npm.io/package/vtril-progress

## Dependencies (1)

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

## Recent versions

- 2.0.0 (latest) — 2021-05-03
- 1.0.1 — 2021-04-28
- 1.0.0 — 2021-04-28

## README

# Inertia.js Progress

This package adds an [NProgress](https://ricostacruz.com/nprogress/) page loading indicator to your Inertia.js app.

## Installation

```bash
npm install vtril-progress
yarn add vtril-progress
```

Once it's been installed, initialize it in your app:

```js
import VtrilProgress from "vtril-progress";

VtrilProgress.init({
  // The delay after which the progress bar will
  // appear during navigation, in milliseconds.
  delay: 250,

  // The color of the progress bar.
  color: "#29d",

  // Whether to include the default NProgress styles.
  includeCSS: true,

  // Whether the NProgress spinner will be shown.
  showSpinner: false,
});
```

### Disable for an Inertia Request

```js
VtrilProgress.disable(() => {
  Inertia.post("/notification-seen");
});
```

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