dbuenzli/useri

Declarative user input for OCaml (unreleased)

Useri — Declarative user input for OCaml

Release %%VERSION%%

Useri gathers user input as React signals and events.

Useri can be used with different backends. The library comes with a backend that depends on Tsdl and a JavaScript backend that depends on js_of_ocaml.

Useri and its backends depend on React and Gg. They are distributed under the ISC license.

Home page: http://erratique.ch/software/useri
Contact: Daniel Bünzli <daniel.buenzl [email protected]>

Installation

Useri can be installed with opam:

opam install tsdl useri             # tsdl backend
opam install js_of_ocaml useri      # js_of_ocaml backend
opam isntall tsdl js_of_ocaml useri # all backends 

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online or via or via odig doc useri and there is a generated version in the doc directory of the distribution.

Sample programs

If you installed Fut with opam sample programs are located in the directory opam config var useri:doc.

In the distribution sample programs are located in the test directory of the distribution. They can be built with:

ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in _build/test.

• test.native tests the library, nothing should fail.

useri's Issues

Optdep `js_of_ocaml` is not, because we are using the `Ocamlbuild_js_of_ocaml` plugin.

Environment lookup

match the interface of bos. See dbuenzli/bos#6.

usage from dune

I built this project with nix and then tried to use it in a dune project, and got the following error:

File "_none_", line 1:
Error: No implementations provided for the following modules:
         Useri_backend referenced from /nix/store/l6ff6bjd7clj54bbwxdzp8hvvi4qh8cl-useri/lib/ocaml/4.10.0/site-lib/useri/useri.cmxa(Useri)

Other projects gg, tgls, tsdl all built, so I'm wondering if backend selection in this project requires some extra build configuration. I'm using the topkg helper here https://github.com/NixOS/nixpkgs/blob/e7fe577d9803885d1191c6612b95c246cb605dde/pkgs/development/ocaml-modules/topkg/default.nix#L20-L26 to build it.