tricycle / elm-actor-framework-template-markdown / Framework.Template.Markdown


type alias MarkdownTemplate appActors =
Internal.MarkdownTemplate.MarkdownTemplate appActors

Your parsed template that originated from a string containing valid Html

Creation

blank : MarkdownTemplate appActors

An empty, blank MarkdownTemplate

parse : Framework.Template.Components.Components appActors -> String -> Result String (MarkdownTemplate appActors)

Parse a string containing valid Html into an MarkdownTemplate

Add Components to replace Html Elements with your Actors based on their nodeNames. (e.g. <my-actor></my-actor>)

fromNodes : List (Framework.Template.Node appActors) -> MarkdownTemplate appActors

Turn a list of Nodes into an MarkdownTemplate

This could be useful for when you use your own Html Parser.

Rendering

toNodes : MarkdownTemplate appActors -> List (Framework.Template.Node appActors)

Turn a MarkdownTemplate into a list of Nodes

This could be useful for when you want to write or use another method of rendering the template in question.

Utility

getActorsToSpawn : MarkdownTemplate appActors -> List { actor : appActors, reference : String, actorElement : Framework.Template.ActorElement appActors }

Get the actor, reference and original complete node from a template that are meant to be spawned.

The String is a reference that can be used on the render function in combination with a Pid to render the Actors output.