{"id":13450480,"url":"https://github.com/vardius/react-peer-data","last_synced_at":"2025-03-21T23:33:42.882Z","repository":{"id":34911777,"uuid":"187557648","full_name":"vardius/react-peer-data","owner":"vardius","description":"React wrapper for PeerData library for files, media streaming/sharing using WebRTC.","archived":false,"fork":false,"pushed_at":"2022-12-10T15:21:12.000Z","size":974,"stargazers_count":20,"open_issues_count":13,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T04:36:18.627Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/vardius.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["vardius"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-05-20T02:53:55.000Z","updated_at":"2022-01-16T01:38:36.000Z","dependencies_parsed_at":"2023-01-15T10:16:39.752Z","dependency_job_id":null,"html_url":"https://github.com/vardius/react-peer-data","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Freact-peer-data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Freact-peer-data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Freact-peer-data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vardius%2Freact-peer-data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vardius","download_url":"https://codeload.github.com/vardius/react-peer-data/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221820606,"owners_count":16886222,"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":[],"created_at":"2024-07-31T07:00:35.026Z","updated_at":"2024-10-28T11:15:25.190Z","avatar_url":"https://github.com/vardius.png","language":"TypeScript","funding_links":["https://github.com/sponsors/vardius"],"categories":["Packages"],"sub_categories":[],"readme":"React WebRTC - PeerData\n================\n[![Build Status](https://travis-ci.org/vardius/react-peer-data.svg?branch=master)](https://travis-ci.org/vardius/react-peer-data)\n[![npm version](https://img.shields.io/npm/v/react-peer-data.svg)](https://www.npmjs.com/package/react-peer-data)\n[![npm downloads](https://img.shields.io/npm/dm/react-peer-data.svg)](https://www.npmjs.com/package/react-peer-data)\n[![license](https://img.shields.io/github/license/vardius/react-peer-data.svg)](LICENSE)\n[![codecov](https://codecov.io/gh/vardius/react-peer-data/branch/master/graph/badge.svg)](https://codecov.io/gh/vardius/react-peer-data)\n\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Content\u003c/summary\u003e\n\n\u003c!-- toc --\u003e\n- [About](#about)\n- [How to use](#how-to-use)\n  - [Installation](#installation)\n  - [Examples](#examples)\n    - [Hook](#hook)\n    - [HOC](#hoc)\n- [License](#license)\n\u003c!-- tocstop --\u003e\n\n\u003c/details\u003e\n\nABOUT\n==================================================\nReact wrapper for PeerData library for files, media streaming/sharing using WebRTC.\n\nContributors:\n\n* [Rafał Lorenz](http://rafallorenz.com)\n\nWant to contribute ? Feel free to send pull requests!\n\nHave problems, bugs, feature ideas?\nWe are using the github [issue tracker](https://github.com/vardius/react-peer-data/issues) to manage them.\n\n\u003c!-- ![Dashboard](../master/.github/kubernetes-dashboard-overview.png)\n![Dashboard](../master/.github/kubernetes-dashboard-pods.png) --\u003e\n\nHOW TO USE\n==================================================\n\n1. [Chat Example](https://github.com/vardius/react-webrtc-chat)\n\n## Getting started\n### Installation\n```bash\nnpm install react-peer-data\n```\n### Examples\nUse `PeerDataProvider` to instantiate and pass peerData object down the component tree\n```javascript\nimport React from 'react';\nimport ReactDOM from 'react-dom';\nimport { EventDispatcher } from \"peer-data\";\nimport { PeerDataProvider } from 'react-peer-data';\n\nimport App from './App';\n\nReactDOM.render(\n    \u003cPeerDataProvider\n        servers={{ iceServers: [{ url: \"stun:stun.1.google.com:19302\" }] }}\n        constraints={{ ordered: true }}\n        signaling={{ dispatcher: new EventDispatcher() }}\n    \u003e\n        \u003cApp /\u003e\n    \u003c/PeerDataProvider\u003e,\n    document.getElementById(\"root\")\n);\n```\nYou can access peerData context value in two ways:\n#### Hook\n```javascript\nimport React, { useEffect } from 'react';\nimport { usePeerData } from 'react-peer-data';\n\nfunction App() {\n  const peerData = usePeerData();\n\n  useEffect(() =\u003e {\n      const stream = await navigator.mediaDevices.getUserMedia({ audio: true, video: true });\n      const room = peerData.connect('my-room', stream);\n      room\n        .on(\"participant\", participant =\u003e {\n            participant\n                .on(\"disconnected\", () =\u003e { console.log('disconnected', participant.id); })\n                .on(\"track\", event =\u003e { console.log('stream', participant.id, event.streams[0]); })\n                .on(\"message\", payload =\u003e { console.log(participant.id, payload); })\n                .on(\"error\", event =\u003e {\n                    console.error('peer', participant.id, event);\n                    participant.renegotiate();\n                });\n        })\n        .on(\"error\", event =\u003e { console.error('room', name, event); });\n\n      return () =\u003e room.disconnect()\n  }, [peerData]);\n\n  return null; // @TODO: render participants\n}\n\nexport default App;\n```\n#### HOC\n```javascript\nimport React from 'react';\nimport { withPeerData } from 'react-peer-data';\n\nfunction App({ peerData }) {\n  // follow example from above\n\n  return null; // @TODO: render participants\n}\n\nexport default withPeerData(App);\n```\n\nLicense\n-------\n\nThis package is released under the MIT license. See the complete license in the package:\n\n[LICENSE](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvardius%2Freact-peer-data","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvardius%2Freact-peer-data","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvardius%2Freact-peer-data/lists"}