package bonsai

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file form.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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
open! Core
open Bonsai_web
open Bonsai.Let_syntax

module View = struct
  module Private = View
  include View

  let to_vdom ?(custom = View.to_vdom) ?on_submit ?editable t =
    custom ?on_submit ?editable t
  ;;
end

module T = struct
  type ('read, 'write) unbalanced =
    { value : 'read Or_error.t
    ; view : View.t
    ; set : 'write -> unit Vdom.Effect.t
    }
  [@@deriving fields]

  type 'a t = ('a, 'a) unbalanced

  let value_or_default t ~default = t |> value |> Or_error.ok |> Option.value ~default

  let normalize { value; set; view = _ } =
    match value with
    | Ok value -> set value
    | Error _ -> Ui_effect.Ignore
  ;;
end

include T

module Submit = struct
  type 'a t =
    { f : 'a -> unit Ui_effect.t
    ; handle_enter : bool
    ; button_text : string option
    }

  let create ?(handle_enter = true) ?(button = Some "submit") ~f () =
    { f; handle_enter; button_text = button }
  ;;
end

let view_as_vdom ?on_submit ?(editable = `Yes_always) t =
  let on_submit =
    Option.map on_submit ~f:(fun { Submit.f; handle_enter; button_text } ->
      let on_submit = t.value |> Result.ok |> Option.map ~f in
      { View.on_submit; handle_enter; button_text })
  in
  View.to_vdom ?on_submit ~editable t.view
;;

let is_valid t = Or_error.is_ok t.value

let return value =
  { value = Ok value; view = View.Empty; set = (fun _ -> Ui_effect.Ignore) }
;;

let return_error error =
  { value = Error error; view = View.Empty; set = (fun _ -> Ui_effect.Ignore) }
;;

let map_error t ~f = { t with value = t.value |> Result.map_error ~f }

let map t ~f =
  let value = Or_error.map t.value ~f in
  { value; view = t.view; set = t.set }
;;

let contra_map t ~f =
  let set a = t.set (f a) in
  { value = t.value; view = t.view; set }
;;

let both a b =
  let value = Or_error.both a.value b.value in
  let view = View.concat a.view b.view in
  let set (ea, eb) = Ui_effect.Many [ a.set ea; b.set eb ] in
  { value; view; set }
;;

let both_for_profunctor a b =
  let value = Or_error.both a.value b.value in
  let view = View.concat a.view b.view in
  let set v = Ui_effect.Many [ a.set v; b.set v ] in
  { value; view; set }
;;

let label' label t = { t with view = View.set_label label t.view }
let label text = label' (Vdom.Node.text text)
let tooltip' tooltip t = { t with view = View.set_tooltip tooltip t.view }
let tooltip text = tooltip' (Vdom.Node.text text)
let group' label t = { t with view = View.group label t.view }
let group text = group' (Vdom.Node.text text)

let project' t ~parse ~unparse =
  let value =
    Or_error.bind t.value ~f:(fun a -> Or_error.try_with_join (fun () -> parse a))
  in
  let set a = t.set (unparse a) in
  { value; view = t.view; set }
;;

let validate t ~f =
  project' t ~parse:(fun a -> f a |> Or_error.map ~f:(fun () -> a)) ~unparse:Fn.id
;;

let project t ~parse_exn ~unparse = project' t ~parse:(fun a -> Ok (parse_exn a)) ~unparse

let optional' (type a b) (t : a t) ~parse ~unparse ~none : b option t =
  project' t ~parse ~unparse:(Option.value_map ~default:none ~f:unparse)
;;

let optional t ~is_some ~none =
  let parse a = if is_some a then Ok (Some a) else Ok None in
  optional' t ~parse ~unparse:Fn.id ~none
;;

module Record_builder = struct
  include Profunctor.Record_builder (struct
      type ('read, 'write) t = ('read, 'write) unbalanced

      let both = both_for_profunctor
      let map = map
      let contra_map = contra_map
    end)

  let label_of_field fieldslib_field =
    fieldslib_field
    |> Fieldslib.Field.name
    |> String.map ~f:(function
      | '_' -> ' '
      | other -> other)
    |> Vdom.Node.text
  ;;

  let attach_fieldname_to_error t fieldslib_field =
    Result.map_error
      t.value
      ~f:(Error.tag ~tag:(sprintf "in field %s" (Fieldslib.Field.name fieldslib_field)))
  ;;

  (* This function "overrides" the [field] function inside of Record_builder
     by adding a label *)
  let field t fieldslib_field =
    let label = label_of_field fieldslib_field in
    let value = attach_fieldname_to_error t fieldslib_field in
    let view = View.suggest_label label t.view in
    let with_label = { t with view; value } in
    field with_label fieldslib_field
  ;;

  let build_for_record a =
    let t = build_for_record a in
    { t with view = View.Group { label = None; tooltip = None; view = t.view } }
  ;;
end

module Dynamic = struct
  let with_default default form =
    let open Bonsai.Let_syntax in
    let%sub is_loaded, set_is_loaded =
      Bonsai.state [%here] (module Bool) ~default_model:false
    in
    let%sub () =
      Bonsai.Edge.lifecycle
        ~on_activate:
          (let%map default = default
           and is_loaded = is_loaded
           and set_is_loaded = set_is_loaded
           and form = form in
           if not is_loaded
           then Ui_effect.Many [ set form default; set_is_loaded true ]
           else Ui_effect.Ignore)
        ()
    in
    return form
  ;;

  let error_hint t =
    let f view ~error =
      let if_not_none value ~f = Option.value_map value ~default:Fn.id ~f in
      view |> if_not_none error ~f:View.suggest_error
    in
    let t =
      let%sub error_hovered = Bonsai.state [%here] (module Bool) ~default_model:false in
      let%sub error_clicked = Bonsai.state [%here] (module Bool) ~default_model:false in
      Bonsai.read
      @@ let%map t = t
      and is_error_hovered, set_error_hovered = error_hovered
      and is_clicked, set_clicked = error_clicked in
      let on_click = set_clicked (not is_clicked) in
      let error_details =
        Option.map (Result.error t.value) ~f:(fun error ->
          { View.Error_details.is_viewing = is_error_hovered || is_clicked
          ; error
          ; on_mouse_over = set_error_hovered true
          ; on_mouse_out = set_error_hovered false
          ; on_click
          ; is_toggled = is_clicked
          })
      in
      { t with view = f t.view ~error:error_details }
    in
    t
  ;;

  let collapsible_group ?(starts_open = true) label t =
    let%sub open_state = Bonsai.state [%here] (module Bool) ~default_model:starts_open in
    Bonsai.read
    @@ let%map is_open, set_is_open = open_state
    and label = label
    and t = t in
    let label =
      Vdom.Node.div
        ~attr:
          (Vdom.Attr.many_without_merge
             [ Vdom.Attr.on_click (fun _ -> set_is_open (not is_open))
             ; Vdom.Attr.style
                 Css_gen.(
                   user_select `None @> Css_gen.create ~field:"cursor" ~value:"pointer")
             ])
        [ Vdom.Node.text (if is_open then "▾ " ^ label else "► " ^ label) ]
    in
    let form = group' label t in
    let view =
      match is_open, form.view with
      | false, Group { label; tooltip; _ } ->
        View.Group { label; tooltip; view = Empty }
      | _, other -> other
    in
    { form with view }
  ;;

  let on_change
        (type a)
        ?(on_error = Value.return (Fn.const Ui_effect.Ignore))
        (module M : Bonsai.Model with type t = a)
        ~f
        value_to_watch
    =
    let module M_or_error = struct
      type t = M.t Or_error.t [@@deriving equal, sexp]
    end
    in
    let callback =
      let%map f = f
      and on_error = on_error in
      function
      | Error e -> on_error e
      | Ok new_value -> f new_value
    in
    Bonsai.Edge.on_change [%here] (module M_or_error) (value_to_watch >>| value) ~callback
  ;;

  let validate_via_effect
        (type a)
        (module Input : Bonsai.Model with type t = a)
        (t : a t Bonsai.Value.t)
        ~f
    =
    let module Validated = struct
      type t = Input.t Or_error.t [@@deriving sexp, equal]
    end
    in
    match%sub t >>| value with
    | Error _ -> Bonsai.read t
    | Ok value ->
      let%sub validation =
        Bonsai.Edge.Poll.(
          effect_on_change
            [%here]
            (module Input)
            (module Validated)
            Starting.empty
            value
            ~effect:
              (let%map f = f in
               fun a ->
                 match%map.Effect f a with
                 | Ok () -> Ok a
                 | Error e -> Error e))
      in
      Bonsai.read
      @@ let%map t = t
      and validation = validation in
      validate t ~f:(fun a ->
        match validation with
        | Some (Ok x) when Input.equal a x -> Ok ()
        | None | Some (Ok _) -> Error (Error.of_string "validating...")
        | Some (Error e) -> Error e)
  ;;

  module Record_builder = struct
    include Profunctor.Record_builder (struct
        type ('read, 'write) t = ('read, 'write) unbalanced Value.t

        let both a b = Value.map2 a b ~f:both_for_profunctor
        let map a ~f = Value.map a ~f:(map ~f)
        let contra_map a ~f = Value.map a ~f:(contra_map ~f)
      end)

    let field ?(group_lists = true) t fieldslib_field =
      let label = Record_builder.label_of_field fieldslib_field in
      let with_label =
        let%map t = t in
        let view =
          (if group_lists then View.group_list t.view else t.view)
          |> View.suggest_label label
        in
        let value = Record_builder.attach_fieldname_to_error t fieldslib_field in
        { t with view; value }
      in
      field with_label fieldslib_field
    ;;

    let build_for_record creator =
      Bonsai.read
      @@ let%map t = build_for_record creator in
      { t with view = View.Group { label = None; tooltip = None; view = t.view } }
    ;;
  end
end

module Expert = struct
  let create = Fields_of_unbalanced.create
end

module Private = struct
  let group_list t = { t with view = View.group_list t.view }

  let suggest_label label t =
    { t with view = View.suggest_label (Vdom.Node.text label) t.view }
  ;;
end
OCaml

Innovation. Community. Security.