reason-elm

MOVED

This project has been moved to bs-elm

Reason-Elm

Bindings for mounting and interacting with Elm applications in Reason.

Motivation

Writing web applications in Elm is nice. It's type system and enforced architecture are just a couple of the really cool things that it offers. The Elm ecosystem is pretty small compared to the Javascript(JS) ecosystem, and this is a draw back when coming from the world of JS. Interop with JS is possible, but it requires writing regular JS code, which has none of Elm's safety. This is where Reason enters the picture. Reason can communicate more direclty with JS with much more type safety than vanilla JS. The possibility of writing an Elm app and handling JS interop with Reason is pretty powerful. Having access to the entire JS ecosytem in a (more) typesafe way is pretty exciting, so Reason-Elm was created.

Getting Started

• Install
  • With yarn: yarn add reason-elm
  • With npm: npm install --save reason-elm
• Add reason-elm as a dependency in bsconfig.json

{
  ...
  "bs-dependencies": ["reason-elm"]
}

• Use ReasonElm (To import Elm directly in Reason take a look at this webpack config):

module R = Js.Result;

[@bs.module]
external elmProgram : ReasonElm.elmProgram = "path/to/App.elm";

let instance = ReasonElm.mount(
  ~moduleName="App", /* Defaults to "Main" */
  elmProgram /* Must be last arguement */
);

switch instance {
| R.Ok(i) => Js.log("Elm is running.")
| R.Error(errorMessage) => Js.log(errorMessage)
};

Checkout this example that uses flags and ports!

Docs

• elmProgramBase : type
• elmProgram : type
• elmProgramWithPorts : type
• elmInPort : type
• elmOutPort : type
• elmInstance : type
• elmInstanceWithPorts : type
• mount : func

Roadmap

• Make interacting with ports nicer
  • Convert Js.t objects to OCaml records?
  • Subscribe to ports in a pipeline style?

If you have any suggestions or run into any bugs, please open an issue!