Function useChannel

useChannel(channel: string, options?: UseChannelOptions): UseChannelReturn

Join a realtime channel for broadcast messages and presence tracking. Uses the same shared WebSocket as useRealtime.

Parameters

channel: string
options: UseChannelOptions = {}

Returns UseChannelReturn

Example

function Editor() {
  const { presences, broadcast, memberCount } = useChannel('doc:abc', {
    presence: { cursor: { x: 0, y: 0 } },
    onBroadcast: (msg) => {
      if (msg.event === 'cursor_move') updateCursor(msg.sender, msg.payload);
    },
  });

  return <span>{memberCount} online</span>;
}