package bonsai

  1. Overview
  2. Docs
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

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

bonsai-v0.16.0.tar.gz
sha256=1d68aab713659951eba5b85f21d6f9382e0efa8579a02c3be65d9071c6e86303

doc/bonsai.web_ui_form/Bonsai_web_ui_form/View/index.html

Module Bonsai_web_ui_form.ViewSource

include module type of struct include Bonsai_web_ui_form_view end
Sourcetype editable = [
  1. | `Yes_always
  2. | `Currently_yes
  3. | `Currently_no
]
Sourcetype button_location = [
  1. | `Before
  2. | `After
]
Sourcetype submission_options = Bonsai_web_ui_form_view.submission_options = {
  1. on_submit : unit Ui_effect.t option;
  2. handle_enter : bool;
  3. button_text : string option;
  4. button_attr : Virtual_dom.Vdom.Attr.t;
  5. button_location : button_location;
}
Sourcetype context = Bonsai_web_ui_form_view.context = {
  1. tooltip : Virtual_dom.Vdom.Node.t option;
  2. error : Core.Error.t option;
  3. label : Virtual_dom.Vdom.Node.t option;
}
Sourceval sexp_of_context : context -> Sexplib0.Sexp.t
Sourcetype append_item = Bonsai_web_ui_form_view.append_item =
  1. | Append_info of {
    1. append : unit Virtual_dom.Vdom.Effect.t;
    2. text : string option;
    }
  2. | Append_view of Virtual_dom.Vdom.Node.t
Sourceval sexp_of_append_item : append_item -> Sexplib0.Sexp.t
Sourcetype remove_item = Bonsai_web_ui_form_view.remove_item =
  1. | Remove_info of {
    1. remove : unit Virtual_dom.Vdom.Effect.t;
    2. element_label : (delete_button:Virtual_dom.Vdom.Node.t -> int -> Virtual_dom.Vdom.Node.t) option;
    }
  2. | Remove_view of Virtual_dom.Vdom.Node.t
Sourceval sexp_of_remove_item : remove_item -> Sexplib0.Sexp.t
Sourcetype t = Bonsai_web_ui_form_view.t = {
  1. context : context;
  2. view : view;
}
Sourceand view = Bonsai_web_ui_form_view.view =
  1. | Empty
  2. | Collapsible of collapsible
  3. | Raw of raw
  4. | Record of field list
  5. | Variant of variant
  6. | List of list_view
  7. | Tuple of t list
  8. | Option of option_view
Sourceand raw = Bonsai_web_ui_form_view.raw = {
  1. id : string;
  2. raw_view : context -> editable:editable -> Virtual_dom.Vdom.Node.t;
}
Sourceand collapsed_state = Bonsai_web_ui_form_view.collapsed_state =
  1. | Collapsed of t option
  2. | Expanded of t
Sourceand option_status = Bonsai_web_ui_form_view.option_status =
  1. | Currently_some of t
  2. | Currently_none of t option
Sourceand list_view = Bonsai_web_ui_form_view.list_view = {
  1. list_items : list_item list;
  2. append_item : append_item;
  3. legacy_button_position : [ `Inline | `Indented ];
}
Sourceand list_item = Bonsai_web_ui_form_view.list_item = {
  1. item_view : t;
  2. remove_item : remove_item;
}
Sourceand variant = Bonsai_web_ui_form_view.variant = {
  1. clause_selector : Virtual_dom.Vdom.Node.t;
  2. selected_clause : clause option;
}
Sourceand clause = Bonsai_web_ui_form_view.clause = {
  1. clause_name : string;
  2. clause_view : t;
}
Sourceand field = Bonsai_web_ui_form_view.field = {
  1. field_name : string;
  2. field_view : t;
}
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval sexp_of_view : view -> Sexplib0.Sexp.t
Sourceval sexp_of_raw : raw -> Sexplib0.Sexp.t
Sourceval sexp_of_collapsible : collapsible -> Sexplib0.Sexp.t
Sourceval sexp_of_collapsed_state : collapsed_state -> Sexplib0.Sexp.t
Sourceval sexp_of_option_view : option_view -> Sexplib0.Sexp.t
Sourceval sexp_of_option_status : option_status -> Sexplib0.Sexp.t
Sourceval sexp_of_list_view : list_view -> Sexplib0.Sexp.t
Sourceval sexp_of_list_item : list_item -> Sexplib0.Sexp.t
Sourceval sexp_of_variant : variant -> Sexplib0.Sexp.t
Sourceval sexp_of_clause : clause -> Sexplib0.Sexp.t
Sourceval sexp_of_field : field -> Sexplib0.Sexp.t
Sourceval of_vdom' : id:string -> (context -> editable:editable -> Virtual_dom.Vdom.Node.t) -> t

of_vdom' is like of_vdom, but allows access to some extra metadata that is stored in the form's view.

Sourceval tuple : t list -> t

tuple combines a list of t into a single one.

Sourceval record : field list -> t

record combines a list of fields (field names and their corresponding views) into a view representing a record with those fields.

Sourceval variant : clause_selector:Virtual_dom.Vdom.Node.t -> selected_clause:clause option -> t

variant takes a selector for selecting which variant case, as well as an optional selected_clause which contains the name of the currently selected clause and the t representing that clause's arguments.

Sourceval option : toggle:Virtual_dom.Vdom.Node.t -> status:option_status -> t

option takes a toggle for switching between None and Some _, as well as a status for the form. status can be:

  • Currently_some view if toggle is set to Some _ and view represents the form for the type in the option.
  • Currently_none None if the toggle is set to None and we shouldn't show any view for the None case
  • Currently_none (Some view) if the toggle is set to None and we want to display view when the toggle is set to None (e.g. displaying a greyed out textbox)
Sourceval collapsible : label:Virtual_dom.Vdom.Node.t -> state:collapsed_state -> t

collapsible represents a collapsible subform. The supplied label can be used to toggle open/closed the collapsible t.

collapsible_state can be:

  • Collapsed None if the view is collapsed and we shouldn't render any subform
  • Collapsed (Some view) if the view is collapsed but we want to render a subform in this case (e.g. displaying ... in a code editor when folded)
  • Expanded view if the view is expanded and view is the subform to show
Sourceval list_item : view:t -> remove_item:remove_item -> list_item

list_item represents a single form in an extendable list.

remove_item can either be:

  • Remove_info { remove; element_label } in which case the rendering function will decide how to render a remove button for this item with remove being scheduled on click and element_label being called to generate the label for this element.
  • Remove_view view in which case view will be used as the remove button
Sourceval list : append_item:append_item -> legacy_button_position:[ `Inline | `Indented ] -> list_item list -> t

list represents a form for an extendable list.

append_item can either be:

  • Append_info { append; text } in which case the rendering function will decide how to render an append button with append being scheduled on click and text being the text for the button
  • Append_view view in which case view will be used as the append button
Sourceval with_fieldset : currently_editable:bool -> Virtual_dom.Vdom.Node.t -> Virtual_dom.Vdom.Node.t
Sourceval empty : t
Sourceval suggest_error : Core.Error.t -> t -> t
Sourceval suggest_label' : Bonsai_web.Vdom.Node.t -> t -> t
Sourceval suggest_label : string -> t -> t
Sourceval set_label : Bonsai_web.Vdom.Node.t -> t -> t
Sourceval set_tooltip : Bonsai_web.Vdom.Node.t -> t -> t
Sourceval of_vdom : id:string -> Bonsai_web.Vdom.Node.t -> t
Sourceval to_vdom : ?theme:Bonsai_web.View.Theme.t -> ?on_submit:submission_options -> ?editable:editable -> t -> Bonsai_web.Vdom.Node.t
Sourceval to_vdom_plain : ?theme:Bonsai_web.View.Theme.t -> ?editable:editable -> t -> Bonsai_web.Vdom.Node.t list
Sourceval sexp_to_pretty_string : ('a -> Core.Sexp.t) -> 'a -> string
Sourcemodule Expert : sig ... end