jon.recoil.org
this repo has no description
Partial tooltip bindings
Format tooltip
+4
src/tooltip/dune
+4
src/tooltip/dune
+110
src/tooltip/tooltip.ml
+110
src/tooltip/tooltip.ml
···
1
+
open Code_mirror
2
+
3
+
let tooltip = Jv.get Jv.global "__CM__tooltip"
4
+
5
+
module Tooltip_view = struct
6
+
type t = Jv.t
7
+
8
+
include (Jv.Id : Jv.CONV with type t := t)
9
+
10
+
let dom t = Jv.get t "dom" |> Brr.El.of_jv
11
+
12
+
type offset = { x : int; y : int }
13
+
type coords = { left : int; right : int; top : int; bottom : int }
14
+
15
+
let offset_of_jv o = { x = Jv.Int.get o "x"; y = Jv.Int.get o "y" }
16
+
17
+
let offset_to_jv { x; y } =
18
+
let o = Jv.obj [||] in
19
+
Jv.Int.set o "x" x;
20
+
Jv.Int.set o "y" y;
21
+
o
22
+
23
+
let _coords_of_jv o =
24
+
{
25
+
left = Jv.Int.get o "left";
26
+
right = Jv.Int.get o "right";
27
+
top = Jv.Int.get o "top";
28
+
bottom = Jv.Int.get o "bottom";
29
+
}
30
+
31
+
let coords_to_jv { left; right; top; bottom } =
32
+
let o = Jv.obj [||] in
33
+
Jv.Int.set o "left" left;
34
+
Jv.Int.set o "right" right;
35
+
Jv.Int.set o "top" top;
36
+
Jv.Int.set o "bottom" bottom;
37
+
o
38
+
39
+
let offset t = Jv.get t "offset" |> offset_of_jv
40
+
41
+
let create ~dom ?offset ?get_coords ?overlap ?mount ?update ?positioned () =
42
+
let get_coords =
43
+
Option.map
44
+
(fun get_coords ->
45
+
Jv.repr (fun pos -> get_coords (Jv.to_int pos) |> coords_to_jv))
46
+
get_coords
47
+
in
48
+
let o = Jv.obj [||] in
49
+
Jv.set o "dom" (Brr.El.to_jv dom);
50
+
Jv.set_if_some o "offset" @@ Option.map offset_to_jv offset;
51
+
Jv.set_if_some o "getCoords" get_coords;
52
+
Jv.Bool.set_if_some o "overlap" overlap;
53
+
Jv.set_if_some o "mount"
54
+
@@ Option.map
55
+
(fun mount -> Jv.repr (fun view -> mount (Editor.View.of_jv view)))
56
+
mount;
57
+
Jv.set_if_some o "update"
58
+
@@ Option.map
59
+
(fun update ->
60
+
Jv.repr (fun view_up -> update (Editor.View.Update.of_jv view_up)))
61
+
update;
62
+
Jv.set_if_some o "positioned" @@ Option.map Jv.repr positioned;
63
+
o
64
+
end
65
+
66
+
module Tooltip = struct
67
+
type t = Jv.t
68
+
69
+
include (Jv.Id : Jv.CONV with type t := t)
70
+
71
+
let pos t = Jv.Int.get t "pos"
72
+
let end_ t = Jv.to_option Jv.to_int @@ Jv.get t "end"
73
+
74
+
let create ~pos ?end_ ~create ?above ?strict_side ?arrow () =
75
+
let o = Jv.obj [||] in
76
+
Jv.Int.set o "pos" pos;
77
+
Jv.Int.set_if_some o "end" end_;
78
+
Jv.set o "create"
79
+
@@ Jv.repr (fun view ->
80
+
create (Editor.View.of_jv view) |> Tooltip_view.to_jv);
81
+
Jv.Bool.set_if_some o "above" above;
82
+
Jv.Bool.set_if_some o "strictSide" strict_side;
83
+
Jv.Bool.set_if_some o "arrow" arrow;
84
+
o
85
+
end
86
+
87
+
type hover_config = Jv.t
88
+
89
+
let hover_config ?hide_on_change ?hover_time () =
90
+
let o = Jv.obj [||] in
91
+
Jv.Bool.set_if_some o "hide_on_change" hide_on_change;
92
+
Jv.Int.set_if_some o "hover_time" hover_time;
93
+
o
94
+
95
+
let hover_tooltip ?config source =
96
+
let source =
97
+
Jv.repr @@ fun view pos side ->
98
+
let fut =
99
+
source ~view:(Editor.View.of_jv view) ~pos:(Jv.to_int pos)
100
+
~side:(Jv.to_int side)
101
+
in
102
+
let fut = Fut.map (fun v -> Ok v) fut in
103
+
Fut.to_promise fut ~ok:(fun t ->
104
+
Option.value ~default:Jv.null (Option.map Tooltip.to_jv t))
105
+
in
106
+
let args =
107
+
if Option.is_none config then [| source |]
108
+
else [| source; Option.get config |]
109
+
in
110
+
Jv.call tooltip "hoverTooltip" args |> Extension.of_jv
+116
src/tooltip/tooltip.mli
+116
src/tooltip/tooltip.mli
···
1
+
open Code_mirror
2
+
3
+
val tooltip : Jv.t
4
+
(** Global tooltip value *)
5
+
6
+
module Tooltip_view : sig
7
+
(** Describes the way a tooltip is displayed. *)
8
+
9
+
type t
10
+
(** TooltypeView *)
11
+
12
+
include Jv.CONV with type t := t
13
+
14
+
val dom : t -> Brr.El.t
15
+
(** The DOM element to position over the editor. *)
16
+
17
+
type offset = { x : int; y : int }
18
+
type coords = { left : int; right : int; top : int; bottom : int }
19
+
20
+
val offset : t -> offset
21
+
22
+
val create :
23
+
dom:Brr.El.t ->
24
+
?offset:offset ->
25
+
?get_coords:(int -> coords) ->
26
+
?overlap:bool ->
27
+
?mount:(Editor.View.t -> unit) ->
28
+
?update:(Editor.View.Update.t -> unit) ->
29
+
?positioned:(unit -> unit) ->
30
+
unit ->
31
+
t
32
+
(** Creates a TooltipView:
33
+
34
+
@param dom The DOM element to position over the editor.
35
+
@param offset Adjust the position of the tooltip relative to its anchor
36
+
position.
37
+
@param get_coords This method can be provided to make the tooltip view
38
+
itself responsible for finding its screen position.
39
+
@param overlap By default, tooltips are moved when they overlap with other
40
+
tooltips. Set this to true to disable that behavior for this tooltip.
41
+
@param mount Called after the tooltip is added to the DOM for the first
42
+
time.
43
+
@param update Update the DOM element for a change in the view's state.
44
+
@param positioned Called when the tooltip has been (re)positioned.
45
+
46
+
{{:https://codemirror.net/6/docs/ref/#tooltip.TooltipView} See the
47
+
reference for additional information.} *)
48
+
end
49
+
50
+
(** Creates a Tooltip:
51
+
52
+
@param pos The document position at which to show the tooltip.
53
+
@param end The end of the range annotated by this tooltip, if different from
54
+
pos.
55
+
@param create A constructor function that creates the tooltip's DOM
56
+
representation.
57
+
@param above Whether the tooltip should be shown above or below the target
58
+
position.
59
+
@param strict_side Whether the above option should be honored when there
60
+
isn't enough space on that side to show the tooltip inside the viewport.
61
+
@param arrow When set to true, show a triangle connecting the tooltip element
62
+
to position pos.
63
+
64
+
{{:https://codemirror.net/6/docs/ref/#tooltip.Tooltip} See the
65
+
reference for additional information.} *)
66
+
module Tooltip : sig
67
+
(** Describes a tooltip. Values of this type, when provided through the
68
+
show_tooltip facet, control the individual tooltips on the editor. *)
69
+
70
+
type t
71
+
(** Tooltip *)
72
+
73
+
include Jv.CONV with type t := t
74
+
75
+
val pos : t -> int
76
+
(** The document position at which to show the tooltip. *)
77
+
78
+
val end_ : t -> int option
79
+
(** The end of the range annotated by this tooltip, if different from pos. *)
80
+
81
+
val create :
82
+
pos:int ->
83
+
?end_:int ->
84
+
create:(Editor.View.t -> Tooltip_view.t) ->
85
+
?above:bool ->
86
+
?strict_side:bool ->
87
+
?arrow:bool ->
88
+
unit ->
89
+
t
90
+
end
91
+
92
+
type hover_config
93
+
94
+
val hover_config :
95
+
?hide_on_change:bool -> ?hover_time:int -> unit -> hover_config
96
+
(** Options for hover tooltips:
97
+
98
+
@param hover_on_change When enabled (this defaults to false), close the
99
+
tooltip whenever the document changes.
100
+
@param hover_time Hover time after which the tooltip should appear, in
101
+
milliseconds. Defaults to 300ms. *)
102
+
103
+
val hover_tooltip :
104
+
?config:hover_config ->
105
+
(view:Editor.View.t -> pos:int -> side:int -> Tooltip.t option Fut.t) ->
106
+
Extension.t
107
+
(** Enable a hover tooltip, which shows up when the pointer hovers over ranges
108
+
of text. The callback is called when the mouse hovers over the document text.
109
+
It should, if there is a tooltip associated with position pos return the
110
+
tooltip description (either directly or in a promise). The side argument
111
+
indicates on which side of the position the pointer is—it will be -1 if the
112
+
pointer is before the position, 1 if after the position.
113
+
114
+
Note that all hover tooltips are hosted within a single tooltip container
115
+
element. This allows multiple tooltips over the same range to be "merged"
116
+
together without overlapping. *)