createTLUser • tldraw docs

Public function

Signature

function createTLUser(opts?: {
  derivePresenceState?:
    | ((store: TLStore) => Signal<null | TLInstancePresence>)
    | undefined
  userPreferences?: Signal<TLUserPreferences, unknown> | undefined
  setUserPreferences?:
    | ((userPreferences: TLUserPreferences) => void)
    | undefined
}): TLUser

Parameters

Name Description

Name	Description
`opts`	`{ derivePresenceState?: \| (( store: TLStore ) => Signal<null \| TLInstancePresence>) \| undefined userPreferences?: \| Signal<TLUserPreferences, unknown> \| undefined setUserPreferences?: \| ((userPreferences: TLUserPreferences) => void) \| undefined }`

opts

{
  derivePresenceState?:
    | ((
        store: TLStore
      ) => Signal<null | TLInstancePresence>)
    | undefined
  userPreferences?:
    | Signal<TLUserPreferences, unknown>
    | undefined
  setUserPreferences?:
    | ((userPreferences: TLUserPreferences) => void)
    | undefined
}

Returns

TLUser

References

TLStore, TLInstancePresence, TLUserPreferences

Source

packages/editor/src/lib/config/createTLUser.ts

createTLStore CubicBezier2d