Overview

Miso.Subscription.Window provides subscriptions that listen to window-level events. It also exposes windowSub and windowSubWithOptions as the generic primitives on which mouseSub and other per-event wrappers are built.

Quick start

import Miso
import Miso.Subscription.Window

data Action
  = MouseMoved Coord         -- (clientX, clientY)
  | PointerMoved PointerEvent -- full pointer data

subs :: [Sub Action]
subs =
  [ windowCoordsSub      MouseMoved    -- simple (x, y) pair
  , windowPointerMoveSub PointerMoved  -- full PointerEvent
  ]

Subscription variants

• windowCoordsSub — fires (clientX, clientY) as a Coord on every pointermove. Simplest option when only screen position is needed.

• windowPointerMoveSub — fires the full PointerEvent (pressure, tilt, pointer type, …) on every pointermove.
• windowSub — listen to any named window event by providing an event name and a Decoder:

resizeSub :: (Coord -> action) -> Sub action
resizeSub f = windowSub "resize" emptyDecoder (const (f (0,0)))

• windowSubWithOptions — same as windowSub but accepts Options to call preventDefault or stopPropagation on the raw event before forwarding it.

See also

• Miso.Subscription.Mouse — mouseSub (thin alias over windowPointerMoveSub)
• Miso.Event.Decoder — Decoder, pointerDecoder
• Miso.Event.Types — PointerEvent, Options
• Miso.Subscription.Util — createSub used internally