Skip to content

Installation

React

Terminal window
bun add @q9labs/chalk-react

The React SDK includes @q9labs/chalk-core as a dependency.

Import Styles

Import the CSS stylesheet for built-in components:

import '@q9labs/chalk-react/styles.css'

Verify Installation

import { ChalkProvider, VideoConference } from '@q9labs/chalk-react'
import '@q9labs/chalk-react/styles.css'
function App() {
// Token obtained from your backend (see Authentication guide)
const token = 'eyJ...'
return (
<ChalkProvider apiUrl="https://api.chalk.q9labs.ai" token={token}>
<VideoConference
roomId="my-room"
userName="Alice"
/>
</ChalkProvider>
)
}

ChalkProvider Props

PropTypeDescription
apiUrlstringChalk API base URL
tokenstringJWT token from participant join
childrenReactNodeYour app components

Next Steps