package brr

  1. Overview
  2. Docs
Browser programming toolkit for OCaml

Install

dune-project
 Dependency

Authors

Maintainers

Sources

brr-0.0.9.tbz
sha512=45cdf73c6a23c8fc4609a32ae2196d4790e5bdba34ca0b784bff9c0b70dab233eb336f1c11dc3002451042ff4cf25b643098ad0d011f14c3d6175842113bed21

doc/brr.ocaml_poke_ui/Brr_ocaml_poke_ui/index.html

Module Brr_ocaml_poke_uiSource

Interactive toplevel HTML interface for poke objects.

Persistent storage

Sourcemodule Store : sig ... end

Persistent storage.

Prompt history

Sourcemodule History : sig ... end

Prompt history data structure.

Toplevel user interface

Sourcetype t

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

Sourceval 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.

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

The type for specifiyng kinds of output messages.

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

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

Sourceval 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).