package brr

  1. Overview
  2. Docs
package brr
Legend:
Library
Module
Module type
Parameter
Class
Class type

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

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct