package brr

  1. Overview
  2. Docs
Browser programming toolkit for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; BSD-3-Clause License Edit opam file Versions (2)

Authors

  1. T
    The brr programmers

Maintainers

  1. Daniel Bünzli

Sources

brr-0.0.7.tbz
sha512=4b3d42eb6a32c1d6f1c5ef003f5311b5029156b31f6e51af098b695c769699e0304b66afd2dd574ecf1084e095bbbc4eac552daab083766cd81ed2f1d9897d51

doc/brr.ocaml_poke_ui/Brr_ocaml_poke_ui/index.html

Module Brr_ocaml_poke_ui

Interactive toplevel HTML interface for poke objects.

Persistent storage

module Store : sig ... end

Persistent storage.

Prompt history

module History : sig ... end

Prompt history data structure.

Toplevel user interface

type t

The type for representing a toplevel user interface over a poke object.

val create : ?store:Store.t -> Brr.El.t -> t Fut.or_error

create ~store view creates a toplevel interface using the children of the view element whose content model should be flow content. view's children are erased and the class .ocaml-ui is set on element. store is used to store the toplevel history and user settings.

type output_kind = [
  1. | `Past_input
  2. | `Reply
  3. | `Warning
  4. | `Error
  5. | `Info
  6. | `Announce
]

The type for specifiyng kinds of output messages.

val output : t -> kind:output_kind -> Brr.El.t list -> unit

output r ~kind msg outputs message msg with kind to the user interface.

val run : ?drop_target:Brr.Ev.target -> ?buttons:Brr.El.t list -> t -> Brr_ocaml_poke.t -> unit

run t poke ~drop_target ~buttons runs the toplevel with poke object poke. buttons are prepended to the buttons panel. drop_target is the target on which ml files can be droped (defaults to the view).