Skip to main content

KeyboardListener

A control that calls a callback whenever the user presses or releases a key on a keyboard.

Inherits: Control

Properties

  • autofocus - True if this control will be selected as the initial focus when no other node in its scope is currently focused.
  • content - The content control of the keyboard listener.
  • include_semantics - Include semantics information in this control.

Events

  • on_key_down - Fires when a keyboard key is pressed.
  • on_key_repeat - Fires when a keyboard key is being hold, causing repeated events.
  • on_key_up - Fires when a keyboard key is released.

Methods

  • focus - Requests focus for this control.

Examples​

Press any keys​

import flet as ft


async def main(page: ft.Page):
    pressed_keys = set()

    def key_down(e: ft.KeyDownEvent):
        pressed_keys.add(e.key)
        keys.controls = [ft.Text(k, size=20) for k in pressed_keys]
        keys.update()

    def key_up(e: ft.KeyUpEvent):
        pressed_keys.remove(e.key)
        keys.controls = [ft.Text(k, size=20) for k in pressed_keys]
        keys.update()

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Text("Press any keys..."),
                    ft.KeyboardListener(
                        autofocus=True,
                        on_key_down=key_down,
                        on_key_up=key_up,
                        content=(keys := ft.Row()),
                    ),
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

Properties​

autofocusclass-attributeinstance-attribute​

autofocus: bool = False

True if this control will be selected as the initial focus when no other node in its scope is currently focused.

contentinstance-attribute​

content: Control

The content control of the keyboard listener.

include_semanticsclass-attributeinstance-attribute​

include_semantics: bool = True

Include semantics information in this control.

Events​

on_key_downclass-attributeinstance-attribute​

on_key_down: Optional[EventHandler[KeyDownEvent]] = None

Fires when a keyboard key is pressed.

on_key_repeatclass-attributeinstance-attribute​

on_key_repeat: Optional[EventHandler[KeyRepeatEvent]] = None

Fires when a keyboard key is being hold, causing repeated events.

on_key_upclass-attributeinstance-attribute​

on_key_up: Optional[EventHandler[KeyUpEvent]] = None

Fires when a keyboard key is released.

Methods​

focusasync​

focus()

Requests focus for this control.