Halogen.VDom

newtype VDomSpec a w

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

Constructors

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

buildVDom :: forall a w. VDomSpec a w -> VDomMachine a w

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 a b

Constructors

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

type Machine a b = EffectFn1 a (Step a b)

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

Runs the next step.

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

Runs the finalizer associated with a Step

extract :: forall a b. Step 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

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)
• Functor ElemSpec

newtype ElemName

Constructors

• ElemName String

Instances

• Newtype ElemName _
• Eq ElemName
• Ord ElemName

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