//// `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