Packages

redraw_dom

19.2.0
19.2.2 19.2.1 19.2.0 retired 19.1.1 19.1.0 19.0.6 19.0.5 19.0.4 19.0.3 19.0.2 19.0.1 19.0.0 2.1.0 2.0.1 2.0.0 1.1.0 1.0.0

Redraw DOM renderer. Take a look at Redraw to use it.

Retired package: Deprecated - Broke backward compatibility by mistake, use most recent version
HexDocs

Current section

Files

Jump to
Readme
17 Versions
3 Dependencies
Dependants
Files
Activity
redraw_dom src redraw dom event keyboard.gleam
Raw

src/redraw/dom/event/keyboard.gleam 

//// `KeyboardEvent` objects describe a user interaction with the keyboard; each

//// event describes a single interaction between the user and a key (or

//// combination of a key with modifier keys) on the keyboard. The event type

//// ([`keydown`](https://developer.mozilla.org/docs/Web/API/Element/keydown_event),

//// [`keypress`](https://developer.mozilla.org/docs/Web/API/Element/keypress_event),

//// or [`keyup`](https://developer.mozilla.org/docs/Web/API/Element/keyup_event))

//// identifies what kind of keyboard activity occurred.



import redraw/dom/event/ui.{type UIEvent}

import redraw/event.{type Event}

import redraw/internal/unsafe



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent)

pub type KeyboardEvent



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/altKey)

@external(javascript, "./events.ffi.mjs", "altKey")

pub fn alt_key(event: KeyboardEvent) -> Bool



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/code)

@external(javascript, "./events.ffi.mjs", "code")

pub fn code(event: KeyboardEvent) -> String



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/ctrlKey)

@external(javascript, "./events.ffi.mjs", "ctrlKey")

pub fn ctrl_key(event: KeyboardEvent) -> Bool



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/key)

@external(javascript, "./events.ffi.mjs", "key")

pub fn key(event: KeyboardEvent) -> String



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/locale)

@external(javascript, "./events.ffi.mjs", "locale")

pub fn locale(event: KeyboardEvent) -> String



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/metaKey)

@external(javascript, "./events.ffi.mjs", "metaKey")

pub fn meta_key(event: KeyboardEvent) -> Bool



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/location)

@external(javascript, "./events.ffi.mjs", "location")

pub fn location(event: KeyboardEvent) -> Float



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/repeat)

@external(javascript, "./events.ffi.mjs", "repeat")

pub fn repeat(event: KeyboardEvent) -> Bool



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/shiftKey)

@external(javascript, "./events.ffi.mjs", "shiftKey")

pub fn shift_key(event: KeyboardEvent) -> Bool



/// [Documentation](https://developer.mozilla.org/docs/Web/API/KeyboardEvent/getModifierState)

@external(javascript, "./events.ffi.mjs", "getModifierState")

pub fn get_modifier_state(event: KeyboardEvent, key: String) -> Bool



/// `KeyboardEvent` inherits `UIEvent`.

pub const as_ui_event: fn(KeyboardEvent) -> UIEvent = unsafe.coerce



/// `KeyboardEvent` inherits `Event`.

pub const as_event: fn(KeyboardEvent) -> Event = unsafe.coerce