Dispatcher.React

type ReactReaderT props state m a = ReaderT (ReactThis props state) m a

The type of all React action handling functions

type ReactLifecycle props state eval eff = RWS eval Unit (ReactSpec props state eff) Unit

The type of React lifecycle methods - Reader Writer State (RWS) with the eval being the Reader type and the ReactSpec being the State type.

getProps :: forall eff state props m. MonadEff (props :: ReactProps | eff) m => ReactReaderT props state m props

Get the React properties

getState :: forall eff access state props m. MonadEff (state :: ReactState (read :: Read | access) | eff) m => ReactReaderT props state m state

Get the React state

modifyState :: forall eff state props m. MonadEff (state :: ReactState ReadWrite | eff) m => (state -> state) -> ReactReaderT props state m Unit

Modify the React state

getRefs :: forall m state props eff. MonadEff (refs :: ReactRefs ReadOnly | eff) m => ReactReaderT props state m Refs

Get the React refs

unsafeWithRef :: forall m eff ref state props. MonadEff (refs :: ReactRefs ReadOnly | eff) m => (ref -> Eff (refs :: ReactRefs ReadOnly | eff) Unit) -> String -> ReactReaderT props state m Unit

Run an effect with on the object pointed to by the ref string. (or do nothing if it doesn't exist)

unsafeWithRef' :: forall a m eff ref state props. MonadEff (refs :: ReactRefs ReadOnly | eff) m => (ref -> Eff (refs :: ReactRefs ReadOnly | eff) a) -> String -> ReactReaderT props state m (Maybe a)

emptyHandler :: forall m a. Applicative m => a -> m Unit

an empty event handler

execHandler :: forall state props a m eff2 eff. MonadEff eff m => Eff eff2 a -> ReactReaderT props state m a

Run an Eff event handler

class ReactSpecCreator eval initialstate render props state eff | eval initialstate render -> props state eff where

Members

• createSpec :: eval -> initialstate -> (state -> render) -> ReactSpec props state eff

  Given an action evaluator, an initial state, and a render function, return a ReactSpec.

Instances

• (ReactInitialState eval initialstate props state eff, ReactRender eval renderer props state eff) => ReactSpecCreator eval initialstate renderer props state eff

class ReactInitialState eval initialstate props state eff | initialstate -> state where

Members

• createInitialState :: eval -> initialstate -> GetInitialState props state eff

Instances

• ReactInitialState eval (ReactState state) props state eff
• (FromContext eval (ReactThis props state) r Eff (props :: ReactProps, refs :: ReactRefs (), state :: ReactState () | eff), ReactInitialState eval next props state eff) => ReactInitialState eval (r -> next) props state eff

class ReactRender eval renderer props state eff | renderer -> eff where

Members

• createRenderer :: eval -> renderer -> Render props state eff

Instances

• ReactRender eval ReactElement props state eff
• (ReactRender eval next props state eff, FromContext eval (ReactThis props state) r Eff (props :: ReactProps, refs :: ReactRefs (), state :: ReactState (read :: Read) | eff)) => ReactRender eval (r -> next) props state eff

createComponent :: forall eff renderer eval state2 state props. TypeEquals state2 state => ReactSpecCreator eval (ReactState state) renderer props state eff => state2 -> (state -> renderer) -> eval -> ReactClass props

Create a ReactClass with the given state, renderer and action evaluator

createComponent' :: forall eff renderer initialstate eval state props. ReactSpecCreator eval initialstate renderer props state eff => initialstate -> (state -> renderer) -> eval -> ReactClass props

Create a ReactClass with the given initialstate function, renderer and action evaluator The initialstate function must return it's state value wrapped in the ReactState newtype

createLifecycleComponent :: forall eff renderer eval state2 state props. TypeEquals state2 state => ReactSpecCreator eval (ReactState state) renderer props state eff => ReactLifecycle props state eval eff -> state2 -> (state -> renderer) -> eval -> ReactClass props

Create a ReactClass with the given lifecycle, state, renderer and action evaluator

createLifecycleComponent' :: forall eff renderer eval initialstate state props. ReactSpecCreator eval initialstate renderer props state eff => (RWS eval Unit (ReactSpec props state eff) Unit) -> initialstate -> (state -> renderer) -> eval -> ReactClass props

Create a ReactClass with the given lifecycle, initialstate function, renderer and action evaluator The initialstate function must return it's state value wrapped in the ReactState newtype

didMount :: forall eff action state props eval. Dispatchable eval (ReactThis props state) action (Eff (props :: ReactProps, refs :: ReactRefs ReadOnly, state :: ReactState ReadWrite | eff) Unit) => action -> ReactLifecycle props state eval eff

A ReactLifecycle for dispatching the componentDidMount React lifecycle function

willUnmount :: forall eff action state props eval. Dispatchable eval (ReactThis props state) action (Eff (props :: ReactProps, refs :: ReactRefs ReadOnly, state :: ReactState ReadOnly | eff) Unit) => action -> ReactLifecycle props state eval eff

A ReactLifecycle for dispatching the componentWillUnmount React lifecycle function

newtype ReactState s

A newtype to signify the React State Used to denote the state returned from an initial state function

Constructors

• ReactState s

Instances

• ReactInitialState eval (ReactState state) props state eff
• (TypeEquals state state2) => FromContext eval (ReactThis props state) (ReactState state2) Eff (state :: ReactState (read :: Read | access) | eff)

newtype ReactProps p

A newtype representing the React Props Useful in renderers or initial state functions

Constructors

• ReactProps p

Instances

• (TypeEquals props props2) => FromContext eval (ReactThis props state) (ReactProps props2) Eff (props :: ReactProps | eff)
• FromContext eval (ReactThis props state) ReactChildren Eff (props :: ReactProps | eff)

newtype ReactChildren

A newtype representing the React children array Useful in renderers

Constructors

• ReactChildren (Array ReactElement)

Instances

• FromContext eval (ReactThis props state) ReactChildren Eff (props :: ReactProps | eff)