com.codeborne.selenide

Class Selenide

java.lang.Object

com.codeborne.selenide.Selenide

@ParametersAreNonnullByDefault
public class Selenide
extends java.lang.Object

The main starting point of Selenide. You start with methods open(String) for opening the tested application page and $(String) for searching web elements.

Constructor Summary

Constructors

Constructor and Description
Selenide()

Method Summary

Modifier and Type	Method and Description
static SelenideElement	$(org.openqa.selenium.By seleniumSelector) Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!
static SelenideElement	$(org.openqa.selenium.By seleniumSelector, int index)
static SelenideElement	$(java.lang.String cssSelector) Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!
static SelenideElement	$(java.lang.String cssSelector, int index) Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!
static SelenideElement	$(org.openqa.selenium.WebElement webElement) Wrap standard Selenium WebElement into SelenideElement to use additional methods like shouldHave(), selectOption() etc.
static SelenideElement	$(org.openqa.selenium.WebElement parent, org.openqa.selenium.By seleniumSelector) Deprecated. please use $(parent).$(By) which is the same (method will not be removed until 4.x or later)
static SelenideElement	$(org.openqa.selenium.WebElement parent, org.openqa.selenium.By seleniumSelector, int index) Deprecated. please use $(parent).$(By, int) which is the same (method will not be removed until 4.x or later)
static SelenideElement	$(org.openqa.selenium.WebElement parent, java.lang.String cssSelector) Deprecated. please use $(parent).$(String) which is the same (method will not be removed until 4.x or later)
static SelenideElement	$(org.openqa.selenium.WebElement parent, java.lang.String cssSelector, int index) Deprecated. please use $(parent).$(String, int) which is the same (method will not be removed until 4.x or later)
static ElementsCollection	$$(org.openqa.selenium.By seleniumSelector) Locates all elements matching given CSS selector.
static ElementsCollection	$$(java.util.Collection<? extends org.openqa.selenium.WebElement> elements) Initialize collection with Elements
static ElementsCollection	$$(java.lang.String cssSelector) Locates all elements matching given CSS selector.
static ElementsCollection	$$(org.openqa.selenium.WebElement parent, org.openqa.selenium.By seleniumSelector) Deprecated. please use $(parent).$$(By) which is the same (method will not be removed until 4.x or later)
static ElementsCollection	$$(org.openqa.selenium.WebElement parent, java.lang.String cssSelector) Deprecated. please use $(parent).$$(String) which is the same (method will not be removed until 4.x or later)
static ElementsCollection	$$x(java.lang.String xpathExpression) Locates all elements matching given XPATH expression.
static SelenideElement	$x(java.lang.String xpathExpression) Locates the first element matching given XPATH expression ATTENTION! This method doesn't start any search yet!
static org.openqa.selenium.interactions.Actions	actions() With this method you can use Selenium Actions like described in the AdvancedUserInteractions page.
static boolean	atBottom() Return true if bottom of the page is reached Useful if you need to scroll down by x pixels unknown number of times.
static void	back() Navigate browser back to previous page
static void	clearBrowserCookies() Clear browser cookies.
static void	clearBrowserLocalStorage() Clear browser local storage.
static Clipboard	clipboard() Provide access to system clipboard, allows get and set String content.
static void	close() Deprecated. Use either closeWindow() or closeWebDriver()
static void	closeWebDriver() Close the browser if it's open.
static void	closeWindow() Close the current window, quitting the browser if it's the last window currently open.
static java.lang.String	confirm() Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'alert' or 'confirm').
static java.lang.String	confirm(java.lang.String expectedDialogText) Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'alert' or 'confirm').
static java.lang.String	dismiss() Dismiss (click "No" or "Cancel") in the confirmation dialog (javascript 'alert' or 'confirm').
static java.lang.String	dismiss(java.lang.String expectedDialogText) Dismiss (click "No" or "Cancel") in the confirmation dialog (javascript 'alert' or 'confirm').
static java.io.File	download(java.lang.String url) NB! URL must be properly encoded.
static java.io.File	download(java.lang.String url, long timeoutMs) Download file using a direct link.
static java.io.File	download(java.net.URI url)
static java.io.File	download(java.net.URI url, long timeoutMs)
static SelenideElement	element(org.openqa.selenium.By seleniumSelector) Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!
static SelenideElement	element(org.openqa.selenium.By seleniumSelector, int index) Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!
static SelenideElement	element(java.lang.String cssSelector) Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!
static SelenideElement	element(java.lang.String cssSelector, int index) Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!
static SelenideElement	element(org.openqa.selenium.WebElement webElement) Wrap standard Selenium WebElement into SelenideElement to use additional methods like shouldHave(), selectOption() etc.
static ElementsCollection	elements(org.openqa.selenium.By seleniumSelector) Locates all elements matching given CSS selector.
static ElementsCollection	elements(java.util.Collection<? extends org.openqa.selenium.WebElement> elements) Wrap standard Selenium WebElement collection into SelenideElement collection to use additional methods like shouldHave() etc.
static ElementsCollection	elements(java.lang.String cssSelector) Locates all elements matching given CSS selector.
static <T> T	executeAsyncJavaScript(java.lang.String jsCode, java.lang.Object... arguments)
static <T> T	executeJavaScript(java.lang.String jsCode, java.lang.Object... arguments)
static void	forward() Navigate browser forward to next page
static SelenideElement	getElement(org.openqa.selenium.By criteria) Deprecated. please use element(criteria) which is the same (method will not be removed until 4.x or later) Locates the first element matching given criteria ATTENTION! This method doesn't start any search yet!
static SelenideElement	getElement(org.openqa.selenium.By criteria, int index) Deprecated. please use element(criteria, index) which is the same (method will not be removed until 4.x or later) Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!
static ElementsCollection	getElements(org.openqa.selenium.By criteria) Deprecated. please use elements(criteria) which is the same (method will not be removed until 4.x or later) Locates all elements matching given CSS selector ATTENTION! This method doesn't start any search yet!
static org.openqa.selenium.WebElement	getFocusedElement()
static SelenideElement	getSelectedRadio(org.openqa.selenium.By radioField) Returns selected element in radio group
static java.lang.String	getUserAgent() Get current user agent from browser session
static java.util.List<java.lang.String>	getWebDriverLogs(java.lang.String logType) Same as com.codeborne.selenide.Selenide#getWebDriverLogs(java.lang.String, java.util.logging.Level)
static java.util.List<java.lang.String>	getWebDriverLogs(java.lang.String logType, java.util.logging.Level logLevel) Getting and filtering of the WebDriver logs for specified LogType by specified logging level For example to get WebDriver Browser's console output (including JS info, warnings, errors, etc.
static LocalStorage	localStorage() Access browser's local storage.
static void	open() Open an empty browser (without opening any pages).
static void	open(java.lang.String relativeOrAbsoluteUrl) The main starting point in your tests.
static void	open(java.lang.String relativeOrAbsoluteUrl, AuthenticationType authenticationType, Credentials credentials) The main starting point in your tests.
static void	open(java.lang.String relativeOrAbsoluteUrl, AuthenticationType authenticationType, java.lang.String login, java.lang.String password) The main starting point in your tests.
static <PageObjectClass> PageObjectClass	open(java.lang.String relativeOrAbsoluteUrl, java.lang.Class<PageObjectClass> pageObjectClassClass) Open a web page and create PageObject for it.
static void	open(java.lang.String relativeOrAbsoluteUrl, java.lang.String domain, java.lang.String login, java.lang.String password) The main starting point in your tests.
static <PageObjectClass> PageObjectClass	open(java.lang.String relativeOrAbsoluteUrl, java.lang.String domain, java.lang.String login, java.lang.String password, java.lang.Class<PageObjectClass> pageObjectClassClass) Open a web page using Basic Auth credentials and create PageObject for it.
static void	open(java.net.URL absoluteUrl)
static <PageObjectClass> PageObjectClass	open(java.net.URL absoluteUrl, java.lang.Class<PageObjectClass> pageObjectClassClass) Open a web page and create PageObject for it.
static void	open(java.net.URL absoluteUrl, java.lang.String domain, java.lang.String login, java.lang.String password)
static <PageObjectClass> PageObjectClass	open(java.net.URL absoluteUrl, java.lang.String domain, java.lang.String login, java.lang.String password, java.lang.Class<PageObjectClass> pageObjectClassClass) Open a web page using Basic Auth credentials and create PageObject for it.
static <PageObjectClass> PageObjectClass	page(java.lang.Class<PageObjectClass> pageObjectClass) Create a Page Object instance
static <PageObjectClass,T extends PageObjectClass> PageObjectClass	page(T pageObject) Initialize a given Page Object instance
static java.lang.String	prompt() Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'prompt').
static java.lang.String	prompt(java.lang.String inputText) Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'prompt').
static java.lang.String	prompt(java.lang.String expectedDialogText, java.lang.String inputText) Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'prompt').
static void	refresh() Reload current page
static <T> T	screenshot(org.openqa.selenium.OutputType<T> outputType) Take the screenshot of current page and return it.
static java.lang.String	screenshot(java.lang.String fileName) Take the screenshot of current page and save to file fileName.html and fileName.png
static SessionStorage	sessionStorage() Access browser's session storage.
static void	sleep(long milliseconds) Not recommended.
static SelenideTargetLocator	switchTo() Switch to window/tab/frame/parentFrame/innerFrame/alert.
static java.lang.String	title()
static void	updateHash(java.lang.String hash) Update the hash of the window location.
static void	using(org.openqa.selenium.WebDriver webDriver, java.lang.Runnable lambda)
static SelenideWait	Wait() Create a org.openqa.selenium.support.ui.FluentWait instance with Selenide timeout/polling.
static void	zoom(double factor) Zoom current page (in or out).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Selenide

public Selenide()

Method Detail

open

public static void open(java.lang.String relativeOrAbsoluteUrl)

The main starting point in your tests. Open a browser window with given URL. If browser window was already opened before, it will be reused. Don't bother about closing the browser - it will be closed automatically when all your tests are done.

Parameters:

relativeOrAbsoluteUrl - If not starting with "http://" or "https://" or "file://", it's considered to be relative URL. In this case, it's prepended by baseUrl

open

public static void open(java.net.URL absoluteUrl)

See Also:

open(String)

open

public static void open(java.lang.String relativeOrAbsoluteUrl,
                        java.lang.String domain,
                        java.lang.String login,
                        java.lang.String password)

The main starting point in your tests.

Open a browser window with given URL and credentials for basic authentication

If browser window was already opened before, it will be reused.

Don't bother about closing the browser - it will be closed automatically when all your tests are done.

If not starting with "http://" or "https://" or "file://", it's considered to be relative URL.

In this case, it's prepended by baseUrl

open

public static void open(java.lang.String relativeOrAbsoluteUrl,
                        AuthenticationType authenticationType,
                        java.lang.String login,
                        java.lang.String password)

The main starting point in your tests.

Open browser and pass authentication using build-in proxy.

A common authenticationType is "Basic". See Web HTTP reference for other types.

This method can only work if - Configuration.fileDownload == Configuration.FileDownloadMode.PROXY;

See Also:

Web HTTP reference, AuthenticationType

open

public static void open(java.lang.String relativeOrAbsoluteUrl,
                        AuthenticationType authenticationType,
                        Credentials credentials)

The main starting point in your tests.

Open browser and pass authentication using build-in proxy.

A common authenticationType is "Basic". See Web HTTP reference for other types.

This method can only work if - Configuration.fileDownload == Configuration.FileDownloadMode.PROXY;

See Also:

Web HTTP reference, AuthenticationType, Credentials

open

public static void open(java.net.URL absoluteUrl,
                        java.lang.String domain,
                        java.lang.String login,
                        java.lang.String password)

See Also:

open(URL, String, String, String)

open

public static void open()

Open an empty browser (without opening any pages). E.g. useful for starting mobile applications in Appium.

using

public static void using(org.openqa.selenium.WebDriver webDriver,
                         java.lang.Runnable lambda)

updateHash

public static void updateHash(java.lang.String hash)

Update the hash of the window location. Useful to navigate in ajax apps without reloading the page, since open(url) makes a full page reload.

Parameters:

hash - value for window.location.hash - Accept either "#hash" or "hash".

open

@CheckReturnValue
 @Nonnull
public static <PageObjectClass> PageObjectClass open(java.lang.String relativeOrAbsoluteUrl,
                                                                                 java.lang.Class<PageObjectClass> pageObjectClassClass)

Open a web page and create PageObject for it.

Returns:

PageObject of given class

open

@CheckReturnValue
 @Nonnull
public static <PageObjectClass> PageObjectClass open(java.net.URL absoluteUrl,
                                                                                 java.lang.Class<PageObjectClass> pageObjectClassClass)

Open a web page and create PageObject for it.

Returns:

PageObject of given class

open

@CheckReturnValue
 @Nonnull
public static <PageObjectClass> PageObjectClass open(java.lang.String relativeOrAbsoluteUrl,
                                                                                 java.lang.String domain,
                                                                                 java.lang.String login,
                                                                                 java.lang.String password,
                                                                                 java.lang.Class<PageObjectClass> pageObjectClassClass)

Open a web page using Basic Auth credentials and create PageObject for it.

Returns:

PageObject of given class

open

@CheckReturnValue
 @Nonnull
public static <PageObjectClass> PageObjectClass open(java.net.URL absoluteUrl,
                                                                                 java.lang.String domain,
                                                                                 java.lang.String login,
                                                                                 java.lang.String password,
                                                                                 java.lang.Class<PageObjectClass> pageObjectClassClass)

Open a web page using Basic Auth credentials and create PageObject for it.

Returns:

PageObject of given class

closeWindow

public static void closeWindow()

Close the current window, quitting the browser if it's the last window currently open.

See Also:

WebDriver.close()

closeWebDriver

public static void closeWebDriver()

Close the browser if it's open.

NB! Method quits this driver, closing every associated window.

See Also:

WebDriver.quit()

close

@Deprecated
public static void close()

Deprecated. Use either closeWindow() or closeWebDriver()

refresh

public static void refresh()

Reload current page

back

public static void back()

Navigate browser back to previous page

forward

public static void forward()

Navigate browser forward to next page

title

@CheckReturnValue
 @Nullable
public static java.lang.String title()

Returns:

title of the page

sleep

public static void sleep(long milliseconds)

Not recommended. Test should not sleep, but should wait for some condition instead.

Parameters:

milliseconds - Time to sleep in milliseconds

screenshot

@CheckReturnValue
 @Nullable
public static java.lang.String screenshot(java.lang.String fileName)

Take the screenshot of current page and save to file fileName.html and fileName.png

Parameters:

fileName - Name of file (without extension) to save HTML and PNG to

Returns:

The name of resulting file

screenshot

@CheckReturnValue
 @Nullable
public static <T> T screenshot(org.openqa.selenium.OutputType<T> outputType)

Take the screenshot of current page and return it.

Parameters:

outputType - type of the returned screenshot

Returns:

The screenshot (as bytes, base64 or temporary file) or null if webdriver does not support taking screenshots.

$

@CheckReturnValue
 @Nonnull
public static SelenideElement $(org.openqa.selenium.WebElement webElement)

Wrap standard Selenium WebElement into SelenideElement to use additional methods like shouldHave(), selectOption() etc.

Parameters:

webElement - standard Selenium WebElement

Returns:

given WebElement wrapped into SelenideElement

$

@CheckReturnValue
 @Nonnull
public static SelenideElement $(java.lang.String cssSelector)

Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!

Parameters:

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

Returns:

SelenideElement

$x

@CheckReturnValue
 @Nonnull
public static SelenideElement $x(java.lang.String xpathExpression)

Locates the first element matching given XPATH expression ATTENTION! This method doesn't start any search yet!

Parameters:

xpathExpression - any XPATH expression //*[@id='value'] //E[contains(@A, 'value')]

Returns:

SelenideElement which locates elements via XPath

$

@CheckReturnValue
 @Nonnull
public static SelenideElement $(org.openqa.selenium.By seleniumSelector)

Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!

Parameters:

seleniumSelector - any Selenium selector like By.id(), By.name() etc.

Returns:

SelenideElement

$

@CheckReturnValue
 @Nonnull
public static SelenideElement $(org.openqa.selenium.By seleniumSelector,
                                                            int index)

See Also:

getElement(By, int)

$

@Deprecated
 @Nonnull
public static SelenideElement $(org.openqa.selenium.WebElement parent,
                                                      java.lang.String cssSelector)

Deprecated. please use $(parent).$(String) which is the same (method will not be removed until 4.x or later)

Parameters:

parent - the WebElement to search elements in

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

Returns:

SelenideElement

See Also:

Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!

$

@CheckReturnValue
 @Nonnull
public static SelenideElement $(java.lang.String cssSelector,
                                                            int index)

Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!

Parameters:

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

index - 0..N

Returns:

SelenideElement

$

@Deprecated
 @CheckReturnValue
 @Nonnull
public static SelenideElement $(org.openqa.selenium.WebElement parent,
                                                                         java.lang.String cssSelector,
                                                                         int index)

Deprecated. please use $(parent).$(String, int) which is the same (method will not be removed until 4.x or later)

Parameters:

parent - the WebElement to search elements in

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

index - 0..N

Returns:

SelenideElement

See Also:

Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!

$

@Deprecated
 @CheckReturnValue
 @Nonnull
public static SelenideElement $(org.openqa.selenium.WebElement parent,
                                                                         org.openqa.selenium.By seleniumSelector)

Deprecated. please use $(parent).$(By) which is the same (method will not be removed until 4.x or later)

Parameters:

parent - the WebElement to search elements in

seleniumSelector - any Selenium selector like By.id(), By.name() etc.

Returns:

SelenideElement

See Also:

Locates the first element matching given criteria ATTENTION! This method doesn't start any search yet!

$

@Deprecated
 @CheckReturnValue
 @Nonnull
public static SelenideElement $(org.openqa.selenium.WebElement parent,
                                                                         org.openqa.selenium.By seleniumSelector,
                                                                         int index)

Deprecated. please use $(parent).$(By, int) which is the same (method will not be removed until 4.x or later)

Parameters:

parent - the WebElement to search elements in

seleniumSelector - any Selenium selector like By.id(), By.name() etc.

index - 0..N

Returns:

SelenideElement

See Also:

Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!

$$

@CheckReturnValue
 @Nonnull
public static ElementsCollection $$(java.util.Collection<? extends org.openqa.selenium.WebElement> elements)

Initialize collection with Elements

$$

@CheckReturnValue
 @Nonnull
public static ElementsCollection $$(java.lang.String cssSelector)

Locates all elements matching given CSS selector. ATTENTION! This method doesn't start any search yet! Methods returns an ElementsCollection which is a list of WebElement objects that can be iterated, and at the same time is implementation of WebElement interface, meaning that you can call methods .sendKeys(), click() etc. on it.

Parameters:

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

Returns:

empty list if element was no found

$$x

@CheckReturnValue
 @Nonnull
public static ElementsCollection $$x(java.lang.String xpathExpression)

Locates all elements matching given XPATH expression. ATTENTION! This method doesn't start any search yet! Methods returns an ElementsCollection which is a list of WebElement objects that can be iterated, and at the same time is implementation of WebElement interface, meaning that you can call methods .sendKeys(), click() etc. on it.

Parameters:

xpathExpression - any XPATH expression //*[@id='value'] //E[contains(@A, 'value')]

Returns:

ElementsCollection which locates elements via XPath

$$

@CheckReturnValue
 @Nonnull
public static ElementsCollection $$(org.openqa.selenium.By seleniumSelector)

Locates all elements matching given CSS selector. ATTENTION! This method doesn't start any search yet! Methods returns an ElementsCollection which is a list of WebElement objects that can be iterated, and at the same time is implementation of WebElement interface, meaning that you can call methods .sendKeys(), click() etc. on it.

Parameters:

seleniumSelector - any Selenium selector like By.id(), By.name() etc.

Returns:

empty list if element was no found

$$

@Deprecated
 @CheckReturnValue
 @Nonnull
public static ElementsCollection $$(org.openqa.selenium.WebElement parent,
                                                                             java.lang.String cssSelector)

Deprecated. please use $(parent).$$(String) which is the same (method will not be removed until 4.x or later)

Parameters:

parent - the WebElement to search elements in

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

Returns:

empty list if element was no found

See Also:

Locates all elements matching given CSS selector inside given parent element ATTENTION! This method doesn't start any search yet! Methods returns an ElementsCollection which is a list of WebElement objects that can be iterated, and at the same time is implementation of WebElement interface, meaning that you can call methods .sendKeys(), click() etc. on it.

$$

@Deprecated
 @CheckReturnValue
 @Nonnull
public static ElementsCollection $$(org.openqa.selenium.WebElement parent,
                                                                             org.openqa.selenium.By seleniumSelector)

Deprecated. please use $(parent).$$(By) which is the same (method will not be removed until 4.x or later)

See Also:

Locates all elements matching given criteria inside given parent element ATTENTION! This method doesn't start any search yet!, $$(WebElement, String)

element

@CheckReturnValue
 @Nonnull
public static SelenideElement element(org.openqa.selenium.WebElement webElement)

Wrap standard Selenium WebElement into SelenideElement to use additional methods like shouldHave(), selectOption() etc.

Parameters:

webElement - standard Selenium WebElement

Returns:

given WebElement wrapped into SelenideElement

element

@CheckReturnValue
 @Nonnull
public static SelenideElement element(java.lang.String cssSelector)

Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!

Parameters:

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

Returns:

SelenideElement

element

@CheckReturnValue
 @Nonnull
public static SelenideElement element(org.openqa.selenium.By seleniumSelector)

Locates the first element matching given CSS selector ATTENTION! This method doesn't start any search yet!

Parameters:

seleniumSelector - any Selenium selector like By.id(), By.name() etc.

Returns:

SelenideElement

element

@CheckReturnValue
 @Nonnull
public static SelenideElement element(org.openqa.selenium.By seleniumSelector,
                                                                  int index)

Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!

Parameters:

seleniumSelector - any Selenium selector like By.id(), By.name() etc.

index - 0..N

Returns:

SelenideElement

element

@CheckReturnValue
 @Nonnull
public static SelenideElement element(java.lang.String cssSelector,
                                                                  int index)

Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!

Parameters:

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

index - 0..N

Returns:

SelenideElement

elements

@CheckReturnValue
 @Nonnull
public static ElementsCollection elements(java.util.Collection<? extends org.openqa.selenium.WebElement> elements)

Wrap standard Selenium WebElement collection into SelenideElement collection to use additional methods like shouldHave() etc.

Parameters:

elements - standard Selenium WebElement collection

Returns:

given WebElement collection wrapped into SelenideElement collection

elements

@CheckReturnValue
 @Nonnull
public static ElementsCollection elements(java.lang.String cssSelector)

Locates all elements matching given CSS selector. ATTENTION! This method doesn't start any search yet! Methods returns an ElementsCollection which is a list of WebElement objects that can be iterated, and at the same time is implementation of WebElement interface, meaning that you can call methods .sendKeys(), click() etc. on it.

Parameters:

cssSelector - any CSS selector like "input[name='first_name']" or "#messages .new_message"

Returns:

empty list if element was no found

elements

@CheckReturnValue
 @Nonnull
public static ElementsCollection elements(org.openqa.selenium.By seleniumSelector)

Locates all elements matching given CSS selector. ATTENTION! This method doesn't start any search yet! Methods returns an ElementsCollection which is a list of WebElement objects that can be iterated, and at the same time is implementation of WebElement interface, meaning that you can call methods .sendKeys(), click() etc. on it.

Parameters:

seleniumSelector - any Selenium selector like By.id(), By.name() etc.

Returns:

empty list if element was no found

getElement

@Deprecated
 @CheckReturnValue
 @Nonnull
public static SelenideElement getElement(org.openqa.selenium.By criteria)

Deprecated. please use element(criteria) which is the same (method will not be removed until 4.x or later) Locates the first element matching given criteria ATTENTION! This method doesn't start any search yet!

Parameters:

criteria - instance of By: By.id(), By.className() etc.

Returns:

SelenideElement

getElement

@Deprecated
 @CheckReturnValue
 @Nonnull
public static SelenideElement getElement(org.openqa.selenium.By criteria,
                                                                                  int index)

Deprecated. please use element(criteria, index) which is the same (method will not be removed until 4.x or later) Locates the Nth element matching given criteria ATTENTION! This method doesn't start any search yet!

Parameters:

criteria - instance of By: By.id(), By.className() etc.

index - 0..N

Returns:

SelenideElement

getElements

@Deprecated
 @CheckReturnValue
 @Nonnull
public static ElementsCollection getElements(org.openqa.selenium.By criteria)

Deprecated. please use elements(criteria) which is the same (method will not be removed until 4.x or later) Locates all elements matching given CSS selector ATTENTION! This method doesn't start any search yet!

Parameters:

criteria - instance of By: By.id(), By.className() etc.

Returns:

empty list if element was no found

executeJavaScript

@Nullable
public static <T> T executeJavaScript(java.lang.String jsCode,
                                                java.lang.Object... arguments)

See Also:

JavascriptExecutor.executeScript(java.lang.String, java.lang.Object...)

executeAsyncJavaScript

@Nullable
public static <T> T executeAsyncJavaScript(java.lang.String jsCode,
                                                     java.lang.Object... arguments)

See Also:

JavascriptExecutor.executeAsyncScript(java.lang.String, java.lang.Object...)

getSelectedRadio

@CheckReturnValue
 @Nullable
public static SelenideElement getSelectedRadio(org.openqa.selenium.By radioField)

Returns selected element in radio group

Returns:

null if nothing selected

confirm

@Nullable
public static java.lang.String confirm()

Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'alert' or 'confirm').

Returns:

actual dialog text

confirm

@Nullable
public static java.lang.String confirm(@Nullable
                                                 java.lang.String expectedDialogText)

Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'alert' or 'confirm').

Parameters:

expectedDialogText - if not null, check that confirmation dialog displays this message (case-sensitive)

Returns:

actual dialog text

Throws:

DialogTextMismatch - if confirmation message differs from expected message

prompt

@Nullable
public static java.lang.String prompt()

Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'prompt').

Returns:

actual dialog text

prompt

@Nullable
public static java.lang.String prompt(@Nullable
                                                java.lang.String inputText)

Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'prompt').

Parameters:

inputText - if not null, sets value in prompt dialog input

Returns:

actual dialog text

prompt

@Nullable
public static java.lang.String prompt(@Nullable
                                                java.lang.String expectedDialogText,
                                                @Nullable
                                                java.lang.String inputText)

Accept (Click "Yes" or "Ok") in the confirmation dialog (javascript 'prompt').

Parameters:

expectedDialogText - if not null, check that confirmation dialog displays this message (case-sensitive)

inputText - if not null, sets value in prompt dialog input

Returns:

actual dialog text

Throws:

DialogTextMismatch - if confirmation message differs from expected message

dismiss

@Nullable
public static java.lang.String dismiss()

Dismiss (click "No" or "Cancel") in the confirmation dialog (javascript 'alert' or 'confirm').

Returns:

actual dialog text

dismiss

@Nullable
public static java.lang.String dismiss(@Nullable
                                                 java.lang.String expectedDialogText)

Dismiss (click "No" or "Cancel") in the confirmation dialog (javascript 'alert' or 'confirm').

Parameters:

expectedDialogText - if not null, check that confirmation dialog displays this message (case-sensitive)

Returns:

actual dialog text

Throws:

DialogTextMismatch - if confirmation message differs from expected message

switchTo

@Nonnull
 @CheckReturnValue
public static SelenideTargetLocator switchTo()

Switch to window/tab/frame/parentFrame/innerFrame/alert. Allows switching to window by title, index, name etc. Similar to org.openqa.selenium.WebDriver#switchTo(), but all methods wait until frame/window/alert appears if it's not visible yet (like other Selenide methods).

Returns:

SelenideTargetLocator

getFocusedElement

@CheckReturnValue
 @Nullable
public static org.openqa.selenium.WebElement getFocusedElement()

Returns:

WebElement, not SelenideElement! which has focus on it

page

@CheckReturnValue
 @Nonnull
public static <PageObjectClass> PageObjectClass page(java.lang.Class<PageObjectClass> pageObjectClass)

Create a Page Object instance

page

@CheckReturnValue
 @Nonnull
public static <PageObjectClass,T extends PageObjectClass> PageObjectClass page(T pageObject)

Initialize a given Page Object instance

Wait

@CheckReturnValue
 @Nonnull
public static SelenideWait Wait()

Create a org.openqa.selenium.support.ui.FluentWait instance with Selenide timeout/polling. Sample usage: Wait().until(invisibilityOfElementLocated(By.id("magic-id")));

Returns:

instance of org.openqa.selenium.support.ui.FluentWait

actions

@CheckReturnValue
 @Nonnull
public static org.openqa.selenium.interactions.Actions actions()

With this method you can use Selenium Actions like described in the AdvancedUserInteractions page.

   actions()
    .sendKeys($(By.name("rememberMe")), "John")
    .click($(#rememberMe"))
    .click($(byText("Login")))
    .build()
    .perform();
 

zoom

public static void zoom(double factor)

Zoom current page (in or out).

Parameters:

factor - e.g. 1.1 or 2.0 or 0.5

getWebDriverLogs

@CheckReturnValue
 @Nonnull
public static java.util.List<java.lang.String> getWebDriverLogs(java.lang.String logType)

Same as com.codeborne.selenide.Selenide#getWebDriverLogs(java.lang.String, java.util.logging.Level)

getWebDriverLogs

@Nonnull
 @CheckReturnValue
public static java.util.List<java.lang.String> getWebDriverLogs(java.lang.String logType,
                                                                                            java.util.logging.Level logLevel)

Getting and filtering of the WebDriver logs for specified LogType by specified logging level
For example to get WebDriver Browser's console output (including JS info, warnings, errors, etc. messages) you can use:

   
     for(String logEntry : getWebDriverLogs(LogType.BROWSER, Level.ALL)) {
       Reporter.log(logEntry + "<br>");
     }
   
 

Be aware that currently "manage().logs()" is in the Beta stage, but it is beta-then-nothing :)
List of the unsupported browsers and issues:
http://bit.ly/RZcmrM
http://bit.ly/1nZTaqu

Parameters:

logType - WebDriver supported log types

logLevel - logging level that will be used to control logging output

Returns:

list of log entries

See Also:

LogType, Level

clearBrowserCookies

public static void clearBrowserCookies()

Clear browser cookies. It can be useful e.g. if you are trying to avoid restarting browser between tests

clearBrowserLocalStorage

public static void clearBrowserLocalStorage()

Clear browser local storage. In case if you need to be sure that browser's localStorage is empty

getUserAgent

@Nonnull
 @CheckReturnValue
public static java.lang.String getUserAgent()

Get current user agent from browser session

Returns:

browser user agent

atBottom

@CheckReturnValue
public static boolean atBottom()

Return true if bottom of the page is reached Useful if you need to scroll down by x pixels unknown number of times.

download

@Nonnull
 @CheckReturnValue
public static java.io.File download(java.lang.String url)
                                                         throws java.io.IOException,
                                                                java.net.URISyntaxException

NB! URL must be properly encoded. E.g. instead of "/files/ж.txt", it should be "/files/%D0%B6.txt"

Throws:

java.io.IOException

java.net.URISyntaxException

See Also:

Download fails if default timeout (Configuration.timeout) is exceeded

download

@Nonnull
 @CheckReturnValue
public static java.io.File download(java.net.URI url)
                                                         throws java.io.IOException

Throws:

java.io.IOException

See Also:

download(String)

download

@Nonnull
 @CheckReturnValue
public static java.io.File download(java.net.URI url,
                                                                long timeoutMs)
                                                         throws java.io.IOException

Throws:

java.io.IOException

See Also:

download(String, long)

download

@Nonnull
 @CheckReturnValue
public static java.io.File download(java.lang.String url,
                                                                long timeoutMs)
                                                         throws java.io.IOException,
                                                                java.net.URISyntaxException

Download file using a direct link. This method download file like it would be done in currently opened browser: it adds all cookies and "User-Agent" header to the downloading request. Download fails if specified timeout is exceeded

Parameters:

url - either relative or absolute url NB! URL must be properly encoded. E.g. instead of "/files/ж.txt", it should be "/files/%D0%B6.txt"

timeoutMs - specific timeout in ms

Returns:

downloaded File in folder `Configuration.reportsFolder`

Throws:

java.io.IOException - if failed to download file

java.net.URISyntaxException - if given url has invalid syntax

localStorage

@Nonnull
 @CheckReturnValue
public static LocalStorage localStorage()

Access browser's local storage. Allows setting, getting, removing items as well as getting the size and clear the storage.

Returns:

LocalStorage

Since:

5.15.0

sessionStorage

@Nonnull
 @CheckReturnValue
public static SessionStorage sessionStorage()

Access browser's session storage. Allows setting, getting, removing items as well as getting the size, check for contains item and clear the storage.

Returns:

sessionStorage

Since:

5.18.1

clipboard

@Nonnull
 @CheckReturnValue
public static Clipboard clipboard()

Provide access to system clipboard, allows get and set String content. Default implementation acts via Toolkit and supports only local runs. Remote runs support can be implemented via plugins. Plugin for Selenoid will be released soon. Pay attention that Clipboard is shared resource for instance where tests runs and keep in mind while developing test suite with multiple tests for clipboard.

Returns:

Clipboard