{"id":13990850,"url":"https://github.com/zzarcon/react-video-renderer","last_synced_at":"2025-04-06T04:12:28.338Z","repository":{"id":31940511,"uuid":"129981699","full_name":"zzarcon/react-video-renderer","owner":"zzarcon","description":"Build custom video players effortless ","archived":false,"fork":false,"pushed_at":"2023-01-07T04:08:33.000Z","size":1971,"stargazers_count":116,"open_issues_count":44,"forks_count":14,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-30T02:07:55.680Z","etag":null,"topics":["component","custom","player","react","render-prop","render-props","renderer","video","video-player"],"latest_commit_sha":null,"homepage":"https://zzarcon.github.io/react-video-renderer","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zzarcon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-18T00:43:45.000Z","updated_at":"2025-03-23T18:16:27.000Z","dependencies_parsed_at":"2023-01-14T20:15:18.170Z","dependency_job_id":null,"html_url":"https://github.com/zzarcon/react-video-renderer","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzarcon%2Freact-video-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzarcon%2Freact-video-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzarcon%2Freact-video-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzarcon%2Freact-video-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zzarcon","download_url":"https://codeload.github.com/zzarcon/react-video-renderer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430873,"owners_count":20937874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component","custom","player","react","render-prop","render-props","renderer","video","video-player"],"created_at":"2024-08-09T13:03:24.033Z","updated_at":"2025-04-06T04:12:28.269Z","avatar_url":"https://github.com/zzarcon.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","React"],"sub_categories":["React Components"],"readme":"# react-video-renderer [![Build Status](https://travis-ci.org/zzarcon/react-video-renderer.svg?branch=master)](https://travis-ci.org/zzarcon/react-video-renderer)\n\n\u003e Build custom video players effortless\n\n* Render props, get all video state passed down as props.\n* Bidirectional flow to render and update the video state in a declarative way.\n* No side effects out of the box, you just need to build the UI.\n* Actions handling: play, pause, mute, unmute, navigate, etc\n* Dependency free, [\u003c2KB size](https://bundlephobia.com/result?p=react-video-renderer)\n* Cross-browser support, no more browser hacks.\n\n## Demo 🎩\n\n[https://zzarcon.github.io/react-video-renderer](https://zzarcon.github.io/react-video-renderer)\n\n## Installation 🚀\n\n```bash\nyarn add react-video-renderer\n```\n\n## Usage ⛏\n\n\u003e Render video state and communicate user interactions up when volume or time changes.\n\n```jsx\nimport Video from 'react-video-renderer';\n\n\u003cVideo src=\"https://mysite.com/video.mp4\"\u003e\n  {(video, state, actions) =\u003e (\n    \u003cdiv\u003e\n      {video}\n      \u003cdiv\u003e{state.currentTime} / {state.duration} / {state.buffered}\u003c/div\u003e\n      \u003cprogress value={state.currentTime} max={state.duration} onChange={actions.navigate} /\u003e\n      \u003cprogress value={state.volume} max={1} onChange={actions.setVolume} /\u003e\n      \u003cbutton onClick={actions.play}\u003ePlay\u003c/button\u003e\n      \u003cbutton onClick={actions.pause}\u003ePause\u003c/button\u003e\n      \u003cbutton onClick={actions.requestFullScreen}\u003eFullscreen\u003c/button\u003e\n    \u003c/div\u003e\n  )}\n\u003c/Video\u003e\n```\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"example/video-renderer-flow.png\" alt=\"Logo\" \u003e\n  \u003cbr\u003e\u003cbr\u003e\n\u003c/div\u003e\n\n## Api 💅\n\n### Props\n\n```typescript\ninterface Props {\n  src: string;\n  children: RenderCallback;\n  controls?: boolean;\n  autoPlay?: boolean;\n  preload?: string;\n  textTracks?: VideoTextTracks;\n}\n```\n\n### Render method\n\n```typescript\ntype RenderCallback = (reactElement: ReactElement\u003cHTMLMediaElement\u003e, state: VideoState, actions: VideoActions, ref: React.RefObject\u003cHTMLMediaElement\u003e) =\u003e ReactNode;\n```\n\n### State\n\n```typescript\ninterface VideoState {\n  status: 'playing' | 'paused' | 'errored';\n  currentTime: number;\n  currentActiveCues: (kind: VideoTextTrackKind, lang: string) =\u003e TextTrackCueList | null | undefined;\n  volume: number;\n  duration: number;\n  buffered: number;\n  isMuted: boolean;\n  isLoading: boolean;\n  error?: MediaError | null;\n}\n```\n\n### Actions\n\n```typescript\ninterface VideoActions {\n  play: () =\u003e void;\n  pause: () =\u003e void;\n  navigate: (time: number) =\u003e void;\n  setVolume: (volume: number) =\u003e void;\n  requestFullscreen: () =\u003e void;\n  mute: () =\u003e void;\n  unmute: () =\u003e void;\n  toggleMute: () =\u003e void;\n}\n```\n\n## Error handling 💥\n\n\u003e this is all you need to detect video errors\n\n```jsx\n\u003cVideo src=\"some-error-video.mov\"\u003e\n  {(video, state) =\u003e {\n    if (state.status === 'errored') {\n      return (\n        \u003cErrorWrapper\u003e\n          Error\n        \u003c/ErrorWrapper\u003e\n      );\n    }\n\n    return (\n      \u003cdiv\u003e\n        {video}\n      \u003c/div\u003e\n    )\n  }}\n\u003c/Video\u003e\n```\n\n## Loading state ✨\n\n\u003e you can still interact with the player regardless if the video is loading or not\n\n```jsx\n\u003cVideo src=\"my-video.mp4\"\u003e\n  {(video, state, actions) =\u003e {\n    const loadingComponent = state.isLoading ? 'loading...' : undefined;\n\n    return (\n      \u003cdiv\u003e\n        {video}\n        {loadingComponent}\n        \u003cbutton onClick={actions.play}\u003ePlay\u003c/button\u003e\n        \u003cbutton onClick={actions.pause}\u003ePause\u003c/button\u003e\n      \u003c/div\u003e\n    )\n  }}\n\u003c/Video\u003e\n```\n\n## Video text tracks 🚂\n\n\u003e HTML5 [text tracks](https://html.spec.whatwg.org/multipage/media.html#the-track-element) support for videos.\n\u003e\n\u003e subtitles can be rendered natively, or they can be rendered using `VideoState.currentActiveCues` property:\n\n```jsx\n\u003cVideo \n  src=\"my-video.mp4\"\n  textTracks={{\n    'subtitles': {\n      selectedTrackIndex: 0,\n      tracks: [\n        { src: 'subtitles-en.vtt', lang: 'en', label: 'Subtitles (english)' },\n        { src: 'subtitles-es.vtt', lang: 'es', label: 'Subtitles (spanish)' },\n      ]\n    }\n  }}\n\u003e\n  {(video, state, actions) =\u003e {\n    const cues = state.currentActiveCues('subtitles', 'en');\n    const subtitles =\n      cue \u0026\u0026 cue.length \u003e 0 ? (\n        \u003cdiv\u003e\n          {Array.prototype.map.call(cues, (cue, i) =\u003e \u003cspan key={i}\u003e{cue.text}\u003c/span\u003e)}\n        \u003c/div\u003e\n      ) : undefined;\n\n    return (\n      \u003cdiv\u003e\n        {video}\n        {subtitles}\n        \u003cbutton onClick={actions.play}\u003ePlay\u003c/button\u003e\n        \u003cbutton onClick={actions.pause}\u003ePause\u003c/button\u003e\n      \u003c/div\u003e\n    )\n  }}\n\u003c/Video\u003e\n```\n\n## Author 🧔\n\n[@zzarcon](https://twitter.com/zzarcon)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzarcon%2Freact-video-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzzarcon%2Freact-video-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzarcon%2Freact-video-renderer/lists"}