TLUser

Extends BaseRecord<'user', TLUserId>.

A user record in a tldraw store. User records are document-scoped and persist alongside shapes, assets, and pages. They are automatically included in snapshots, clipboard content, and .tldr files so that attribution display names survive across boards and sessions.

User records are populated from the TLUserStore when the editor stamps attribution metadata onto shapes.

Extend user records with custom metadata by passing validators to createTLSchema or createUserRecordType.

interface TLUser extends BaseRecord<"user", TLUserId> {}

Properties

color: string;

readonly id: Id;

imageUrl: string;

meta: JsonObject;

name: string;

readonly typeName: TypeName;