@windover/video-transcript
v1.0.0
Published
<p align="center"> <a href="https://www.windover.com"> <img height="70" src="https://www.windover.com/wp-content/uploads/2023/12/Windover_CMYK-Blue_WindoverAndTagline_WindoverOnly.png" alt="Windover Construction" /> </a> </p>
Downloads
28
Readme
🎬 Windover Video Trancript
A reusable React component for displaying a synchronized transcript alongside a video player (e.g., Vimeo). Perfect for educational or media apps that need subtitle highlighting with video playback.

📦 Installation
Install the package via npm:
npm install @windover/video-transcript
Install the package via yarn:
yarn add @windover/video-transcript
🚀 Usage
📥 1. Import the Component
import "@windover/video-transcript/dist/index.css"
import WindoverVideoTranscript from '@windover/video-transcript';🧩 2. Use the Component in Your App
<WindoverVideoTranscript
tranScriptTitle="TranScript Box title"
videoLink="https://vimeo.com/${video_id}"
tranScriptLink="http://domain.com/file.srt"
/>🧠 Explanation of Props
| Prop | Type | Required | Description |
| ----------------- | -------- | -------- | ------------------------------------------------------------------------------------------ |
| videoLink | string | ✅ Yes | Link to the video you want to play (Must be Vimeo). |
| tranScriptLink | string | ✅ Yes | URL or link to the .srt file (subtitle transcript). Must be accessible from the browser. |
| tranScriptTitle | string | ✅ Yes | text that appears as a heading above the transcript viewer. |
