https://github.com/midori-profile/overlay-video
🎬 This is a high-performance web animation react component with minimal development cost.
https://github.com/midori-profile/overlay-video
high-performance react react-component react-library web-animation webgl
Last synced: 24 days ago
JSON representation
🎬 This is a high-performance web animation react component with minimal development cost.
- Host: GitHub
- URL: https://github.com/midori-profile/overlay-video
- Owner: midori-profile
- Created: 2024-04-04T11:02:59.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-24T12:02:12.000Z (11 months ago)
- Last Synced: 2025-03-26T10:48:04.668Z (about 1 month ago)
- Topics: high-performance, react, react-component, react-library, web-animation, webgl
- Language: TypeScript
- Homepage: https://midori-portfolio.vercel.app/blog/web-animation
- Size: 485 KB
- Stars: 91
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a high-performance web animation React component. For more details, refer to this article: [How to Achieve High-Performance Web Animations at Zero Development Cost](https://midori-portfolio.vercel.app/blog/web-animation).
## Features:
1. **Low development cost**: Designers can directly turn AE-exported video resources into web animations, resulting in zero communication development costs.
2. **Small resource size**: Utilizes the advantages of video compression algorithms to achieve resource volumes far smaller than image frame sequences.
3. **High fidelity**: Completely reproduces effects designed by designers.
4. **High performance and compatibility**: Runs well even on low-end devices like iOS 9 and works well in browsers that support WebGL.
## Preview
Check out the effect on this webpage: [overlay-video-preview](https://overlay-video-preview.vercel.app/)
## Installation
Add the following line to your `.npmrc` file:
```
@midori-profile:registry=https://npm.pkg.github.com
```
Then install the package:
```sh
npm install @midori-profile/overlay-video
```
## Usage
### Props
| Prop Name | Type | Default | Required | Description | Usage Example |
|------------------|---------------|--------------------------|----------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
| path | String | | Yes | Path to the animation resource. Supports both relative and remote URLs. For remote paths, ensure CORS headers. | `` |
| resourceWidth | Number | 800 | No | Width of the video resource used by the component (in px). | `` |
| resourceHeight | Number | 400 | No | Height of the video resource used by the component (in px). | `` |
| loop | Boolean | false | No | Whether the animation loops. | `` |
| autoplay | Boolean | false | No | Whether the animation plays automatically. | `` |
| canvasStyle | Object | {} | No | CSS styles for the animation canvas. | `` |
| onerror | Function | | No | Function to handle component errors. | `` |
| ref | Object | | No | Reference to access play and pause methods. | ` overlayVideoRef.current?.play(); overlayVideoRef.current?.pause();` |
### Example Usage
```js
import OverlayVideo from '@midori-profile/overlay-video';
import video from './resource.mp4';
const overlayVideoRef = useRef<{ play: () => void; pause: () => void } | null>(null);
const handlePlay = () => {
overlayVideoRef.current?.play();
};
const handlePause = () => {
overlayVideoRef.current?.pause();
};
return (
Play
Pause
);
```
### Tips
- The final animation renders on a canvas, which can be styled using `canvasStyle`. For responsive design, you can set `canvasStyle="width:100%;"`.
- **resourceHeight** and **resourceWidth** refer to the dimensions of the video resource (in px), not the animation component. The animation component's dimensions are controlled via CSS. To avoid distortion, set the animation component's aspect ratio to match the video resource's aspect ratio.
- Handling Video in React
To include video files in React, you can import them directly:
```js
import video from './resource.mp4';
```
In your `webpack.config.js`, add a rule to handle `.mp4` files:
```js
{
test: /\.mp4$/,
use: 'file-loader?name=videos/[name].[ext]',
}
```
### Example Project
For detailed usage, refer to this example project: [overlay-video-example](https://github.com/midori-profile/overlay-video/tree/master/example/react).