Struct yew::services::keyboard::KeyboardService

pub struct KeyboardService {}

Service for registering callbacks on elements to get keystrokes from the user.

Note

Elements that natively support keyboard input (input or textarea) can set an onkeypress or oninput attribute within the html macro. You should use those events instead of locating the element and registering it with this service.

This service is for adding key event listeners to elements that don't support these attributes, like the document or <canvas> elements for example.

Methods

impl KeyboardService

pub fn register_key_press<T: AsRef<EventTarget>>(
    element: &T,
    callback: Callback<KeyboardEvent>
) -> KeyListenerHandle

Registers a callback that listens to KeyPressEvents on a provided element.

Documentation

keypress event

Warning

This API has been deprecated in the HTML standard and it is not recommended for use in new projects. Consult with the browser compatibility chart in the linked MDN documentation.

pub fn register_key_down<T: AsRef<EventTarget>>(
    element: &T,
    callback: Callback<KeyboardEvent>
) -> KeyListenerHandle

Registers a callback that listens to KeyDownEvents on a provided element.

Documentation

keydown event

Note

This browser feature is relatively new and is set to replace keypress events. Not all browsers may support it completely. Consult with the browser compatibility chart in the linked MDN documentation.

pub fn register_key_up<T: AsRef<EventTarget>>(
    element: &T,
    callback: Callback<KeyboardEvent>
) -> KeyListenerHandle

Registers a callback that listens to KeyUpEvents on a provided element.

Documentation

keyup event

Note

This browser feature is relatively new and is set to replace keypress events. Not all browsers may support it completely. Consult with the browser compatibility chart in the linked MDN documentation.

Trait Implementations

impl Debug for KeyboardService

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.