useRoom | RelayRTC Docs

Import

import { useRoom } from '@relayrtc/react'

Requirements

Call this hook inside RelayProvider, in a React function component or custom hook. A joined room is needed for live data and actions.

Returns

Field	Type	Meaning
room	Room or null	Active room once the join has completed.
client	RelayClient or null	Underlying browser client.
connectionState	RoomConnectionState	connecting, connected, reconnecting, disconnected or failed.
error	RoomError or null	Latest store error.
join	`(token, options?) => Promise<Room>`	Join manually. JoinOptions accepts signal.
leave	`() => Promise<void>`	Leave the current room.
clearError	`() => void`	Clear the displayed store error.

Example

const { connectionState, error, leave, clearError } = useRoom()
 
return (
  <div>
    <p>{connectionState}</p>
    {error && <button onClick={clearError}>{error.message}</button>}
    <button onClick={() => void leave().catch(console.error)}>Leave</button>
  </div>
)

Options and behavior

Use either RelayRoom’s automatic join or a manual join flow. Do not start both for the same provider. Null room state during setup is expected.