https://github.com/jitsi/jitsi-meet-react-sdk
React SDK for Jitsi Meet
https://github.com/jitsi/jitsi-meet-react-sdk
jitsi-meet react
Last synced: 2 months ago
JSON representation
React SDK for Jitsi Meet
- Host: GitHub
- URL: https://github.com/jitsi/jitsi-meet-react-sdk
- Owner: jitsi
- License: apache-2.0
- Created: 2021-11-02T11:37:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-13T10:23:34.000Z (over 1 year ago)
- Last Synced: 2024-05-06T22:01:38.287Z (about 1 year ago)
- Topics: jitsi-meet, react
- Language: TypeScript
- Homepage:
- Size: 996 KB
- Stars: 65
- Watchers: 12
- Forks: 35
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jitsi Meet React SDK
The Jitsi Meet React SDK provides the same user experience as the [Jitsi Meet](https://github.com/jitsi/jitsi-meet) app, in a customizable way which you can embed in your apps.
## Install
```bash
npm install @jitsi/react-sdk
```
### Usage
Import into React | NextJs page for usage
```js
import {JitsiMeeting} from "@jitsi/react-sdk";
```
### Modules
This library exposes two components with similar properties, intended for different use-cases.
#### JitsiMeeting
To be used with custom domains as-it-is in React projects:
```js
```
##### Properties specific to the `JitsiMeeting` component
###### `domain`
Optional. Field used to retrieve the external_api.js file that initializes the IFrame. If omitted, defaults to `meet.jit.si`.
#### JaaSMeeting
To be used with the `8x8.vc` domain as-it-is in React projects:
```js
```
...or with the `stage.8x8.vc` domain:
```js
```
##### Properties specific to the `JaasMeeting` component
###### `appId`
Required. Provides an isolated context and prefixes the room name.
###### `useStaging`
Optional. Tells whether to use the staging environment or not.
##### Common properties
###### `roomName`
Required. String used when joining the meeting.
###### `getIFrameRef`
Optional. Callback to retrieve the parent node of the IFrame for more control (e.g. styling).
```js
{ iframeRef.style.height = '700px'; } }
/>
```
###### `onApiReady`
Optional. Callback triggered when the external API is loaded to expose it for events and commands.
```js
console.log('Jitsi Meet External API', externalApi) }
/>
```
###### `onReadyToClose`
Optional. Callback triggered when the meeting is ready to be closed.
```js
console.log('Jitsi Meet is ready to be closed') }
/>
```
###### `configOverwrite`
Optional. Object used for options overrides.
###### `interfaceConfigOverwrite`
Optional. Object used for more options overrides.
###### `jwt`
Optional. Token for authentication.
###### `invitees`
Optional. Participants list.
###### `devices`
Optional. Information regarding the devices used during the call.
###### `userInfo`
Optional. Details about the participant that started the meeting.
###### `lang`
Optional. The default meeting language.
###### `release`
Optional. Information regarding the `stage.8x8.vc` or `8x8.vc` release version. Expects the following format: `release-1234`.
###### `spinner`
Optional. Custom loading view while the IFrame is loading.
## Sample
Install and run the project from the `example` directory to see the JitsiMeeting module in action.
```bash
npm run demo
```