Skip to main content

Hover

Enable tracking when a pointer enters/leaves the component or moves within it.

modifier Hover
import { Hover, Text } from ui

component HoverText {
hovered: Bool = false

Text( self.hovered ? "Hovered" : "Not Hovered" ) with {
Hover(self.$hovered)
}
}

export var main = HoverText()

Constructors

(_ hovered)

Allows tracking whether a pointer is within the component.

_ hovered: $<Bool>

A binding for the hover state.

(enter:move:​exit)

Allows tracking when a pointer enters/exits the component or moves within it.

enter: (HoverEvent) -> ()

Called when a pointer enters the component.

See HoverEvent.

move: (HoverEvent) -> ()

Called when an already entered pointer moves within the component.

See HoverEvent.

exit: (HoverEvent) -> ()

Called when an already entered pointer exits the component.

See HoverEvent.

Layout Behavior

None.

HoverEvent

Properties

position: Point

The pointer position in the component's coordinate system.

See Point

frame: Rect

The component's bounding box during the event.

See Rect

modifiers: KeyboardModifiers

The keyboard modifiers that were active during the event.

See KeyboardModifiers