TLCollaboratorCursorOverlay • tldraw Docs

Deprecated: Collaborator cursors are rendered as DOM elements rather than drawn to the overlay canvas. Use TLCursorProps, the props of the CollaboratorCursor editor component.

Table of contents

id
props
type
Properties

Extends TLOverlay.

interface TLCollaboratorCursorOverlay extends TLOverlay {}

Properties

id

from TLOverlay

Globally unique id for this overlay instance across all overlay utils. Hit-test and hover lookup key on id alone, so utils must namespace their ids (e.g. 'selection_fg:top_left', 'handle:<shapeId>:<handleId>') to avoid colliding with overlays from other utils.

id: string;

props

props: {
  chatMessage: string;
  color: string;
  name: null | string;
  x: number;
  y: number;
};

type

from TLOverlay

The overlay util type that owns this instance

type: string;