@mocanvas/mocanvas · interface

HighlightShapeUtilDisplayValues

interface HighlightShapeUtilDisplayValues extends TLDefaultDisplayValues

What a highlight paints with.

color on the base is the palette's *solid* ink, which is not what a highlighter lays down — the palette carries a separate, much paler highlight token for exactly this. Both are reported: the solid one so a caller that only knows the shared set still gets something sensible, and HighlightShapeUtilDisplayValues.highlightColor for the real ink.


Properties · 3

highlightColor: string

The highlighter ink: the palette's highlight token for props.color.

highlightOpacity: number

How see-through the stroke is drawn, 0..1.

highlightStrokeWidth: number

The stroke width actually drawn — the base width, widened and scaled.

mocanvas is built by Symbio. Free for non-commercial, non-profit and development use; commercial use needs an agreement. Not affiliated with or endorsed by tldraw.