package virtual_dom

  1. Overview
  2. Docs
package virtual_dom
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Vdom_keyboard.Help_textSource

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 Base__Ppx_compare_lib.compare
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 with one row per command.

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