PresenceState
The full presence state for a user.PresenceUpdateInput
The input shape forclient.presence.update(). All fields are optional.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
CollabKit is currently in Beta. APIs and features may change.
Types for ephemeral presence state.
import type { PresenceState, PresenceUpdateInput } from '@collab-kit/utils';
interface PresenceState {
cursor: { x: number; y: number; state: 'typing' | 'idle' };
screen: { width: number; height: number };
scroll: { x: number; y: number };
zoom?: number;
color: string;
userId: string;
meta?: Record<string, unknown>;
}
client.presence.update(). All fields are optional.
type PresenceUpdateInput = {
cursor?: { x: number; y: number; state: 'typing' | 'idle' };
screen?: { width: number; height: number };
scroll?: { x: number; y: number };
zoom?: number;
meta?: Record<string, unknown>;
};