docs(events): document the delivery channel for browser view events - #5
Open
Klo1337 wants to merge 1 commit into
Open
docs(events): document the delivery channel for browser view events#5Klo1337 wants to merge 1 commit into
Klo1337 wants to merge 1 commit into
Conversation
The client contract declares Browser*Event payloads, but they are absent from EventMap and Web.on does not receive them, so there is no way to discover the delivery channel from the reference. Verified on a live server: they arrive in the shared Events.on table under camelCase names (browserInputFocusChange, browserCursorChange, ...) with the payload as a single argument. Documents that, with the viewId filtering caveat and the input-focus use case.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The client contract declares the
Browser*Eventpayload interfaces (BrowserInputFocusChangeEvent,BrowserCursorChangeEvent, …), but they are not inEventMapandWeb.ondoes not receive them, so the reference gives no way to find out how to subscribe.Verified on a live server (build
1.0.0-3a40a8f): they are dispatched to the sharedEvents.ontable under camelCase names derived from the payload interface (browserInputFocusChange,browserCursorChange), with the payload object as a single argument; a parallelWeb.on(viewId, ...)subscription with the same names never fires.This adds a short section to the events guide documenting the channel, the
viewIdfiltering caveat, and the main practical use (browserInputFocusChangeas the reliable hotkey gate while typing into CEF).If the intended design is different (e.g. these belong in
EventMap), happy to rework the wording.