JSDOM.EventM

EventM provides a convenient monadic interface for handling DOM events.

The DOM Event interface is exposed, as well as functions for accessing UIEvents and MouseEvents.

Documentation

TODO: small tutorial w/ example function

type EventM t e = ReaderT e DOM

IO with the current Event in scope (read with event).

newtype SaferEventListener t e

Constructors

SaferEventListener Function

Instances

ToJSVal (SaferEventListener t e)

Defined in JSDOM.EventTargetClosures

Methods

toJSVal :: SaferEventListener t e -> JSM JSVal

toJSValListOf :: [SaferEventListener t e] -> JSM JSVal

data EventName t e

newListener :: IsEvent e => EventM t e () -> DOM (SaferEventListener t e)

See eventListenerNew.

newListenerSync :: IsEvent e => EventM t e () -> DOM (SaferEventListener t e)

See eventListenerNewSync.

newListenerAsync :: IsEvent e => EventM t e () -> DOM (SaferEventListener t e)

See eventListenerNewAsync.

addListener :: (IsEventTarget t, IsEvent e) => t -> EventName t e -> SaferEventListener t e -> Bool -> DOM ()

Add an EventListener to an EventTarget.

removeListener :: (IsEventTarget t, IsEvent e) => t -> EventName t e -> SaferEventListener t e -> Bool -> DOM ()

Remove an EventListener from an EventTarget.

releaseListener :: (IsEventTarget t, IsEvent e) => SaferEventListener t e -> DOM ()

Release the listener (deallocates callbacks).

on :: (IsEventTarget t, IsEvent e) => t -> EventName t e -> EventM t e () -> DOM (DOM ())

Shortcut for create, add and release:

releaseAction <- on element click $ do
    w <- currentWindowUnchecked
    alert w "I was clicked!"
-- remove click handler again
releaseAction

onSync :: (IsEventTarget t, IsEvent e) => t -> EventName t e -> EventM t e () -> DOM (DOM ())

Like on but always uses newListenerSync

onAsync :: (IsEventTarget t, IsEvent e) => t -> EventName t e -> EventM t e () -> JSM (JSM ())

Like on but always uses newListenerAsync

onTheseSync :: (IsEventTarget t, IsEvent e) => [(t, EventName t e)] -> EventM t e () -> DOM (DOM ())

onSync for multiple targets & events.

The returned IO action removes them all at once.

onTheseAsync :: (IsEventTarget t, IsEvent e) => [(t, EventName t e)] -> EventM t e () -> DOM (DOM ())

onAsync for multiple targets & events.

The returned IO action removes them all at once.

Event interface

event :: EventM t e e

eventTarget :: IsEvent e => EventM t e (Maybe EventTarget)

target :: (IsEvent e, IsGObject t) => EventM t e (Maybe t)

eventCurrentTarget :: IsEvent e => EventM t e (Maybe EventTarget)

eventPhase :: IsEvent e => EventM t e Word

bubbles :: IsEvent e => EventM t e Bool

cancelable :: IsEvent e => EventM t e Bool

timeStamp :: IsEvent e => EventM t e Word

stopPropagation :: IsEvent e => EventM t e ()

preventDefault :: IsEvent e => EventM t e ()

defaultPrevented :: IsEvent e => EventM t e Bool

stopImmediatePropagation :: IsEvent e => EventM t e ()

srcElement :: IsEvent e => EventM t e EventTarget

getCancelBubble :: IsEvent e => EventM t e Bool

cancelBubble :: IsEvent e => Bool -> EventM t e ()

getReturnValue :: IsEvent e => EventM t e Bool

returnValue :: IsEvent e => Bool -> EventM t e ()

UIEvent helpers

uiView :: IsUIEvent e => EventM t e Window

uiDetail :: IsUIEvent e => EventM t e Int

uiKeyCode :: EventM t KeyboardEvent Word

uiCharCode :: EventM t KeyboardEvent Word

uiLayerX :: IsUIEvent e => EventM t e Int

uiLayerY :: IsUIEvent e => EventM t e Int

uiLayerXY :: IsUIEvent e => EventM t e (Int, Int)

uiPageX :: IsUIEvent e => EventM t e Int

uiPageY :: IsUIEvent e => EventM t e Int

uiPageXY :: IsUIEvent e => EventM t e (Int, Int)

uiWhich :: IsUIEvent e => EventM t e Int

MouseEvent helpers

mouseScreenX :: IsMouseEvent e => EventM t e Int

mouseScreenY :: IsMouseEvent e => EventM t e Int

mouseScreenXY :: IsMouseEvent e => EventM t e (Int, Int)

mouseClientX :: IsMouseEvent e => EventM t e Int

mouseClientY :: IsMouseEvent e => EventM t e Int

mouseClientXY :: IsMouseEvent e => EventM t e (Int, Int)

mouseMovementX :: IsMouseEvent e => EventM t e Int

mouseMovementY :: IsMouseEvent e => EventM t e Int

mouseMovementXY :: IsMouseEvent e => EventM t e (Int, Int)

mouseCtrlKey :: IsMouseEvent e => EventM t e Bool

mouseShiftKey :: IsMouseEvent e => EventM t e Bool

mouseAltKey :: IsMouseEvent e => EventM t e Bool

mouseMetaKey :: IsMouseEvent e => EventM t e Bool

mouseButton :: IsMouseEvent e => EventM t e Word

mouseRelatedTarget :: IsMouseEvent e => EventM t e (Maybe EventTarget)

mouseOffsetX :: IsMouseEvent e => EventM t e Int

mouseOffsetY :: IsMouseEvent e => EventM t e Int

mouseOffsetXY :: IsMouseEvent e => EventM t e (Int, Int)

mouseX :: IsMouseEvent e => EventM t e Int

mouseY :: IsMouseEvent e => EventM t e Int

mouseXY :: IsMouseEvent e => EventM t e (Int, Int)

mouseFromElement :: IsMouseEvent e => EventM t e (Maybe Node)

mouseToElement :: IsMouseEvent e => EventM t e (Maybe Node)