react-create-html-video 1.1.0 → 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sricharan Krishnan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,13 +1,20 @@
 ![component-preview-compressed](https://github.com/user-attachments/assets/2f791123-8aa4-4118-b031-a087fcd70ebf)
+![npm](https://img.shields.io/npm/v/react-create-html-video)
+![downloads](https://img.shields.io/npm/dw/react-create-html-video)
+![license](https://img.shields.io/npm/l/react-create-html-video)
+
 ## React Create HTML Video
+
 A lightweight React component that programmatically generates and plays an HTML `<video>` element with a clean, reusable API. This library does not rely on CSS-in-JS, with styles are intentionally kept minimal. Created with Typescript support.
 
 ### 📦 Installation
+
 ```console
 npm install react-create-html-video
 ```
 
 ### 🎲 Features
+
 1. Built for modern React with support for Typescript
 2. A lightweight API surface that is easy to understand
 3. Helps render a native HTML `<video>` element on the browser
@@ -15,27 +22,33 @@ npm install react-create-html-video
 5. No manual CSS import is required — styles are bundled with the package.
 
 ### 📄 API Type Signature
+
 ```javascript
 export type TReactCreateHTMLVideo = {
   mp4: string;
   webm: string;
 };
 ```
+
 ### 🤝 Peer Dependencies
+
 ```javascript
 "peerDependencies": {
   "react": ">=17",
   "react-dom": ">=17"
 }
 ```
+
 ### 🧪 How This Works
-1. Detects browser support using ```HTMLVideoElement.canPlayType```
+
+1. Detects browser support using `HTMLVideoElement.canPlayType`
 2. Prefers MP4 if supported
 3. Falls back to WebM if MP4 is unavailable
 4. Disables video rendering on Internet Explorer
-5. Returns ```null``` when no supported format is available
+5. Returns `null` when no supported format is available
 
 ### 🔤 Example Usage
+
 ```javascript
 /* node modules */
 import { ReactCreateHTMLVideo } from "react-create-html-video";
@@ -56,9 +69,38 @@ function UIComponent() {
 /* exports */
 export default UIComponent;
 ```
+
+### 📗 Test Coverage
+
+```
+PASS  src/video-component/test/index.test.tsx
+  RCHV Test Suite:
+    ✓ renders null when videoSource is null
+    ✓ renders video container when videoSource is provided
+    ✓ renders video element with correct attributes
+    ✓ sets video src to the videoSource from useVideo hook
+    ✓ passes correct props to useVideo hook
+    ✓ memoizes component and does not re-render with same props
+    ✓ renders video element inside parent container
+    ✓ updates when videoSource changes
+    ✓ returns null when videoSource is falsy
+    ✓ renders only one video element
+```
+
+```
+-----------|---------|----------|---------|---------|-------------------
+File       | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
+-----------|---------|----------|---------|---------|-------------------
+All files  |     100 |      100 |     100 |     100 |
+ index.tsx |     100 |      100 |     100 |     100 |
+-----------|---------|----------|---------|---------|-------------------
+```
+
 ### 📘 Contributing
+
 Contributions, suggestions, and improvements are welcome.<br/>
 Feel free to open issues or pull requests.
 
 ### ❤️ Support
+
 Like this project? Support it with a github star, it would mean a lot to me! Cheers and Happy Coding.