Tutorial/Guide

[djleonskennedy]

Hello Have you plans for add some tutorial how to use it, like https://guide.elm-lang.org/

[Gozala]

@djleonskennedy There is semi-finished guide here https://gozala.gitbooks.io/reflex/content/

[Gozala]

Current implementation is based on Elm 0.16, in 0.17 they introduced breaking API changes and new concepts like subscriptions plan was to update this library to match new API and also update guide accordingly, unfortunately I have not got around to wrapping that work up.

Than being said linked guide matches API of the library in it's current state.

[sp4ghet]

Where is a good place to report issues/problems when reading the docs?

I found that the reflex-virtual-dom-driver/examples/counter is different from the docs and that the sample in the docs uses the address/send API differently than the examples. The one from the examples works for me, whereas the one from the Docs(Introduction) does not in my environment:

"reflex": "^0.4.1",
"reflex-virtual-dom-driver": "^0.2.5"

Docs(Introduction):

export const view =
  (model:Model, send:Address<Command>):DOM =>
  html.section({ className: "counter" }, [
    html.button({
      onClick: event => send({ type: "Decrement" })
    }, ["-"]),
    html.output({
        className: "value"
    }, [`${model.value}`]),
    html.button({
        onClick: event => send({ type: "Increment" })
    }, ["+"])
  ])

Docs(Basics):

export const view = (model:Model, address:Address<Message>):DOM =>
  html.section({
    className: "counter"
  }, [
    html.button({
      onClick: forward(address, createIncrement)
    }, ["-"]),
    html.output({ 
      className: "value"
    }, [`${model.value}`]),
    html.button({
      onClick: forward(address, createDecrement)
    }, ["+"])
  ])

Example:

export const view =
  ( model/*:Model*/
  , address/*:Address<Action>*/
  )/*:DOM*/ =>
  html.span
  ( { key: "counter"
    }
  , [ html.button
      ( { key: "decrement"
        , onClick: forward(address, Decrement)
        }
      , ["-"]
      )
    , html.span
      ( { key: "value"
        , style: counterStyle.value
        }
      , [ `${model.value}` ]
      )
    , html.button
      ( { key: "increment"
        , onClick: forward(address, Increment)
        }
      , ["+"]
      )
    ]
  )

[Gozala]

Where is a good place to report issues/problems when reading the docs?

@Spaghet feel free to open issues in this repo.

I found that the reflex-virtual-dom-driver/examples/counter is different from the docs and that the sample in the docs uses the address/send API differently than the examples. The one from the examples works for me, whereas the one from the Docs(Introduction) does not in my environment:

Can you elaborate (in the separate issue) what do you mean by does not work ? Are the exceptions thrown ? Is something else gets rendered ?

[sp4ghet]

Cool, thanks! It's been a bit since I went over this so I will get back to you.