A custom React Video Player component
npm install @zaaik/react-video-player!GitHub repo size
!GitHub language count
!GitHub forks
!Bitbucket open issues
!Bitbucket open pull requests

> @zaaik/react-video-player is a lightweight, zero-dependency video player for React, built with TypeScript and designed for full control and easy customization.
This project is still under development. Upcoming updates will focus on the following tasks:
- [ ] Loop mode
- [ ] Settings: Quality
- [ ] Settings: Download
Before getting started, make sure you meet the following requirements:
- React >= 18
To install @zaaik/react-video-player, follow these steps:
Linux, macOS and Windows:
```
npm install @zaaik/react-video-player
To use @zaaik/react-video-player, follow these steps:
`ts
import Video from "@zaaik/react-video-player";
import myVideo from "./video.mp4" / Import your video /
export default function MyApp({
return (
src={myVideo} / Or use src={"/video.mp4"} from public /
width={800}
height={400}
autoPlay={true} / Default 'false' /
muted={false} / Default 'true' /
settings={true} / Default 'true' /
/>
)
}
`
| Prop | Type | Default | Description |
|------------|---------|---------|-------------------------------------|
| src | string | β | Video source URL or imported file |width
| | number | β | Player width in pixels |height
| | number | β | Player height in pixels |autoPlay
| | boolean | false | Automatically starts video playback |muted
| | boolean | true | Starts the video muted |settings
| | boolean | true | Shows settings button |
To contribute to @zaaik/react-video-player, follow these steps:
1. Fork this repository.
2. Create a new branch: git checkout -b .git commit -m "
3. Make your changes and commit them: .git push origin
4. Push your branch to your fork:
5. Open a Pull Request.
Alternatively, you can check GitHubβs documentation on how to create a pull request.
For more detailed guidelines, please read the CONTRIBUTING.md file.
We would like to thank the following people who have contributed to this project:
ZaaikJS (Owner) |
Want to be part of this project? Click HERE and learn how to contribute.
This project is licensed. See the LICENSE file for more details.