jsoo-react

Bindings to React for js_of_ocaml, including the JSX ppx.

Status: experimental phase

The library is expected to break backwards compatibility on minor releases.

Adapted from ReasonReact.

Bug reports and contributions are welcome!

Getting started

New project

For new projects, the best way to start is by using the jsoo-react template.

Existing project

1. Install the jsoo-react package:

   opam install jsoo-react
   

2. Add jsoo-react library and ppx to dune file of your executable JavaScript app:

       (executables
       (names index)
       (modes js)
       (libraries jsoo-react.lib)
       (preprocess
       (pps jsoo-react.ppx)))
   

3. Provision React.js library

   jsoo-react uses require to import React and ReactDOM. This means that you will likely need to use a bundler such as Webpack or rollup.js.

   Note that at this moment, jsoo-react is compatible with React 16, so be sure to have the appropriate constraints in your package.json.

Contributing

Take a look at our Contributing Guide.

Acknowledgements

Thanks to the authors and maintainers of ReasonReact, in particular @rickyvetter for his work on the v3 of the JSX ppx.

Thanks to the authors and maintainers of Js_of_ocaml, in particular @hhugo who has been answering many many questions in GitHub threads.

Thanks to the Lexifi team for creating and maintaining gen_js_api.

Thanks to @tmattio for creating Spin and the jsoo-react template :raised_hands:

And thanks to the team behind React.js! What an amazing library :)