package bonsai

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

Source file column_intf.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
open! Core
open! Bonsai_web
module Sort_kind = Bonsai_web_ui_partial_render_table_protocol.Sort_kind

module type S = sig
  type t
  type key
  type data
  type column_id

  val headers : t -> column_id Header_tree.t Computation.t

  val instantiate_cells
    :  t
    -> (key, 'cmp) Bonsai.comparator
    -> (key * data) Opaque_map.t Value.t
    -> (key * (column_id * Vdom.Node.t) list) Opaque_map.t Computation.t
end

module type S_with_sorter = sig
  type t
  type key
  type data
  type column_id
  type column_id_cmp

  val headers_and_sorters
    :  multisort_columns_when:[ `Shift_click | `Ctrl_click | `Shift_or_ctrl_click ] Value.t
    -> t
    -> column_id Sortable.t Value.t
    -> ((column_id, (key, data) Sort_kind.t, column_id_cmp) Map.t
       * column_id Header_tree.t)
       Computation.t

  val instantiate_cells
    :  t
    -> (key, 'cmp) Bonsai.comparator
    -> (key * data) Opaque_map.t Value.t
    -> (key * (column_id * Vdom.Node.t) list) Opaque_map.t Computation.t
end

type ('key, 'data, 'column_id) t =
  | T :
      { value : 'a
      ; vtable :
          (module S
             with type t = 'a
              and type key = 'key
              and type data = 'data
              and type column_id = 'column_id)
      ; column_id : ('column_id, 'column_id_cmp) Bonsai.comparator
      }
      -> ('key, 'data, 'column_id) t

type ('key, 'data, 'column_id) with_sorter =
  | Y :
      { value : 'a
      ; vtable :
          (module S_with_sorter
             with type t = 'a
              and type key = 'key
              and type data = 'data
              and type column_id = 'column_id
              and type column_id_cmp = 'column_id_cmp)
      ; column_id : ('column_id, 'column_id_cmp) Bonsai.comparator
      }
      -> ('key, 'data, 'column_id) with_sorter