react-nprogress
A React primitive for building slim progress bars.
Background | Usage | Live Examples | API | Installation | License
Background
This is a React port of rstacruz's nprogress module. It exposes an API that encapsulates the logic of nprogress and renders nothing, giving you complete control over rendering.
Usage
In the following examples, Container, Bar and Spinner are custom components.
Hook
import { useNProgress } from '@tanem/react-nprogress'
import React from 'react'
import { render } from 'react-dom'
import Bar from './Bar'
import Container from './Container'
import Spinner from './Spinner'
const Progress = ({ isAnimating }) => {
const { animationDuration, isFinished, progress } = useNProgress({
isAnimating,
})
return (
<Container animationDuration={animationDuration} isFinished={isFinished}>
<Bar animationDuration={animationDuration} progress={progress} />
<Spinner />
</Container>
)
}
render(<Progress isAnimating />, document.getElementById('root'))Render Props
import { NProgress } from '@tanem/react-nprogress'
import React from 'react'
import { render } from 'react-dom'
import Bar from './Bar'
import Container from './Container'
import Spinner from './Spinner'
render(
<NProgress isAnimating>
{({ animationDuration, isFinished, progress }) => (
<Container animationDuration={animationDuration} isFinished={isFinished}>
<Bar animationDuration={animationDuration} progress={progress} />
<Spinner />
</Container>
)}
</NProgress>,
document.getElementById('root')
)HOC
import { withNProgress } from '@tanem/react-nprogress'
import React from 'react'
import { render } from 'react-dom'
import Bar from './Bar'
import Container from './Container'
import Spinner from './Spinner'
const Inner = ({ animationDuration, isFinished, progress }) => (
<Container animationDuration={animationDuration} isFinished={isFinished}>
<Bar animationDuration={animationDuration} progress={progress} />
<Spinner />
</Container>
)
const Enhanced = withNProgress(Inner)
render(<Enhanced isAnimating />, document.getElementById('root'))Live Examples
- HOC: Source | Sandbox
- Material UI: Source | Sandbox
- Multiple Instances: Source | Sandbox
- Next Router: Source | Sandbox
- Original Design: Source | Sandbox
- Plain JS: Source | Sandbox
- Reach Router: Source | Sandbox
- React Router V5: Source | Sandbox
- React Router V6: Source | Sandbox
- Render Props: Source | Sandbox
- UMD Build (Development): Source | Sandbox
- UMD Build (Production): Source | Sandbox
API
Props
animationDuration- Optional Number indicating the animation duration inms. Defaults to200.incrementDuration- Optional Number indicating the length of time between progress bar increments inms. Defaults to800.isAnimating- Optional Boolean indicating if the progress bar is animating. Defaults tofalse.minimum- Optional Number between0and1indicating the minimum value of the progress bar. Defaults to0.08.
Hook Example
const Progress = ({
animationDuration,
incrementDuration,
isAnimating,
minimum
}) => {
const { isFinished, progress } = useNProgress({
animationDuration,
incrementDuration,
isAnimating,
minimum
})
return (
<Container animationDuration={animationDuration} isFinished={isFinished}>
<Bar animationDuration={animationDuration} progress={progress} />
<Spinner />
</Container>
)
}
<Progress
animationDuration={300}
incrementDuration={500}
isAnimating
minimum={0.1}
/>Render Props Example
<NProgress
animationDuration={300}
incrementDuration={500}
isAnimating
minimum={0.1}
>
{({ animationDuration, isFinished, progress }) => (
<Container animationDuration={animationDuration} isFinished={isFinished}>
<Bar animationDuration={animationDuration} progress={progress} />
<Spinner />
</Container>
)}
</NProgress>HOC Example
const Inner = ({ animationDuration, isFinished, progress }) => (
<Container animationDuration={animationDuration} isFinished={isFinished}>
<Bar animationDuration={animationDuration} progress={progress} />
<Spinner />
</Container>
)
const Enhanced = withNProgress(Inner)
<Enhanced
animationDuration={300}
incrementDuration={500}
isAnimating
minimum={0.1}
/>Installation
$ npm install @tanem/react-nprogress
There are also UMD builds available via unpkg:
- https://unpkg.com/@tanem/react-nprogress/dist/react-nprogress.umd.development.js
- https://unpkg.com/@tanem/react-nprogress/dist/react-nprogress.umd.production.js
For the non-minified development version, make sure you have already included:
For the minified production version, make sure you have already included:
License
MIT
![@renovate[bot]](https://web.archive.org/web/20230330052211im_/https://avatars.githubusercontent.com/in/2740?s=64&v=4){kind=small}
![@dependabot[bot]](https://web.archive.org/web/20230330052211im_/https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}