A monad for succinctly expressing model transitions in the update function.

Effect is a RWS, where the State abstracts over manually passing the model around. It's also a Writer Monad, where the accumulator is a list of scheduled IO actions. Multiple actions can be scheduled using tell from the mtl library and a single action can be scheduled using io_.

An Effect represents the results of an update action.

It consists of the updated model and a list of subscriptions. Each Sub is run in a new thread so there is no risk of accidentally blocking the application.

Tip: use the Effect monad in combination with the stateful lens operators (all operators ending in "="). The following example assumes the lenses field1, counter and field2 are in scope and that the LambdaCase language extension is enabled:

myComponent = Component
  { update = \case
      MyAction1 -> do
        field1 .= value1
        counter += 1
      MyAction2 -> do
        field2 %= f
        io_ $ do
          putStrLn "Hello"
          putStrLn "World!"
  , ...
  }

Type synonym for constructing event subscriptions.

The Sink callback is used to dispatch actions which are then fed back into the update function.

Function to asynchronously dispatch actions to the update function.

Type to represent a DOM reference

This is the 'Reader r' in Effect. Accessible via ask. It holds a phantom type for parent. This is used as a witness when calling the parent function, and using prop.

ComponentId of the current Component

Smart constructor for ComponentInfo

Smart constructor for an Effect with exactly one action.

Effect smart constructor, flipped

Smart constructor for an Effect with multiple actions.

Since: 1.9.0.0

Like batch but action are discarded

Since: 1.9.0.0

Schedule a single IO action for later execution.

Note that multiple IO action can be scheduled using tell from the mtl library.

Since: 1.9.0.0

Like io_ but doesn't cause an action to be dispatched to the update function.

This is handy for scheduling IO computations where you don't care about their results or when they complete.

Since: 1.9.0.0

Like io but generalized to any instance of Foldable

This is handy for scheduling IO computations that return a Maybe value

Since: 1.9.0.0

Issue a new action to be processed by update.

data Action = HelloWorld

update :: Action -> Effect Model Action
update = \case
  Click -> issue HelloWorld

Since: 1.9.0.0

withSink allows users to access the sink of the Component or top-level Component in their application. This is useful for introducing IO into the system. A synonym for tell, specialized to Effect.

A use-case is scheduling an IO computation which creates a 3rd-party JS widget which has an associated callback. The callback can then call the sink to turn events into actions. To do this without accessing a sink requires going via a Subscription which introduces a leaky-abstraction.

update FetchJSON = withSink $ \sink -> getJSON (sink . ReceivedJSON) (sink . HandleError)

Since: 1.9.0.0

Turn a Sub that consumes actions of type a into a Sub that consumes actions of type b using the supplied function of type a -> b.

Helper for Component construction, when you want to ignore the update function temporarily, or permanently.

Since: 1.9.0.0

Performs the given JSM action before all JSM actions collected by the given effect.

Example usage:

-- delays connecting a websocket by 100000 microseconds
beforeAll (liftIO $ threadDelay 100000) $ websocketConnectJSON OnConnect OnClose OnOpen OnError

Performs the given JSM action after all JSM actions collected by the given effect.

Example usage:

-- log that running the a websocket Effect completed
afterAll (consoleLog "Done running websocket effect") $ websocketConnectJSON OnConnect OnClose OnOpen OnError

Modifies all JSM collected by the given Effect.

All JSM expressions collected by Effect are evaluated asynchronously. This function can be used to adjoin synchronous actions to all JSM expressions in an effect. For examples see beforeAll and afterAll.

Internal function used to unwrap an Effect

See io

See io_

See for

See withSink

See withSink, put

See put, batch

See put