React

Quick Start

Get started with BProgress in your React application

Import

import { ProgressProvider } from '@bprogress/react';

Usage

<ProgressProvider>
  ...
</ProgressProvider>

Example

src/index.tsx
import React from 'react';
import ReactDOM from 'react-dom/client';
import './index.css';
import App from './App';
import { ProgressProvider } from '@bprogress/react';
 
const root = ReactDOM.createRoot(
  document.getElementById('root') as HTMLElement,
);
root.render(
  <React.StrictMode>
    <ProgressProvider>
      <App />
    </ProgressProvider>
  </React.StrictMode>,
);
src/App.tsx
import { useProgress } from '@bprogress/react';
 
function App() {
  const { start, stop, pause, resume } = useProgress();
 
  return (
    <div className="App">
      <button onClick={start}>Start</button>
      <button onClick={stop}>Stop</button>
      <button onClick={pause}>Pause</button>
      <button onClick={resume}>Resume</button>
    </div>
  );
}
 
export default App;

On this page