HoverTooltipDetector class

Widget that detects hover events and triggers hover tooltips.

This widget wraps editor content and monitors mouse hover events. When the mouse hovers over text for a configurable duration, it queries all registered hover tooltip sources (via hoverTooltipFacet) and dispatches state effects to show the resulting tooltips.

This is a standalone implementation that can be used outside of EditorView. EditorView has its own integrated hover handling that uses the same hoverTooltipFacet mechanism.

Usage

HoverTooltipDetector(
  state: editorState,
  dispatch: (tr) => setState(() => editorState = editorState.apply(tr)),
  posAtCoords: (offset) => view.posAtCoords(offset),
  coordsAtPos: (pos) => view.coordsAtPos(pos),
  child: editorContent,
)

Inheritance

Constructors

HoverTooltipDetector({Key? key, required EditorState state, required void dispatch(Transaction tr), required int? posAtCoords(Offset position), required Offset? coordsAtPos(int pos), required Widget child}): const

Properties

child → Widget: The child widget.
final
coordsAtPos → Offset? Function(int pos): Function to get coordinates for a document position. Used to compute the tooltip anchor position.
final
dispatch → void Function(Transaction tr): Function to dispatch transactions.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
posAtCoords → int? Function(Offset position): Function to get the document position at a point.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state → EditorState: The editor state.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<HoverTooltipDetector>: Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited