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

Touch interactions using Selenium Actions API #4237

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

dikwickley
Copy link
Contributor

@dikwickley dikwickley commented Jul 18, 2024

Fixes: dikwickley/gsoc24#3

This PR adds few touch interactions commands that use the selenium actions API. New commands are

  • tap
  • doubleTap
  • scrollElement
  • longPress
  • force param to browser.sendkeys
  • force param to browser.click

Thanks in advance for your contribution. Please follow the below steps in submitting a pull request, as it will help us with reviewing it quicker.

  • Before marking your PR for review, please test and verify your changes by making appropriate modifications to any of the Nightwatch example tests (present in examples/tests directory of the project) and running them. ecosia.js and duckDuckGo.js are good examples to work with.
  • Create a new branch from master (e.g. features/my-new-feature or issue/123-my-bugfix);
  • If you're fixing a bug also create an issue if one doesn't exist yet;
  • If it's a new feature explain why do you think it's necessary. Please check with the maintainers beforehand to make sure it is something that we will accept. Usually we only accept new features if we feel that they will benefit the entire community;
  • Please avoid sending PRs which contain drastic or low level changes. If you are certain that the changes are needed, please discuss them beforehand and indicate what the impact will be;
  • If your change is based on existing functionality please consider refactoring first. Pull requests that duplicate code will most likely be ignored;
  • Do not include changes that are not related to the issue at hand;
  • Follow the same coding style with regards to spaces, semicolons, variable naming etc.;
  • [ pending] Always add unit tests - PRs without tests are most of the times ignored.

@@ -2681,6 +2691,7 @@ export interface ElementCommands {
*/
click(
selector: Definition,
force: boolean,
Copy link
Member

Choose a reason for hiding this comment

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

The force option should be part of the new Element API commands.

Copy link
Contributor Author

@dikwickley dikwickley Aug 12, 2024

Choose a reason for hiding this comment

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

The click with force param is only available on ScopedElement and not on Selenium's WebElement.
This should be documented properly in the docs where we mention that when you await you get Selenium's WebElement and when used without await you get ScopedElement.

We do not recommend users to chain commands over Selenium's WebElement instance. They should be only used to pass into some other command as args.

There are links to the docs where we specify when and when not to use await.

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.

Add action commands
2 participants