Struct yew::services::keyboard::KeyboardService

pub struct KeyboardService {}

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

Note

Elements which natively support keyboard input (such as <input/> or <textarea/>) can use the onkeypress or oninput attributes from within the html macro. You should use those events instead of locating the element and registering an event listener using this service.

This service is for adding key event listeners to elements which don't support these attributes, (for example the document and <canvas> elements).

Implementations

impl KeyboardService

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

Registers a callback which 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 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 which listens to KeyDownEvents on a provided element.

Documentation

keydown event

Note

This browser feature is relatively new and is set to replace the keypress event. It may not be fully supported in all browsers. Consult 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. It may not be fully supported in all browsers. Consult 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.