package bonsai

You can search for identifiers within the package.

in-package search v0.2.0

A library for building dynamic webapps, using Js_of_ocaml

Install

dune-project

Dependency

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

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.17.0.tar.gz

sha256=c78c4476ee6b856846e2d0941e5965009d5e1b853e564b2b1bee61202f0b1ebb

doc/bonsai.web_ui_visibility/Bonsai_web_ui_visibility/index.html

Module `Bonsai_web_ui_visibility`Source

Source

val only_when_visible : 
  ?visible_attr:Bonsai_web.Vdom.Attr.t Bonsai_web.Value.t ->
  ?hidden_attr:Bonsai_web.Vdom.Attr.t Bonsai_web.Value.t ->
  Bonsai_web.Vdom.Node.t Bonsai_web.Computation.t ->
  Bonsai_web.Vdom.Node.t Bonsai_web.Computation.t

only_when_visible runs the provided computation for at least one frame initially, and then if the node is visible, will keep that computation active, but if it ever becomes hidden, the computation is deactivated and the most recent computed vdom node is returned instead. Upon becoming visible again, the computation is reactivated.

visible_attr and hidden_attr are optional attributes that will be attached to the dom nodes based on their visibility status.

Source

val only_when_visible' : 
  ?visible_attr:Bonsai_web.Vdom.Attr.t Bonsai_web.Value.t ->
  ?hidden_attr:Bonsai_web.Vdom.Attr.t Bonsai_web.Value.t ->
  (Bonsai_web.Vdom.Node.t * 'a) Bonsai_web.Computation.t ->
  (Bonsai_web.Vdom.Node.t * 'a option) Bonsai_web.Computation.t

Like only_when_visible, but if the component returns more than just a vdom node, you can propagate the value to the outside. This value is Some when the computation is active, and otherwise None.

Sourcemodule Tracker : sig ... end

A lower-level API, Tracker.component returns an attribute that can be attached to a vdom node along with the status for the visibility of the node that the attribute was attached to.