Skip to content

[Technical review] BiDi - Add pages for input module commands and event#43919

Open
dipikabh wants to merge 3 commits intomdn:mainfrom
dipikabh:bidi-input
Open

[Technical review] BiDi - Add pages for input module commands and event#43919
dipikabh wants to merge 3 commits intomdn:mainfrom
dipikabh:bidi-input

Conversation

@dipikabh
Copy link
Copy Markdown
Contributor

@dipikabh dipikabh commented Apr 24, 2026

Description

This PR adds the following pages:

  • input.performActions
  • input.releaseActions
  • input.setFiles
  • input.fileDialogOpened

Quick 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, and log modules in a follow-up PR.

Spec links

Related issue

Doc issue: mdn/mdn#339

@dipikabh dipikabh requested a review from a team April 24, 2026 00:40
@dipikabh dipikabh requested review from a team as code owners April 24, 2026 00:40
@dipikabh dipikabh requested review from pepelsbey and removed request for a team April 24, 2026 00:40
@github-actions github-actions Bot added the Content:WebDriver WebDriver docs label Apr 24, 2026
@dipikabh dipikabh removed request for a team and pepelsbey April 24, 2026 00:40
@github-actions github-actions Bot added the size/m [PR only] 51-500 LoC changed label Apr 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

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: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/input/fileDialogOpened
Title: input.fileDialogOpened event
Flaw count: 1

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/input/performActions
Title: input.performActions command
Flaw count: 6

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/script/evaluate doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/script/callFunction doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/script/evaluate doesn't resolve
    • and 1 more flaws omitted

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/input/setFiles
Title: input.setFiles command
Flaw count: 6

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/script/evaluate doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/script/callFunction doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/script/evaluate doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/script/callFunction doesn't resolve
    • and 1 more flaws omitted

(comment last updated: 2026-04-27 23:11:13)

@github-actions github-actions Bot added size/l [PR only] 501-1000 LoC changed and removed size/m [PR only] 51-500 LoC changed labels Apr 27, 2026
@dipikabh dipikabh changed the title [Technical review] BiDi - Add pages for input module commands [Technical review] BiDi - Add pages for input module commands and event Apr 27, 2026
Copy link
Copy Markdown
Contributor

@whimboo whimboo left a comment

Choose a reason for hiding this comment

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

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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}}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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"`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:WebDriver WebDriver docs size/l [PR only] 501-1000 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants