package virtual_dom

You can search for identifiers within the package.

in-package search v0.2.0

OCaml bindings for the virtual-dom library

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (7)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.17.0.tar.gz

sha256=812711b4d5ce634a413580cd7096482de8d71abec9ae37bb01f7c0dcec2968ec

doc/virtual_dom.keyboard/Vdom_keyboard/Help_text/index.html

Module `Vdom_keyboard.Help_text`Source

A Help_text.t represents the documentation for a collection of commands. It can be displayed as a Vdom node.

This can be used to create a web ui help menu.

Sourcemodule View_spec : sig ... end

Sourcemodule Command : sig ... end

A Command.t represents the help text for a single command.

Sourcetype t

include Sexplib0.Sexpable.S with type t := t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

include Ppx_compare_lib.Comparable.S with type t := t

Sourceval compare : t -> t -> int

Sourceval empty : t

Sourceval is_empty : t -> bool

Sourceval of_command_list : Command.t list -> t

Sourceval add_command : t -> Command.t -> t

add_command is linear in the number of commands in t.

Sourceval commands : t -> Command.t list

Sourceval view : ?sep:string -> t -> View_spec.t -> Virtual_dom.Vdom.Node.t

view displays a help text table. Each row shows a list of keys and a description. Multiple commands with the same description may be combined into one row.

view_rows is similar to view, but returns a list of row nodes instead of wrapping them in a table node.

Sourceval view_rows : ?sep:string -> t -> View_spec.t -> Virtual_dom.Vdom.Node.t list