Module

DOM.Simple.Event

Package: purescript-dom-simple
Repository: garganscript/purescript-dom-simple

#IsEvent Source

class IsEvent :: forall k. k -> Constraintclass IsEvent e

Instances

#click Source

click :: Element -> Effect Unit

#EventPhase Source

data EventPhase

Constructors

#AnimationEvent Source

data AnimationEvent

Instances

IsEvent AnimationEvent

#ClipboardEvent Source

data ClipboardEvent

Instances

IsEvent ClipboardEvent

#CompositionEvent Source

data CompositionEvent

Instances

IsEvent CompositionEvent

#DragEvent Source

data DragEvent

Instances

IsEvent DragEvent

#FocusEvent Source

data FocusEvent

Instances

IsEvent FocusEvent

#HashChangeEvent Source

data HashChangeEvent

Instances

IsEvent HashChangeEvent

#ImageEvent Source

data ImageEvent

Instances

IsEvent ImageEvent

#InputEvent Source

data InputEvent

#KeyboardEvent Source

data KeyboardEvent

Instances

#MediaEvent Source

data MediaEvent

Instances

IsEvent MediaEvent

#MessageEvent Source

data MessageEvent

Instances

IsEvent MessageEvent

#MouseEvent Source

data MouseEvent

Instances

#MouseButtonEvent Source

data MouseButtonEvent

A MouseEvent where the button property can be trusted

Instances

#PageTransitionEvent Source

data PageTransitionEvent

Instances

IsEvent PageTransitionEvent

#PointerEvent Source

data PointerEvent

Instances

#PopStateEvent Source

data PopStateEvent

Instances

IsEvent PopStateEvent

#ProgressEvent Source

data ProgressEvent

Instances

IsEvent ProgressEvent

#SelectionEvent Source

data SelectionEvent

Instances

IsEvent SelectionEvent

#StorageEvent Source

data StorageEvent

Instances

IsEvent StorageEvent

#ToggleEvent Source

data ToggleEvent

Instances

IsEvent ToggleEvent

#TouchEvent Source

data TouchEvent

Instances

#TransitionEvent Source

data TransitionEvent

Instances

IsEvent TransitionEvent

#UIEvent Source

data UIEvent

Instances

IsEvent UIEvent

#UpdateEvent Source

data UpdateEvent

#WheelEvent Source

data WheelEvent

Instances

IsEvent WheelEvent

#IsMouseEvent Source

class IsMouseEvent :: forall k. k -> Constraintclass (IsEvent e) <= IsMouseEvent e

Instances

#Events Source

data Events

Constructors

#event Source

event :: forall a. a

#animationEvent Source

animationEvent :: forall a. a

#clipboardEvent Source

clipboardEvent :: forall a. a

#compositionEvent Source

compositionEvent :: forall a. a

#dragEvent Source

dragEvent :: forall a. a

#hashChangeEvent Source

hashChangeEvent :: forall a. a

#historyEvent Source

historyEvent :: forall a. a

#imageEvent Source

imageEvent :: forall a. a

#focusEvent Source

focusEvent :: forall a. a

#keyboardEvent Source

keyboardEvent :: forall a. a

#mediaEvent Source

mediaEvent :: forall a. a

#mouseEvent Source

mouseEvent :: forall a. a

#pageTransitionEvent Source

pageTransitionEvent :: forall a. a

#pointerEvent Source

pointerEvent :: forall a. a

#popStateEvent Source

popStateEvent :: forall a. a

#progressEvent Source

progressEvent :: forall a. a

#selectionEvent Source

selectionEvent :: forall a. a

#storageEvent Source

storageEvent :: forall a. a

#toggleEvent Source

toggleEvent :: forall a. a

#touchEvent Source

touchEvent :: forall a. a

#transitionEvent Source

transitionEvent :: forall a. a

#uiEvent Source

uiEvent :: forall a. a

#wheelEvent Source

wheelEvent :: forall a. a

#downcast Source

downcast :: forall ctor from to. ctor -> from -> Maybe to

Attempt to cast to a type given a constructor for it

#subclass Source

subclass :: forall e. IsEvent e => e -> Maybe Events

Looks up the type of an Event and attempts to match it against a known list, cast it to the relevant subclass and return as an ADT type for matching. Reference: https://developer.mozilla.org/en-US/docs/Web/Events

#bubbles Source

bubbles :: forall e. IsEvent e => e -> Boolean

Whether the event bubbles

#cancelable Source

cancelable :: forall e. IsEvent e => e -> Boolean

Whether the event is cancelable

#composed Source

composed :: forall e. IsEvent e => e -> Boolean

Whether the event is a composed event (shadow DOM)

#trusted Source

trusted :: forall e. IsEvent e => e -> Boolean

Whether the event is browser-generated

#defaultPrevented Source

defaultPrevented :: forall e. IsEvent e => e -> Boolean

Whether the default action has been prevented

#propagationStopped Source

propagationStopped :: forall e. IsEvent e => e -> Effect Unit

Whether propagation has been stopped

#eventPhase Source

eventPhase :: forall e. IsEvent e => e -> EventPhase

The phase the event is currently in

#timestamp Source

timestamp :: forall e. IsEvent e => e -> Number

When the event was generated

#type' Source

type' :: forall e. IsEvent e => e -> String

A string descriptor of the event name (lowercase, no on)

#target Source

target :: forall e. IsEvent e => e -> Element

Returns the Element the event was dispatched against

#currentTarget Source

currentTarget :: forall e. IsEvent e => e -> Element

Returns the Element the event is currently bubbling through

#relatedTarget Source

relatedTarget :: forall e. IsEvent e => e -> Maybe Element

For drag and drop and such, a related Element

#stopPropagation Source

stopPropagation :: forall e. IsEvent e => e -> Effect Unit

Stops propagation of the event

#stopImmediatePropagation Source

stopImmediatePropagation :: forall e. IsEvent e => e -> Effect Unit

Stops immediate propagation of the event

#preventDefault Source

preventDefault :: forall e. IsEvent e => e -> Effect Unit

Prevents the default action from being executed after propagation

#HasModifierKeys Source

class HasModifierKeys :: forall k. k -> Constraintclass (IsEvent e) <= HasModifierKeys e

Events with information about modifier keys (Mouse, Keyboard, Touch)

Instances

#altKey Source

altKey :: forall e. HasModifierKeys e => e -> Boolean

Was the alt key held down?

#ctrlKey Source

ctrlKey :: forall e. HasModifierKeys e => e -> Boolean

Was the ctrl key held down?

#shiftKey Source

shiftKey :: forall e. HasModifierKeys e => e -> Boolean

Was the shift key held down?

#metaKey Source

metaKey :: forall e. HasModifierKeys e => e -> Boolean

Was the meta key held down?

#ModifierKey Source

data ModifierKey

Constructors

Instances

Show ModifierKey

#getModifierState Source

getModifierState :: forall e. HasModifierKeys e => e -> ModifierKey -> Boolean

Returns whether the given ModifierKey was pressed

#composing Source

composing :: KeyboardEvent -> Boolean

Returns whether the event is composing (shadow dom)

#key Source

key :: KeyboardEvent -> String

Returns a string describing the key List: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values

#locale Source

locale :: KeyboardEvent -> String

The locale string of the user's keyboard at present, which may or may not be the locale of the data

#location Source

location :: KeyboardEvent -> Number

An index of the key on the input device

#repeat Source

repeat :: KeyboardEvent -> Boolean

Returns whether this event was generated while the key was held down

#buttons Source

buttons :: MouseEvent -> Number

#region Source

region :: MouseEvent -> Maybe String

#clientX Source

clientX :: MouseEvent -> Number

#clientY Source

clientY :: MouseEvent -> Number

#movementX Source

movementX :: MouseEvent -> Number

#movementY Source

movementY :: MouseEvent -> Number

#offsetX Source

offsetX :: MouseEvent -> Number

#offsetY Source

offsetY :: MouseEvent -> Number

#pageX Source

pageX :: MouseEvent -> Number

#pageY Source

pageY :: MouseEvent -> Number

#screenX Source

screenX :: MouseEvent -> Number

#screenY Source

screenY :: MouseEvent -> Number

#button Source

button :: MouseButtonEvent -> Int

Which button was pressed to trigger the event Reference: https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button

Modules: DOM.Simple; DOM.Simple.Child; DOM.Simple.Console; DOM.Simple.Document; DOM.Simple.Element; DOM.Simple.Event; DOM.Simple.EventListener; DOM.Simple.Node; DOM.Simple.Parent; DOM.Simple.Sibling; DOM.Simple.Types; DOM.Simple.Window

DOM.Simple.Event

#IsEvent Source

Instances

#click Source

#EventPhase Source

Constructors

#Event Source

Instances

#AnimationEvent Source

Instances

#ClipboardEvent Source

Instances

#CompositionEvent Source

Instances

#DragEvent Source

Instances

#FocusEvent Source

Instances

#HashChangeEvent Source

Instances

#ImageEvent Source

Instances

#InputEvent Source

#KeyboardEvent Source

Instances

#MediaEvent Source

Instances

#MessageEvent Source

Instances

#MouseEvent Source

Instances

#MouseButtonEvent Source

Instances

#PageTransitionEvent Source

Instances

#PointerEvent Source

Instances

#PopStateEvent Source

Instances

#ProgressEvent Source

Instances

#SelectionEvent Source

Instances

#StorageEvent Source

Instances

#ToggleEvent Source

Instances

#TouchEvent Source

Instances

#TransitionEvent Source

Instances

#UIEvent Source

Instances

#UpdateEvent Source

#WheelEvent Source

Instances

#IsMouseEvent Source

Instances

#Events Source

Constructors

#event Source

#animationEvent Source

#clipboardEvent Source

#compositionEvent Source

#dragEvent Source

#hashChangeEvent Source

#historyEvent Source

#imageEvent Source

#focusEvent Source

#keyboardEvent Source

#mediaEvent Source

#mouseEvent Source

#pageTransitionEvent Source

#pointerEvent Source

#popStateEvent Source

#progressEvent Source

#selectionEvent Source

#storageEvent Source

#toggleEvent Source

#touchEvent Source