Skip to content

[draft] Implement the popover API. #1734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[draft] Implement the popover API. #1734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@
* Runtime: reimplement the runtime of weak and ephemeron (#1707)
* Lib: Modify Typed_array API for compatibility with WebAssembly
* Lib: add details element and toggle event (#1728)
* Lib: implement popover API (#1734)
* Toplevel: no longer set globals for toplevel initialization
* Runtime: precompute constants used in `caml_lxm_next` (#1730)
* Runtime: cleanup runtime
Expand Down
30 changes: 28 additions & 2 deletions lib/js_of_ocaml/dom_html.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,10 @@ and eventTarget = object ('self)

method onpointerup : ('self t, pointerEvent t) event_listener writeonly_prop

method onbeforetoggle : ('self t, toggleEvent t) event_listener writeonly_prop

method ontoggle : ('self t, toggleEvent t) event_listener writeonly_prop

Comment on lines +572 to +575
Copy link
Contributor Author

@SylvainBoilard SylvainBoilard Nov 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are similar methods related to event handlers in this file that have the prop type instead of writeonly_prop. In fact, the ontoggle method initially used the former type. Is this new version correct?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

writeonly_prop is often used for situation where the property might be undefined.

method dispatchEvent : event t -> bool t meth
end

Expand Down Expand Up @@ -747,6 +751,8 @@ and element = object

method scrollHeight : int prop

method popover : js_string t opt prop

method getClientRects : clientRectList t meth

method getBoundingClientRect : clientRect t meth
Expand All @@ -759,6 +765,18 @@ and element = object

method blur : unit meth

method hidePopover : unit meth

method showPopover : unit meth

method showPopover_options : _ -> unit meth

method togglePopover : bool t meth

method togglePopover_force : bool t -> bool t meth

method togglePopover_options : _ -> bool t meth

Comment on lines +770 to +779
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the specs, these methods accept a dictionary as a parameter for passing options. How would that be reflected in Js_of_ocaml?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is an example in lib/js_of_ocaml/eventSource.ml

inherit eventTarget
end

Expand Down Expand Up @@ -979,6 +997,8 @@ module Event = struct

let waiting = Dom.Event.make "waiting"

let beforetoggle = Dom.Event.make "beforetoggle"

let toggle = Dom.Event.make "toggle"

let make = Dom.Event.make
Expand Down Expand Up @@ -1209,6 +1229,10 @@ class type inputElement = object ('self)

method selectionEnd : int prop

method popovertarget : element t opt prop

method popovertargetaction : js_string t prop

method onselect : ('self t, event t) event_listener prop

method onchange : ('self t, event t) event_listener prop
Expand Down Expand Up @@ -1284,6 +1308,10 @@ class type buttonElement = object
method _type : js_string t readonly_prop

method value : js_string t prop

method popovertarget : element t opt prop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be popoverTargetElement ?


method popovertargetaction : js_string t prop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be popoverTargetAction ?

end

class type labelElement = object
Expand Down Expand Up @@ -1400,8 +1428,6 @@ class type detailsElement = object ('self)
method open_ : bool t prop

method name : js_string t prop

method ontoggle : ('self t, toggleEvent t) event_listener prop
end

class type imageElement = object ('self)
Expand Down
30 changes: 28 additions & 2 deletions lib/js_of_ocaml/dom_html.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,10 @@ and eventTarget = object ('self)

method onpointerup : ('self t, pointerEvent t) event_listener writeonly_prop

method onbeforetoggle : ('self t, toggleEvent t) event_listener writeonly_prop

method ontoggle : ('self t, toggleEvent t) event_listener writeonly_prop

method dispatchEvent : event t -> bool t meth
end

Expand Down Expand Up @@ -767,6 +771,8 @@ and element = object

method scrollHeight : int prop

method popover : js_string t opt prop

method getClientRects : clientRectList t meth

method getBoundingClientRect : clientRect t meth
Expand All @@ -779,6 +785,18 @@ and element = object

method blur : unit meth

method hidePopover : unit meth

method showPopover : unit meth

method showPopover_options : _ -> unit meth

method togglePopover : bool t meth

method togglePopover_force : bool t -> bool t meth

method togglePopover_options : _ -> bool t meth

inherit eventTarget
end

Expand Down Expand Up @@ -1021,6 +1039,10 @@ class type inputElement = object ('self)

method selectionEnd : int prop

method popovertarget : element t opt prop

method popovertargetaction : js_string t prop

method onselect : ('self t, event t) event_listener prop

method onchange : ('self t, event t) event_listener prop
Expand Down Expand Up @@ -1096,6 +1118,10 @@ class type buttonElement = object
method _type : js_string t readonly_prop

method value : js_string t prop

method popovertarget : element t opt prop

method popovertargetaction : js_string t prop
end

class type labelElement = object
Expand Down Expand Up @@ -1212,8 +1238,6 @@ class type detailsElement = object ('self)
method open_ : bool t prop

method name : js_string t prop

method ontoggle : ('self t, toggleEvent t) event_listener prop
end

class type imageElement = object ('self)
Expand Down Expand Up @@ -2580,6 +2604,8 @@ module Event : sig

val waiting : mediaEvent t typ

val beforetoggle : toggleEvent t typ

val toggle : toggleEvent t typ

val make : string -> 'a typ
Expand Down
Loading