zwilias/elm-html-string

A drop-in elm-lang/html replacement that can stringify to a pretty HTML string


License
BSD-3-Clause
Install
elm-package install zwilias/elm-html-string 1.0.1

Documentation

elm-html-string Build Status

Write code resembling elm-lang/html and serialize to either a string or actual HTML

This package copies the entire API of elm-lang/html, but adds 2 functions:

  • toHtml which serializes the resulting Html.String.Html msg node into a Html.Html msg node
  • toString which serializes the node into a String with optional indentation

Two caveats:

  • You need to change your imports
  • It can't properly support lazy nodes since those can't be expressed in Elm

Show me an example!

import Html.String as Html exposing (Html)
import Html.String.Attributes as Attr
import Html.String.Events as Events


type Msg = Increment | Decrement


counter : Int -> Html Msg
counter count =
    Html.div
        [ Attr.classList [ ( "below-zero" = count < 0 ), ( "counter" = True ) ] ]
        [ Html.button [ Events.onClick Decrement ] [ Html.text "-" ]
        , Html.text <| toString count
        , Html.button [ Events.onClick Increment ] [ Html.text "+" ]
        ]

counterAsString : String
counterAsString =
    Html.toString 2 <| counter -5

{- Expected output:

    <div class="below-zero counter">
      <button>
        -
      </button>
      -5
      <button>
        +
      </button>
    </div>
-}

Cool, anything else I should be aware of?

Yes.

  • Event handlers are removed from the output.
  • Void elements ignore children (br, img, etc.)
  • Boolean properties are stripped from the output when False, and added as boolean properties when True. I.e. selected True will result in <someNode selected>.

Alright, coolbeans

Made with ❤️ and licensed under BSD-3. Fork me and send me some pull-requests!