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 Dependency

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

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

bonsai-v0.16.0.tar.gz

sha256=1d68aab713659951eba5b85f21d6f9382e0efa8579a02c3be65d9071c6e86303

doc/bonsai.web_ui_file/Bonsai_web_ui_file/index.html

Module `Bonsai_web_ui_file`Source

An API that allows one to read files from the client's local disk.

A value of type t can be created in two ways:

1. Using the companion library Bonsai_web_ui_file_from_web_file, which uses the Web File API to drive t. Note that the Web File API does not permit the reading of arbitrary files on the client computer's disk. Instead, one typically uses a file selector form to allow the user to specify a file to be read. See Bonsai_web_ui_form.Elements.File_picker for a convenient wrapper.

2. For tests, one can also create a t which is driven manually using the For_testing module.

Sourcetype t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Sourceval filename : t -> string

Sourceval contents : t -> string Core.Or_error.t Ui_effect.t

Get the contents of the file. For an advanced API that includes e.g. progress on loading the file, and the ability to abort in-progress reads, see read below.

Sourcemodule Progress : sig ... end

Sourcemodule Read_error : sig ... end

Sourcemodule File_read : sig ... end

Source

val read : 
  ?on_progress:(Progress.t -> unit Ui_effect.t) ->
  t ->
  File_read.t Ui_effect.t

Sourcemodule Read_on_change : sig ... end

Functions that take bonsai values that contain t, and kicking off reads whenever those values change.

Sourcemodule For_testing : sig ... end

This module supports a test / simulation mode where file data can be fed in by you rather than coming from an actual file on disk.

Sourcemodule Expert : sig ... end