# react-video-thumbnail

> Create a thumbnail by providing a video url

Latest version **0.1.3** (published 2018-04-19) · ISC license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2018-04-19 |
| First published | 2018-04-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 54.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | brothatru |
| Maintainers | brothatru |
| Keywords | react, thumbnail, thumnail, generator, creator, generate, create |

## Links

- npm: https://www.npmjs.com/package/react-video-thumbnail
- npm.io page: https://npm.io/package/react-video-thumbnail

## 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

- 0.1.3 (latest) — 2018-04-19
- 0.1.2 — 2018-04-19
- 0.1.1 — 2018-04-19
- 0.1.0 — 2018-04-19

## README

# React Video Thumbnail
Given a video url, attempt to generate a video thumbnail using HTML Canvas Element

Note*: The **`<Canvas>`** element will only be able to generate a thumbnail, if CORS allows it.

If not, you may see a similar console error as below:
```
DOMException: Failed to execute 'toDataURL' on 'HTMLCanvasElement': Tainted canvases may not be exported.
```

Please read about [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), if you would like more details on how it works.


## Installation

```bash
git clone https://github.com/brothatru/react-video-thumbnail.git
```
OR
```bash
npm install --save-dev react-video-thumbnail
```

## Usage

```es6
import VideoThumbnail from 'react-video-thumbnail'; // use npm published version
...
<VideoThumbnail
    videoUrl="https://dl.dropboxusercontent.com/s/7b21gtvsvicavoh/statue-of-admiral-yi-no-audio.mp4?dl=1"
    thumbnailHandler={(thumbnail) => console.log(thumbnail)}
    width={120}
    height={80}
    />
```


## Properties

| Prop Name | Type | Default | Description |
| --- | --- | --- | --- |
| **videoUrl** (Required) | **string** | | The url of the video you want to generate a thumbnail from |
| **cors** | **bool** | false |Whether or not to set **crossOrigin** attribute to **anonymous**. |
| **height** | **int** | | Resize thumbnail to specified height |
| **renderThumbnail** | **bool** | true | Whether to render an image tag and show the thumbnail or not. |
| **snapshotAtTime** | **int** | 2 | The second at which the component should snap the image at. |
| **thumbnailHandler** | **func** | | Callback function that takes in **thumbnail** url as an argument |
| **width** | **int** | | Resize thumbnail to specified width |

*Note: The longer the snapshotAtTime, the more video data it may have to download.

## Examples


## Contributors

- mike trieu [@brothatru](https://github.com/brothatru)

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