Hover

Module path

kivydk.uix.behavior.hover

---

Overview

This behavior adds simple hover awareness to widgets, allowing them to react when the mouse cursor moves over or away from them. It provides an easy way to create interactive, desktop‑friendly UI elements that respond visually or functionally to hover interactions.

---

Example

Sample illustrating how HoverBehavior can be used to create widgets that react to mouse hover.

#// IMPORT
from kivy.uix.button import Button

from kivydk.uix.behavior import HoverBehavior


#// LOGIC
class TestHover(HoverBehavior, Button):
    """Each event updates the color and text to reflect the current hover state."""
    def __init__(self, **kwargs):
        super().__init__(**kwargs)

        # Initialize the button with default information
        self.on_hover()

    def on_hover(self, *args):
        """
        Update the label text and color to display the current hover state.

        :param args: Unused arguments from event callbacks.
        """
        self.background_color = [0.8, 0.4, 0.2, 1] if self.hovered else [1, 1, 1, 1]
        self.text = "Hovered" if self.hovered else "Unhovered"


#// RUN FILE
if __name__ == "__main__":
    from kivy.app import App

    class Example(App):
        def build(self):
            return TestHover(size_hint_y=None, height=256)

    Example().run()

---

Reference

class HoverBehavior(**kwargs)

Bases: object

A mixin that adds lightweight hover detection to any widget.

Events

on_hover

Called when the cursor enters and leaves the widget’s bounds.

on_hover_start

Called when the cursor enters the widget’s bounds.

on_hover_end

Called when the cursor leaves the widget’s bounds.

hovered: AliasProperty

Whether the mouse cursor is currently hovering over the widget.

hovered is a read-only AliasProperty that returns a bool and defaults to False.

on_hover(state: bool) → None

Called when the cursor enters and leaves the widget’s bounds.

This method is dispatched every time the hover state changes, allowing widgets to react to both hover‑start and hover‑end transitions.

Parameters

Name	Description
state	True when the cursor is currently hovering over the widget and False otherwise.

on_hover_start() → None

Called when the cursor enters the widget’s bounds.

on_hover_end() → None

Called when the cursor leaves the widget’s bounds.