Create the docs for the locator api for xk6-browser
#743
Conversation
This file contains 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
ankur22
force-pushed
the
docs/582-xk6-browser
branch
from
51e5ae0
to
7928525
Compare
ankur22
force-pushed
the
docs/459-xk6-browser-locator-class-docs
branch
2 times, most recently
from
b5779c5
to
8b9912d
Compare
imiric
suggested changes
Jul 28, 2022
There was a problem hiding this comment.
Nicely done! Just left some minor suggestions.
Also, I think we need examples, at least for some of the trickier methods like click(), selectOption(), type(), etc. We can follow Playwright's lead here and not include a fully working script, but just an example usage of each method.
We might want to add a full script to the main Locator page though. Maybe one of the scripts that @inancgumus added to the xk6-browser repo?
| @@ -1437,6 +1437,8 @@ const createRedirects = ({ actions }) => { | |||
| '/javascript-api/xk6-browser/jshandle/', | |||
| '/javascript-api/k6-x-browser/keyboard/': | |||
| '/javascript-api/xk6-browser/keyboard/', | |||
| '/javascript-api/k6-x-browser/locator/': | |||
| '/javascript-api/xk6-browser/locator/', | |||
There was a problem hiding this comment.
It's silly that we need these redirects for every xk6-browser page 😕 These are not some unique pages, so we should try to get rid of this (not in this PR, of course).
... Wait, we also have this for some k6 JS API pages. 😦
@ppcano Any ideas why this is needed? Can we change the directory-to-URL mapping instead?
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator/check--options--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator/click--options--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator/click--options--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator/inputvalue--options--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator/selectoption--options--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator/textcontent--options--.md
Outdated
Show resolved
Hide resolved
imiric
reviewed
Jul 28, 2022
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/09 Locator/press--options--.md
Outdated
Show resolved
Hide resolved
ankur22
force-pushed
the
docs/459-xk6-browser-locator-class-docs
branch
3 times, most recently
from
3ca9b89
to
4afb73c
Compare
ankur22
added a commit
that referenced
this pull request
Jul 29, 2022
ankur22
added a commit
that referenced
this pull request
Jul 29, 2022
ankur22
added a commit
that referenced
this pull request
Aug 1, 2022
ankur22
added a commit
that referenced
this pull request
Aug 1, 2022
ankur22
added a commit
that referenced
this pull request
Aug 1, 2022
Resolves: #743 (comment) Resolves: #743 (comment)
ankur22
force-pushed
the
docs/459-xk6-browser-locator-class-docs
branch
from
8d0fc6b
to
2a3d1d6
Compare
ankur22
added a commit
that referenced
this pull request
Aug 1, 2022
ankur22
added a commit
that referenced
this pull request
Aug 1, 2022
imiric
approved these changes
Aug 1, 2022
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/07 Locator/check--options--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/07 Locator/click--options--.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/30 xk6-browser/01 xk6-browser/07 Locator/inputvalue--options--.md
Show resolved
Hide resolved
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
Resolves: #743 (comment) Resolves: #743 (comment)
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
force-pushed
the
docs/459-xk6-browser-locator-class-docs
branch
from
19d2a60
to
5ed89cc
Compare
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
Resolves: #743 (comment) Resolves: #743 (comment)
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
added a commit
that referenced
this pull request
Aug 2, 2022
ankur22
force-pushed
the
docs/459-xk6-browser-locator-class-docs
branch
2 times, most recently
from
cd978b0
to
6775f46
Compare
This adds the locator docs for xk6-browser, and all the options that go along with it. It only documents the APIs that work or have known issues. Closes: grafana/xk6-browser#459
ankur22
force-pushed
the
docs/459-xk6-browser-locator-class-docs
branch
from
6775f46
to
573258c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes: grafana/xk6-browser#459
This change documents all the methods for the
locatorapi forxk6-browser. It was tested against grafana/xk6-browser@dbede12. Several issues were also raised that need to be resolved. Testing was only done on a Mac, and not on a Windows or Linux based system.