Interface UsePeerPresenceOptions

interface UsePeerPresenceOptions {
    color: string;
    enabled?: boolean;
    fileId: string;
    label: string;
    localUserId: string;
    status: PresenceStatus;
    tool: WhiteboardTool | null;
}

Index

Properties

color enabled? fileId label localUserId status tool

Properties

color

color: string

Stable colour for the local user (passed in so it matches what peers see).

`Optional`enabled

enabled?: boolean

fileId

fileId: string

label

label: string

Display name for the local user.

localUserId

localUserId: string

status

status: PresenceStatus

Current local status — flipped to 'drawing' / 'idle' / 'away' as the user works.

tool

tool: WhiteboardTool | null

Local current tool (sent so peers can label "Alice is using the pen").