Locating elements\x3c/h2>\n
All keywords in SeleniumLibrary that need to interact with an element on a web page take an argument typically named `locator\x3c/code> that specifies how to find the element. Most often the locator is given as a string using the locator syntax described below, but` `using WebElements\x3c/a> is possible too.\x3c/p>\n`

Locator syntax\x3c/h3>\nSeleniumLibrary supports finding elements based on different strategies such as the element id, XPath expressions, or CSS selectors. The strategy can either be explicitly specified with a prefix or the strategy can be implicit.\x3c/p>\nDefault locator strategy\x3c/h4>\nBy default locators are considered to use the keyword specific default locator strategy. All keywords support finding elements based on id\x3c/code> and name\x3c/code> attributes, but some keywords support additional attributes or other values that make sense in their context. For example, Click Link\x3c/a> supports the href\x3c/code> attribute and the link text and addition to the normal id\x3c/code> and name\x3c/code>.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\nClick Element\x3c/a>\x3c/td>\n example\x3c/td>\n # Match based on id\x3c/code> or name\x3c/code>.\x3c/td>\n\x3c/tr>\n
Click Link\x3c/a>\x3c/td>\n example\x3c/td>\n # Match also based on link text and href\x3c/code>.\x3c/td>\n\x3c/tr>\n
Click Button\x3c/a>\x3c/td>\n example\x3c/td>\n # Match based on id\x3c/code>, name\x3c/code> or value\x3c/code>.\x3c/td>\n\x3c/tr>\n\x3c/table>\nIf a locator accidentally starts with a prefix recognized as explicit locator strategy\x3c/a> or implicit XPath strategy\x3c/a>, it is possible to use the explicit default\x3c/code> prefix to enable the default strategy.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\nClick Element\x3c/a>\x3c/td>\n name:foo\x3c/td>\n # Find element with name foo\x3c/code>.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n default:name:foo\x3c/td>\n # Use default strategy with value name:foo\x3c/code>.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n //foo\x3c/td>\n # Find element using XPath //foo\x3c/code>.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n default: //foo\x3c/td>\n # Use default strategy with value //foo\x3c/code>.\x3c/td>\n\x3c/tr>\n\x3c/table>\nExplicit locator strategy\x3c/h4>\nThe explicit locator strategy is specified with a prefix using either syntax strategy:value\x3c/code> or strategy=value\x3c/code>. The former syntax is preferred, because the latter is identical to Robot Framework's named argument syntax\x3c/a> and that can cause problems. Spaces around the separator are ignored, so id:foo\x3c/code>, id: foo\x3c/code> and id : foo\x3c/code> are all equivalent.\x3c/p>\n
Locator strategies that are supported by default are listed in the table below. In addition to them, it is possible to register custom locators\x3c/a>.\x3c/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStrategy\x3c/th>\n Match based on\x3c/th>\n Example\x3c/th>\n\x3c/tr>\n
id\x3c/td>\n Element id\x3c/code>.\x3c/td>\n id:example\x3c/code>\x3c/td>\n\x3c/tr>\n
name\x3c/td>\n name\x3c/code> attribute.\x3c/td>\n name:example\x3c/code>\x3c/td>\n\x3c/tr>\n
identifier\x3c/td>\n Either id\x3c/code> or name\x3c/code>.\x3c/td>\n identifier:example\x3c/code>\x3c/td>\n\x3c/tr>\n
class\x3c/td>\n Element class\x3c/code>.\x3c/td>\n class:example\x3c/code>\x3c/td>\n\x3c/tr>\n
tag\x3c/td>\n Tag name.\x3c/td>\n tag:div\x3c/code>\x3c/td>\n\x3c/tr>\n
xpath\x3c/td>\n XPath expression.\x3c/td>\n xpath://div[@id=\"example\"]\x3c/code>\x3c/td>\n\x3c/tr>\n
css\x3c/td>\n CSS selector.\x3c/td>\n css:div#example\x3c/code>\x3c/td>\n\x3c/tr>\n
dom\x3c/td>\n DOM expression.\x3c/td>\n dom:document.images[5]\x3c/code>\x3c/td>\n\x3c/tr>\n
link\x3c/td>\n Exact text a link has.\x3c/td>\n link:The example\x3c/code>\x3c/td>\n\x3c/tr>\n
partial link\x3c/td>\n Partial link text.\x3c/td>\n partial link:he ex\x3c/code>\x3c/td>\n\x3c/tr>\n
sizzle\x3c/td>\n Sizzle selector deprecated.\x3c/td>\n sizzle:div.example\x3c/code>\x3c/td>\n\x3c/tr>\n
jquery\x3c/td>\n jQuery expression.\x3c/td>\n jquery:div.example\x3c/code>\x3c/td>\n\x3c/tr>\n
default\x3c/td>\n Keyword specific default behavior.\x3c/td>\n default:example\x3c/code>\x3c/td>\n\x3c/tr>\n\x3c/table>\nSee the Default locator strategy\x3c/a> section below for more information about how the default strategy works. Using the explicit default\x3c/code> prefix is only necessary if the locator value itself accidentally matches some of the explicit strategies.\x3c/p>\n
Different locator strategies have different pros and cons. Using ids, either explicitly like id:foo\x3c/code> or by using the default locator strategy\x3c/a> simply like foo\x3c/code>, is recommended when possible, because the syntax is simple and locating elements by an id is fast for browsers. If an element does not have an id or the id is not stable, other solutions need to be used. If an element has a unique tag name or class, using tag\x3c/code>, class\x3c/code> or css\x3c/code> strategy like tag:h1\x3c/code>, class:example\x3c/code> or css:h1.example\x3c/code> is often an easy solution. In more complex cases using XPath expressions is typically the best approach. They are very powerful but a downside is that they can also get complex.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\nClick Element\x3c/a>\x3c/td>\n id:foo\x3c/td>\n # Element with id 'foo'.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n css:div#foo h1\x3c/td>\n # h1 element under div with id 'foo'.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n xpath: //div[@id=\"foo\"]//h1\x3c/td>\n # Same as the above using XPath, not CSS.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n xpath: //*[contains(text(), \"example\")]\x3c/td>\n # Element containing text 'example'.\x3c/td>\n\x3c/tr>\n\x3c/table>\nNOTE:\x3c/b>\x3c/p>\n
\nThe strategy:value\x3c/code> syntax is only supported by SeleniumLibrary 3.0 and newer.\x3c/li>\n
Using the sizzle\x3c/code> strategy or its alias jquery\x3c/code> requires that the system under test contains the jQuery library.\x3c/li>\n
Prior to SeleniumLibrary 3.0, table related keywords only supported xpath\x3c/code>, css\x3c/code> and sizzle/jquery\x3c/code> strategies.\x3c/li>\n\x3c/ul>\nImplicit XPath strategy\x3c/h4>\nIf the locator starts with //\x3c/code> or (//\x3c/code>, the locator is considered to be an XPath expression. In other words, using //div\x3c/code> is equivalent to using explicit xpath://div\x3c/code>.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\nClick Element\x3c/a>\x3c/td>\n //div[@id=\"foo\"]//h1\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n (//div)[2]\x3c/td>\n\x3c/tr>\n\x3c/table>\nThe support for the (//\x3c/code> prefix is new in SeleniumLibrary 3.0.\x3c/p>\n
Using WebElements\x3c/h3>\nIn addition to specifying a locator as a string, it is possible to use Selenium's WebElement objects. This requires first getting a WebElement, for example, by using the Get WebElement\x3c/a> keyword.\x3c/p>\n
\n\n\n${elem} =\x3c/td>\n Get WebElement\x3c/a>\x3c/td>\n id:example\x3c/td>\n\x3c/tr>\n
Click Element\x3c/a>\x3c/td>\n ${elem}\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nCustom locators\x3c/h3>\nIf more complex lookups are required than what is provided through the default locators, custom lookup strategies can be created. Using custom locators is a two part process. First, create a keyword that returns a WebElement that should be acted on:\x3c/p>\n
\n\n\n\nCustom Locator Strategy\x3c/td>\n [Arguments]\x3c/td>\n ${browser}\x3c/td>\n ${locator}\x3c/td>\n ${tag}\x3c/td>\n ${constraints}\x3c/td>\n\x3c/tr>\n
\x3c/td>\n ${element}=\x3c/td>\n Execute Javascript\x3c/td>\n return window.document.getElementById('${locator}');\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
\x3c/td>\n [Return]\x3c/td>\n ${element}\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nThis keyword is a reimplementation of the basic functionality of the id\x3c/code> locator where ${browser}\x3c/code> is a reference to a WebDriver instance and ${locator}\x3c/code> is name of the locator strategy. To use this locator it must first be registered by using the Add Location Strategy\x3c/a> keyword:\x3c/p>\n
\n\nAdd Location Strategy\x3c/a>\x3c/td>\n custom\x3c/td>\n Custom Locator Strategy\x3c/td>\n\x3c/tr>\n\x3c/table>\nThe first argument of Add Location Strategy\x3c/a> specifies the name of the strategy and it must be unique. After registering the strategy, the usage is the same as with other locators:\x3c/p>\n
\n\nClick Element\x3c/a>\x3c/td>\n custom:example\x3c/td>\n\x3c/tr>\n\x3c/table>\nSee the Add Location Strategy\x3c/a> keyword for more details.\x3c/p>\n
Browser and Window\x3c/h2>\nThere is different conseptual meaning when SeleniumLibrary talks windows and browsers. This chapter explains those differences.\x3c/p>\nBrowser\x3c/h3>\nWhen Open Browser\x3c/a> or Create WebDriver\x3c/a> keyword is called, it will create a new Selenium WebDriver instance by using the Selenium WebDriver\x3c/a> API. In SeleniumLibrary terms, a new broser is created. It is possible to start multiple independent browsers (Selenium Webdriver instances) at the same time, by calling Open Browser\x3c/a> or Create WebDriver\x3c/a> multiple times. These browsers are usually independent to each other and do not share data like cookies, sessions or profiles. Typicall when browser starts, it creates a single window in the desktop.\x3c/p>\n
Window\x3c/h3>\nWindows are the part of a browser that loads the web site and presents it to the user. All content of the site is content of the window. Windows are children of a WebDriver instance, in SeleniumLibrary WebDriver is referred as browser. One browser may have multiple windows. Windows can appear as tabs or as separate windows with different position and size. Windows belonning to the same browser typically share the sessions detail, like cookies. If there is a need to separate sessions detail, example login with two different users, two browser (Selenium WebDriver instances) must be created. New windows can be opened example by the application under test or by example Execute Javascript\x3c/a> keyword:\x3c/p>\n
\nExecute Javascript\x3c/a>    window.open()    # Opens a new window with location about:blank\n\x3c/pre>\nIn the example in below opens multiple browser and windows, to demonstrate how the different keywords can be used to interact with a browser and windows attached to the browser.\x3c/p>\n
Structure:\x3c/p>\n
\nBrowserA\n           Window 1  (location=https://robotframework.org/)\n           Window 2  (location=https://robocon.io/)\n           Window 3  (location=https://github.com/robotframework/)\n\nBrowserB\n           Window 1  (location=https://github.com/)\n\x3c/pre>\nExample:\x3c/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\nOpen Browser\x3c/a>\x3c/td>\n https://robotframework.org\x3c/a>\x3c/td>\n ${BROWSER}\x3c/td>\n alias=BrowserA\x3c/td>\n # BrowserA with first window is opened.\x3c/td>\n\x3c/tr>\n
Execute Javascript\x3c/a>\x3c/td>\n window.open()\x3c/td>\n \x3c/td>\n \x3c/td>\n # In BrowserA second window is opened.\x3c/td>\n\x3c/tr>\n
Switch Window\x3c/a>\x3c/td>\n locator=NEW\x3c/td>\n \x3c/td>\n \x3c/td>\n # Switched to second window in BrowserA\x3c/td>\n\x3c/tr>\n
Go To\x3c/a>\x3c/td>\n https://robocon.io\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n # Second window navigates to to robocon site.\x3c/td>\n\x3c/tr>\n
Execute Javascript\x3c/a>\x3c/td>\n window.open()\x3c/td>\n \x3c/td>\n \x3c/td>\n # In BrowserA third window is opened.\x3c/td>\n\x3c/tr>\n
${handle}\x3c/td>\n Switch Window\x3c/a>\x3c/td>\n locator=NEW\x3c/td>\n \x3c/td>\n # Switched to third window in BrowserA\x3c/td>\n\x3c/tr>\n
Go To\x3c/a>\x3c/td>\n https://github.com/robotframework/\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n # Third windows goes to robot framework github site.\x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n https://github.com\x3c/a>\x3c/td>\n ${BROWSER}\x3c/td>\n alias=BrowserB\x3c/td>\n # BrowserB with first windows is opened.\x3c/td>\n\x3c/tr>\n
${location}\x3c/td>\n Get Location\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n # ${location} is: https://www.github.com\x3c/a>\x3c/td>\n\x3c/tr>\n
Switch Window\x3c/a>\x3c/td>\n ${handle}\x3c/td>\n browser=BrowserA\x3c/td>\n \x3c/td>\n # BrowserA second windows is selected.\x3c/td>\n\x3c/tr>\n
${location}\x3c/td>\n Get Location\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n # ${location} = https://robocon.io/\x3c/a>\x3c/td>\n\x3c/tr>\n
@{locations 1}\x3c/td>\n Get Locations\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n # By default lists locations under the currectly active browser.\x3c/td>\n\x3c/tr>\n
@{locations 2}\x3c/td>\n Get Locations\x3c/a>\x3c/td>\n browser=ALL\x3c/td>\n \x3c/td>\n # By using browser=ALL argument keyword list all locations from all browsers.\x3c/td>\n\x3c/tr>\n\x3c/table>\nThe above example, @{locations 1} contains the following items: https://robotframework.org/\x3c/a>, https://robocon.io/\x3c/a> and https://github.com/robotframework/\x3c/a>'. The @{locations 2} contains the following items: https://robotframework.org/\x3c/a>, https://robocon.io/\x3c/a>, https://github.com/robotframework/\x3c/a>' and 'https://github.com/\x3c/a>.\x3c/p>\n
Timeouts, waits and delays\x3c/h2>\nThis section discusses different ways how to wait for elements to appear on web pages and to slow down execution speed otherwise. It also explains the time format\x3c/a> that can be used when setting various timeouts, waits and delays.\x3c/p>\n
Timeout\x3c/h3>\nSeleniumLibrary contains various keywords that have an optional timeout\x3c/code> argument that specifies how long these keywords should wait for certain events or actions. These keywords include, for example, Wait ...\x3c/code> keywords and keywords related to alerts. Additionally Execute Async Javascript\x3c/a>. although it does not have timeout\x3c/code>, argument, uses timeout to define how long asynchronous JavaScript can run.\x3c/p>\n
The default timeout these keywords use can be set globally either by using the Set Selenium Timeout\x3c/a> keyword or with the timeout\x3c/code> argument when importing\x3c/a> the library. See time format\x3c/a> below for supported timeout syntax.\x3c/p>\n
Implicit wait\x3c/h3>\nImplicit wait specifies the maximum time how long Selenium waits when searching for elements. It can be set by using the Set Selenium Implicit Wait\x3c/a> keyword or with the implicit_wait\x3c/code> argument when importing\x3c/a> the library. See Selenium documentation\x3c/a> for more information about this functionality.\x3c/p>\n
See time format\x3c/a> below for supported syntax.\x3c/p>\n
Selenium speed\x3c/h3>\nSelenium execution speed can be slowed down globally by using Set Selenium speed\x3c/a> keyword. This functionality is designed to be used for demonstrating or debugging purposes. Using it to make sure that elements appear on a page is not a good idea, and the above explained timeouts and waits should be used instead.\x3c/p>\n
See time format\x3c/a> below for supported syntax.\x3c/p>\n
Time format\x3c/h3>\nAll timeouts and waits can be given as numbers considered seconds (e.g. 0.5\x3c/code> or 42\x3c/code>) or in Robot Framework's time syntax (e.g. 1.5 seconds\x3c/code> or 1 min 30 s\x3c/code>). For more information about the time syntax see the Robot Framework User Guide\x3c/a>.\x3c/p>\n
Run-on-failure functionality\x3c/h2>\nSeleniumLibrary has a handy feature that it can automatically execute a keyword if any of its own keywords fails. By default it uses the Capture Page Screenshot\x3c/a> keyword, but this can be changed either by using the Register Keyword To Run On Failure\x3c/a> keyword or with the run_on_failure\x3c/code> argument when importing\x3c/a> the library. It is possible to use any keyword from any imported library or resource file.\x3c/p>\n
The run-on-failure functionality can be disabled by using a special value NOTHING\x3c/code> or anything considered false (see Boolean arguments\x3c/a>) such as NONE\x3c/code>.\x3c/p>\n
Boolean arguments\x3c/h2>\nSome keywords accept arguments that are handled as Boolean values true or false. If such an argument is given as a string, it is considered false if it is either empty or case-insensitively equal to false\x3c/code>, no\x3c/code>, off\x3c/code>, 0\x3c/code> or none\x3c/code>. Other strings are considered true regardless their value, and other argument types are tested using same rules as in Python\x3c/a>.\x3c/p>\n
True examples:\x3c/p>\n
\n\n\n\n\nSet Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=True\x3c/td>\n # Strings are generally true.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=yes\x3c/td>\n # Same as the above.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=${TRUE}\x3c/td>\n # Python True is true.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=${42}\x3c/td>\n # Numbers other than 0 are true.\x3c/td>\n\x3c/tr>\n\x3c/table>\nFalse examples:\x3c/p>\n
\n\n\n\n\n\n\nSet Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=False\x3c/td>\n # String false is false.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=no\x3c/td>\n # Also string no is false.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=NONE\x3c/td>\n # String NONE is false.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=${EMPTY}\x3c/td>\n # Empty string is false.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=${FALSE}\x3c/td>\n # Python False is false.\x3c/td>\n\x3c/tr>\n
Set Screenshot Directory\x3c/a>\x3c/td>\n ${RESULTS}\x3c/td>\n persist=${NONE}\x3c/td>\n # Python None is false.\x3c/td>\n\x3c/tr>\n\x3c/table>\nNote that prior to SeleniumLibrary 3.0, all non-empty strings, including false\x3c/code>, no\x3c/code> and none\x3c/code>, were considered true. Starting from SeleniumLibrary 4.0, strings 0\x3c/code> and off\x3c/code> are considered as false.\x3c/p>\n
EventFiringWebDriver\x3c/h2>\nThe SeleniumLibrary offers support for EventFiringWebDriver\x3c/a>. See the Selenium and SeleniumLibrary EventFiringWebDriver support\x3c/a> documentation for futher details.\x3c/p>\n
EventFiringWebDriver is new in SeleniumLibrary 4.0\x3c/p>\n
Thread support\x3c/h2>\nSeleniumLibrary is not thread safe. This is mainly due because the underlying Selenium tool is not thread safe\x3c/a> within one browser/driver instance. Because of the limitation in the Selenium side, the keywords or the API provided by the SeleniumLibrary is not thread safe.\x3c/p>\n
Plugins\x3c/h2>\nSeleniumLibrary offers plugins as a way to modify and add library keywords and modify some of the internal functionality without creating new library or hacking the source code. See plugin API\x3c/a> documentation for further details.\x3c/p>\n
Plugin API is new SeleniumLibrary 4.0\x3c/p>","generated":"2019-09-08 01:00:22","inits":[{"args":["timeout=5.0","implicit_wait=0.0","run_on_failure=Capture Page Screenshot","screenshot_root_directory=None","plugins=None","event_firing_webdriver=None"],"doc":"
SeleniumLibrary can be imported with several optional arguments.\x3c/p>\n
\ntimeout\x3c/code>: Default value for timeouts\x3c/span> used with Wait ...\x3c/code> keywords.\x3c/li>\nimplicit_wait\x3c/code>: Default value for implicit wait\x3c/a> used when locating elements.\x3c/li>\n
run_on_failure\x3c/code>: Default action for the run-on-failure functionality\x3c/a>.\x3c/li>\n
screenshot_root_directory\x3c/code>: Location where possible screenshots are created. If not given, the directory where the log file is written is used.\x3c/li>\n
plugins\x3c/code>: Allows extending the SeleniumLibrary with external Python classes.\x3c/li>\n
event_firing_webdriver\x3c/code>: Class for wrapping Selenium with EventFiringWebDriver\x3c/a>\x3c/li>\n\x3c/ul>","matched":true,"name":"Init","shortdoc":"SeleniumLibrary can be imported with several optional arguments.","tags":[]}],"keywords":[{"args":["name","value","path=None","domain=None","secure=None","expiry=None"],"doc":"Adds a cookie to your current session.\x3c/p>\nname\x3c/code> and value\x3c/code> are required, path\x3c/code>, domain\x3c/code>, secure\x3c/code> and expiry\x3c/code> are optional.  Expiry supports the same formats as the DateTime\x3c/a> library or an epoch time stamp.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n\nAdd Cookie\x3c/a>\x3c/td>\n foo\x3c/td>\n bar\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Add Cookie\x3c/a>\x3c/td>\n foo\x3c/td>\n bar\x3c/td>\n domain=example.com\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Add Cookie\x3c/a>\x3c/td>\n foo\x3c/td>\n bar\x3c/td>\n expiry=2027-09-28 16:21:35\x3c/td>\n # Expiry as timestamp.\x3c/td>\n\x3c/tr>\n
Add Cookie\x3c/a>\x3c/td>\n foo\x3c/td>\n bar\x3c/td>\n expiry=1822137695\x3c/td>\n # Expiry as epoch seconds.\x3c/td>\n\x3c/tr>\n\x3c/table>\nPrior to SeleniumLibrary 3.0 setting expiry did not work.\x3c/p>","matched":true,"name":"Add Cookie","shortdoc":"Adds a cookie to your current session.","tags":[]},{"args":["strategy_name","strategy_keyword","persist=False"],"doc":"
Adds a custom location strategy.\x3c/p>\n
See Custom locators\x3c/a> for information how to create and use custom strategies. Remove Location Strategy\x3c/a> can be used to remove a registered strategy.\x3c/p>\n
Location strategies are automatically removed after leaving the current scope by default. Setting persist\x3c/code> to a true value (see Boolean arguments\x3c/a>) will cause the location strategy to stay registered throughout the life of the test.\x3c/p>","matched":true,"name":"Add Location Strategy","shortdoc":"Adds a custom location strategy.","tags":[]},{"args":["text=","action=ACCEPT","timeout=None"],"doc":"
Verifies that an alert is present and, by default, accepts it.\x3c/p>\n
Fails if no alert is present. If text\x3c/code> is a non-empty string, then it is used to verify alert's message. The alert is accepted by default, but that behavior can be controlled by using the action\x3c/code> argument same way as with Handle Alert\x3c/a>.\x3c/p>\n
timeout\x3c/code> specifies how long to wait for the alert to appear. If it is not given, the global default timeout\x3c/a> is used instead.\x3c/p>\n
action\x3c/code> and timeout\x3c/code> arguments are new in SeleniumLibrary 3.0. In earlier versions the alert was always accepted and timeout was hard coded to one second.\x3c/p>","matched":true,"name":"Alert Should Be Present","shortdoc":"Verifies that an alert is present and, by default, accepts it.","tags":[]},{"args":["action=ACCEPT","timeout=0"],"doc":"
Verifies that no alert is present.\x3c/p>\n
If the alert actually exists, the action\x3c/code> argument determines how it should be handled. By default the alert is accepted, but it can be also dismissed or left open the same way as with the Handle Alert\x3c/a> keyword.\x3c/p>\n
timeout\x3c/code> specifies how long to wait for the alert to appear. By default the alert is not waited at all, but a custom time can be given if alert may be delayed. See the time format\x3c/a> section for information about the syntax.\x3c/p>\n
New in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Alert Should Not Be Present","shortdoc":"Verifies that no alert is present.","tags":[]},{"args":["locator","id"],"doc":"
Assigns temporary id\x3c/code> to element specified by locator\x3c/code>.\x3c/p>\n
This is mainly useful if the locator is complicated and/or slow XPath expression and it is needed multiple times. Identifier expires when the page is reloaded.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Example:\x3c/p>\n
\n\n\nAssign ID to Element\x3c/a>\x3c/td>\n //ul[@class='example' and ./li[contains(., 'Stuff')]]\x3c/td>\n my id\x3c/td>\n\x3c/tr>\n
Page Should Contain Element\x3c/a>\x3c/td>\n my id\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Assign Id To Element","shortdoc":"Assigns temporary ``id`` to element specified by ``locator``.","tags":[]},{"args":["locator","filename=selenium-element-screenshot-{index}.png"],"doc":"Captures screenshot from the element identified by locator\x3c/code> and embeds it into log file.\x3c/p>\n
See Capture Page Screenshot\x3c/a> for details about filename\x3c/code> argument. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
An absolute path to the created element screenshot is returned.\x3c/p>\n
Support for capturing the screenshot from a element has limited support among browser vendors. Please check the browser vendor driver documentation does the browser support capturing a screenshot from a element.\x3c/p>\n
New in SeleniumLibrary 3.3\x3c/p>\n
Examples:\x3c/p>\n
\n\n\nCapture Element Screenshot\x3c/a>\x3c/td>\n id:image_id\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Capture Element Screenshot\x3c/a>\x3c/td>\n id:image_id\x3c/td>\n ${OUTPUTDIR}/id_image_id-1.png\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Capture Element Screenshot","shortdoc":"Captures screenshot from the element identified by ``locator`` and embeds it into log file.","tags":[]},{"args":["filename=selenium-screenshot-{index}.png"],"doc":"Takes screenshot of the current page and embeds it into log file.\x3c/p>\n
filename\x3c/code> argument specifies the name of the file to write the screenshot into. The directory where screenshots are saved can be set when importing\x3c/a> the library or by using the Set Screenshot Directory\x3c/a> keyword. If the directory is not configured, screenshots are saved to the same directory where Robot Framework's log file is written.\x3c/p>\n
Starting from SeleniumLibrary 1.8, if filename\x3c/code> contains marker {index}\x3c/code>, it will be automatically replaced with unique running index preventing files to be overwritten. Indices start from 1, and how they are represented can be customized using Python's format string syntax\x3c/a>.\x3c/p>\n
An absolute path to the created screenshot file is returned.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\n\n\n\n\n\n\n\nCapture Page Screenshot\x3c/a>\x3c/td>\n \x3c/td>\n\x3c/tr>\n
File Should Exist\x3c/span>\x3c/td>\n ${OUTPUTDIR}/selenium-screenshot-1.png\x3c/td>\n\x3c/tr>\n
${path} =\x3c/td>\n Capture Page Screenshot\x3c/a>\x3c/td>\n\x3c/tr>\n
File Should Exist\x3c/span>\x3c/td>\n ${OUTPUTDIR}/selenium-screenshot-2.png\x3c/td>\n\x3c/tr>\n
File Should Exist\x3c/span>\x3c/td>\n ${path}\x3c/td>\n\x3c/tr>\n
Capture Page Screenshot\x3c/a>\x3c/td>\n custom_name.png\x3c/td>\n\x3c/tr>\n
File Should Exist\x3c/span>\x3c/td>\n ${OUTPUTDIR}/custom_name.png\x3c/td>\n\x3c/tr>\n
Capture Page Screenshot\x3c/a>\x3c/td>\n custom_with_index_{index}.png\x3c/td>\n\x3c/tr>\n
File Should Exist\x3c/span>\x3c/td>\n ${OUTPUTDIR}/custom_with_index_1.png\x3c/td>\n\x3c/tr>\n
Capture Page Screenshot\x3c/a>\x3c/td>\n formatted_index_{index:03}.png\x3c/td>\n\x3c/tr>\n
File Should Exist\x3c/span>\x3c/td>\n ${OUTPUTDIR}/formatted_index_001.png\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Capture Page Screenshot","shortdoc":"Takes screenshot of the current page and embeds it into log file.","tags":[]},{"args":["locator"],"doc":"Verifies checkbox locator\x3c/code> is selected/checked.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Checkbox Should Be Selected","shortdoc":"Verifies checkbox ``locator`` is selected/checked.","tags":[]},{"args":["locator"],"doc":"
Verifies checkbox locator\x3c/code> is not selected/checked.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax..\x3c/p>","matched":true,"name":"Checkbox Should Not Be Selected","shortdoc":"Verifies checkbox ``locator`` is not selected/checked.","tags":[]},{"args":["locator","file_path"],"doc":"
Inputs the file_path\x3c/code> into file input field locator\x3c/code>.\x3c/p>\n
This keyword is most often used to input files into upload forms. Keyword  does not check file_path\x3c/code> is the file or folder available on machine where tests are executed. If the file_path\x3c/code> point sot a file and when using Selenium Grid, Selenium will, magically\x3c/a>, transfer the file from the machine where test are executed to the Selenium Grid node where the browser is running. Then Selenium will send the file path, from to node file system, to the browser.\x3c/p>\n
file_path\x3c/code> is not checked is new in SeleniumLibrary 4.0\x3c/p>\n
Example:\x3c/p>\n
\n\nChoose File\x3c/a>\x3c/td>\n my_upload_field\x3c/td>\n ${CURDIR}/trades.csv\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Choose File","shortdoc":"Inputs the ``file_path`` into file input field ``locator``.","tags":[]},{"args":["locator"],"doc":"Clears the value of text entry element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Clear Element Text","shortdoc":"Clears the value of text entry element identified by ``locator``.","tags":[]},{"args":["locator","modifier=False"],"doc":"
Clicks button identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, buttons are searched using id\x3c/code>, name\x3c/code> and value\x3c/code>.\x3c/p>\n
See the Click Element\x3c/a> keyword for details about the modifier\x3c/code> argument.\x3c/p>\n
The modifier\x3c/code> argument is new in SeleniumLibrary 3.3\x3c/p>","matched":true,"name":"Click Button","shortdoc":"Clicks button identified by ``locator``.","tags":[]},{"args":["locator","modifier=False"],"doc":"
Click element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The modifier\x3c/code> argument can be used to pass Selenium Keys\x3c/a> when clicking the element. The +\x3c/span> can be used as a separator for different Selenium Keys. The CTRL\x3c/span> is internally translated to CONTROL\x3c/span> key. The modifier\x3c/code> is space and case insensitive, example \"alt\" and \" aLt \" are supported formats to ALT key\x3c/a> . If modifier\x3c/code> does not match to Selenium Keys, keyword fails.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\nClick Element\x3c/td>\n id:button\x3c/td>\n \x3c/td>\n # Would click element without any modifiers.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/td>\n id:button\x3c/td>\n CTRL\x3c/td>\n # Would click element with CTLR key pressed down.\x3c/td>\n\x3c/tr>\n
Click Element\x3c/td>\n id:button\x3c/td>\n CTRL+ALT\x3c/td>\n # Would click element with CTLR and ALT keys pressed down.\x3c/td>\n\x3c/tr>\n\x3c/table>\nThe modifier\x3c/code> argument is new in SeleniumLibrary 3.2\x3c/p>","matched":true,"name":"Click Element","shortdoc":"Click element identified by ``locator``.","tags":[]},{"args":["locator","xoffset","yoffset"],"doc":"
Click element locator\x3c/code> at xoffset/yoffset\x3c/code>.\x3c/p>\n
Cursor is moved and the center of the element and x/y coordinates are calculated from that point.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Click Element At Coordinates","shortdoc":"Click element ``locator`` at ``xoffset/yoffset``.","tags":[]},{"args":["locator","modifier=False"],"doc":"
Clicks an image identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, images are searched using id\x3c/code>, name\x3c/code>, src\x3c/code> and alt\x3c/code>.\x3c/p>\n
See the Click Element\x3c/a> keyword for details about the modifier\x3c/code> argument.\x3c/p>\n
The modifier\x3c/code> argument is new in SeleniumLibrary 3.3\x3c/p>","matched":true,"name":"Click Image","shortdoc":"Clicks an image identified by ``locator``.","tags":[]},{"args":["locator","modifier=False"],"doc":"
Clicks a link identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, links are searched using id\x3c/code>, name\x3c/code>, href\x3c/code> and the link text.\x3c/p>\n
See the Click Element\x3c/a> keyword for details about the modifier\x3c/code> argument.\x3c/p>\n
The modifier\x3c/code> argument is new in SeleniumLibrary 3.3\x3c/p>","matched":true,"name":"Click Link","shortdoc":"Clicks a link identified by ``locator``.","tags":[]},{"args":[],"doc":"
Closes all open browsers and resets the browser cache.\x3c/p>\n
After this keyword new indexes returned from Open Browser\x3c/a> keyword are reset to 1.\x3c/p>\n
This keyword should be used in test or suite teardown to make sure all browsers are closed.\x3c/p>","matched":true,"name":"Close All Browsers","shortdoc":"Closes all open browsers and resets the browser cache.","tags":[]},{"args":[],"doc":"
Closes the current browser.\x3c/p>","matched":true,"name":"Close Browser","shortdoc":"Closes the current browser.","tags":[]},{"args":[],"doc":"
Closes currently opened and selected browser window/tab.\x3c/p>","matched":true,"name":"Close Window","shortdoc":"Closes currently opened and selected browser window/tab.","tags":[]},{"args":["locator"],"doc":"
Will cover elements identified by locator\x3c/code> with a blue div without breaking page layout.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
New in SeleniumLibrary 3.3.0\x3c/p>\n
Example: |Cover Element\x3c/a> | css:div#container |\x3c/p>","matched":true,"name":"Cover Element","shortdoc":"Will cover elements identified by ``locator`` with a blue div without breaking page layout.","tags":[]},{"args":["driver_name","alias=None","kwargs={}","**init_kwargs"],"doc":"
Creates an instance of Selenium WebDriver.\x3c/p>\n
Like Open Browser\x3c/a>, but allows passing arguments to the created WebDriver instance directly. This keyword should only be used if functionality provided by Open Browser\x3c/a> is not adequate.\x3c/p>\n
driver_name\x3c/code> must be an WebDriver implementation name like Firefox, Chrome, Ie, Opera, Safari, PhantomJS, or Remote.\x3c/p>\n
The initialized WebDriver can be configured either with a Python dictionary kwargs\x3c/code> or by using keyword arguments **init_kwargs\x3c/code>. These arguments are passed directly to WebDriver without any processing. See Selenium API documentation\x3c/a> for details about the supported arguments.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\n\n\n\n# Use proxy with Firefox\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
${proxy}=\x3c/td>\n Evaluate\x3c/span>\x3c/td>\n sys.modules['selenium.webdriver'].Proxy()\x3c/td>\n sys, selenium.webdriver\x3c/td>\n\x3c/tr>\n
${proxy.http_proxy}=\x3c/td>\n Set Variable\x3c/span>\x3c/td>\n localhost:8888\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Create Webdriver\x3c/a>\x3c/td>\n Firefox\x3c/td>\n proxy=${proxy}\x3c/td>\n \x3c/td>\n\x3c/tr>\n
# Use proxy with PhantomJS\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
${service args}=\x3c/td>\n Create List\x3c/span>\x3c/td>\n --proxy=192.168.132.104:8888\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Create Webdriver\x3c/a>\x3c/td>\n PhantomJS\x3c/td>\n service_args=${service args}\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nReturns the index of this browser instance which can be used later to switch back to it. Index starts from 1 and is reset back to it when Close All Browsers\x3c/a> keyword is used. See Switch Browser\x3c/a> for an example.\x3c/p>","matched":true,"name":"Create Webdriver","shortdoc":"Creates an instance of Selenium WebDriver.","tags":[]},{"args":["text","loglevel=TRACE"],"doc":"
Verifies that current frame contains text\x3c/code>.\x3c/p>\n
See Page Should Contain\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>\n
Prior to SeleniumLibrary 3.0 this keyword was named Current Frame Contains\x3c/span>.\x3c/p>","matched":true,"name":"Current Frame Should Contain","shortdoc":"Verifies that current frame contains ``text``.","tags":[]},{"args":["text","loglevel=TRACE"],"doc":"
Verifies that current frame does not contains text\x3c/code>.\x3c/p>\n
See Page Should Contain\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Current Frame Should Not Contain","shortdoc":"Verifies that current frame does not contains ``text``.","tags":[]},{"args":[],"doc":"
Deletes all cookies.\x3c/p>","matched":true,"name":"Delete All Cookies","shortdoc":"Deletes all cookies.","tags":[]},{"args":["name"],"doc":"
Deletes cookie matching name\x3c/code>.\x3c/p>\n
If the cookie is not found, nothing happens.\x3c/p>","matched":true,"name":"Delete Cookie","shortdoc":"Deletes cookie matching ``name``.","tags":[]},{"args":["locator"],"doc":"
Double click element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Double Click Element","shortdoc":"Double click element identified by ``locator``.","tags":[]},{"args":["locator","target"],"doc":"
Drags element identified by locator\x3c/code> into target\x3c/code> element.\x3c/p>\n
The locator\x3c/code> argument is the locator of the dragged element and the target\x3c/code> is the locator of the target. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Example:\x3c/p>\n
\n\nDrag And Drop\x3c/a>\x3c/td>\n css:div#element\x3c/td>\n css:div.target\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Drag And Drop","shortdoc":"Drags element identified by ``locator`` into ``target`` element.","tags":[]},{"args":["locator","xoffset","yoffset"],"doc":"Drags element identified with locator\x3c/code> by xoffset/yoffset\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Element will be moved by xoffset\x3c/code> and yoffset\x3c/code>, each of which is a negative or positive number specifying the offset.\x3c/p>\n
Example:\x3c/p>\n
\n\nDrag And Drop By Offset\x3c/a>\x3c/td>\n myElem\x3c/td>\n 50\x3c/td>\n -35\x3c/td>\n # Move myElem 50px right and 35px down\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Drag And Drop By Offset","shortdoc":"Drags element identified with ``locator`` by ``xoffset/yoffset``.","tags":[]},{"args":["locator","attribute","expected","message=None"],"doc":"Verifies element identified by locator\x3c/code> contains expected attribute value.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Example: Element Attribute Value Should Be\x3c/a> | css:img | href | value\x3c/p>\n
New in SeleniumLibrary 3.2.\x3c/p>","matched":true,"name":"Element Attribute Value Should Be","shortdoc":"Verifies element identified by ``locator`` contains expected attribute value.","tags":[]},{"args":["locator"],"doc":"
Verifies that element identified with locator\x3c/code> is disabled.\x3c/p>\n
This keyword considers also elements that are read-only to be disabled.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Element Should Be Disabled","shortdoc":"Verifies that element identified with ``locator`` is disabled.","tags":[]},{"args":["locator"],"doc":"
Verifies that element identified with locator\x3c/code> is enabled.\x3c/p>\n
This keyword considers also elements that are read-only to be disabled.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Element Should Be Enabled","shortdoc":"Verifies that element identified with ``locator`` is enabled.","tags":[]},{"args":["locator"],"doc":"
Verifies that element identified with locator\x3c/code> is focused.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
New in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Element Should Be Focused","shortdoc":"Verifies that element identified with ``locator`` is focused.","tags":[]},{"args":["locator","message=None"],"doc":"
Verifies that the element identified by locator\x3c/code> is visible.\x3c/p>\n
Herein, visible means that the element is logically visible, not optically visible in the current browser viewport. For example, an element that carries display:none\x3c/code> is not logically visible, so using this keyword on that element would fail.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>","matched":true,"name":"Element Should Be Visible","shortdoc":"Verifies that the element identified by ``locator`` is visible.","tags":[]},{"args":["locator","expected","message=None","ignore_case=False"],"doc":"
Verifies that element locator\x3c/code> contains text expected\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
The ignore_case\x3c/code> argument can be set to True to compare case insensitive, default is False. New in SeleniumLibrary 3.1.\x3c/p>\n
ignore_case\x3c/code> argument new in SeleniumLibrary 3.1.\x3c/p>\n
Use Element Text Should Be\x3c/a> if you want to match the exact text, not a substring.\x3c/p>","matched":true,"name":"Element Should Contain","shortdoc":"Verifies that element ``locator`` contains text ``expected``.","tags":[]},{"args":["locator","message=None"],"doc":"
Verifies that the element identified by locator\x3c/code> is NOT visible.\x3c/p>\n
Passes if element does not exists. See Element Should Be Visible\x3c/a> for more information about visibility and supported arguments.\x3c/p>","matched":true,"name":"Element Should Not Be Visible","shortdoc":"Verifies that the element identified by ``locator`` is NOT visible.","tags":[]},{"args":["locator","expected","message=None","ignore_case=False"],"doc":"
Verifies that element locator\x3c/code> does not contains text expected\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
The ignore_case\x3c/code> argument can be set to True to compare case insensitive, default is False.\x3c/p>\n
ignore_case\x3c/code> argument new in SeleniumLibrary 3.1.\x3c/p>","matched":true,"name":"Element Should Not Contain","shortdoc":"Verifies that element ``locator`` does not contains text ``expected``.","tags":[]},{"args":["locator","expected","message=None","ignore_case=False"],"doc":"
Verifies that element locator\x3c/code> contains exact text expected\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
The ignore_case\x3c/code> argument can be set to True to compare case insensitive, default is False.\x3c/p>\n
ignore_case\x3c/code> argument new in SeleniumLibrary 3.1.\x3c/p>\n
Use Element Should Contain\x3c/a> if a substring match is desired.\x3c/p>","matched":true,"name":"Element Text Should Be","shortdoc":"Verifies that element ``locator`` contains exact text ``expected``.","tags":[]},{"args":["locator","not_expected","message=None","ignore_case=False"],"doc":"
Verifies that element locator\x3c/code> does not contain exact text not_expected\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
The ignore_case\x3c/code> argument can be set to True to compare case insensitive, default is False.\x3c/p>\n
New in SeleniumLibrary 3.1.1\x3c/p>","matched":true,"name":"Element Text Should Not Be","shortdoc":"Verifies that element ``locator`` does not contain exact text ``not_expected``.","tags":[]},{"args":["*code"],"doc":"
Executes asynchronous JavaScript code with possible arguments.\x3c/p>\n
Similar to Execute Javascript\x3c/a> except that scripts executed with this keyword must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.\x3c/p>\n
Scripts must complete within the script timeout or this keyword will fail. See the Timeout\x3c/a> section for more information.\x3c/p>\n
Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript arguments\x3c/a> as part of code\x3c/code> argument. See Execute Javascript\x3c/a> for more details.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\n\n\n\nExecute Async JavaScript\x3c/a>\x3c/td>\n var callback = arguments[arguments.length - 1]; window.setTimeout(callback, 2000);\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Execute Async JavaScript\x3c/a>\x3c/td>\n ${CURDIR}/async_js_to_execute.js\x3c/td>\n \x3c/td>\n\x3c/tr>\n
${result} =\x3c/td>\n Execute Async JavaScript\x3c/a>\x3c/td>\n \x3c/td>\n\x3c/tr>\n
...\x3c/td>\n var callback = arguments[arguments.length - 1];\x3c/td>\n \x3c/td>\n\x3c/tr>\n
...\x3c/td>\n function answer(){callback(\"text\");};\x3c/td>\n \x3c/td>\n\x3c/tr>\n
...\x3c/td>\n window.setTimeout(answer, 2000);\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Should Be Equal\x3c/span>\x3c/td>\n ${result}\x3c/td>\n text\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Execute Async Javascript","shortdoc":"Executes asynchronous JavaScript code with possible arguments.","tags":[]},{"args":["*code"],"doc":"Executes the given JavaScript code with possible arguments.\x3c/p>\n
code\x3c/code> may be divided into multiple cells in the test data and code\x3c/code> may contain multiple lines of code and arguments. In that case, the JavaScript code parts are concatenated together without adding spaces and optional arguments are separated from code\x3c/code>.\x3c/p>\n
If code\x3c/code> is a path to an existing file, the JavaScript to execute will be read from that file. Forward slashes work as a path separator on all operating systems.\x3c/p>\n
The JavaScript executes in the context of the currently selected frame or window as the body of an anonymous function. Use window\x3c/code> to refer to the window of your application and document\x3c/code> to refer to the document object of the current frame or window, e.g. document.getElementById('example')\x3c/code>.\x3c/p>\n
This keyword returns whatever the executed JavaScript code returns. Return values are converted to the appropriate Python types.\x3c/p>\n
Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript arguments\x3c/a> as part of code\x3c/code> argument. The JavaScript code and arguments must be separated with JAVASCRIPT\x3c/span> and ARGUMENTS\x3c/span> markers and must used exactly with this format. If the Javascript code is first, then the JAVASCRIPT\x3c/span> marker is optional. The order of JAVASCRIPT\x3c/span> and ARGUMENTS\x3c/span> markers can swapped, but if ARGUMENTS\x3c/span> is first marker, then JAVASCRIPT\x3c/span> marker is mandatory. It is only allowed to use JAVASCRIPT\x3c/span> and ARGUMENTS\x3c/span> markers only one time in the code\x3c/code> argument.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\nExecute JavaScript\x3c/a>\x3c/td>\n window.myFunc('arg1', 'arg2')\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Execute JavaScript\x3c/a>\x3c/td>\n ${CURDIR}/js_to_execute.js\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Execute JavaScript\x3c/a>\x3c/td>\n alert(arguments[0]);\x3c/td>\n ARGUMENTS\x3c/td>\n 123\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Execute JavaScript\x3c/a>\x3c/td>\n ARGUMENTS\x3c/td>\n 123\x3c/td>\n JAVASCRIPT\x3c/td>\n alert(arguments[0]);\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Execute Javascript","shortdoc":"Executes the given JavaScript code with possible arguments.","tags":[]},{"args":["locator","text","loglevel=TRACE"],"doc":"Verifies that frame identified by locator\x3c/code> contains text\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
See Page Should Contain\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Frame Should Contain","shortdoc":"Verifies that frame identified by ``locator`` contains ``text``.","tags":[]},{"args":[],"doc":"
Returns a list containing ids of all links found in current page.\x3c/p>\n
If a link has no id, an empty string will be in the list instead.\x3c/p>","matched":true,"name":"Get All Links","shortdoc":"Returns a list containing ids of all links found in current page.","tags":[]},{"args":[],"doc":"
Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary ${aliases.key}\x3c/code> or as list @{aliases}[0]\x3c/code>.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n\n\n\n\nOpen Browser\x3c/a>\x3c/td>\n https://example.com\x3c/a>\x3c/td>\n alias=BrowserA\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n https://example.com\x3c/a>\x3c/td>\n alias=BrowserB\x3c/td>\n \x3c/td>\n\x3c/tr>\n
&{aliases}\x3c/td>\n Get Browser Aliases\x3c/a>\x3c/td>\n \x3c/td>\n # &{aliases} = { BrowserA=1|BrowserB=2 }\x3c/td>\n\x3c/tr>\n
Log\x3c/span>\x3c/td>\n ${aliases.BrowserA}\x3c/td>\n \x3c/td>\n # logs 1\x3c/code>\x3c/td>\n\x3c/tr>\n
FOR\x3c/td>\n ${alias}\x3c/td>\n IN\x3c/td>\n @{aliases}\x3c/td>\n\x3c/tr>\n
\x3c/td>\n Log\x3c/span>\x3c/td>\n ${alias}\x3c/td>\n # logs BrowserA\x3c/code> and BrowserB\x3c/code>\x3c/td>\n\x3c/tr>\n
END\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nSee Switch Browser\x3c/a> for more information and examples.\x3c/p>\n
New in SeleniumLibrary 4.0\x3c/p>","matched":true,"name":"Get Browser Aliases","shortdoc":"Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary ``${aliases.key}`` or as list ``@{aliases}[0]``.","tags":[]},{"args":[],"doc":"
Returns index of all active browser as list.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n\n\n@{browser_ids}=\x3c/td>\n Get Browser Ids\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
FOR\x3c/td>\n ${id}\x3c/td>\n IN\x3c/td>\n @{browser_ids}\x3c/td>\n\x3c/tr>\n
\x3c/td>\n @{window_titles}=\x3c/td>\n Get Window Titles\x3c/td>\n browser=${id}\x3c/td>\n\x3c/tr>\n
\x3c/td>\n Log\x3c/td>\n Browser ${id} has these windows: ${window_titles}\x3c/td>\n \x3c/td>\n\x3c/tr>\n
END\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nSee Switch Browser\x3c/a> for more information and examples.\x3c/p>\n
New in SeleniumLibrary 4.0\x3c/p>","matched":true,"name":"Get Browser Ids","shortdoc":"Returns index of all active browser as list.","tags":[]},{"args":["name"],"doc":"
Returns information of cookie with name\x3c/code> as an object.\x3c/p>\n
If no cookie is found with name\x3c/code>, keyword fails. The cookie object contains details about the cookie. Attributes available in the object are documented in the table below.\x3c/p>\n
\n\n\n\n\n\n\n\n\n\nAttribute\x3c/th>\n Explanation\x3c/th>\n\x3c/tr>\n
name\x3c/td>\n The name of a cookie.\x3c/td>\n\x3c/tr>\n
value\x3c/td>\n Value of the cookie.\x3c/td>\n\x3c/tr>\n
path\x3c/td>\n Indicates a URL path, for example /\x3c/code>.\x3c/td>\n\x3c/tr>\n
domain\x3c/td>\n The domain the cookie is visible to.\x3c/td>\n\x3c/tr>\n
secure\x3c/td>\n When true, cookie is only used with HTTPS connections.\x3c/td>\n\x3c/tr>\n
httpOnly\x3c/td>\n When true, cookie is not accessible via JavaScript.\x3c/td>\n\x3c/tr>\n
expiry\x3c/td>\n Python datetime object indicating when the cookie expires.\x3c/td>\n\x3c/tr>\n
extra\x3c/td>\n Possible attributes outside of the WebDriver specification\x3c/td>\n\x3c/tr>\n\x3c/table>\nSee the WebDriver specification\x3c/a> for details about the cookie information. Notice that expiry\x3c/code> is specified as a datetime object\x3c/a>, not as seconds since Unix Epoch like WebDriver natively does.\x3c/p>\n
In some cases, example when running browser in the cloud, it is possible that cookie contains other attributes than is defined in the WebDriver specification\x3c/a>. These other attributes are available in a extra\x3c/code> attribute in the cookie object and it contains a dictionary of the other attributes. The extra\x3c/code> attribute is new in SeleniumLibrary 4.0.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n\n\nAdd Cookie\x3c/a>\x3c/td>\n foo\x3c/td>\n bar\x3c/td>\n\x3c/tr>\n
${cookie} =\x3c/td>\n Get Cookie\x3c/a>\x3c/td>\n foo\x3c/td>\n\x3c/tr>\n
Should Be Equal\x3c/span>\x3c/td>\n ${cookie.name}\x3c/td>\n bar\x3c/td>\n\x3c/tr>\n
Should Be Equal\x3c/span>\x3c/td>\n ${cookie.value}\x3c/td>\n foo\x3c/td>\n\x3c/tr>\n
Should Be True\x3c/span>\x3c/td>\n ${cookie.expiry.year} > 2017\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nNew in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Get Cookie","shortdoc":"Returns information of cookie with ``name`` as an object.","tags":[]},{"args":["as_dict=False"],"doc":"
Returns all cookies of the current page.\x3c/p>\n
If as_dict\x3c/code> argument evaluates as false, see Boolean arguments\x3c/a> for more details, then cookie information is returned as a single string in format name1=value1; name2=value2; name3=value3\x3c/code>. When as_dict\x3c/code> argument evaluates as true, cookie information is returned as Robot Framework dictionary format. The string format can be used, for example, for logging purposes or in headers when sending HTTP requests. The dictionary format is helpful when the result can be passed to requests library's Create Session keyword's optional cookies parameter.\x3c/p>\n
The ` as_dict\x3c/span>` argument is new in SeleniumLibrary 3.3\x3c/p>","matched":true,"name":"Get Cookies","shortdoc":"Returns all cookies of the current page.","tags":[]},{"args":["locator","attribute"],"doc":"
Returns value of attribute\x3c/code> from element locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Example:\x3c/p>\n
\n\n${id}=\x3c/td>\n Get Element Attribute\x3c/a>\x3c/td>\n css:h1\x3c/td>\n id\x3c/td>\n\x3c/tr>\n\x3c/table>\nPassing attribute name as part of the locator\x3c/code> was removed in SeleniumLibrary 3.2. The explicit attribute\x3c/code> argument should be used instead.\x3c/p>","matched":true,"name":"Get Element Attribute","shortdoc":"Returns value of ``attribute`` from element ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns number of elements matching locator\x3c/code>.\x3c/p>\n
If you wish to assert the number of matching elements, use Page Should Contain Element\x3c/a> with limit\x3c/code> argument. Keyword will always return an integer.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n${count} =\x3c/td>\n Get Element Count\x3c/a>\x3c/td>\n name:div_name\x3c/td>\n\x3c/tr>\n
Should Be True\x3c/span>\x3c/td>\n ${count} > 2\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nNew in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Get Element Count","shortdoc":"Returns number of elements matching ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns width and height of element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Both width and height are returned as integers.\x3c/p>\n
Example:\x3c/p>\n
\n\n${width}\x3c/td>\n ${height} =\x3c/td>\n Get Element Size\x3c/a>\x3c/td>\n css:div#container\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Get Element Size","shortdoc":"Returns width and height of element identified by ``locator``.","tags":[]},{"args":["locator"],"doc":"Returns horizontal position of element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The position is returned in pixels off the left side of the page, as an integer.\x3c/p>\n
See also Get Vertical Position\x3c/a>.\x3c/p>","matched":true,"name":"Get Horizontal Position","shortdoc":"Returns horizontal position of element identified by ``locator``.","tags":[]},{"args":["locator","values=False"],"doc":"
Returns all labels or values of selection list locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Returns visible labels by default, but values can be returned by setting the values\x3c/code> argument to a true value (see Boolean arguments\x3c/a>).\x3c/p>\n
Example:\x3c/p>\n
\n\n\n${labels} =\x3c/td>\n Get List Items\x3c/a>\x3c/td>\n mylist\x3c/td>\n \x3c/td>\n\x3c/tr>\n
${values} =\x3c/td>\n Get List Items\x3c/a>\x3c/td>\n css:#example select\x3c/td>\n values=True\x3c/td>\n\x3c/tr>\n\x3c/table>\nSupport to return values is new in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Get List Items","shortdoc":"Returns all labels or values of selection list ``locator``.","tags":[]},{"args":[],"doc":"
Returns the current browser window URL.\x3c/p>","matched":true,"name":"Get Location","shortdoc":"Returns the current browser window URL.","tags":[]},{"args":["browser=CURRENT"],"doc":"
Returns and logs URLs of all windows of the selected browser.\x3c/p>\n
Browser Scope:\x3c/b>\x3c/p>\n
The browser\x3c/code> argument specifies the browser that shall return its windows information.\x3c/p>\n
\nbrowser\x3c/code> can be index_or_alias\x3c/code> like in Switch Browser\x3c/a>.\x3c/li>\n\x3c/ul>\n\nIf browser\x3c/code> is CURRENT\x3c/code> (default, case-insensitive) the currently active browser is selected.\x3c/li>\n\x3c/ul>\n\nIf browser\x3c/code> is ALL\x3c/code> (case-insensitive) the window information of all windows of all opened browsers are returned.\x3c/li>\n\x3c/ul>","matched":true,"name":"Get Locations","shortdoc":"Returns and logs URLs of all windows of the selected browser.","tags":[]},{"args":["locator"],"doc":"Returns label of selected option from selection list locator\x3c/code>.\x3c/p>\n
If there are multiple selected options, label of the first option is returned.\x3c/p>\nSee the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Get Selected List Label","shortdoc":"Returns label of selected option from selection list ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns labels of selected options from selection list locator\x3c/code>.\x3c/p>\n
Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions this caused an error.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Get Selected List Labels","shortdoc":"Returns labels of selected options from selection list ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns value of selected option from selection list locator\x3c/code>.\x3c/p>\n
If there are multiple selected options, value of the first option is returned.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Get Selected List Value","shortdoc":"Returns value of selected option from selection list ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns values of selected options from selection list locator\x3c/code>.\x3c/p>\n
Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions this caused an error.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Get Selected List Values","shortdoc":"Returns values of selected options from selection list ``locator``.","tags":[]},{"args":[],"doc":"
Gets the implicit wait value used by Selenium.\x3c/p>\n
The value is returned as a human readable string like 1 second\x3c/code>.\x3c/p>\n
See the Implicit wait\x3c/a> section above for more information.\x3c/p>","matched":true,"name":"Get Selenium Implicit Wait","shortdoc":"Gets the implicit wait value used by Selenium.","tags":[]},{"args":[],"doc":"
Gets the delay that is waited after each Selenium command.\x3c/p>\n
The value is returned as a human readable string like 1 second\x3c/code>.\x3c/p>\n
See the Selenium Speed\x3c/a> section above for more information.\x3c/p>","matched":true,"name":"Get Selenium Speed","shortdoc":"Gets the delay that is waited after each Selenium command.","tags":[]},{"args":[],"doc":"
Gets the timeout that is used by various keywords.\x3c/p>\n
The value is returned as a human readable string like 1 second\x3c/code>.\x3c/p>\n
See the Timeout\x3c/a> section above for more information.\x3c/p>","matched":true,"name":"Get Selenium Timeout","shortdoc":"Gets the timeout that is used by various keywords.","tags":[]},{"args":[],"doc":"
Returns the currently active browser session id.\x3c/p>\n
New in SeleniumLibrary 3.2\x3c/p>","matched":true,"name":"Get Session Id","shortdoc":"Returns the currently active browser session id.","tags":[]},{"args":[],"doc":"
Returns the entire HTML source of the current page or frame.\x3c/p>","matched":true,"name":"Get Source","shortdoc":"Returns the entire HTML source of the current page or frame.","tags":[]},{"args":["locator","row","column","loglevel=TRACE"],"doc":"
Returns contents of table cell.\x3c/p>\n
The table is located using the locator\x3c/code> argument and its cell found using row\x3c/code> and column\x3c/code>. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Both row and column indexes start from 1, and header and footer rows are included in the count. It is possible to refer to rows and columns from the end by using negative indexes so that -1 is the last row/column, -2 is the second last, and so on.\x3c/p>\n
All <th>\x3c/code> and <td>\x3c/code> elements anywhere in the table are considered to be cells.\x3c/p>\n
See Page Should Contain\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Get Table Cell","shortdoc":"Returns contents of table cell.","tags":[]},{"args":["locator"],"doc":"
Returns the text value of element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Get Text","shortdoc":"Returns the text value of element identified by ``locator``.","tags":[]},{"args":[],"doc":"
Returns the title of current page.\x3c/p>","matched":true,"name":"Get Title","shortdoc":"Returns the title of current page.","tags":[]},{"args":["locator"],"doc":"
Returns the value attribute of element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Get Value","shortdoc":"Returns the value attribute of element identified by ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns vertical position of element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The position is returned in pixels off the top of the page, as an integer.\x3c/p>\n
See also Get Horizontal Position\x3c/a>.\x3c/p>","matched":true,"name":"Get Vertical Position","shortdoc":"Returns vertical position of element identified by ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns the first WebElement matching the given locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Get WebElement","shortdoc":"Returns the first WebElement matching the given ``locator``.","tags":[]},{"args":["locator"],"doc":"
Returns list of WebElement objects matching the locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Starting from SeleniumLibrary 3.0, the keyword returns an empty list if there are no matching elements. In previous releases the keyword failed in this case.\x3c/p>","matched":true,"name":"Get WebElements","shortdoc":"Returns list of WebElement objects matching the ``locator``.","tags":[]},{"args":["browser=CURRENT"],"doc":"
Returns all child window handles of the selected browser as a list.\x3c/p>\n
Can be used as a list of windows to exclude with Select Window\x3c/a>.\x3c/p>\n
How to select the browser\x3c/code> scope of this keyword, see Get Locations\x3c/a>.\x3c/p>\n
Prior to SeleniumLibrary 3.0, this keyword was named List Windows\x3c/span>.\x3c/p>","matched":true,"name":"Get Window Handles","shortdoc":"Returns all child window handles of the selected browser as a list.","tags":[]},{"args":["browser=CURRENT"],"doc":"
Returns and logs id attributes of all windows of the selected browser.\x3c/p>\n
How to select the browser\x3c/code> scope of this keyword, see Get Locations\x3c/a>.\x3c/p>","matched":true,"name":"Get Window Identifiers","shortdoc":"Returns and logs id attributes of all windows of the selected browser.","tags":[]},{"args":["browser=CURRENT"],"doc":"
Returns and logs names of all windows of the selected browser.\x3c/p>\n
How to select the browser\x3c/code> scope of this keyword, see Get Locations\x3c/a>.\x3c/p>","matched":true,"name":"Get Window Names","shortdoc":"Returns and logs names of all windows of the selected browser.","tags":[]},{"args":[],"doc":"
Returns current window position.\x3c/p>\n
Position is relative to the top left corner of the screen. Returned values are integers. See also Set Window Position\x3c/a>.\x3c/p>\n
Example:\x3c/p>\n
\n\n${x}\x3c/td>\n ${y}=\x3c/td>\n Get Window Position\x3c/a>\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Get Window Position","shortdoc":"Returns current window position.","tags":[]},{"args":["inner=False"],"doc":"Returns current window width and height as integers.\x3c/p>\nSee also Set Window Size\x3c/a>.\x3c/p>\n
If inner\x3c/code> parameter is set to True, keyword returns HTML DOM window.innerWidth and window.innerHeight properties. See Boolean arguments\x3c/a> for more details how to set boolean arguments. The inner\x3c/code> is new in SeleniumLibrary 4.0.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n${width}\x3c/td>\n ${height}=\x3c/td>\n Get Window Size\x3c/a>\x3c/td>\n \x3c/td>\n\x3c/tr>\n
${width}\x3c/td>\n ${height}=\x3c/td>\n Get Window Size\x3c/a>\x3c/td>\n True\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Get Window Size","shortdoc":"Returns current window width and height as integers.","tags":[]},{"args":["browser=CURRENT"],"doc":"Returns and logs titles of all windows of the selected browser.\x3c/p>\n
How to select the browser\x3c/code> scope of this keyword, see Get Locations\x3c/a>.\x3c/p>","matched":true,"name":"Get Window Titles","shortdoc":"Returns and logs titles of all windows of the selected browser.","tags":[]},{"args":[],"doc":"
Simulates the user clicking the back button on their browser.\x3c/p>","matched":true,"name":"Go Back","shortdoc":"Simulates the user clicking the back button on their browser.","tags":[]},{"args":["url"],"doc":"
Navigates the current browser window to the provided url\x3c/code>.\x3c/p>","matched":true,"name":"Go To","shortdoc":"Navigates the current browser window to the provided ``url``.","tags":[]},{"args":["action=ACCEPT","timeout=None"],"doc":"
Handles the current alert and returns its message.\x3c/p>\n
By default the alert is accepted, but this can be controlled with the action\x3c/code> argument that supports the following case-insensitive values:\x3c/p>\n
\nACCEPT\x3c/code>: Accept the alert i.e. press Ok\x3c/code>. Default.\x3c/li>\n
DISMISS\x3c/code>: Dismiss the alert i.e. press Cancel\x3c/code>.\x3c/li>\nLEAVE\x3c/code>: Leave the alert open.\x3c/li>\n\x3c/ul>\nThe timeout\x3c/code> argument specifies how long to wait for the alert to appear. If it is not given, the global default timeout\x3c/a> is used instead.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\n\n\nHandle Alert\x3c/td>\n \x3c/td>\n \x3c/td>\n # Accept alert.\x3c/td>\n\x3c/tr>\n
Handle Alert\x3c/td>\n action=DISMISS\x3c/td>\n \x3c/td>\n # Dismiss alert.\x3c/td>\n\x3c/tr>\n
Handle Alert\x3c/td>\n timeout=10 s\x3c/td>\n \x3c/td>\n # Use custom timeout and accept alert.\x3c/td>\n\x3c/tr>\n
Handle Alert\x3c/td>\n DISMISS\x3c/td>\n 1 min\x3c/td>\n # Use custom timeout and dismiss alert.\x3c/td>\n\x3c/tr>\n
${message} =\x3c/td>\n Handle Alert\x3c/td>\n \x3c/td>\n # Accept alert and get its message.\x3c/td>\n\x3c/tr>\n
${message} =\x3c/td>\n Handle Alert\x3c/td>\n LEAVE\x3c/td>\n # Leave alert open and get its message.\x3c/td>\n\x3c/tr>\n\x3c/table>\nNew in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Handle Alert","shortdoc":"Handles the current alert and returns its message.","tags":[]},{"args":["locator","password","clear=True"],"doc":"
Types the given password into text field identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. See Input Text\x3c/a> for clear\x3c/code> argument details.\x3c/p>\n
Difference compared to Input Text\x3c/a> is that this keyword does not log the given password on the INFO level. Notice that if you use the keyword like\x3c/p>\n
\n\nInput Password\x3c/td>\n password_field\x3c/td>\n password\x3c/td>\n\x3c/tr>\n\x3c/table>\nthe password is shown as a normal keyword argument. A way to avoid that is using variables like\x3c/p>\n
\n\nInput Password\x3c/td>\n password_field\x3c/td>\n ${PASSWORD}\x3c/td>\n\x3c/tr>\n\x3c/table>\nNotice also that SeleniumLibrary logs all the communication with browser drivers using the DEBUG level, and the actual password can be seen there. Additionally Robot Framework logs all arguments using the TRACE level. Tests must thus not be executed using level below INFO if password should not be logged in any format.\x3c/p>\n
The clear\x3c/span> argument is new in SeleniumLibrary 4.0\x3c/p>","matched":true,"name":"Input Password","shortdoc":"Types the given password into text field identified by ``locator``.","tags":[]},{"args":["locator","text","clear=True"],"doc":"
Types the given text\x3c/code> into text field identified by locator\x3c/code>.\x3c/p>\n
When clear\x3c/code> is true, the input element is cleared before text is typed to the element. When false, the previous text is not cleared from the element. Use Input Password\x3c/a> if you do not want the given text\x3c/code> to be logged.\x3c/p>\n
If Selenium Grid\x3c/a> is used and the text\x3c/code> argument points to a file in the file system, then this keyword prevents the Selenium to transfer the file to the Selenium Grid hub. Instead this keyword will send the text\x3c/code> string as is to the element. If file should be transferred to the hub and upload should be performed, please use Choose File\x3c/a> keyword.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. See the Boolean arguments\x3c/a> section how Boolean values are handled.\x3c/p>\n
Disabling the file upload the Selenium Grid node and the clear\x3c/span> argument are new in SeleniumLibrary 4.0\x3c/p>","matched":true,"name":"Input Text","shortdoc":"Types the given ``text`` into text field identified by ``locator``.","tags":[]},{"args":["text","action=ACCEPT","timeout=None"],"doc":"
Types the given text\x3c/code> into an input field in an alert.\x3c/p>\n
The alert is accepted by default, but that behavior can be controlled by using the action\x3c/code> argument same way as with Handle Alert\x3c/a>.\x3c/p>\n
timeout\x3c/code> specifies how long to wait for the alert to appear. If it is not given, the global default timeout\x3c/a> is used instead.\x3c/p>\n
New in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Input Text Into Alert","shortdoc":"Types the given ``text`` into an input field in an alert.","tags":[]},{"args":["locator","*expected"],"doc":"
Verifies selection list locator\x3c/code> has expected\x3c/code> options selected.\x3c/p>\n
It is possible to give expected options both as visible labels and as values. Starting from SeleniumLibrary 3.0, mixing labels and values is not possible. Order of the selected options is not validated.\x3c/p>\n
If no expected options are given, validates that the list has no selections. A more explicit alternative is using List Should Have No Selections\x3c/a>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\nList Selection Should Be\x3c/a>\x3c/td>\n gender\x3c/td>\n Female\x3c/td>\n \x3c/td>\n\x3c/tr>\n
List Selection Should Be\x3c/a>\x3c/td>\n interests\x3c/td>\n Test Automation\x3c/td>\n Python\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"List Selection Should Be","shortdoc":"Verifies selection list ``locator`` has ``expected`` options selected.","tags":[]},{"args":["locator"],"doc":"Verifies selection list locator\x3c/code> has no options selected.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"List Should Have No Selections","shortdoc":"Verifies selection list ``locator`` has no options selected.","tags":[]},{"args":["url","message=None"],"doc":"
Verifies that current URL is exactly url\x3c/code>.\x3c/p>\n
The url\x3c/code> argument contains the exact url that should exist in browser.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
message\x3c/code> argument new in SeleniumLibrary 3.2.0.\x3c/p>","matched":true,"name":"Location Should Be","shortdoc":"Verifies that current URL is exactly ``url``.","tags":[]},{"args":["expected","message=None"],"doc":"
Verifies that current URL contains expected\x3c/code>.\x3c/p>\n
The expected\x3c/code> argument contains the expected value in url.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
message\x3c/code> argument new in SeleniumLibrary 3.2.0.\x3c/p>","matched":true,"name":"Location Should Contain","shortdoc":"Verifies that current URL contains ``expected``.","tags":[]},{"args":["locator","x","message=None","loglevel=TRACE"],"doc":"
DEPRECATED in SeleniumLibrary 4.0.\x3c/b>, use Page Should Contain Element\x3c/a> with limit\x3c/code> argument instead.\x3c/p>","matched":true,"name":"Locator Should Match X Times","shortdoc":"*DEPRECATED in SeleniumLibrary 4.0.*, use `Page Should Contain Element` with ``limit`` argument instead.","tags":[]},{"args":[],"doc":"
Logs and returns the current browser window URL.\x3c/p>","matched":true,"name":"Log Location","shortdoc":"Logs and returns the current browser window URL.","tags":[]},{"args":["loglevel=INFO"],"doc":"
Logs and returns the HTML source of the current page or frame.\x3c/p>\n
The loglevel\x3c/code> argument defines the used log level. Valid log levels are WARN\x3c/code>, INFO\x3c/code> (default), DEBUG\x3c/code>, TRACE\x3c/code> and NONE\x3c/code> (no logging).\x3c/p>","matched":true,"name":"Log Source","shortdoc":"Logs and returns the HTML source of the current page or frame.","tags":[]},{"args":[],"doc":"
Logs and returns the title of current page.\x3c/p>","matched":true,"name":"Log Title","shortdoc":"Logs and returns the title of current page.","tags":[]},{"args":[],"doc":"
Maximizes current browser window.\x3c/p>","matched":true,"name":"Maximize Browser Window","shortdoc":"Maximizes current browser window.","tags":[]},{"args":["locator"],"doc":"
Simulates pressing the left mouse button on the element locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The element is pressed without releasing the mouse button.\x3c/p>\n
See also the more specific keywords Mouse Down On Image\x3c/a> and Mouse Down On Link\x3c/a>.\x3c/p>","matched":true,"name":"Mouse Down","shortdoc":"Simulates pressing the left mouse button on the element ``locator``.","tags":[]},{"args":["locator"],"doc":"
Simulates a mouse down event on an image identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, images are searched using id\x3c/code>, name\x3c/code>, src\x3c/code> and alt\x3c/code>.\x3c/p>","matched":true,"name":"Mouse Down On Image","shortdoc":"Simulates a mouse down event on an image identified by ``locator``.","tags":[]},{"args":["locator"],"doc":"
Simulates a mouse down event on a link identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, links are searched using id\x3c/code>, name\x3c/code>, href\x3c/code> and the link text.\x3c/p>","matched":true,"name":"Mouse Down On Link","shortdoc":"Simulates a mouse down event on a link identified by ``locator``.","tags":[]},{"args":["locator"],"doc":"
Simulates moving mouse away from the element locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Mouse Out","shortdoc":"Simulates moving mouse away from the element ``locator``.","tags":[]},{"args":["locator"],"doc":"
Simulates hovering mouse over the element locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Mouse Over","shortdoc":"Simulates hovering mouse over the element ``locator``.","tags":[]},{"args":["locator"],"doc":"
Simulates releasing the left mouse button on the element locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Mouse Up","shortdoc":"Simulates releasing the left mouse button on the element ``locator``.","tags":[]},{"args":["url","browser=firefox","alias=None","remote_url=False","desired_capabilities=None","ff_profile_dir=None","options=None","service_log_path=None"],"doc":"
Opens a new browser instance to the given url\x3c/code>.\x3c/p>\n
The browser\x3c/code> argument specifies which browser to use, and the supported browser are listed in the table below. The browser names are case-insensitive and some browsers have multiple supported names.\x3c/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nBrowser\x3c/th>\n Name(s)\x3c/th>\n\x3c/tr>\n
Firefox\x3c/td>\n firefox, ff\x3c/td>\n\x3c/tr>\n
Google Chrome\x3c/td>\n googlechrome, chrome, gc\x3c/td>\n\x3c/tr>\n
Headless Firefox\x3c/td>\n headlessfirefox\x3c/td>\n\x3c/tr>\n
Headless Chrome\x3c/td>\n headlesschrome\x3c/td>\n\x3c/tr>\n
Internet Explorer\x3c/td>\n internetexplorer, ie\x3c/td>\n\x3c/tr>\n
Edge\x3c/td>\n edge\x3c/td>\n\x3c/tr>\n
Safari\x3c/td>\n safari\x3c/td>\n\x3c/tr>\n
Opera\x3c/td>\n opera\x3c/td>\n\x3c/tr>\n
Android\x3c/td>\n android\x3c/td>\n\x3c/tr>\n
Iphone\x3c/td>\n iphone\x3c/td>\n\x3c/tr>\n
PhantomJS\x3c/td>\n phantomjs\x3c/td>\n\x3c/tr>\n
HTMLUnit\x3c/td>\n htmlunit\x3c/td>\n\x3c/tr>\n
HTMLUnit with Javascript\x3c/td>\n htmlunitwithjs\x3c/td>\n\x3c/tr>\n\x3c/table>\nTo be able to actually use one of these browsers, you need to have a matching Selenium browser driver available. See the project documentation\x3c/a> for more details. Headless Firefox and Headless Chrome are new additions in SeleniumLibrary 3.1.0 and require Selenium 3.8.0 or newer.\x3c/p>\n
Optional alias\x3c/code> is an alias given for this browser instance and it can be used for switching between browsers. When same alias\x3c/code> is given with two Open Browser\x3c/a> keywords, the first keyword will open new browser. But the second one will switch to the already opened browser and will not open new browser. The alias\x3c/code> definition overrules browser\x3c/code> definition. When same alias\x3c/code> is used but different browser\x3c/code> is defined, then switch to browser with same alias is done and new browser is not opened. An alternative approach for switching is using an index returned by this keyword. These indices start from 1, are incremented when new browsers are opened, and reset back to 1 when Close All Browsers\x3c/a> is called. See Switch Browser\x3c/a> for more information and examples.\x3c/p>\n
Optional remote_url\x3c/code> is the URL for a Selenium Grid\x3c/a>.\x3c/p>\n
Optional desired_capabilities\x3c/code> can be used to configure, for example, logging preferences for a browser or a browser and operating system when using Sauce Labs\x3c/a>. Desired capabilities can be given either as a Python dictionary or as a string in format key1:value1,key2:value2\x3c/code>. Selenium documentation\x3c/a> lists possible capabilities that can be enabled.\x3c/p>\n
Optional ff_profile_dir\x3c/code> is the path to the Firefox profile directory if you wish to overwrite the default profile Selenium uses. Notice that prior to SeleniumLibrary 3.0, the library contained its own profile that was used by default. The ff_profile_dir\x3c/code> can also be instance of the selenium.webdriver.FirefoxProfile\x3c/a> . As third option, it possible to use FirefoxProfile\x3c/span> methods and attributes to define the profile. Using method and attributes in same way as with options\x3c/code> argument. Example it is possible to use FirefoxProfile set_preference\x3c/span> to define different profile settings.\x3c/p>\n
Optional options\x3c/code> argument allows to define browser specific Selenium options. Example for Chrome, the options\x3c/code> argument allows defining the following methods and attributes\x3c/a> and for Firefox these methods and attributes\x3c/a> are available. Please note that not all browsers supported by the SeleniumLibrary have Selenium options available. Therefore please consult the Selenium documentation which browsers do support the Selenium options. If browser\x3c/code> argument is android\x3c/span> then Chrome options\x3c/a> is used. Selenium options are also supported, when remote_url\x3c/code> argument is used.\x3c/p>\n
The SeleniumLibrary options\x3c/code> argument accepts Selenium options in two different formats: as a string and as Python object which is an instance of the Selenium options class.\x3c/p>\n
The string format allows to define Selenium options methods or attributes and their arguments in Robot Framework test data. The method and attributes names are case and space sensitive and must match to the Selenium options methods and attributes names. When defining a method, is must defined in similar way as in python: method name, opening parenthesis, zero to many arguments and closing parenthesis. If there is need to define multiple arguments for a single method, arguments must be separated with comma, just like in Python. Example: add_argument(\"--headless\")\x3c/span> or add_experimental_option(\"key\", \"value\")\x3c/span>. Attributes are defined in similar way as in Python: attribute name, equal sing and attribute value. Example, headless=True\x3c/span>. Multiple methods and attributes must separated by a semicolon, example: add_argument(\"--headless\");add_argument(\"--start-maximized\")\x3c/span>.\x3c/p>\n
Arguments allow defining Python data types and arguments are evaluated by using Python ast.literal_eval\x3c/a>. Strings must be quoted with single or double quotes, example \"value\" or 'value'. It is also possible define other Python builtin data types, example True\x3c/span> or None\x3c/span>, by not using quotes around the arguments.\x3c/p>\n
The string format is space friendly and usually spaces do not alter the defining the methods or attributes. There are two exceptions. In some Robot Framework test data formats, two or more spaces are considered as cell separator and instead of defining a single argument, two or more arguments may be defined. Spaces in string arguments are not removed and are left as is. Example add_argument ( \"--headless\" )\x3c/span> is same as add_argument(\"--headless\")\x3c/span>. But add_argument(\" --headless \")\x3c/span> is not same same as add_argument ( \"--headless\" )\x3c/span>, because spaces inside of quotes are not removed.\x3c/p>\n
As last format options\x3c/code> argument also support receiving the Selenium options as Python class instance. In this case, the instance is used as is and the SeleniumLibrary will not convert the instance to other formats. For example, if the following code return value is saved to ${options}\x3c/span> variable in the Robot Framework data:\x3c/p>\n
\noptions = webdriver.ChromeOptions()\noptions.add_argument('--disable-dev-shm-usage')\nreturn options\n\x3c/pre>\nThen the ${options}\x3c/span> variable can be used as argument to options\x3c/code>.\x3c/p>\nOptional service_log_path\x3c/code> argument defines the name of the file where to write the browser driver logs. If the service_log_path\x3c/code>  argument contain a  marker {index}\x3c/code>, it will be automatically replaced with unique running index preventing files to be overwritten. Indices start's from 1, and how they are represented can be customized using Python's format string syntax\x3c/a>.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\nOpen Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Chrome\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Firefox\x3c/td>\n alias=Firefox\x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Edge\x3c/td>\n remote_url=http://127.0.0.1:4444/wd/hub\x3c/td>\n\x3c/tr>\n\x3c/table>\nAlias examples:\x3c/p>\n
\n\n\n\n\n\n\n\n${1_index} =\x3c/td>\n Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Chrome\x3c/td>\n alias=Chrome\x3c/td>\n # Opens new browser because alias is new.\x3c/td>\n\x3c/tr>\n
${2_index} =\x3c/td>\n Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Firefox\x3c/td>\n \x3c/td>\n # Opens new browser because alias is not defined.\x3c/td>\n\x3c/tr>\n
${3_index} =\x3c/td>\n Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Chrome\x3c/td>\n alias=Chrome\x3c/td>\n # Switches to the browser with Chrome alias.\x3c/td>\n\x3c/tr>\n
${4_index} =\x3c/td>\n Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Chrome\x3c/td>\n alias=${1_index}\x3c/td>\n # Switches to the browser with Chrome alias.\x3c/td>\n\x3c/tr>\n
Should Be Equal\x3c/td>\n ${1_index}\x3c/td>\n ${3_index}\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Should Be Equal\x3c/td>\n ${1_index}\x3c/td>\n ${4_index}\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Should Be Equal\x3c/td>\n ${2_index}\x3c/td>\n ${2}\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nExample when using Chrome options\x3c/a> method:\x3c/p>\n
\n\n\n\nOpen Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Chrome\x3c/td>\n options=add_argument(\"--disable-popup-blocking\"); add_argument(\"--ignore-certificate-errors\")\x3c/td>\n # Sting format\x3c/td>\n\x3c/tr>\n
${options} =\x3c/td>\n Get Options\x3c/td>\n \x3c/td>\n \x3c/td>\n # Selenium options instance\x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Chrome\x3c/td>\n options=${options}\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nExample for FirefoxProfile\x3c/p>\n
\n\n\n\nOpen Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Firefox\x3c/td>\n ff_profile_dir=/path/to/profile\x3c/td>\n # Using profile from disk\x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Firefox\x3c/td>\n ff_profile_dir=${FirefoxProfile_instance}\x3c/td>\n # Using instance of FirefoxProfile\x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n http://example.com\x3c/a>\x3c/td>\n Firefox\x3c/td>\n ff_profile_dir=set_preference(\"key\", \"value\");set_preference(\"other\", \"setting\")\x3c/td>\n # Defining profile using FirefoxProfile mehtods\x3c/td>\n\x3c/tr>\n\x3c/table>\nIf the provided configuration options are not enough, it is possible to use Create Webdriver\x3c/a> to customize browser initialization even more.\x3c/p>\n
Applying desired_capabilities\x3c/code> argument also for local browser is new in SeleniumLibrary 3.1.\x3c/p>\n
Using alias\x3c/code> to decide, is the new browser opened is new in SeleniumLibrary 4.0. The options\x3c/code> and service_log_path\x3c/code> are new in SeleniumLibrary 4.0. Support for ff_profile_dir\x3c/code> accepting instance of the selenium.webdriver.FirefoxProfile\x3c/span> and support defining FirefoxProfile with methods and attributes are new in SeleniumLibrary 4.0.\x3c/p>","matched":true,"name":"Open Browser","shortdoc":"Opens a new browser instance to the given ``url``.","tags":[]},{"args":["locator"],"doc":"
Opens context menu on element identified by locator\x3c/code>.\x3c/p>","matched":true,"name":"Open Context Menu","shortdoc":"Opens context menu on element identified by ``locator``.","tags":[]},{"args":["text","loglevel=TRACE"],"doc":"
Verifies that current page contains text\x3c/code>.\x3c/p>\n
If this keyword fails, it automatically logs the page source using the log level specified with the optional loglevel\x3c/code> argument. Valid log levels are DEBUG\x3c/code>, INFO\x3c/code> (default), WARN\x3c/code>, and NONE\x3c/code>. If the log level is NONE\x3c/code> or below the current active log level the source will not be logged.\x3c/p>","matched":true,"name":"Page Should Contain","shortdoc":"Verifies that current page contains ``text``.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies button locator\x3c/code> is found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, buttons are searched using id\x3c/code>, name\x3c/code> and value\x3c/code>.\x3c/p>","matched":true,"name":"Page Should Contain Button","shortdoc":"Verifies button ``locator`` is found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies checkbox locator\x3c/code> is found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Page Should Contain Checkbox","shortdoc":"Verifies checkbox ``locator`` is found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE","limit=None"],"doc":"
Verifies that element locator\x3c/code> is found on the current page.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
The limit\x3c/code> argument can used to define how many elements the page should contain. When limit\x3c/code> is None\x3c/code> (default) page can contain one or more elements. When limit is a number, page must contain same number of elements.\x3c/p>\n
See Page Should Contain\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>\n
Examples assumes that locator matches to two elements.\x3c/p>\n
\n\n\n\n\nPage Should Contain Element\x3c/a>\x3c/td>\n div_name\x3c/td>\n limit=1\x3c/td>\n # Keyword fails.\x3c/td>\n\x3c/tr>\n
Page Should Contain Element\x3c/a>\x3c/td>\n div_name\x3c/td>\n limit=2\x3c/td>\n # Keyword passes.\x3c/td>\n\x3c/tr>\n
Page Should Contain Element\x3c/a>\x3c/td>\n div_name\x3c/td>\n limit=none\x3c/td>\n # None is considered one or more.\x3c/td>\n\x3c/tr>\n
Page Should Contain Element\x3c/a>\x3c/td>\n div_name\x3c/td>\n \x3c/td>\n # Same as above.\x3c/td>\n\x3c/tr>\n\x3c/table>\nThe limit\x3c/code> argument is new in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Page Should Contain Element","shortdoc":"Verifies that element ``locator`` is found on the current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies image identified by locator\x3c/code> is found from current page.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, images are searched using id\x3c/code>, name\x3c/code>, src\x3c/code> and alt\x3c/code>.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>","matched":true,"name":"Page Should Contain Image","shortdoc":"Verifies image identified by ``locator`` is found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies link identified by locator\x3c/code> is found from current page.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, links are searched using id\x3c/code>, name\x3c/code>, href\x3c/code> and the link text.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>","matched":true,"name":"Page Should Contain Link","shortdoc":"Verifies link identified by ``locator`` is found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies selection list locator\x3c/code> is found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Page Should Contain List","shortdoc":"Verifies selection list ``locator`` is found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies radio button locator\x3c/code> is found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using id\x3c/code>, name\x3c/code> and value\x3c/code>.\x3c/p>","matched":true,"name":"Page Should Contain Radio Button","shortdoc":"Verifies radio button ``locator`` is found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies text field locator\x3c/code> is found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Page Should Contain Textfield","shortdoc":"Verifies text field ``locator`` is found from current page.","tags":[]},{"args":["text","loglevel=TRACE"],"doc":"
Verifies the current page does not contain text\x3c/code>.\x3c/p>\n
See Page Should Contain\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Page Should Not Contain","shortdoc":"Verifies the current page does not contain ``text``.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies button locator\x3c/code> is not found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, buttons are searched using id\x3c/code>, name\x3c/code> and value\x3c/code>.\x3c/p>","matched":true,"name":"Page Should Not Contain Button","shortdoc":"Verifies button ``locator`` is not found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies checkbox locator\x3c/code> is not found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Page Should Not Contain Checkbox","shortdoc":"Verifies checkbox ``locator`` is not found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies that element locator\x3c/code> is found on the current page.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
See Page Should Contain\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>","matched":true,"name":"Page Should Not Contain Element","shortdoc":"Verifies that element ``locator`` is found on the current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies image identified by locator\x3c/code> is found from current page.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, images are searched using id\x3c/code>, name\x3c/code>, src\x3c/code> and alt\x3c/code>.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>","matched":true,"name":"Page Should Not Contain Image","shortdoc":"Verifies image identified by ``locator`` is found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies link identified by locator\x3c/code> is not found from current page.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, links are searched using id\x3c/code>, name\x3c/code>, href\x3c/code> and the link text.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>","matched":true,"name":"Page Should Not Contain Link","shortdoc":"Verifies link identified by ``locator`` is not found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies selection list locator\x3c/code> is not found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Page Should Not Contain List","shortdoc":"Verifies selection list ``locator`` is not found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies radio button locator\x3c/code> is not found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using id\x3c/code>, name\x3c/code> and value\x3c/code>.\x3c/p>","matched":true,"name":"Page Should Not Contain Radio Button","shortdoc":"Verifies radio button ``locator`` is not found from current page.","tags":[]},{"args":["locator","message=None","loglevel=TRACE"],"doc":"
Verifies text field locator\x3c/code> is not found from current page.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about message\x3c/code> and loglevel\x3c/code> arguments.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Page Should Not Contain Textfield","shortdoc":"Verifies text field ``locator`` is not found from current page.","tags":[]},{"args":["locator","key"],"doc":"
DEPRECATED in SeleniumLibrary 4.0.\x3c/b> use Press Keys\x3c/a> instead.\x3c/p>","matched":true,"name":"Press Key","shortdoc":"*DEPRECATED in SeleniumLibrary 4.0.* use `Press Keys` instead.","tags":[]},{"args":["locator=None","*keys"],"doc":"
Simulates user pressing key(s) to an element or on the active browser.\x3c/p>\n
If locator\x3c/code> evaluates as false, see Boolean arguments\x3c/a> for more details, then the keys\x3c/code> are sent to the currently active browser. Otherwise element is searched and keys\x3c/code> are send to the element identified by the locator\x3c/code>. In later case, keyword fails if element is not found. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
keys\x3c/code> arguments can contain one or many strings, but it can not be empty. keys\x3c/code> can also be a combination of Selenium Keys\x3c/a> and strings or a single Selenium Key. If Selenium Key is combined with strings, Selenium key and strings must be separated by the +\x3c/span> character, like in CONTROL+c\x3c/span>. Selenium Keys are space and case sensitive and Selenium Keys are not parsed inside of the string. Example AALTO, would send string AALTO\x3c/span> and ALT\x3c/span> not parsed inside of the string. But A+ALT+O\x3c/span> would found Selenium ALT key from the keys\x3c/code> argument. It also possible to press many Selenium Keys down at the same time, example 'ALT+ARROW_DOWN`.\x3c/p>\n
If Selenium Keys are detected in the keys\x3c/code> argument, keyword will press the Selenium Key down, send the strings and then release the Selenium Key. If keyword needs to send a Selenium Key as a string, then each character must be separated with +\x3c/span> character, example E+N+D\x3c/span>.\x3c/p>\n
CTRL\x3c/span> is alias for Selenium CONTROL\x3c/a> and ESC is alias for Selenium ESCAPE\x3c/a>\x3c/p>\n
New in SeleniumLibrary 3.3\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\n\n\n\n\n\n\nPress Keys\x3c/a>\x3c/td>\n text_field\x3c/td>\n AAAAA\x3c/td>\n \x3c/td>\n # Sends string \"AAAAA\" to element.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n None\x3c/td>\n BBBBB\x3c/td>\n \x3c/td>\n # Sends string \"BBBBB\" to currently active browser.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n text_field\x3c/td>\n E+N+D\x3c/td>\n \x3c/td>\n # Sends string \"END\" to element.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n text_field\x3c/td>\n XXX\x3c/td>\n YY\x3c/td>\n # Sends strings \"XXX\" and \"YY\" to element.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n text_field\x3c/td>\n XXX+YY\x3c/td>\n \x3c/td>\n # Same as above.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n text_field\x3c/td>\n ALT+ARROW_DOWN\x3c/td>\n \x3c/td>\n # Pressing \"ALT\" key down, then pressing ARROW_DOWN and then releasing both keys.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n text_field\x3c/td>\n ALT\x3c/td>\n ARROW_DOWN\x3c/td>\n # Pressing \"ALT\" key and then pressing ARROW_DOWN.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n text_field\x3c/td>\n CTRL+c\x3c/td>\n \x3c/td>\n # Pressing CTRL key down, sends string \"c\" and then releases CTRL key.\x3c/td>\n\x3c/tr>\n
Press Keys\x3c/a>\x3c/td>\n button\x3c/td>\n RETURN\x3c/td>\n \x3c/td>\n # Pressing \"ENTER\" key to element.\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Press Keys","shortdoc":"Simulates user pressing key(s) to an element or on the active browser.","tags":[]},{"args":["group_name","value"],"doc":"Verifies radio button group group_name\x3c/code> is set to value\x3c/code>.\x3c/p>\n
group_name\x3c/code> is the name\x3c/code> of the radio button group.\x3c/p>","matched":true,"name":"Radio Button Should Be Set To","shortdoc":"Verifies radio button group ``group_name`` is set to ``value``.","tags":[]},{"args":["group_name"],"doc":"
Verifies radio button group group_name\x3c/code> has no selection.\x3c/p>\n
group_name\x3c/code> is the name\x3c/code> of the radio button group.\x3c/p>","matched":true,"name":"Radio Button Should Not Be Selected","shortdoc":"Verifies radio button group ``group_name`` has no selection.","tags":[]},{"args":["keyword"],"doc":"
Sets the keyword to execute when a SeleniumLibrary keyword fails.\x3c/p>\n
keyword\x3c/code> is the name of a keyword that will be executed if a SeleniumLibrary keyword fails. It is possible to use any available keyword, including user keywords or keywords from other libraries, but the keyword must not take any arguments.\x3c/p>\n
The initial keyword to use is set when importing\x3c/a> the library, and the keyword that is used by default is Capture Page Screenshot\x3c/a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.\x3c/p>\n
It is possible to use string NOTHING\x3c/code> or NONE\x3c/code>, case-insensitively, as well as Python None\x3c/code> to disable this feature altogether.\x3c/p>\n
This keyword returns the name of the previously registered failure keyword or Python None\x3c/code> if this functionality was previously disabled. The return value can be always used to restore the original value later.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\nRegister Keyword To Run On Failure\x3c/a>\x3c/td>\n Log Source\x3c/td>\n \x3c/td>\n\x3c/tr>\n
${previous kw}=\x3c/td>\n Register Keyword To Run On Failure\x3c/a>\x3c/td>\n NONE\x3c/td>\n\x3c/tr>\n
Register Keyword To Run On Failure\x3c/a>\x3c/td>\n ${previous kw}\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nChanges in SeleniumLibrary 3.0:\x3c/p>\n
\nPossible to use string NONE\x3c/code> or Python None\x3c/code> to disable the functionality.\x3c/li>\n
Return Python None\x3c/code> when the functionality was disabled earlier. In previous versions special value No Keyword\x3c/code> was returned and it could not be used to restore the original state.\x3c/li>\n\x3c/ul>","matched":true,"name":"Register Keyword To Run On Failure","shortdoc":"Sets the keyword to execute when a SeleniumLibrary keyword fails.","tags":[]},{"args":[],"doc":"Simulates user reloading page.\x3c/p>","matched":true,"name":"Reload Page","shortdoc":"Simulates user reloading page.","tags":[]},{"args":["strategy_name"],"doc":"
Removes a previously added custom location strategy.\x3c/p>\n
See Custom locators\x3c/a> for information how to create and use custom strategies.\x3c/p>","matched":true,"name":"Remove Location Strategy","shortdoc":"Removes a previously added custom location strategy.","tags":[]},{"args":["locator"],"doc":"
Scrolls an element identified by locator\x3c/code> into view.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
New in SeleniumLibrary 3.2.0\x3c/p>","matched":true,"name":"Scroll Element Into View","shortdoc":"Scrolls an element identified by ``locator`` into view.","tags":[]},{"args":["locator"],"doc":"
Selects all options from multi-selection list locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Select All From List","shortdoc":"Selects all options from multi-selection list ``locator``.","tags":[]},{"args":["locator"],"doc":"
Selects checkbox identified by locator\x3c/code>.\x3c/p>\n
Does nothing if checkbox is already selected.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Select Checkbox","shortdoc":"Selects checkbox identified by ``locator``.","tags":[]},{"args":["locator"],"doc":"
Sets frame identified by locator\x3c/code> as the current frame.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Works both with frames and iframes. Use Unselect Frame\x3c/a> to cancel the frame selection and return to the main frame.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n\nSelect Frame\x3c/a>\x3c/td>\n top-frame\x3c/td>\n # Select frame with id or name 'top-frame'\x3c/td>\n\x3c/tr>\n
Click Link\x3c/a>\x3c/td>\n example\x3c/td>\n # Click link 'example' in the selected frame\x3c/td>\n\x3c/tr>\n
Unselect Frame\x3c/a>\x3c/td>\n \x3c/td>\n # Back to main frame.\x3c/td>\n\x3c/tr>\n
Select Frame\x3c/a>\x3c/td>\n //iframe[@name='xxx']\x3c/td>\n # Select frame using xpath\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Select Frame","shortdoc":"Sets frame identified by ``locator`` as the current frame.","tags":[]},{"args":["locator","*indexes"],"doc":"Selects options from selection list locator\x3c/code> by indexes\x3c/code>.\x3c/p>\n
Indexes of list options start from 0.\x3c/p>\n
If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Select From List By Index","shortdoc":"Selects options from selection list ``locator`` by ``indexes``.","tags":[]},{"args":["locator","*labels"],"doc":"
Selects options from selection list locator\x3c/code> by labels\x3c/code>.\x3c/p>\n
If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Select From List By Label","shortdoc":"Selects options from selection list ``locator`` by ``labels``.","tags":[]},{"args":["locator","*values"],"doc":"
Selects options from selection list locator\x3c/code> by values\x3c/code>.\x3c/p>\n
If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Select From List By Value","shortdoc":"Selects options from selection list ``locator`` by ``values``.","tags":[]},{"args":["group_name","value"],"doc":"
Sets radio button group group_name\x3c/code> to value\x3c/code>.\x3c/p>\n
The radio button to be selected is located by two arguments:\x3c/p>\n
\ngroup_name\x3c/code> is the name of the radio button group.\x3c/li>\n
value\x3c/code> is the id\x3c/code> or value\x3c/code> attribute of the actual radio button.\x3c/li>\n\x3c/ul>\nExamples:\x3c/p>\n
\n\n\nSelect Radio Button\x3c/a>\x3c/td>\n size\x3c/td>\n XL\x3c/td>\n\x3c/tr>\n
Select Radio Button\x3c/a>\x3c/td>\n contact\x3c/td>\n email\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Select Radio Button","shortdoc":"Sets radio button group ``group_name`` to ``value``.","tags":[]},{"args":["locator=MAIN","timeout=None"],"doc":"DEPRECATED in SeleniumLibrary 4.0. , use Switch Window\x3c/a> instead.\x3c/p>","matched":true,"name":"Select Window","shortdoc":"DEPRECATED in SeleniumLibrary 4.0. , use `Switch Window` instead.","tags":[]},{"args":["value"],"doc":"
Sets the implicit wait value used by Selenium.\x3c/p>\n
Same as Set Selenium Implicit Wait\x3c/a> but only affects the current browser.\x3c/p>","matched":true,"name":"Set Browser Implicit Wait","shortdoc":"Sets the implicit wait value used by Selenium.","tags":[]},{"args":["locator"],"doc":"
Sets focus to element identified by locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Prior to SeleniumLibrary 3.0 this keyword was named Focus\x3c/span>.\x3c/p>","matched":true,"name":"Set Focus To Element","shortdoc":"Sets focus to element identified by ``locator``.","tags":[]},{"args":["path"],"doc":"
Sets the directory for captured screenshots.\x3c/p>\n
path\x3c/code> argument specifies the absolute path to a directory where the screenshots should be written to. If the directory does not exist, it will be created. The directory can also be set when importing\x3c/a> the library. If it is not configured anywhere, screenshots are saved to the same directory where Robot Framework's log file is written.\x3c/p>\n
The previous value is returned and can be used to restore the original value later if needed.\x3c/p>\n
Returning the previous value is new in SeleniumLibrary 3.0. The persist argument was removed in SeleniumLibrary 3.2.\x3c/p>","matched":true,"name":"Set Screenshot Directory","shortdoc":"Sets the directory for captured screenshots.","tags":[]},{"args":["value"],"doc":"
Sets the implicit wait value used by Selenium.\x3c/p>\n
The value can be given as a number that is considered to be seconds or as a human readable string like 1 second\x3c/code>. The previous value is returned and can be used to restore the original value later if needed.\x3c/p>\n
This keyword sets the implicit wait for all opened browsers. Use Set Browser Implicit Wait\x3c/a> to set it only to the current browser.\x3c/p>\n
See the Implicit wait\x3c/a> section above for more information.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n${orig wait} =\x3c/td>\n Set Selenium Implicit Wait\x3c/a>\x3c/td>\n 10 seconds\x3c/td>\n\x3c/tr>\n
Perform AJAX call that is slow\x3c/span>\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Set Selenium Implicit Wait\x3c/a>\x3c/td>\n ${orig wait}\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Selenium Implicit Wait","shortdoc":"Sets the implicit wait value used by Selenium.","tags":[]},{"args":["value"],"doc":"Sets the delay that is waited after each Selenium command.\x3c/p>\n
The value can be given as a number that is considered to be seconds or as a human readable string like 1 second\x3c/code>. The previous value is returned and can be used to restore the original value later if needed.\x3c/p>\n
See the Selenium Speed\x3c/a> section above for more information.\x3c/p>\n
Example:\x3c/p>\n
\n\nSet Selenium Speed\x3c/a>\x3c/td>\n 0.5 seconds\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Selenium Speed","shortdoc":"Sets the delay that is waited after each Selenium command.","tags":[]},{"args":["value"],"doc":"Sets the timeout that is used by various keywords.\x3c/p>\n
The value can be given as a number that is considered to be seconds or as a human readable string like 1 second\x3c/code>. The previous value is returned and can be used to restore the original value later if needed.\x3c/p>\n
See the Timeout\x3c/a> section above for more information.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n${orig timeout} =\x3c/td>\n Set Selenium Timeout\x3c/a>\x3c/td>\n 15 seconds\x3c/td>\n\x3c/tr>\n
Open page that loads slowly\x3c/span>\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Set Selenium Timeout\x3c/a>\x3c/td>\n ${orig timeout}\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Selenium Timeout","shortdoc":"Sets the timeout that is used by various keywords.","tags":[]},{"args":["x","y"],"doc":"Sets window position using x\x3c/code> and y\x3c/code> coordinates.\x3c/p>\n
The position is relative to the top left corner of the screen, but some browsers exclude possible task bar set by the operating system from the calculation. The actual position may thus be different with different browsers.\x3c/p>\n
Values can be given using strings containing numbers or by using actual numbers. See also Get Window Position\x3c/a>.\x3c/p>\n
Example:\x3c/p>\n
\n\nSet Window Position\x3c/a>\x3c/td>\n 100\x3c/td>\n 200\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Window Position","shortdoc":"Sets window position using ``x`` and ``y`` coordinates.","tags":[]},{"args":["width","height","inner=False"],"doc":"Sets current windows size to given width\x3c/code> and height\x3c/code>.\x3c/p>\n
Values can be given using strings containing numbers or by using actual numbers. See also Get Window Size\x3c/a>.\x3c/p>\n
Browsers have a limit how small they can be set. Trying to set them smaller will cause the actual size to be bigger than the requested size.\x3c/p>\n
If inner\x3c/code> parameter is set to True, keyword sets the necessary window width and height to have the desired HTML DOM window.innerWidth and window.innerHeight The inner\x3c/code> is new in SeleniumLibrary 4.0. See Boolean arguments\x3c/a> for more details how to set boolean arguments.\x3c/p>\n
This inner\x3c/code> argument does not support Frames. If a frame is selected, switch to default before running this.\x3c/p>\n
Example:\x3c/p>\n
\n\n\nSet Window Size\x3c/a>\x3c/td>\n 800\x3c/td>\n 600\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Set Window Size\x3c/a>\x3c/td>\n 800\x3c/td>\n 600\x3c/td>\n True\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Set Window Size","shortdoc":"Sets current windows size to given ``width`` and ``height``.","tags":[]},{"args":["locator","event"],"doc":"Simulates event\x3c/code> on element identified by locator\x3c/code>.\x3c/p>\n
This keyword is useful if element has OnEvent\x3c/code> handler that needs to be explicitly invoked.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Prior to SeleniumLibrary 3.0 this keyword was named Simulate\x3c/span>.\x3c/p>","matched":true,"name":"Simulate Event","shortdoc":"Simulates ``event`` on element identified by ``locator``.","tags":[]},{"args":["locator=None"],"doc":"
Submits a form identified by locator\x3c/code>.\x3c/p>\n
If locator\x3c/code> is not given, first form on the page is submitted.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Submit Form","shortdoc":"Submits a form identified by ``locator``.","tags":[]},{"args":["index_or_alias"],"doc":"
Switches between active browsers using index_or_alias\x3c/code>.\x3c/p>\n
Indices are returned by the Open Browser\x3c/a> keyword and aliases can be given to it explicitly. Indices start from 1.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n\n\n\n\n\n\nOpen Browser\x3c/a>\x3c/td>\n http://google.com\x3c/a>\x3c/td>\n ff\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Location Should Be\x3c/a>\x3c/td>\n http://google.com\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Open Browser\x3c/a>\x3c/td>\n http://yahoo.com\x3c/a>\x3c/td>\n ie\x3c/td>\n alias=second\x3c/td>\n\x3c/tr>\n
Location Should Be\x3c/a>\x3c/td>\n http://yahoo.com\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Switch Browser\x3c/a>\x3c/td>\n 1\x3c/td>\n # index\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Page Should Contain\x3c/a>\x3c/td>\n I'm feeling lucky\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Switch Browser\x3c/a>\x3c/td>\n second\x3c/td>\n # alias\x3c/td>\n \x3c/td>\n\x3c/tr>\n
Page Should Contain\x3c/a>\x3c/td>\n More Yahoo!\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Close All Browsers\x3c/a>\x3c/td>\n \x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nAbove example expects that there was no other open browsers when opening the first one because it used index 1\x3c/code> when switching to it later. If you are not sure about that, you can store the index into a variable as below.\x3c/p>\n
\n\n\n\n${index} =\x3c/td>\n Open Browser\x3c/a>\x3c/td>\n http://google.com\x3c/a>\x3c/td>\n\x3c/tr>\n
# Do something ...\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Switch Browser\x3c/a>\x3c/td>\n ${index}\x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Switch Browser","shortdoc":"Switches between active browsers using ``index_or_alias``.","tags":[]},{"args":["locator=MAIN","timeout=None","browser=CURRENT"],"doc":"Switches to browser window matching locator\x3c/code>.\x3c/p>\n
If the window is found, all subsequent commands use the selected window, until this keyword is used again. If the window is not found, this keyword fails. The previous window handle is returned, and can be used to return back to it later.\x3c/p>\n
Notice that alerts should be handled with Handle Alert\x3c/a> or other alert related keywords.\x3c/p>\n
The locator\x3c/code> can be specified using different strategies somewhat similarly as when locating elements\x3c/a> on pages.\x3c/p>\n
\nBy default the locator\x3c/code> is matched against window handle, name, title, and URL. Matching is done in that order and the the first matching window is selected.\x3c/li>\n\x3c/ul>\n\nThe locator\x3c/code> can specify an explicit strategy by using format strategy:value\x3c/code> (recommended) or strategy=value\x3c/code>. Supported strategies are name\x3c/code>, title\x3c/code> and url\x3c/code>, which match windows using name, title, and URL, respectively. Additionally, default\x3c/code> can be used to explicitly use the default strategy explained above.\x3c/li>\n\x3c/ul>\n\nIf the locator\x3c/code> is NEW\x3c/code> (case-insensitive), the latest opened window is selected. It is an error if this is the same as the current window.\x3c/li>\n\x3c/ul>\n\nIf the locator\x3c/code> is MAIN\x3c/code> (default, case-insensitive), the main window is selected.\x3c/li>\n\x3c/ul>\n\nIf the locator\x3c/code> is CURRENT\x3c/code> (case-insensitive), nothing is done. This effectively just returns the current window handle.\x3c/li>\n\x3c/ul>\n\nIf the locator\x3c/code> is not a string, it is expected to be a list of window handles to exclude\x3c/i>. Such a list of excluded windows can be get from Get Window Handles\x3c/a> prior to doing an action that opens a new window.\x3c/li>\n\x3c/ul>\nThe timeout\x3c/code> is used to specify how long keyword will poll to select the new window. The timeout\x3c/code> is new in SeleniumLibrary 3.2.\x3c/p>\n
Example:\x3c/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nClick Link\x3c/a>\x3c/td>\n popup1\x3c/td>\n \x3c/td>\n # Open new window\x3c/td>\n\x3c/tr>\n
Switch Window\x3c/a>\x3c/td>\n example\x3c/td>\n \x3c/td>\n # Select window using default strategy\x3c/td>\n\x3c/tr>\n
Title Should Be\x3c/a>\x3c/td>\n Pop-up 1\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Click Button\x3c/a>\x3c/td>\n popup2\x3c/td>\n \x3c/td>\n # Open another window\x3c/td>\n\x3c/tr>\n
${handle} =\x3c/td>\n Switch Window\x3c/a>\x3c/td>\n NEW\x3c/td>\n # Select latest opened window\x3c/td>\n\x3c/tr>\n
Title Should Be\x3c/a>\x3c/td>\n Pop-up 2\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Switch Window\x3c/a>\x3c/td>\n ${handle}\x3c/td>\n \x3c/td>\n # Select window using handle\x3c/td>\n\x3c/tr>\n
Title Should Be\x3c/a>\x3c/td>\n Pop-up 1\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
Switch Window\x3c/a>\x3c/td>\n MAIN\x3c/td>\n \x3c/td>\n # Select the main window\x3c/td>\n\x3c/tr>\n
Title Should Be\x3c/a>\x3c/td>\n Main\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n
${excludes} =\x3c/td>\n Get Window Handles\x3c/a>\x3c/td>\n \x3c/td>\n # Get list of current windows\x3c/td>\n\x3c/tr>\n
Click Link\x3c/a>\x3c/td>\n popup3\x3c/td>\n \x3c/td>\n # Open one more window\x3c/td>\n\x3c/tr>\n
Switch Window\x3c/a>\x3c/td>\n ${excludes}\x3c/td>\n \x3c/td>\n # Select window using excludes\x3c/td>\n\x3c/tr>\n
Title Should Be\x3c/a>\x3c/td>\n Pop-up 3\x3c/td>\n \x3c/td>\n \x3c/td>\n\x3c/tr>\n\x3c/table>\nThe browser\x3c/code> argument allows with index_or_alias\x3c/code> to implicitly switch to a specific browser when switching to a window. See Switch Browser\x3c/a>\x3c/p>\n
\nIf the browser\x3c/code> is CURRENT\x3c/code> (case-insensitive), no other browser is selected.\x3c/li>\n\x3c/ul>\nNOTE:\x3c/b>\x3c/p>\n\nThe strategy:value\x3c/code> syntax is only supported by SeleniumLibrary 3.0 and newer.\x3c/li>\n
Prior to SeleniumLibrary 3.0 matching windows by name, title and URL was case-insensitive.\x3c/li>\nEarlier versions supported aliases None\x3c/code>, null\x3c/code> and the empty string for selecting the main window, and alias self\x3c/code> for selecting the current window. Support for these aliases were removed in SeleniumLibrary 3.2.\x3c/li>\n\x3c/ul>","matched":true,"name":"Switch Window","shortdoc":"Switches to browser window matching ``locator``.","tags":[]},{"args":["locator","row","column","expected","loglevel=TRACE"],"doc":"Verifies table cell contains text expected\x3c/code>.\x3c/p>\nSee Get Table Cell\x3c/a> that this keyword uses internally for explanation about accepted arguments.\x3c/p>","matched":true,"name":"Table Cell Should Contain","shortdoc":"Verifies table cell contains text ``expected``.","tags":[]},{"args":["locator","column","expected","loglevel=TRACE"],"doc":"
Verifies table column contains text expected\x3c/code>.\x3c/p>\n
The table is located using the locator\x3c/code> argument and its column found using column\x3c/code>. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Column indexes start from 1. It is possible to refer to columns from the end by using negative indexes so that -1 is the last column, -2 is the second last, and so on.\x3c/p>\n
If a table contains cells that span multiple columns, those merged cells count as a single column.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Table Column Should Contain","shortdoc":"Verifies table column contains text ``expected``.","tags":[]},{"args":["locator","expected","loglevel=TRACE"],"doc":"
Verifies table footer contains text expected\x3c/code>.\x3c/p>\n
Any <td>\x3c/code> element inside <tfoot>\x3c/code> element is considered to be part of the footer.\x3c/p>\n
The table is located using the locator\x3c/code> argument. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Table Footer Should Contain","shortdoc":"Verifies table footer contains text ``expected``.","tags":[]},{"args":["locator","expected","loglevel=TRACE"],"doc":"
Verifies table header contains text expected\x3c/code>.\x3c/p>\n
Any <th>\x3c/code> element anywhere in the table is considered to be part of the header.\x3c/p>\n
The table is located using the locator\x3c/code> argument. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Table Header Should Contain","shortdoc":"Verifies table header contains text ``expected``.","tags":[]},{"args":["locator","row","expected","loglevel=TRACE"],"doc":"
Verifies that table row contains text expected\x3c/code>.\x3c/p>\n
The table is located using the locator\x3c/code> argument and its column found using column\x3c/code>. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
Row indexes start from 1. It is possible to refer to rows from the end by using negative indexes so that -1 is the last row, -2 is the second last, and so on.\x3c/p>\n
If a table contains cells that span multiple rows, a match only occurs for the uppermost row of those merged cells.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Table Row Should Contain","shortdoc":"Verifies that table row contains text ``expected``.","tags":[]},{"args":["locator","expected","loglevel=TRACE"],"doc":"
Verifies table contains text expected\x3c/code>.\x3c/p>\n
The table is located using the locator\x3c/code> argument. See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
See Page Should Contain Element\x3c/a> for explanation about the loglevel\x3c/code> argument.\x3c/p>","matched":true,"name":"Table Should Contain","shortdoc":"Verifies table contains text ``expected``.","tags":[]},{"args":["locator","expected","message=None"],"doc":"
Verifies text area locator\x3c/code> contains text expected\x3c/code>.\x3c/p>\n
message\x3c/code> can be used to override default error message.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Textarea Should Contain","shortdoc":"Verifies text area ``locator`` contains text ``expected``.","tags":[]},{"args":["locator","expected","message=None"],"doc":"
Verifies text area locator\x3c/code> has exactly text expected\x3c/code>.\x3c/p>\n
message\x3c/code> can be used to override default error message.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Textarea Value Should Be","shortdoc":"Verifies text area ``locator`` has exactly text ``expected``.","tags":[]},{"args":["locator","expected","message=None"],"doc":"
Verifies text field locator\x3c/code> contains text expected\x3c/code>.\x3c/p>\n
message\x3c/code> can be used to override the default error message.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Textfield Should Contain","shortdoc":"Verifies text field ``locator`` contains text ``expected``.","tags":[]},{"args":["locator","expected","message=None"],"doc":"
Verifies text field locator\x3c/code> has exactly text expected\x3c/code>.\x3c/p>\n
message\x3c/code> can be used to override default error message.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Textfield Value Should Be","shortdoc":"Verifies text field ``locator`` has exactly text ``expected``.","tags":[]},{"args":["title","message=None"],"doc":"
Verifies that current page title equals title\x3c/code>.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
message\x3c/code> argument is new in SeleniumLibrary 3.1.\x3c/p>","matched":true,"name":"Title Should Be","shortdoc":"Verifies that current page title equals ``title``.","tags":[]},{"args":["locator"],"doc":"
Unselects all options from multi-selection list locator\x3c/code>.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
New in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Unselect All From List","shortdoc":"Unselects all options from multi-selection list ``locator``.","tags":[]},{"args":["locator"],"doc":"
Removes selection of checkbox identified by locator\x3c/code>.\x3c/p>\n
Does nothing if the checkbox is not selected.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Unselect Checkbox","shortdoc":"Removes selection of checkbox identified by ``locator``.","tags":[]},{"args":[],"doc":"
Sets the main frame as the current frame.\x3c/p>\n
In practice cancels the previous Select Frame\x3c/a> call.\x3c/p>","matched":true,"name":"Unselect Frame","shortdoc":"Sets the main frame as the current frame.","tags":[]},{"args":["locator","*indexes"],"doc":"
Unselects options from selection list locator\x3c/code> by indexes\x3c/code>.\x3c/p>\n
Indexes of list options start from 0. This keyword works only with multi-selection lists.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Unselect From List By Index","shortdoc":"Unselects options from selection list ``locator`` by ``indexes``.","tags":[]},{"args":["locator","*labels"],"doc":"
Unselects options from selection list locator\x3c/code> by labels\x3c/code>.\x3c/p>\n
This keyword works only with multi-selection lists.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Unselect From List By Label","shortdoc":"Unselects options from selection list ``locator`` by ``labels``.","tags":[]},{"args":["locator","*values"],"doc":"
Unselects options from selection list locator\x3c/code> by values\x3c/code>.\x3c/p>\n
This keyword works only with multi-selection lists.\x3c/p>\n
See the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>","matched":true,"name":"Unselect From List By Value","shortdoc":"Unselects options from selection list ``locator`` by ``values``.","tags":[]},{"args":["condition","timeout=None","error=None"],"doc":"
Waits until condition\x3c/code> is true or timeout\x3c/code> expires.\x3c/p>\n
The condition can be arbitrary JavaScript expression but it must return a value to be evaluated. See Execute JavaScript\x3c/a> for information about accessing content on pages.\x3c/p>\n
Fails if the timeout expires before the condition becomes true. See the Timeouts\x3c/span> section for more information about using timeouts and their default value.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>\n
Examples:\x3c/p>\n
\n\n\n\nWait For Condition\x3c/a>\x3c/td>\n return document.title == \"New Title\"\x3c/td>\n\x3c/tr>\n
Wait For Condition\x3c/a>\x3c/td>\n return jQuery.active == 0\x3c/td>\n\x3c/tr>\n
Wait For Condition\x3c/a>\x3c/td>\n style = document.querySelector('h1').style; return style.background == \"red\" && style.color == \"white\"\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Wait For Condition","shortdoc":"Waits until ``condition`` is true or ``timeout`` expires.","tags":[]},{"args":["locator","text","timeout=None","error=None"],"doc":"Waits until element locator\x3c/code> contains text\x3c/code>.\x3c/p>\n
Fails if timeout\x3c/code> expires before the text appears. See the Timeouts\x3c/span> section for more information about using timeouts and their default value and the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Element Contains","shortdoc":"Waits until element ``locator`` contains ``text``.","tags":[]},{"args":["locator","text","timeout=None","error=None"],"doc":"
Waits until element locator\x3c/code> does not contain text\x3c/code>.\x3c/p>\n
Fails if timeout\x3c/code> expires before the text disappears. See the Timeouts\x3c/span> section for more information about using timeouts and their default value and the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Element Does Not Contain","shortdoc":"Waits until element ``locator`` does not contain ``text``.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"
Waits until element locator\x3c/code> is enabled.\x3c/p>\n
Element is considered enabled if it is not disabled nor read-only.\x3c/p>\n
Fails if timeout\x3c/code> expires before the element is enabled. See the Timeouts\x3c/span> section for more information about using timeouts and their default value and the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>\n
Considering read-only elements to be disabled is a new feature in SeleniumLibrary 3.0.\x3c/p>","matched":true,"name":"Wait Until Element Is Enabled","shortdoc":"Waits until element ``locator`` is enabled.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"
Waits until element locator\x3c/code> is not visible.\x3c/p>\n
Fails if timeout\x3c/code> expires before the element is not visible. See the Timeouts\x3c/span> section for more information about using timeouts and their default value and the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Element Is Not Visible","shortdoc":"Waits until element ``locator`` is not visible.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"
Waits until element locator\x3c/code> is visible.\x3c/p>\n
Fails if timeout\x3c/code> expires before the element is visible. See the Timeouts\x3c/span> section for more information about using timeouts and their default value and the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Element Is Visible","shortdoc":"Waits until element ``locator`` is visible.","tags":[]},{"args":["expected","timeout=None","message=None"],"doc":"
Wait until that current URL contains expected\x3c/code>.\x3c/p>\n
The expected\x3c/code> argument contains the expected value in url.\x3c/p>\n
Fails if timeout\x3c/code> expires before the location contains. See the Timeouts\x3c/span> section for more information about using timeouts and their default value.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
New in SeleniumLibrary 4.0\x3c/p>","matched":true,"name":"Wait Until Location Contains","shortdoc":"Wait until that current URL contains ``expected``.","tags":[]},{"args":["expected","timeout=None","message=None"],"doc":"
Wait until that current URL is expected\x3c/code>.\x3c/p>\n
The expected\x3c/code> argument is the expected value in url.\x3c/p>\n
Fails if timeout\x3c/code> expires before the location is. See the Timeouts\x3c/span> section for more information about using timeouts and their default value.\x3c/p>\n
The message\x3c/code> argument can be used to override the default error message.\x3c/p>\n
New in SeleniumLibrary 4.0\x3c/p>","matched":true,"name":"Wait Until Location Is","shortdoc":"Wait until that current URL is ``expected``.","tags":[]},{"args":["text","timeout=None","error=None"],"doc":"
Waits until text\x3c/code> appears on current page.\x3c/p>\n
Fails if timeout\x3c/code> expires before the text appears. See the Timeouts\x3c/span> section for more information about using timeouts and their default value.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Page Contains","shortdoc":"Waits until ``text`` appears on current page.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"
Waits until element locator\x3c/code> appears on current page.\x3c/p>\n
Fails if timeout\x3c/code> expires before the element appears. See the Timeouts\x3c/span> section for more information about using timeouts and their default value and the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Page Contains Element","shortdoc":"Waits until element ``locator`` appears on current page.","tags":[]},{"args":["text","timeout=None","error=None"],"doc":"
Waits until text\x3c/code> disappears from current page.\x3c/p>\n
Fails if timeout\x3c/code> expires before the text disappears. See the Timeouts\x3c/span> section for more information about using timeouts and their default value.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Page Does Not Contain","shortdoc":"Waits until ``text`` disappears from current page.","tags":[]},{"args":["locator","timeout=None","error=None"],"doc":"
Waits until element locator\x3c/code> disappears from current page.\x3c/p>\n
Fails if timeout\x3c/code> expires before the element disappears. See the Timeouts\x3c/span> section for more information about using timeouts and their default value and the Locating elements\x3c/a> section for details about the locator syntax.\x3c/p>\n
error\x3c/code> can be used to override the default error message.\x3c/p>","matched":true,"name":"Wait Until Page Does Not Contain Element","shortdoc":"Waits until element ``locator`` disappears from current page.","tags":[]}],"name":"SeleniumLibrary","named_args":true,"scope":"global","version":"4.0.0rc1"};












  Opening library documentation failed
  
    Verify that you have JavaScript enabled in your browser.
    Make sure you are using a modern enough browser. If using Internet Explorer, version 8 or newer is required.
    Check are there messages in your browser's JavaScript error log. Please report the problem if you suspect you have encountered a bug.