TLArrowHintOverlay • tldraw Docs

Table of contents

id
props
type
Properties

Extends TLOverlay.

interface TLArrowHintOverlay 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: {
  anchorX: number;
  anchorY: number;
  arrowKind: string;
  handles: {
    bottom: {
      isEnabled: boolean;
      x: number;
      y: number;
    };
    left: {
      isEnabled: boolean;
      x: number;
      y: number;
    };
    right: {
      isEnabled: boolean;
      x: number;
      y: number;
    };
    top: {
      isEnabled: boolean;
      x: number;
      y: number;
    };
  };
  isExact: boolean;
  isPrecise: boolean;
  showEdgeHints: boolean;
  snap: string;
  targetId: TLShapeId;
};

type

from TLOverlay

The overlay util type that owns this instance

type: string;