@huddle01/react

Huddle01 React SDK

People-powered Communication

Community · Documentation

React SDK

The Huddle01 React SDK offers a comprehensive suite of hooks, methods and event listeners that allow for seamless real-time audio and video communication with minimal coding required.

Pre Requisites

Before using the React SDK, you must have Node.js installed on your machine. You can install Node.js using one of the following methods:

• Install Node.js with NVM by following the instructions on this GitHub page
• Install Node.js with FNM by following the instructions on this GitHub page
• Download Node.js from the official website

Pro Tip : Use NVM or FNM to install Node.js as they help in version management and easy updation

After installing Node.js, verify it's installed by running the following command in your terminal:

node --version

Installing the packages:

To get started with the Huddle01 React SDK, you can install the package using npm or pnpm or bun:

npm install @huddle01/react

Initializing the SDK:

After installing the package, you can initialize the SDK by using the HuddleProvider hook:

import { HuddleProvider, HuddleClient } from '@huddle01/react';
 
const huddleClient = new HuddleClient({
  projectId: env.NEXT_PUBLIC_PROJECT_ID,
  options: {
    activeSpeakers: {
      size: 8,
    },
  },
});
 
...
<HuddleProvider client={huddleClient}>
  <App />
</HuddleProvider>
...

💡 For more information head to https://huddle01.com/docs

💡 For any help reach out to us on Discord