UseSyncDemoOptions

interface UseSyncDemoOptions {}

Properties

The room ID to sync with. Make sure the room ID is unique. The namespace is shared by everyone using the demo server. Consider prefixing it with your company or project name.

roomId: string

A signal that contains the user information needed for multiplayer features. This should be synchronized with the userPreferences configuration for the main <Tldraw /> component. If not provided, a default implementation based on localStorage will be used.

userInfo?: Signal<TLSyncUserInfo> | TLSyncUserInfo