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

1import { useNProgress } from '@tanem/react-nprogress'
2import React from 'react'
3import { render } from 'react-dom'
4
5import Bar from './Bar'
6import Container from './Container'
7import Spinner from './Spinner'
8
9const Progress = ({ isAnimating }) => {
10  const { animationDuration, isFinished, progress } = useNProgress({
11    isAnimating,
12  })
13
14  return (
15    <Container animationDuration={animationDuration} isFinished={isFinished}>
16      <Bar animationDuration={animationDuration} progress={progress} />
17      <Spinner />
18    </Container>
19  )
20}
21
22render(<Progress isAnimating />, document.getElementById('root'))

Render Props

1import { NProgress } from '@tanem/react-nprogress'
2import React from 'react'
3import { render } from 'react-dom'
4
5import Bar from './Bar'
6import Container from './Container'
7import Spinner from './Spinner'
8
9render(
10  <NProgress isAnimating>
11    {({ animationDuration, isFinished, progress }) => (
12      <Container animationDuration={animationDuration} isFinished={isFinished}>
13        <Bar animationDuration={animationDuration} progress={progress} />
14        <Spinner />
15      </Container>
16    )}
17  </NProgress>,
18  document.getElementById('root')
19)

HOC

1import { withNProgress } from '@tanem/react-nprogress'
2import React from 'react'
3import { render } from 'react-dom'
4
5import Bar from './Bar'
6import Container from './Container'
7import Spinner from './Spinner'
8
9const Inner = ({ animationDuration, isFinished, progress }) => (
10  <Container animationDuration={animationDuration} isFinished={isFinished}>
11    <Bar animationDuration={animationDuration} progress={progress} />
12    <Spinner />
13  </Container>
14)
15
16const Enhanced = withNProgress(Inner)
17
18render(<Enhanced isAnimating />, document.getElementById('root'))

Live Examples

• HOC: Source | Sandbox
• Material UI: Source | Sandbox
• Multiple Instances: Source | Sandbox
• Next Pages 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 in ms. Defaults to 200.
• incrementDuration - Optional Number indicating the length of time between progress bar increments in ms. Defaults to 800.
• isAnimating - Optional Boolean indicating if the progress bar is animating. Defaults to false.
• minimum - Optional Number between 0 and 1 indicating the minimum value of the progress bar. Defaults to 0.08.

Hook Example

1const Progress = ({
2  animationDuration,
3  incrementDuration,
4  isAnimating,
5  minimum
6}) => {
7  const { isFinished, progress } = useNProgress({
8    animationDuration,
9    incrementDuration,
10    isAnimating,
11    minimum
12  })
13
14  return (
15    <Container animationDuration={animationDuration} isFinished={isFinished}>
16      <Bar animationDuration={animationDuration} progress={progress} />
17      <Spinner />
18    </Container>
19  )
20}
21
22<Progress
23  animationDuration={300}
24  incrementDuration={500}
25  isAnimating
26  minimum={0.1}
27/>

Render Props Example

1<NProgress
2  animationDuration={300}
3  incrementDuration={500}
4  isAnimating
5  minimum={0.1}
6>
7  {({ animationDuration, isFinished, progress }) => (
8    <Container animationDuration={animationDuration} isFinished={isFinished}>
9      <Bar animationDuration={animationDuration} progress={progress} />
10      <Spinner />
11    </Container>
12  )}
13</NProgress>

HOC Example

1const Inner = ({ animationDuration, isFinished, progress }) => (
2  <Container animationDuration={animationDuration} isFinished={isFinished}>
3    <Bar animationDuration={animationDuration} progress={progress} />
4    <Spinner />
5  </Container>
6)
7
8const Enhanced = withNProgress(Inner)
9
10<Enhanced
11  animationDuration={300}
12  incrementDuration={500}
13  isAnimating
14  minimum={0.1}
15/>

Installation

$ npm install @tanem/react-nprogress

UMD builds are also available for use with pre-React 19 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:

• React
• ReactDOM

For the minified production version, make sure you have already included:

• React
• ReactDOM

License

MIT