Struct patternfly_dioxus::dioxus_elements::on::KeyboardData

pub struct KeyboardData {
    pub char_code: u32,
    pub key: String,
    pub key_code: KeyCode,
    pub alt_key: bool,
    pub ctrl_key: bool,
    pub meta_key: bool,
    pub shift_key: bool,
    pub locale: String,
    pub location: usize,
    pub repeat: bool,
    pub which: usize,
}

Fields

char_code: u32

key: String

Identify which “key” was entered.

This is the best method to use for all languages. They key gets mapped to a String sequence which you can match on. The key isn’t an enum because there are just so many context-dependent keys.

A full list on which keys to use is available at: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values

Example

match event.key().as_str() {
    "Esc" | "Escape" => {}
    "ArrowDown" => {}
    "ArrowLeft" => {}
     _ => {}
}

key_code: KeyCode

Get the key code as an enum Variant.

This is intended for things like arrow keys, escape keys, function keys, and other non-international keys. To match on unicode sequences, use the [KeyboardEvent::key] method - this will return a string identifier instead of a limited enum.

Example

use dioxus::KeyCode;
match event.key_code() {
    KeyCode::Escape => {}
    KeyCode::LeftArrow => {}
    KeyCode::RightArrow => {}
    _ => {}
}

alt_key: bool

Indicate if the alt modifier key was pressed during this keyboard event

ctrl_key: bool

Indicate if the ctrl modifier key was pressed during this keyboard event

meta_key: bool

Indicate if the meta modifier key was pressed during this keyboard event

shift_key: bool

Indicate if the shift modifier key was pressed during this keyboard event

locale: String

location: usize

repeat: bool

which: usize

Trait Implementations

impl Clone for KeyboardData

fn clone(&self) -> KeyboardData

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyboardData

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&Event> for KeyboardData

fn from(e: &Event) -> KeyboardData

Converts to this type from the input type.

impl From<&KeyboardEvent> for KeyboardData

fn from(e: &KeyboardEvent) -> KeyboardData

Converts to this type from the input type.

impl From<Event> for KeyboardData

fn from(e: Event) -> KeyboardData

Converts to this type from the input type.