package quickterface

  1. Overview
  2. Docs
Quick-to-program app interfaces in OCaml for terminal and web

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (1)

Authors

  1. O
    Ofsouzap <ofsouzap@gmail.com>

Maintainers

  1. O
    Ofsouzap <ofsouzap@gmail.com>

Sources

quickterface-0.1.0.tbz
sha256=8261e3819564fb5d05f1f313e62b73382152591d7a4349ae5b1b08a4fc2469f3
sha512=e739a971bb0e696ab716c168419c59a3d195922d2d1e4963106a845e3442ffa085b05106f36cceeec9b806bf7d6ef2c31e98db04911fbf73c5ac0ce626449d0f

doc/src/quickterface_web_app_backend/outputs.ml.html

Source file outputs.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
open! Core
open! Js_of_ocaml

module Output = struct
  module type S = sig
    type options
    type value
    type t

    val make :
      document:Dom_html.document Js.t ->
      options:options ->
      value:value ->
      t Lwt.t

    val element : t -> Dom_html.element Js.t
  end
end

module Text = struct
  type t = { element : Dom_html.element Js.t }

  let make ~document ~options:{ Quickterface.Output_text_options.color } ~value
      =
    let itemDiv = Dom_html.createDiv document in
    let newP = (Dom_html.createP document :> Dom_html.element Js.t) in
    newP##.innerText := Js.string value;
    (match color with
    | `Default -> ()
    | `Custom color ->
        newP##.style##.color
        := Js.string (Quickterface.Color.css_color_string color));
    Dom.appendChild itemDiv newP;

    Lwt.return { element = itemDiv }

  let element t = t.element
end

module Math = struct
  type t = { element : Dom_html.element Js.t }

  let katex_render ?(throw_on_error = true) latex_string ~target_element =
    let arg_string = Js.string latex_string |> Js.Unsafe.inject in
    let arg_element = target_element |> Js.Unsafe.inject in
    let arg_options =
      Js.Unsafe.obj
        [| ("throwOnError", Js.bool throw_on_error |> Js.Unsafe.inject) |]
      |> Js.Unsafe.inject
    in
    let _ =
      Js.Unsafe.fun_call
        (Js.Unsafe.js_expr "katex.render")
        [| arg_string; arg_element; arg_options |]
    in
    Lwt.return ()

  let make ~document ~options:{ Quickterface.Output_text_options.color } ~value
      =
    let itemDiv = Dom_html.createDiv document in
    (itemDiv##.className := Class.(to_js_string Output_math));
    (match color with
    | `Default -> ()
    | `Custom color ->
        itemDiv##.style##.color
        := Js.string (Quickterface.Color.css_color_string color));

    let%lwt () =
      katex_render
        (Quickterface.Math.latex_string_of_t value)
        ~target_element:itemDiv
    in
    Lwt.return { element = itemDiv }

  let element t = t.element
end

module Title = struct
  type t = { element : Dom_html.element Js.t }

  let make ~document ~options:() ~value =
    let itemDiv = Dom_html.createDiv document in
    let newH = (Dom_html.createH1 document :> Dom_html.element Js.t) in
    newH##.innerText := Js.string value;
    Dom.appendChild itemDiv newH;

    Lwt.return { element = itemDiv }

  let element t = t.element
end

module Progress_bar = struct
  type t = {
    element : Dom_html.element Js.t;
    bar_fill : Dom_html.divElement Js.t;
    progress_label : Dom_html.paragraphElement Js.t;
    maximum : int;
  }

  let make ~document ~label ~maximum =
    let item_div = Dom_html.createDiv document in
    (item_div##.className := Class.(to_js_string Progress_bar_item));

    (match label with
    | None -> ()
    | Some label ->
        let label_element = Dom_html.createP document in
        (label_element##.className := Class.(to_js_string Progress_bar_label));
        label_element##.innerText := Js.string label;
        Dom.appendChild item_div label_element);

    let bar_container = Dom_html.createDiv document in
    (bar_container##.className :=
       Class.(to_js_string Progress_bar_bar_container));
    Dom.appendChild item_div bar_container;

    let bar_fill = Dom_html.createDiv document in
    (bar_fill##.className :=
       Class.(to_js_string Progress_bar_bar_fill_in_progress));
    Dom.appendChild bar_container bar_fill;

    let progress_label = Dom_html.createP document in
    (progress_label##.className :=
       Class.(to_js_string Progress_bar_progress_label));
    progress_label##.innerText := Js.string "0%";
    Dom.appendChild item_div progress_label;

    Lwt.return { element = item_div; bar_fill; progress_label; maximum }

  let element t = t.element

  let set_value t value () =
    let percentage_fill = 100 * value / t.maximum in
    t.bar_fill##.style##.width
    := Js.string (Printf.sprintf "%d%%" percentage_fill);

    t.progress_label##.innerText
    := Js.string (Printf.sprintf "%d/%d" value t.maximum);

    Lwt.return ()

  let finish { bar_fill; _ } () =
    (bar_fill##.className :=
       Class.(to_js_string Progress_bar_bar_fill_completed));
    Lwt.return ()
end