Clarity.Vertex.TooltipProvider protocol (Clarity v0.5.1)

Protocol for providing tooltip content for vertices.

This protocol allows vertices to specify their tooltip content, which is displayed when hovering over the vertex in graph visualizations.

Note: This component is rendered for every vertex in the graph, so it should be efficient.

Summary

t()

All the types that implement this protocol.

tooltip(vertex)

Returns the tooltip content for this vertex.

@type t() :: term()

All the types that implement this protocol.

@spec tooltip(t()) :: iodata() | nil

Returns the tooltip content for this vertex.

Returns iodata that will be rendered as markdown, or nil if no tooltip should be displayed.