Skip to content

Add show and hide events to the spec #4

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

Merged
almarklein merged 2 commits into from
Mar 18, 2026
Merged

Add show and hide events to the spec #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbec3af
Add show and hide events to the spec
almarklein Mar 18, 2026
13d015e
update date
almarklein Mar 18, 2026
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
40 changes: 31 additions & 9 deletions src/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

A protocol for interactive rendering surfaces.

*Last update: 09-05-2025*
*Last update: 18-03-2026*

*This spec was previously known as the jupyter_rfb event spec, but was rolled into a separate project.*

Expand Down Expand Up @@ -31,7 +31,7 @@ This spec if used by:

## Controlling the view

The way that the view (a.k.a. canvas, surface) can be controlled is left up to
The way that the view (a.k.a. canvas, surface, widget) can be controlled is left up to
the implementation. This spec does not say much about it, except for the
following suggestions for settable things:

Expand Down Expand Up @@ -60,7 +60,7 @@ are well-defined, they can always be serialized to json, and send to other progr

### resize

This event is emitted when the widget changes size.
This event is emitted when the canvas changes size.


Fields:
Expand All @@ -76,14 +76,36 @@ Fields:

### close

This event is emitted when the widget is closed (i.e. destroyed).
This event is emitted when the canvas is closed (i.e. destroyed).

Fields:

* `event_type`: 'close'
* `time_stamp`: A timestamp in seconds.


### show

This event is emitted when the canvas is shown. The implementation may
optionally emit an initial 'show' event; the canvas is initially assumed to be
shown. If this is not the case, the implementation should emit a 'hide' event.

Fields:

* `event_type`: 'show'
* `time_stamp`: A timestamp in seconds.


### hide

This event is emitted when the canvas is hidden. It can e.g. be minimized or scrolled out of view.

Fields:

* `event_type`: 'hide'
* `time_stamp`: A timestamp in seconds.


### pointer_down

This event is emitted when the user interacts with mouse, touch or other pointer devices, by pressing it down.
Expand Down Expand Up @@ -135,7 +157,7 @@ Fields:

### pointer_enter

This event is emitted when the user moves a pointer into the boundary of the widget.
This event is emitted when the user moves a pointer into the boundary of the canvas.

Fields:

Expand All @@ -145,7 +167,7 @@ Fields:

### pointer_leave

This event is emitted when the user moves a pointer out of the boundary of the widget.
This event is emitted when the user moves a pointer out of the boundary of the canvas.

Fields:

Expand Down Expand Up @@ -259,11 +281,11 @@ Positive `x` moves to the right, positive `y` moves down.

### Event capturing

The `pointer_move` event only occurs when the pointer is over the widget,
The `pointer_move` event only occurs when the pointer is over the canvas,
unless a button is down (i.e. dragging). The `pointer_down` event can only
occur inside the widget, the `pointer_up` can occur outside of the widget.
occur inside the canvas, the `pointer_up` can occur outside of the canvas.

Some events only work when the widget has focus within the application
Some events only work when the canvas has focus within the application
(i.e. having received a pointer down).
This applies to the `key_down`, `key_up`, and `wheel` events.

Expand Down
Loading