Halogen.VDom

type VDomStep eff a b = Eff eff (Step (Eff eff) a b)

newtype VDomSpec eff a w

Widget machines recursively reference the configured spec to potentially enable recursive trees of Widgets.

Constructors

• VDomSpec { buildAttributes :: Element -> VDomMachine eff a Unit, buildWidget :: VDomSpec eff a w -> VDomMachine eff w Node, document :: Document }

type VDomMachine eff a b = Machine (Eff eff) a b

buildVDom :: forall w a eff. VDomSpec (VDomEffects eff) a w -> VDomMachine (VDomEffects eff) (VDom a w) Node

Starts an initial VDom machine by providing a VDomSpec.

main = do
  machine1 ← buildVDom spec vdomTree1
  machine2 ← Machine.step machine1 vdomTree2
  machine3 ← Machine.step machine2 vdomTree3
  ...

data Step m a b

Constructors

• Step b (Machine m a b) (m Unit)

Instances

• (Functor m) => Functor (Step m a)

type Machine m a b = a -> m (Step m a b)

step :: forall b a m. Step m a b -> a -> m (Step m a b)

Runs the next step.

halt :: forall b a m. Step m a b -> m Unit

Runs the finalizer associated with a Step

extract :: forall b a m. Step m a b -> b

Returns the output value of a Step.

data VDom a w

The core virtual-dom tree type, where a is the type of attributes, and w is the type of "widgets". Widgets are machines that have complete control over the lifecycle of some DOM.Node.

The Grafted constructor and associated machinery enables bimap fusion using a Coyoneda-like encoding.

Constructors

• Text String
• Elem (ElemSpec a) (Array (VDom a w))
• Keyed (ElemSpec a) (Array (Tuple String (VDom a w)))
• Widget w
• Grafted (Graft a w)

Instances

• Functor (VDom a)
• Bifunctor VDom

newtype Namespace

Constructors

• Namespace String

Instances

• Newtype Namespace _
• Eq Namespace
• Ord Namespace
• Generic Namespace

data Graft :: Type -> Type -> Type

Instances

• Functor (Graft a)
• Bifunctor Graft

data ElemSpec a

Constructors

• ElemSpec (Maybe Namespace) ElemName a

Instances

• (Eq a) => Eq (ElemSpec a)
• (Ord a) => Ord (ElemSpec a)
• (Generic a) => Generic (ElemSpec a)
• Functor ElemSpec

newtype ElemName

Constructors

• ElemName String

Instances

• Newtype ElemName _
• Eq ElemName
• Ord ElemName
• Generic ElemName

runGraft :: forall w' a'. Graft a' w' -> VDom a' w'