tyxml_js.mli

(* Js_of_ocaml library
 * http://www.ocsigen.org/js_of_ocaml/
 * Copyright (C) 2014 Hugo Heuzard
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *)

(** Tyxml interface.
    Example of use for HTML:
    {[
     module T = Tyxml_js.Html
     let html = T.(
       div ~a:[a_class ["several"; "css"; "class"]; a_id "id-of-div"] [
         ul ~a:[a_class ["one-css-class"]; a_id "id-of-ul"] [
           li [
             a ~a:[a_id "id-of-a"; a_href "/url/file.html"] [
               pcdata "Go to /url/file.html"
             ]
           ]
         ]
       ]
     )
   ]}
   @see <https://ocsigen.org/tyxml/> the Tyxml project website.
   @see <https://ocsigen.org/tyxml/dev/api/Html_sigs.T> Html_sigs.T to have a list of available functions to build HTML.
*)

open Js_of_ocaml

module type XML =
  Xml_sigs.T
    with type uri = string
     and type event_handler = Dom_html.event Js.t -> bool
     and type mouse_event_handler = Dom_html.mouseEvent Js.t -> bool
     and type keyboard_event_handler = Dom_html.keyboardEvent Js.t -> bool
     and type elt = Dom.node Js.t

module Xml : XML with module W = Xml_wrap.NoWrap

module Svg : Svg_sigs.Make(Xml).T with module Xml.W = Xml_wrap.NoWrap

module Html : Html_sigs.Make(Xml)(Svg).T with module Xml.W = Xml_wrap.NoWrap

(** @deprecated Use {!Tyxml_js.Html}. *)
module Html5 :
  Html_sigs.Make(Xml)(Svg).T
    with module Xml.W = Xml_wrap.NoWrap
     and type 'a elt = 'a Html.elt
     and type +'a attrib = 'a Html.attrib

module Register : sig
  val html : ?head:Html_types.head Html.elt -> Html_types.body Html.elt -> unit
  (** [Register.html head body] uses the given head and body elements
      as document. It replaces the previous body and head.

      [head] and [body] can be reactive.
  *)

  val body : ?keep:bool -> [< Html_types.body_content ] Html.elt list -> unit
  (** [Register.body elements] add [elements] as children of [body].
      If [keep] is false (default is true), the children of the body are
      removed before adding the new elements.
  *)

  val head : ?keep:bool -> [< Html_types.head_content ] Html.elt list -> unit
  (** [Register.head elements] add [elements] as children of [body].
      If [keep] is false (default is true), the children of the head are
      removed before adding the new elements.
  *)

  val id : ?keep:bool -> string -> 'a Html.elt list -> unit
  (** [Register.id "some_id" elements] add [elements] as children of the node
      with the id ["some_id"].
      If [keep] is false (default is true), the children of the node are
      removed before adding the new elements.

      Beware, this function ignores tyxml's type information.
  *)
end

module Wrap :
  Xml_wrap.T
    with type 'a t = 'a React.signal
     and type 'a tlist = 'a ReactiveData.RList.t
     and type ('a, 'b) ft = 'a -> 'b

module Util : sig
  val update_children : Dom.node Js.t -> Dom.node Js.t ReactiveData.RList.t -> unit
end

module R : sig
  module Xml : XML with module W = Wrap

  module Svg :
    Svg_sigs.Make(Xml).T
      with type +'a elt = 'a Svg.elt
       and type +'a attrib = 'a Svg.attrib

  module Html :
    Html_sigs.Make(Xml)(Svg).T
      with type +'a elt = 'a Html.elt
       and type +'a attrib = 'a Html.attrib

  val filter_attrib : 'a Html.attrib -> bool React.signal -> 'a Html.attrib

  (** @deprecated Use {!Tyxml_js.R.Html}. *)
  module Html5 :
    Html_sigs.Make(Xml)(Svg).T
      with type +'a elt = 'a Html.elt
       and type +'a attrib = 'a Html.attrib
end

module To_dom : Tyxml_cast_sigs.TO with type 'a elt = 'a Html.elt

module Of_dom : Tyxml_cast_sigs.OF with type 'a elt = 'a Html.elt