Skip to content



Bases: Widget

A simple footer widget which docks itself to the bottom of the parent container.

COMPONENT_CLASSES: ClassVar[set[str]] class-attribute

Class Description
footer--description Targets the descriptions of the key bindings.
footer--highlight Targets the highlighted key binding.
footer--highlight-key Targets the key portion of the highlighted key binding.
footer--key Targets the key portions of the key bindings.


Create text containing all the keys.

on_leave(event) async

Clear any highlight when the mouse leaves the widget

on_mouse_move(event) async

Store any key we are moving over.

watch_highlight_key(value) async

If highlight key changes we need to regenerate the text.