React.Halo

newtype UseHalo props ctx state action hooks

Instances

• Newtype (UseHalo props ctx state action hooks) _

type HookSpec props ctx state action m = { context :: ctx, eval :: Lifecycle props ctx action -> HaloM props ctx state action m Unit, initialState :: state, props :: props }

type ComponentSpec hooks props ctx state action m = { context :: props -> Render Unit hooks ctx, eval :: Lifecycle props ctx action -> HaloM props ctx state action m Unit, initialState :: props -> ctx -> state, render :: { context :: ctx, props :: props, send :: action -> Effect Unit, state :: state } -> JSX }

useHalo :: forall props ctx state action. HookSpec props ctx state action Aff -> Hook (UseHalo props ctx state action) (state /\ (action -> Effect Unit))

Run renderless Halo in the current component. This allows Halo to be used with other hooks and other ways of building components.

component :: forall hooks props ctx state action. String -> ComponentSpec hooks props ctx state action Aff -> Component props

Build a component by providing a name and a Halo component spec.

newtype HaloM props ctx state action (m :: Type -> Type) a

The Halo evaluation monad. It lifts the HaloF algebra into a free monad.

• props are the component props
• ctx is some component context
• state is the component state
• action is the set of actions that the component handles
• m is the monad used during evaluation
• a is the result type

Instances

• Functor (HaloM props ctx state action m)
• Apply (HaloM props ctx state action m)
• Applicative (HaloM props ctx state action m)
• Bind (HaloM props ctx state action m)
• Monad (HaloM props ctx state action m)
• (Semigroup a) => Semigroup (HaloM props ctx state action m a)
• (Monoid a) => Monoid (HaloM props ctx state action m a)
• MonadTrans (HaloM props ctx state action)
• (MonadEffect m) => MonadEffect (HaloM props ctx state action m)
• (MonadAff m) => MonadAff (HaloM props ctx state action m)
• MonadState state (HaloM props ctx state action m)
• MonadRec (HaloM props ctx state action m)
• (MonadAsk r m) => MonadAsk r (HaloM props ctx state action m)
• (MonadTell w m) => MonadTell w (HaloM props ctx state action m)
• (MonadThrow e m) => MonadThrow e (HaloM props ctx state action m)
• Parallel (HaloAp props ctx state action m) (HaloM props ctx state action m)

newtype HaloAp props ctx state action (m :: Type -> Type) a

The Halo parallel evaluation applicative. It lifts HaloM into a free applicative.

• props are the component props
• ctx is some component context
• state is the component state
• action is the set of actions that the component handles
• m is the monad used during evaluation
• a is the result type

Instances

• Functor (HaloAp props ctx state action m)
• Apply (HaloAp props ctx state action m)
• Applicative (HaloAp props ctx state action m)
• Parallel (HaloAp props ctx state action m) (HaloM props ctx state action m)

unsubscribe :: forall props ctx state action m. SubscriptionId -> HaloM props ctx state action m Unit

Cancels the event subscription belonging to the SubscriptionId.

subscribe' :: forall props ctx state action m. (SubscriptionId -> Emitter action) -> HaloM props ctx state action m SubscriptionId

Same as subscribe but the event-producing logic is also passed the SuscriptionId. This is useful when events need to unsubscribe themselves.

subscribe :: forall props ctx state action m. Emitter action -> HaloM props ctx state action m SubscriptionId

Subscribe to new actions from an Emitter. Subscriptions will be automatically cancelled when the component unmounts.

Returns a SubscriptionId which can be used with unsubscribe to manually cancel a subscription.

props :: forall props ctx state action m. HaloM props ctx state action m props

Read the current props.

kill :: forall props ctx state action m. ForkId -> HaloM props ctx state action m Unit

Kills the process belonging to the ForkId.

hoistAp :: forall props ctx state action m m'. Functor m => (m ~> m') -> (HaloAp props ctx state action m) ~> (HaloAp props ctx state action m')

Hoist (transform) the base applicative of a HaloAp expression.

hoist :: forall props ctx state action m m'. Functor m => (m ~> m') -> (HaloM props ctx state action m) ~> (HaloM props ctx state action m')

Hoist (transform) the base monad of a HaloM expression.

fork :: forall props ctx state action m. HaloM props ctx state action m Unit -> HaloM props ctx state action m ForkId

Start a HaloM process running independantly from the current "thread". Forks are tracked automatically and killed when the Finalize event occurs (when the component unmounts). New forks can still be created during the Finalize event, but once evaluation ends there will be no way of killing them.

Returns a ForkId for the new process.

context :: forall props ctx state action m. HaloM props ctx state action m ctx

Read the current context.

type EvalSpec props ctx state action m = { onAction :: action -> HaloM props ctx state action m Unit, onFinalize :: Maybe action, onInitialize :: { context :: ctx, props :: props } -> Maybe action, onUpdate :: { context :: ctx, props :: props } -> { context :: ctx, props :: props } -> Maybe action }

A simpler interface for building the components eval function. The main lifecycle events map directly into actions, so only the action handling logic needs to be written using HaloM.

mkEval :: forall props ctx state action m. (EvalSpec props ctx state action m -> EvalSpec props ctx state action m) -> Lifecycle props ctx action -> HaloM props ctx state action m Unit

Given an EvalSpec builder, it will return an eval function.

defaultEval :: forall props ctx action state m. EvalSpec props ctx state action m

The empty EvalSpec.

newtype SubscriptionId

Instances

• Eq SubscriptionId
• Ord SubscriptionId

data Lifecycle props ctx action

The Halo lifecycle events.

• Initialize contains the initial props. It occurs when the component mounts, and only once per component.
• Update contains the previous and new props. It occurs when the component re-renders and the props have changes.
• Action contains the dispatched action. It occurs each time an action is dispatched to be eval'd, up until the Finalize event.
• Finalize occurs when the component unmounts.

Constructors

• Initialize { context :: ctx, props :: props }
• Update { context :: ctx, props :: props } { context :: ctx, props :: props }
• Action action
• Finalize

newtype ForkId

Instances

• Eq ForkId
• Ord ForkId