https://github.com/inertiajs/progress
This package adds an NProgress page loading indicator to your Inertia.js app.
https://github.com/inertiajs/progress
Last synced: 4 months ago
JSON representation
This package adds an NProgress page loading indicator to your Inertia.js app.
- Host: GitHub
- URL: https://github.com/inertiajs/progress
- Owner: inertiajs
- License: mit
- Created: 2020-09-22T17:50:44.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-25T12:01:13.000Z (over 2 years ago)
- Last Synced: 2025-04-08T01:35:02.876Z (8 months ago)
- Language: JavaScript
- Size: 33.2 KB
- Stars: 78
- Watchers: 5
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
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 @inertiajs/progress
yarn add @inertiajs/progress
```
Once it's been installed, initialize it in your app:
```js
import { InertiaProgress } from '@inertiajs/progress'
InertiaProgress.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,
})
```