Scrolling to element using webdriver?

Question

I am still learning and in response to one of my questions: here, I was told to that it might be due because the element in question is not in view.

I looked through the documentation and SO, here was the most relevant answer: here

You can use the "org.openqa.selenium.interactions.Actions" class to move to an element:

WebElement element = driver.findElement(By.id("my-id"));
Actions actions = new Actions(driver);
actions.moveToElement(element);
## actions.click();
actions.perform();

When I try to use the above to scroll to the element: It says WebElement not defined.

I think this is because I have not imported the relevant module. Can someone point out what I am supposed to import?

Edit: As pointed out by alecxe, this was java code.

But in the meantime right after trying to figure it out for some time. I have found out the import method for WebElement:

from selenium.webdriver.remote.webelement import WebElement

Might help someone like me.

The how of it is also a good lesson, IMO:

Went to: Documentation The

class selenium.webdriver.remote.webelement.WebElement(parent, id_, w3c=False)

Need to be separated into the command form mentioned above.

Community · Accepted Answer · 2017-05-23 10:31:07Z

226

You are trying to run Java code with Python. In Python/Selenium, the org.openqa.selenium.interactions.Actions are reflected in ActionChains class:

from selenium.webdriver.common.action_chains import ActionChains

element = driver.find_element_by_id("my-id")

actions = ActionChains(driver)
actions.move_to_element(element).perform()

Or, you can also "scroll into view" via scrollIntoView():

driver.execute_script("arguments[0].scrollIntoView();", element)

If you are interested in the differences:

scrollIntoView vs moveToElement

edited May 23, 2017 at 10:31

CommunityBot

11 silver badge

answered Jan 19, 2017 at 14:35

alecxe

476k127 gold badges1.1k silver badges1.2k bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Sid Over a year ago

Ah...there I was for 3 hours trying every method I found on SO and the documentation. I tried the first solution but must have messed it up somehow. I will read the ScrollIntoView Vs moveToElement. Just a quick question, I need the same steps to be done 100 times, I am thinking of using a for loop. Would this be a good approach?

oldboy Over a year ago

will move_to_element(ele).perform() simply scroll to an element, even if the element isn't currently in view?

jeepers mcface Over a year ago

@alecxe I don't get how this works (it doesn't with my project) because how can selenium find the object to scroll to if the object isn't visible? Mine is unable to locate the element that I want it to scroll to.

dotz Over a year ago

When I called move_to as you suggested, I got selenium.common.exceptions.MoveTargetOutOfBoundsException: Message: (164, 1297) is out of bounds of viewport width (1366) and height (694). I'm grateful for your answer and I think this IS the way (and also I've learned about ActionChains from your answer), but looks like it needs a bit of improvement. Thanks1

Fernando Over a year ago

find_element_by_id is now: element = driver.find_element(By.ID,'my-id'), as you can see here

|

Andersson · Accepted Answer · 2017-01-19 14:43:22Z

78

It's not a direct answer on question (its not about Actions), but it also allow you to scroll easily to required element:

element = driver.find_element_by_id('some_id')
element.location_once_scrolled_into_view

This actually intend to return you coordinates (x, y) of element on page, but also scroll down right to target element

answered Jan 19, 2017 at 14:43

Andersson

52.8k18 gold badges83 silver badges132 bronze badges

6 Comments

Sid Over a year ago

Thanks @Andersson I was trying to find the way to do this since you pointed out this might be the problem on the other question. :)

Lei Yang Over a year ago

at first i appended () behind, and error ''dict' object is not callable', i checked the element type is WebElement. then i removed () and worked. isn't this a method? I mean, why no () need?

Andersson Over a year ago

@LeiYang, because location_once_scrolled_into_view is a Python property. Properties takes no arguments (except object instance -self) and should be called without parenthesis

dotz Over a year ago

@Andersson .move_to_element() didn't work for me (I commented on alecxe answer) but yours solution did. THANKS!

DataAlchemist Over a year ago

@LeiYang Here is the source code about location_once_scrolled_into_view, to help explain why () not need : selenium/webelement.py at d3b6ad006bd7dbee59f8539d81cee4f06bd81d64 · SeleniumHQ/selenium

|

Neil C. Obremski · Accepted Answer · 2019-08-23 16:54:27Z

16

In addition to move_to_element() and scrollIntoView() I wanted to pose the following code which attempts to center the element in the view:

desired_y = (element.size['height'] / 2) + element.location['y']
window_h = driver.execute_script('return window.innerHeight')
window_y = driver.execute_script('return window.pageYOffset')
current_y = (window_h / 2) + window_y
scroll_y_by = desired_y - current_y

driver.execute_script("window.scrollBy(0, arguments[0]);", scroll_y_by)

answered Aug 23, 2019 at 16:54

Neil C. Obremski

20.6k26 gold badges102 silver badges136 bronze badges

2 Comments

Wonka Over a year ago

Thanks for your solution, tried other ways but element wasnt clickable. Some time not enought scroll, element was under "Chat box" on bottom, other code too much scroll element was on top below. menu

Sagie Over a year ago

An easier way to do this is simply: driver.execute_script('arguments[0].scrollIntoView({block: "center", inline: "center"})', elem)

vitaliis · Accepted Answer · 2020-12-20 07:27:11Z

8

Example:

driver.execute_script("arguments[0].scrollIntoView();", driver.find_element_by_css_selector(.your_css_selector))

This one always works for me for any type of selectors. There is also the Actions class, but for this case, it is not so reliable.

answered Dec 20, 2020 at 7:27

vitaliis

4,1975 gold badges26 silver badges48 bronze badges

Comments

ePandit · Accepted Answer · 2020-05-14 11:24:12Z

2

This can be done using driver.execute_script():-

driver.execute_script("document.getElementById('myelementid').scrollIntoView();")

answered May 14, 2020 at 11:24

ePandit

3,3032 gold badges27 silver badges16 bronze badges

Comments

Sagie · Accepted Answer · 2024-11-22 23:50:38Z

1

This might be helpful to whoever gets here, as the methods in the top answer here didn't work for me - actions.move_to_element(element).perform() did nothing, and driver.execute_script("arguments[0].scrollIntoView();", element) scrolled the view so the element was obscured by a floating menu bar positioned on top of the view. What worked for me was using scrollIntoView with options that centered it in the view, to make sure it was clickable:

driver.execute_script('arguments[0].scrollIntoView({block: "center", inline: "center"})', elem)

answered Nov 22, 2024 at 23:50

Sagie

2531 silver badge10 bronze badges

Comments

Andersson · Accepted Answer · 2018-11-27 13:38:59Z

0

There is another option to scroll page to required element if element has "id" attribute

If you want to navigate to page and scroll down to element with @id, it can be done automatically by adding #element_id to URL...

Example

Let's say we need to navigate to Selenium Waits documentation and scroll page down to "Implicit Wait" section. We can do

driver.get('https://selenium-python.readthedocs.io/waits.html')

and add code for scrolling...OR use

driver.get('https://selenium-python.readthedocs.io/waits.html#implicit-waits')

to navigate to page AND scroll page automatically to element with id="implicit-waits" (<div class="section" id="implicit-waits">...</div>)

answered Nov 27, 2018 at 13:38

Andersson

52.8k18 gold badges83 silver badges132 bronze badges

Comments

Antony Fuentes · Accepted Answer · 2019-07-12 23:26:34Z

0

You can scroll to the element by using javascript through the execute_javascript method. For example here is how I do it using SeleniumLibrary on Robot Framework:

web_element = self.selib.find_element(locator)
self.selib.execute_javascript(
    "ARGUMENTS",
    web_element,
    "JAVASCRIPT",
    'arguments[0].scrollIntoView({behavior: "instant", block: "start", inline: "start"});'
)

answered Jul 12, 2019 at 23:26

Antony Fuentes

1,0539 silver badges15 bronze badges

Collectives™ on Stack Overflow

Scrolling to element using webdriver?

8 Answers 8

6 Comments

6 Comments

2 Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

6 Comments

6 Comments

2 Comments

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related