TLBrushOverlay • tldraw Docs

Table of contents

id
props
type
Properties

Extends TLOverlay.

interface TLBrushOverlay 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: {
  h: number;
  w: number;
  x: number;
  y: number;
};

type

from TLOverlay

The overlay util type that owns this instance

type: string;