Overview

Miso.Subscription is the re-export hub for all of miso's built-in Sub subscriptions. A subscription is a long-running IO action of type Sink action -> IO () that delivers external events — mouse moves, key presses, URL changes, animation frames — into the update loop by calling its Sink.

Register subscriptions in the subs field of a Component:

import Miso
import Miso.Subscription

myComponent = (component model update view)
  { subs =
      [ mouseSub    MouseMoved
      , keyboardSub KeyPressed
      , uriSub      UrlChanged
      , rAFSub      Tick
      ]
  }

Subscription catalogue

mouseSub

global pointermove — Miso.Subscription.Mouse

keyboardSub

global keydown / keyup — Miso.Subscription.Keyboard

arrowsSub, wasdSub, directionSub

arrow or WASD keys held — Miso.Subscription.Keyboard

uriSub

browser popstate (back/forward/pushState) — Miso.Subscription.History

routerSub

same, decoded via Router — Miso.Subscription.History

windowCoordsSub

global window pointermove — Miso.Subscription.Window

windowPointerMoveSub

global window pointermove — Miso.Subscription.Window

windowSubWithOptions

any window event — Miso.Subscription.Window

onLineSub

online / offline change — Miso.Subscription.OnLine

rAFSub

every requestAnimationFrame tick — Miso.Subscription.RAF

History helpers

The Miso.Subscription.History module also exports imperative navigation functions usable from within Effect:

update GoHome = io_ (pushURI (toURI Home))
update GoBack = io_ back

See also

• Miso.Effect — Sub, Sink, mapSub
• Miso.Subscription.Util — createSub for custom subscriptions
• Miso.Router — Router typeclass used by routerSub