# react-video-progress

> React component to show progress at video frame borders

Latest version **3.0.0** (published 2025-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-video-progress
pnpm add react-video-progress
yarn add react-video-progress
bun add react-video-progress
```

## Health

**Score 45/100 (D)** — status: stable.

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

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2025-08-04 |
| First published | 2020-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 0 |
| Unpacked size | 152.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Alex Oliynyk |
| Maintainers | jim_digriz |
| Keywords | react, video, progress, progressbar |

## Links

- npm: https://www.npmjs.com/package/react-video-progress
- Repository: https://github.com/asashay/react-video-progress
- Homepage: https://github.com/asashay/react-video-progress#readme
- Issues: https://github.com/asashay/react-video-progress/issues
- npm.io page: https://npm.io/package/react-video-progress

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2025-08-04
- 2.0.0-0 (next) — 2022-09-05
- 2.0.5 — 2024-06-02
- 2.0.4 — 2024-06-02
- 2.0.3 — 2024-03-24
- 2.0.2 — 2024-01-03
- 2.0.1 — 2023-08-20
- 2.0.0 — 2022-09-05
- 1.2.0 — 2021-01-28
- 1.1.9 — 2020-12-14
- 1.1.8 — 2020-10-27
- 1.1.7 — 2020-10-19
- 1.1.6 — 2020-09-22
- 1.1.5 — 2020-09-11
- 1.1.4 — 2020-08-31
- … 15 more at https://npm.io/package/react-video-progress/versions

## README

# React Video Progress

> React component to show video progress at the video frame border build in Typescript

[![NPM](https://img.shields.io/npm/v/react-video-progress.svg)](https://www.npmjs.com/package/react-video-progress) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![Build Status](https://travis-ci.org/asashay/react-video-progress.svg?branch=master)](https://travis-ci.org/asashay/react-video-progress) [![Coverage Status](https://coveralls.io/repos/github/asashay/react-video-progress/badge.svg?branch=master)](https://coveralls.io/github/asashay/react-video-progress?branch=master)

## Demo
![Video Progressbar Demo](demo/demo.gif)

[Live samples](https://asashay.github.io/react-video-progress/)

## Installation

```bash
npm install --save react-video-progress

yarn add react-video-progress
```


## Usage

```tsx
import React, { Component } from 'react'

import { VideoProgress } from 'react-video-progress'

class Example extends Component {
  render() {
    return <VideoProgress
      progressStart="BottomLeft"
      type="OneLine"
      pathColor="red"
      pathWidth="4px"
      pathBorderRadius="2px"
      src='http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4'
      height="200px"
      controls
      />
  }
}

// or in the functional component
const FunctionalComponentExample = () => {
  return <VideoProgress
    progressStart="BottomLeft"
    type="OneLine"
    pathColor="red"
    pathWidth="4px"
    pathBorderRadius="2px"
    src='http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4'
    height="200px"
    controls
  />
}
```

Also it takes in all the `<video>` props and passes them down to the underlying video element.


## Props
All props are **optional**.

* `pathColor`: String, default `red`
  * Any valid color string (e.g. `#ffffff, rgb(0,0,0)` )

* `pathWidth`: String, default `3px`
  * Any valid width value (e.g. `2em, .5rem`)

* `pathBorderRadius`: String, default `0`
  * Any valid border radius value (e.g. `2px, 5%`)

* `progressStart`: String, default `BottomLeft`
  * One of `BottomLeft, TopLeft, TopRight, BottomRight`

* `type`: String, default `OneLine`
  * One of `OneLine, TwoLines, BottomLine`

* `wrapperStyle`: Object, default `{ display: 'inline-block', position: 'relative'}`
  * inline styles for wrapper `div`

* `wrapperClassName`: String, default `''`
  * Class assigned to wrapper

* ...rest: any of [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement) props
  * Any of `<video>` attributes (e.g. `autoPlay, width, className` etc)

## License

MIT © [asashay](https://github.com/asashay)

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