@mocanvas/editor · interface

User

interface User

Who somebody *is*, as opposed to what they have configured.

Identity and preferences are separate on purpose: a User is stable, shared and can be looked up by id (it is what attribution and presence name), while {@link ../user/userPreferences.UserPreferencesState} is local, mutable and never leaves this browser.


Properties · 6

avatarUrl: string | null

Where to fetch an avatar, or null when there is none.

color: string

CSS colour used for this person's cursor and selection outlines.

readonly id: UserId
meta: JsonObject
name: string

Display name, as shown on a cursor chip or next to an edit.

readonly typeName: "user"

mocanvas is built by Symbio. Free for non-commercial, non-profit and development use; commercial use needs an agreement. Not affiliated with or endorsed by tldraw.