@goheadroom/client-react-sdk v0.0.5
Headroom React SDK
Welcome to the official Headroom React SDK. This SDK is a React wrapper around the Headroom JavaScript SDK, providing developers with convenient hooks and components to integrate real-time video and audio capabilities into their React applications.
Overview
The Headroom React SDK is designed to simplify the integration of Headroom's real-time video conferencing capabilities into React applications. It leverages the power of the Headroom JavaScript SDK and provides additional convenient React hooks and components that make it easier to build and manage video conferencing features in your React application.
Getting Started
To get started with the Headroom React SDK, follow the steps outlined in the 'Quickstart' section of our documentation. This will guide you through the process of setting up your React application, installing the necessary packages, and initializing the Headroom client using the obtained tokens.
Prerequisites
Before you begin, make sure you have installed the necessary packages using either npm (Node Package Manager) or Yarn. Detailed instructions can be found in the 'Quickstart' section of our documentation.
Installation
To install the Headroom React SDK package, use the following commands based on your package manager:
Using npm:
npm install @goheadroom/client-js-sdk @goheadroom/client-react-sdkUsing Yarn:
yarn add @goheadroom/client-js-sdk @goheadroom/client-react-sdkUsage
The Headroom React SDK provides a set of hooks and components that you can use in your React application. For detailed information on how to use these hooks and components, please refer to our comprehensive API documentation.
Documentation
For detailed information about the API endpoints, parameters, and responses, as well as the usage of hooks and components, please refer to our comprehensive API documentation.
Support
If you encounter any issues or have questions, please feel free to reach out to our support team at support@goheadroom.com.
Running unit tests
Run nx test client-react-sdk to execute the unit tests via Jest.