This is client API (go to server)

Warning: Reason support is experimental. We are looking for beta-tester and contributors.

Module Ot_lib

module Ot_lib : sig..end

NOTE: be careful when using the functions onresizes, window_scroll, and window_scrolls. They may be called before the new document is displayed (and thus the new window is there) and therefore may be attached to the window that is about to be replaced. In most use-cases you should have a line as follows before: let%lwt () = Ot_nodeready.nodeready @@ To_dom.of_element some_elt in


val in_ancestors : 
  elt:Dom_html.element Js.t -> ancestor:Dom_html.element Js.t -> bool
val onloads : (unit -> unit) -> unit
val onresizes : 
  (Dom_html.event Js.t -> unit Lwt.t -> unit Lwt.t) -> unit Lwt.t

NOTE: be careful when using the functions onresizes, window_scroll, and window_scrolls. They may be called before the new document is displayed (and thus the new window is there) and therefore may be attached to the window that is about to be replaced. In most use-cases you should have a line as follows before: let%lwt () = Ot_nodeready.nodeready @@ To_dom.of_element some_elt in

val window_scroll : ?use_capture:bool -> unit -> Dom_html.event Js.t Lwt.t
val window_scrolls : 
  ?ios_html_scroll_hack:bool ->
  ?use_capture:bool ->
  (Dom_html.event Js.t -> unit Lwt.t -> unit Lwt.t) -> unit Lwt.t

If ios_html_scroll_hack then listen on window + html + body instead of only window. On iOS (8 and 9), in WkWebView and in Safari, some CSS properties (e.g. html) may move the scroll event from window to html or to body. For instance, with (ON) or without (OFF) the following CSS: html{overflow:scroll;-webkit-overflow-scrolling: touch;} we may observe this:

| capture | elements receiving the scroll events
    -----+---------+-------------------------------------
    OFF  |    true | window
    -----+---------+-------------------------------------
    OFF  |   false | window
    -----+---------+-------------------------------------
    ON   |    true | window + html + body
    -----+---------+-------------------------------------
    ON   |   false | body
    -----------------------------------------------------

(Also, note that pure JavaScript "onscroll" attribute might be broken when ON.) It's useful to listen on html even if it's only relevant when ON + capture=true, because we probably want, when capture=true, to capture the event as early as possible.

val click_outside : 
  ?use_capture:bool ->
  ?inside:Dom_html.element Js.t ->
  #Dom_html.element Js.t -> Dom_html.mouseEvent Js.t Lwt.t

click_outside e returns when user clicks outside element e. Will only catch clicks inside the element given as optional parameter ?inside (default is Dom_html.document##.body).

module List : sig..end