Skip to content
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.

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

Update browser module dblclick docs #1456

Merged
merged 15 commits into from Jan 4, 2024
Merged

Update browser module dblclick docs #1456

merged 15 commits into from Jan 4, 2024

Conversation

ankur22
Copy link
Contributor

@ankur22 ankur22 commented Dec 20, 2023

What?

Updates the dblclick API for elementHandle, frame and locator.

Checklist

Please fill in this template:

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the make docs command locally and verified that the changes look good.

If updating the documentation for the next release of k6:

  • I have made my changes in the docs/sources/next folder of the documentation.

Related PR(s)/Issue(s)

Related to issue: grafana/xk6-browser#469

| <a href="https://playwright.dev/docs/api/class-frame#frame-child-frames" target="_blank" >frame.childFrames()</a> | - |
| <a href="https://playwright.dev/docs/api/class-frame#frame-click" target="_blank" >frame.click(selector[, options])</a> | - |
| <a href="https://playwright.dev/docs/api/class-frame#frame-content" target="_blank" >frame.content()</a> | - |
| [frame.dblclick(selector[, options])](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/frame/dblclick) | Double click on an element matching the provided `selector`. |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the change in this file.

@@ -7,28 +7,27 @@ excerpt: 'Browser module: locator.dblclick method'

{{% admonition type="caution" %}}

This feature has known issues. For details, refer to
[#469](https://github.com/grafana/xk6-browser/issues/469) and [#471](https://github.com/grafana/xk6-browser/issues/471).
This feature has known issues. For details, refer to [#471](https://github.com/grafana/xk6-browser/issues/471).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The main change is here.

Copy link
Member

@inancgumus inancgumus left a comment

Choose a reason for hiding this comment

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

It's nice that we've switched to our documentation 👏 Some mild suggestions.

Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
Copy link
Contributor

@ka3de ka3de left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

Just left a small style guide comment about i.e., everything else looks good! :shipit:

| options | object | `null` | |
| options.button | string | `left` | The mouse button (`left`, `middle` or `right`) to use during the action. |
| options.delay | number | `0` | Milliseconds to wait between `mousedown` and `mouseup`. |
| options.force | boolean | `false` | Bypasses the actionability checks (i.e., `visible`, `stable`, `enabled`) if set to `true`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same as previous comment.

@ankur22 ankur22 merged commit fb34756 into main Jan 4, 2024
6 checks passed
@ankur22 ankur22 deleted the update/browser-dblclick branch January 4, 2024 13:44
ankur22 added a commit that referenced this pull request Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants