[Technical review] BiDi - Add pages for input module commands and event#43919
[Technical review] BiDi - Add pages for input module commands and event#43919
Conversation
|
Preview URLs (5 pages)
Flaws (13) Note! 2 documents with no flaws that don't need to be listed. 🎉 Found an unexpected or unresolvable flaw? Please report it here. URL:
URL:
URL:
(comment last updated: 2026-04-27 23:11:13) |
whimboo
left a comment
There was a problem hiding this comment.
Thank you for starting work on this module. It's clearly the most complicated one because it includes the action commands. For these I have indeed the most feedback for you. Please see my inline comments for all of these.
| The `params` field in the event notification is an object with the following fields: | ||
|
|
||
| - `context` | ||
| - : A string that contains the ID ([UUID](/en-US/docs/Glossary/UUID)) of the context in which the file picker dialog was triggered. |
There was a problem hiding this comment.
We do not use the reference to UUID in other places. Should we get started doing so?
|
|
||
| - `context` | ||
| - : A string that contains the ID ([UUID](/en-US/docs/Glossary/UUID)) of the context in which the file picker dialog was triggered. | ||
| Context IDs are returned by commands such as [`browsingContext.getTree`](/en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree). |
There was a problem hiding this comment.
This reference is also not used elsewhere.
| The `params` field contains: | ||
|
|
||
| - `context` | ||
| - : A string that contains the ID ([UUID](/en-US/docs/Glossary/UUID)) of the context in which to perform the actions. Context IDs are returned by commands such as [`browsingContext.getTree`](/en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree). |
There was a problem hiding this comment.
Similar comment to the UUID as mentioned for the event. Are you planning to continue using it? If yes, then we probably should update all pages simultaneously?
| | `"pointerMove"` | [`x`](#x), [`y`](#y), [`duration`](#duration), [`origin`](#origin), [pointer properties](#common_pointer_properties) | | ||
| | `"scroll"` | [`x`](#x), [`y`](#y), [`deltaX`](#deltax), [`deltaY`](#deltay), [`duration`](#duration), [`origin`](#origin) | | ||
|
|
||
| - `parameters` {{optional_inline}} |
There was a problem hiding this comment.
Hm, this entry is kinda glued to the bottom of the table and hard to spot as if margin/padding is missing. Could we improve that?
There was a problem hiding this comment.
As a workaround, I've added a lead-in sentence to add a gap between the table and the definition list. parameters still correctly renders as nested.
What do you think?
| Specify this when the `type` field value is `"scroll"`. | ||
| - `duration` {{optional_inline}} | ||
| - : A non-negative integer that specifies the time in milliseconds. | ||
| Specify this when the `type` field value is `"pause"`, `"pointerMove"`, or `"scroll"`. |
There was a problem hiding this comment.
We should note that specifying a duration splits the action into sub-steps per tick (~17 ms). For example, a 100 ms duration results in about 6 pointer moves, each covering roughly 1/6 of the total distance.
|
|
||
| ### Errors | ||
|
|
||
| - `no such element` |
There was a problem hiding this comment.
You missed the invalid argument and no such frame errors which are basically present for each of the commands which accept parameters and especially a context. We should check other already added commands if those are listed as well.
Description
This PR adds the following pages:
input.performActionsinput.releaseActionsinput.setFilesinput.fileDialogOpenedQuick note about short-titles in front matter: In this module, I've used shorter short-titles (eg, performActions instead of input.performActions) - this only affects command (and event) names in the sidebar and breadcrumb. I'll update the short-titles in the already published
session,browser, andlogmodules in a follow-up PR.Spec links
Related issue
Doc issue: mdn/mdn#339