TLOverlay

interface TLOverlay<Props = Record<string, unknown>> {}

Properties

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;

Arbitrary props for the overlay (handle id, corner name, etc.)

props: Props;

The overlay util type that owns this instance

type: string;