From b58c466a292c4539d5db3256715237ceb9eb43e9 Mon Sep 17 00:00:00 2001
From: aaltat <aaltat@users.noreply.github.com>
Date: Thu, 16 May 2024 15:38:14 +0000
Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20MarketSq?=
 =?UTF-8?q?uare/robotframework-browser@330d7dbc4e1d56c776a300be5b35ab259fc?=
 =?UTF-8?q?2e5a1=20=F0=9F=9A=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Browser.html                    |    2 +-
 index.html                      |    2 +-
 releasenotes/Browser-18.5.0.rst |   66 ++
 versions/Browser-18.4.0.html    | 1873 +++++++++++++++++++++++++++++++
 4 files changed, 1941 insertions(+), 2 deletions(-)
 create mode 100644 releasenotes/Browser-18.5.0.rst
 create mode 100644 versions/Browser-18.4.0.html

diff --git a/Browser.html b/Browser.html
index f04263c62..178216380 100644
--- a/Browser.html
+++ b/Browser.html
@@ -1192,7 +1192,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"specversion": 3, "name": "Browser", "doc": "<p>Browser library is a browser automation library for Robot Framework.</p>\n<p>This is the keyword documentation for Browser library. For information about installation, support, and more please visit the <a href=\"https://github.com/MarketSquare/robotframework-playwright\">project pages</a>. For more information about Robot Framework itself, see <a href=\"https://robotframework.org\">robotframework.org</a>.</p>\n<p>Browser library uses <a href=\"https://github.com/microsoft/playwright\">Playwright Node module</a> to automate <a href=\"https://www.chromium.org/Home\">Chromium</a>, <a href=\"https://www.mozilla.org/en-US/firefox/new/\">Firefox</a> and <a href=\"https://webkit.org/\">WebKit</a> with a single library.</p>\n<h3 id=\"Table of contents\">Table of contents</h3>\n<ul>\n<li><a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a></li>\n<li><a href=\"#Automatic%20page%20and%20context%20closing\" class=\"name\">Automatic page and context closing</a></li>\n<li><a href=\"#Finding%20elements\" class=\"name\">Finding elements</a></li>\n<li><a href=\"#Assertions\" class=\"name\">Assertions</a></li>\n<li><a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a></li>\n<li><a href=\"#Experimental%3A%20Re-using%20same%20node%20process\" class=\"name\">Experimental: Re-using same node process</a></li>\n<li><a href=\"#Experimental%3A%20Provide%20parameters%20to%20node%20process\" class=\"name\">Experimental: Provide parameters to node process</a></li>\n<li><a href=\"#Scope%20Setting\" class=\"name\">Scope Setting</a></li>\n<li><a href=\"#Extending%20Browser%20library%20with%20a%20JavaScript%20module\" class=\"name\">Extending Browser library with a JavaScript module</a></li>\n<li><a href=\"#Plugins\" class=\"name\">Plugins</a></li>\n<li><a href=\"#Language\" class=\"name\">Language</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Browser, Context and Page\">Browser, Context and Page</h2>\n<p>Browser library works with three different layers that build on each other: <b>Browser</b>, <b>Context</b> and <b>Page</b>.</p>\n<h3 id=\"Browsers\">Browsers</h3>\n<p>A <b>browser</b> can be started with one of the three different engines Chromium, Firefox or Webkit.</p>\n<h4 id=\"Supported Browsers\">Supported Browsers</h4>\n<table border=\"1\">\n<tr>\n<td>Browser</td>\n<td>Browser with this engine</td>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td>Google Chrome, Microsoft Edge (since 2020), Opera</td>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td>Mozilla Firefox</td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td>Apple Safari, Mail, AppStore on MacOS and iOS</td>\n</tr>\n</table>\n<p>Since <a href=\"https://github.com/microsoft/playwright\">Playwright</a> comes with a pack of builtin binaries for all browsers, no additional drivers e.g. geckodriver are needed.</p>\n<p>All these browsers that cover more than 85% of the world wide used browsers, can be tested on Windows, Linux and MacOS. There is no need for dedicated machines anymore.</p>\n<p>A browser process is started <code>headless</code> (without a GUI) by default. Run <a href=\"#New%20Browser\" class=\"name\">New Browser</a> with specified arguments if a browser with a GUI is requested or if a proxy has to be configured. A browser process can contain several contexts.</p>\n<h3 id=\"Contexts\">Contexts</h3>\n<p>A <b>context</b> corresponds to a set of independent incognito pages in a browser that share cookies, sessions or profile settings. Pages in two separate contexts do not share cookies, sessions or profile settings. Compared to Selenium, these do <b>not</b> require their own browser process. To get a clean environment a test can just open a new context. Due to this new independent browser sessions can be opened with Robot Framework Browser about 10 times faster than with Selenium by just opening a <a href=\"#New%20Context\" class=\"name\">New Context</a> within the opened browser.</p>\n<p>To make pages in the same suite share state, use the same context by opening the context with <a href=\"#New%20Context\" class=\"name\">New Context</a> on suite setup.</p>\n<p>The context layer is useful e.g. for testing different user sessions on the same webpage without opening a whole new browser context. Contexts can also have detailed configurations, such as geo-location, language settings, the viewport size or color scheme. Contexts do also support http credentials to be set, so that basic authentication can also be tested. To be able to download files within the test, the <code>acceptDownloads</code> argument must be set to <code>True</code> in <a href=\"#New%20Context\" class=\"name\">New Context</a> keyword. A context can contain different pages.</p>\n<h3 id=\"Pages\">Pages</h3>\n<p>A <b>page</b> does contain the content of the loaded web site and has a browsing history. Pages and browser tabs are the same.</p>\n<p>Typical usage could be:</p>\n<pre>\n<b>*</b> Test Cases <b>*</b>\nStarting a browser with a page\n    New Browser    chromium    headless=false\n    New Context    viewport={'width': 1920, 'height': 1080}\n    New Page       <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html\">https://marketsquare.github.io/robotframework-browser/Browser.html</a>\n    Get Title      ==    Browser\n</pre>\n<p>The <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword opens a new browser, a new context and a new page. This keyword is useful for quick experiments or debugging sessions.</p>\n<p>When a <a href=\"#New%20Page\" class=\"name\">New Page</a> is called without an open browser, <a href=\"#New%20Browser\" class=\"name\">New Browser</a> and <a href=\"#New%20Context\" class=\"name\">New Context</a> are executed with default values first.</p>\n<p>Each Browser, Context and Page has a unique ID with which they can be addressed. A full catalog of what is open can be received by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a> as a dictionary.</p>\n<h2 id=\"Automatic page and context closing\">Automatic page and context closing</h2>\n<p>Controls when contexts and pages are closed during the test execution.</p>\n<p>If automatic closing level is <span class=\"name\">TEST</span>, contexts and pages that are created during a single test are automatically closed when the test ends. Contexts and pages that are created during suite setup are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">SUITE</span>, all contexts and pages that are created during the test suite are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">MANUAL</span>, nothing is closed automatically while the test execution is ongoing. All browsers, context and pages are automatically closed when test execution ends.</p>\n<p>If automatic closing level is <span class=\"name\">KEEP</span>, nothing is closed automatically while the test execution is ongoing. Also, nothing is closed when test execution ends, including the node process. Therefore, it is users responsibility to close all browsers, context and pages and ensure that all process that are left running after the test execution end are closed. This level is only intended for test case development and must not be used when running tests in CI or similar environments.</p>\n<p>Automatic closing can be configured or switched off with the auto_closing_level library import parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>\n<h2 id=\"Finding elements\">Finding elements</h2>\n<p>All keywords in the library that need to interact with an element on a web page take an argument typically named <code>selector</code> that specifies how to find the element. Keywords can find elements with strict mode. If strict mode is true and locator finds multiple elements from the page, keyword will fail. If keyword finds one element, keyword does not fail because of strict mode. If strict mode is false, keyword does not fail if selector points many elements. Strict mode is enabled by default, but can be changed in library <a href=\"#Importing\" class=\"name\">importing</a> or <a href=\"#Set%20Strict%20Mode\" class=\"name\">Set Strict Mode</a> keyword. Keyword documentation states if keyword uses strict mode. If keyword does not state that strict mode is used, then strict mode is not applied for the keyword. For more details, see Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-query-selector\">strict documentation</a>.</p>\n<p>Selector strategies that are supported by default are listed in the table below.</p>\n<table border=\"1\">\n<tr>\n<th>Strategy</th>\n<th>Match based on</th>\n<th>Example</th>\n</tr>\n<tr>\n<td><code>css</code></td>\n<td>CSS selector.</td>\n<td><code>css=.class &gt; \\#login_btn</code></td>\n</tr>\n<tr>\n<td><code>xpath</code></td>\n<td>XPath expression.</td>\n<td><code>xpath=//input[@id=\"login_btn\"]</code></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Browser text engine.</td>\n<td><code>text=Login</code></td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>Element ID Attribute.</td>\n<td><code>id=login_btn</code></td>\n</tr>\n</table>\n<p>CSS Selectors can also be recorded with <a href=\"#Record%20Selector\" class=\"name\">Record selector</a> keyword.</p>\n<h3 id=\"Explicit Selector Strategy\">Explicit Selector Strategy</h3>\n<p>The explicit selector strategy is specified with a prefix using syntax <code>strategy=value</code>. Spaces around the separator are ignored, so <code>css=foo</code>, <code>css= foo</code> and <code>css = foo</code> are all equivalent.</p>\n<h3 id=\"Implicit Selector Strategy\">Implicit Selector Strategy</h3>\n<p><b>The default selector strategy is <a href=\"#CSS\" class=\"name\">css</a>.</b></p>\n<p>If selector does not contain one of the know explicit selector strategies, it is assumed to contain css selector.</p>\n<p>Selectors that are starting with <code>//</code> or <code>..</code> are considered as xpath selectors.</p>\n<p>Selectors that are in quotes are considered as text selectors.</p>\n<p>Examples:</p>\n<pre>\n# CSS selectors are default.\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class         # This is equivalent\n<a href=\"#Click\" class=\"name\">Click</a>  css=span &gt; button.some_class     # to this.\n\n# // or .. leads to xpath selector strategy\n<a href=\"#Click\" class=\"name\">Click</a>  //span/button[@class=\"some_class\"]\n<a href=\"#Click\" class=\"name\">Click</a>  xpath=//span/button[@class=\"some_class\"]\n\n# \"text\" in quotes leads to exact text selector strategy\n<a href=\"#Click\" class=\"name\">Click</a>  \"Login\"\n<a href=\"#Click\" class=\"name\">Click</a>  text=\"Login\"\n</pre>\n<h3 id=\"CSS\">CSS</h3>\n<p>As written before, the default selector strategy is <a href=\"#CSS\" class=\"name\">css</a>. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\">css selector</a> for more information.</p>\n<p>Any malformed selector not starting with <code>//</code> or <code>..</code> nor starting and ending with a quote is assumed to be a css selector.</p>\n<p>Note that <code>#</code> is a comment character in <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#ignored-data\">Robot Framework syntax</a> and needs to be escaped like <code>\\#</code> to work as a <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors\">css ID selector</a>.</p>\n<p>Examples:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>  \\#username_field  ==  George\n</pre>\n<h3 id=\"XPath\">XPath</h3>\n<p>XPath engine is equivalent to <a href=\"https://developer.mozilla.org/en/docs/Web/API/Document/evaluate\">Document.evaluate</a>. Example: <code>xpath=//html/body//span[text()=\"Hello World\"]</code>.</p>\n<p>Malformed selector starting with <code>//</code> or <code>..</code> is assumed to be an xpath selector. For example, <code>//html/body</code> is converted to <code>xpath=//html/body</code>. More examples are displayed in <a href=\"#Examples\" class=\"name\">Examples</a>.</p>\n<p>Note that xpath does not pierce <a href=\"https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM\">shadow_roots</a>.</p>\n<h3 id=\"Text\">Text</h3>\n<p>Text engine finds an element that contains a text node with the passed text. For example, <code>Click    text=Login</code> clicks on a login button, and <code>Wait For Elements State   text=\"lazy loaded text\"</code> waits for the \"lazy loaded text\" to appear in the page.</p>\n<p>Text engine finds fields based on their labels in text inserting keywords.</p>\n<p>Malformed selector starting and ending with a quote (either <code>\"</code> or <code>'</code>) is assumed to be a text selector. For example, <code>Click    \"Login\"</code> is converted to <code>Click    text=\"Login\"</code>. Be aware that these leads to exact matches only! More examples are displayed in <a href=\"#Examples\" class=\"name\">Examples</a>.</p>\n<h4 id=\"Insensitive match\">Insensitive match</h4>\n<p>By default, the match is case-insensitive, ignores leading/trailing whitespace and searches for a substring. This means <code>text= Login</code> matches <code>&lt;button&gt;Button loGIN (click me)&lt;/button&gt;</code>.</p>\n<h4 id=\"Exact match\">Exact match</h4>\n<p>Text body can be escaped with single or double quotes for precise matching, insisting on exact match, including specified whitespace and case. This means <code>text=\"Login \"</code> will only match <code>&lt;button&gt;Login &lt;/button&gt;</code> with exactly one space after \"Login\". Quoted text follows the usual escaping rules, e.g. use <code>\\\"</code> to escape double quote in a double-quoted string: <code>text=\"foo\\\"bar\"</code>.</p>\n<h4 id=\"RegEx\">RegEx</h4>\n<p>Text body can also be a JavaScript-like regex wrapped in / symbols. This means <code>text=/^hello .*!$/i</code> or <code>text=/^Hello .*!$/</code> will match <code>&lt;span&gt;Hello Peter Parker!&lt;/span&gt;</code> with any name after <code>Hello</code>, ending with <code>!</code>. The first one flagged with <code>i</code> for case-insensitive. See <a href=\"https://regex101.com/\">https://regex101.com</a> for more information about RegEx.</p>\n<h4 id=\"Button and Submit Values\">Button and Submit Values</h4>\n<p>Input elements of the type button and submit are rendered with their value as text, and text engine finds them. For example, <code>text=Login</code> matches <code>&lt;input type=button value=\"Login\"&gt;</code>.</p>\n<h3 id=\"Cascaded selector syntax\">Cascaded selector syntax</h3>\n<p>Browser library supports the same selector strategies as the underlying Playwright node module: xpath, css, id and text. The strategy can either be explicitly specified with a prefix or the strategy can be implicit.</p>\n<p>A major advantage of Browser is that multiple selector engines can be used within one selector. It is possible to mix XPath, CSS and Text selectors while selecting a single element.</p>\n<p>Selectors are strings that consists of one or more clauses separated by <code>&gt;&gt;</code> token, e.g. <code>clause1 &gt;&gt; clause2 &gt;&gt; clause3</code>. When multiple clauses are present, next one is queried relative to the previous one's result. Browser library supports concatenation of different selectors separated by <code>&gt;&gt;</code>.</p>\n<p>For example:</p>\n<pre>\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    \"Hello\" &gt;&gt; ../.. &gt;&gt; .select_button\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    text=Hello &gt;&gt; xpath=../.. &gt;&gt; css=.select_button\n</pre>\n<p>Each clause contains a selector engine name and selector body, e.g. <code>engine=body</code>. Here <code>engine</code> is one of the supported engines (e.g. css or a custom one). Selector <code>body</code> follows the format of the particular engine, e.g. for css engine it should be a <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\">css selector</a>. Body format is assumed to ignore leading and trailing white spaces, so that extra whitespace can be added for readability. If the selector engine needs to include <code>&gt;&gt;</code> in the body, it should be escaped inside a string to not be confused with clause separator, e.g. <code>text=\"some &gt;&gt; text\"</code>.</p>\n<p>Selector engine name can be prefixed with <code>*</code> to capture an element that matches the particular clause instead of the last one. For example, <code>css=article &gt;&gt; text=Hello</code> captures the element with the text <code>Hello</code>, and <code>*css=article &gt;&gt; text=Hello</code> (note the *) captures the article element that contains some element with the text Hello.</p>\n<p>For convenience, selectors in the wrong format are heuristically converted to the right format. See <a href=\"#Implicit%20Selector%20Strategy\" class=\"name\">Implicit Selector Strategy</a></p>\n<h3 id=\"Examples\">Examples</h3>\n<pre>\n# queries 'div' css selector\nGet Element    css=div\n\n# queries '//html/body/div' xpath selector\nGet Element    //html/body/div\n\n# queries '\"foo\"' text selector\nGet Element    text=foo\n\n# queries 'span' css selector inside the result of '//html/body/div' xpath selector\nGet Element    xpath=//html/body/div &gt;&gt; css=span\n\n# converted to 'css=div'\nGet Element    div\n\n# converted to 'xpath=//html/body/div'\nGet Element    //html/body/div\n\n# converted to 'text=\"foo\"'\nGet Element    \"foo\"\n\n# queries the div element of every 2nd span element inside an element with the id foo\nGet Element    \\#foo &gt;&gt; css=span:nth-child(2n+1) &gt;&gt; div\nGet Element    id=foo &gt;&gt; css=span:nth-child(2n+1) &gt;&gt; div\n</pre>\n<p>Be aware that using <code>#</code> as a starting character in Robot Framework would be interpreted as comment. Due to that fact a <code>#id</code> must be escaped as <code>\\#id</code>.</p>\n<h3 id=\"iFrames\">iFrames</h3>\n<p>By default, selector chains do not cross frame boundaries. It means that a simple CSS selector is not able to select an element located inside an iframe or a frameset. For this use case, there is a special selector <code>&gt;&gt;&gt;</code> which can be used to combine a selector for the frame and a selector for an element inside a frame.</p>\n<p>Given this simple pseudo html snippet:</p>\n<pre>\n&lt;iframe id=\"iframe\" src=\"src.html\"&gt;\n  #document\n    &lt;!DOCTYPE html&gt;\n    &lt;html&gt;\n      &lt;head&gt;&lt;/head&gt;\n      &lt;body&gt;\n        &lt;button id=\"btn\"&gt;Click Me&lt;/button&gt;\n      &lt;/body&gt;\n    &lt;/html&gt;\n&lt;/iframe&gt;\n</pre>\n<p>Here's a keyword call that clicks the button inside the frame.</p>\n<pre>\nClick   id=iframe &gt;&gt;&gt; id=btn\n</pre>\n<p>The selectors on the left and right side of <code>&gt;&gt;&gt;</code> can be any valid selectors. The selector clause directly before the frame opener <code>&gt;&gt;&gt;</code> must select the frame element itself. Frame selection is the only place where Browser Library modifies the selector, as explained in above. In all cases, the library does not alter the selector in any way, instead it is passed as is to the Playwright side.</p>\n<p>If multiple keyword shall be performed inside a frame, it is possible to define a selector prefix with <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>. If this prefix is set to a frame/iframe it has similar behavior as SeleniumLibrary keyword <span class=\"name\">Select Frame</span>.</p>\n<h3 id=\"WebComponents and Shadow DOM\">WebComponents and Shadow DOM</h3>\n<p>Playwright and so also Browser are able to do automatic piercing of Shadow DOMs and therefore are the best automation technology when working with WebComponents.</p>\n<p>Also other technologies claim that they can handle <a href=\"https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM\">Shadow DOM and Web Components</a>. However, none of them do pierce shadow roots automatically, which may be inconvenient when working with Shadow DOM and Web Components.</p>\n<p>For that reason, the css engine pierces shadow roots. More specifically, every <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/Descendant_combinator\">Descendant combinator</a> pierces an arbitrary number of open shadow roots, including the implicit descendant combinator at the start of the selector.</p>\n<p>That means, it is not necessary to select each shadow host, open its shadow root and select the next shadow host until you reach the element that should be controlled.</p>\n<h4 id=\"CSS:light\">CSS:light</h4>\n<p><code>css:light</code> engine is equivalent to <a href=\"https://developer.mozilla.org/en/docs/Web/API/Document/querySelector\">Document.querySelector</a> and behaves according to the CSS spec. However, it does not pierce shadow roots.</p>\n<p><code>css</code> engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.</p>\n<p>Examples:</p>\n<pre>\n&lt;article&gt;\n  &lt;div&gt;In the light dom&lt;/div&gt;\n  &lt;div slot='myslot'&gt;In the light dom, but goes into the shadow slot&lt;/div&gt;\n  &lt;open mode shadow root&gt;\n      &lt;div class='in-the-shadow'&gt;\n          &lt;span class='content'&gt;\n              In the shadow dom\n              &lt;open mode shadow root&gt;\n                  &lt;li id='target'&gt;Deep in the shadow&lt;/li&gt;\n              &lt;/open mode shadow root&gt;\n          &lt;/span&gt;\n      &lt;/div&gt;\n      &lt;slot name='myslot'&gt;&lt;/slot&gt;\n  &lt;/open mode shadow root&gt;\n&lt;/article&gt;\n</pre>\n<p>Note that <code>&lt;open mode shadow root&gt;</code> is not an html element, but rather a shadow root created with <code>element.attachShadow({mode: 'open'})</code>.</p>\n<ul>\n<li>Both <code>\"css=article div\"</code> and <code>\"css:light=article div\"</code> match the first <code>&lt;div&gt;In the light dom&lt;/div&gt;</code>.</li>\n<li>Both <code>\"css=article &gt; div\"</code> and <code>\"css:light=article &gt; div\"</code> match two <code>div</code> elements that are direct children of the <code>article</code>.</li>\n<li><code>\"css=article .in-the-shadow\"</code> matches the <code>&lt;div class='in-the-shadow'&gt;</code>, piercing the shadow root, while <code>\"css:light=article .in-the-shadow\"</code> does not match anything.</li>\n<li><code>\"css:light=article div &gt; span\"</code> does not match anything, because both light-dom <code>div</code> elements do not contain a <code>span</code>.</li>\n<li><code>\"css=article div &gt; span\"</code> matches the <code>&lt;span class='content'&gt;</code>, piercing the shadow root.</li>\n<li><code>\"css=article &gt; .in-the-shadow\"</code> does not match anything, because <code>&lt;div class='in-the-shadow'&gt;</code> is not a direct child of <code>article</code></li>\n<li><code>\"css:light=article &gt; .in-the-shadow\"</code> does not match anything.</li>\n<li><code>\"css=article li#target\"</code> matches the <code>&lt;li id='target'&gt;Deep in the shadow&lt;/li&gt;</code>, piercing two shadow roots.</li>\n</ul>\n<h4 id=\"text:light\">text:light</h4>\n<p><code>text</code> engine open pierces shadow roots similarly to <code>css</code>, while <code>text:light</code> does not. Text engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.</p>\n<h4 id=\"id, data-testid, data-test-id, data-test and their :light counterparts\">id, data-testid, data-test-id, data-test and their :light counterparts</h4>\n<p>Attribute engines are selecting based on the corresponding attribute value. For example: <code>data-test-id=foo</code> is equivalent to <code>css=[data-test-id=\"foo\"]</code>, and <code>id:light=foo</code> is equivalent to <code>css:light=[id=\"foo\"]</code>.</p>\n<h3 id=\"Element reference syntax\">Element reference syntax</h3>\n<p>It is possible to get a reference to a Locator by using <a href=\"#Get%20Element\" class=\"name\">Get Element</a> and <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a> keywords. Keywords do not save reference to an element in the HTML document, instead it saves reference to a Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a>. In nutshell Locator captures the logic of how to retrieve that element from the page. Each time an action is performed, the locator re-searches the elements in the page. This reference can be used as a <b>first</b> part of a selector by using a special selector syntax <span class=\"name\">element=</span>. like this:</p>\n<pre>\n${ref}=    Get Element    .some_class\n           Click          ${ref} &gt;&gt; .some_child     # Locator searches an element from the page.\n           Click          ${ref} &gt;&gt; .other_child    # Locator searches again an element from the page.\n</pre>\n<p>The <span class=\"name\">.some_child</span> and <span class=\"name\">.other_child</span> selectors in the example are relative to the element referenced by ${ref}. Please note that frame piercing is not possible with element reference.</p>\n<h2 id=\"Assertions\">Assertions</h2>\n<p>Keywords that accept arguments <code>assertion_operator</code> &lt;<a href=\"#type-AssertionOperator\" class=\"name\">AssertionOperator</a>&gt; and <code>assertion_expected</code> can optionally assert that a specified condition holds. Keywords will return the value even when the assertion is performed by the keyword.</p>\n<p>Assert will retry and fail only after a specified timeout. See <a href=\"#Importing\" class=\"name\">Importing</a> and <code>retry_assertions_for</code> (default is 1 second) for configuring this timeout.</p>\n<p>Currently supported assertion operators are:</p>\n<table border=\"1\">\n<tr>\n<th>Operator</th>\n<th>Alternative Operators</th>\n<th>Description</th>\n<th>Validate Equivalent</th>\n</tr>\n<tr>\n<td><code>==</code></td>\n<td><code>equal</code>, <code>equals</code>, <code>should be</code></td>\n<td>Checks if returned value is equal to expected value.</td>\n<td><code>value == expected</code></td>\n</tr>\n<tr>\n<td><code>!=</code></td>\n<td><code>inequal</code>, <code>should not be</code></td>\n<td>Checks if returned value is not equal to expected value.</td>\n<td><code>value != expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;</code></td>\n<td><code>greater than</code></td>\n<td>Checks if returned value is greater than expected value.</td>\n<td><code>value &gt; expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;=</code></td>\n<td></td>\n<td>Checks if returned value is greater than or equal to expected value.</td>\n<td><code>value &gt;= expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;</code></td>\n<td><code>less than</code></td>\n<td>Checks if returned value is less than expected value.</td>\n<td><code>value &lt; expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;=</code></td>\n<td></td>\n<td>Checks if returned value is less than or equal to expected value.</td>\n<td><code>value &lt;= expected</code></td>\n</tr>\n<tr>\n<td><code>*=</code></td>\n<td><code>contains</code></td>\n<td>Checks if returned value contains expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td></td>\n<td><code>not contains</code></td>\n<td>Checks if returned value does not contain expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td><code>^=</code></td>\n<td><code>should start with</code>, <code>starts</code></td>\n<td>Checks if returned value starts with expected value.</td>\n<td><code>re.search(f\"^{expected}\", value)</code></td>\n</tr>\n<tr>\n<td><code>$=</code></td>\n<td><code>should end with</code>, <code>ends</code></td>\n<td>Checks if returned value ends with expected value.</td>\n<td><code>re.search(f\"{expected}$\", value)</code></td>\n</tr>\n<tr>\n<td><code>matches</code></td>\n<td></td>\n<td>Checks if given RegEx matches minimum once in returned value.</td>\n<td><code>re.search(expected, value)</code></td>\n</tr>\n<tr>\n<td><code>validate</code></td>\n<td></td>\n<td>Checks if given Python expression evaluates to <code>True</code>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>evaluate</code></td>\n<td><code>then</code></td>\n<td>When using this operator, the keyword does return the evaluated Python expression.</td>\n<td></td>\n</tr>\n</table>\n<p>Currently supported formatters for assertions are:</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Substitutes multiple spaces to single space from the value</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from the beginning and end of the value</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts value to lower case before comparing</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies rules also for the expected value</td>\n</tr>\n</table>\n<p>Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If <code>apply to expected</code> formatter is defined, then formatters are then formatter are also applied to expected value.</p>\n<p>By default, keywords will provide an error message if an assertion fails. Default error messages can be overwritten with a <code>message</code> argument. The <code>message</code> argument accepts <span class=\"name\">{value}</span>, <span class=\"name\">{value_type}</span>, <span class=\"name\">{expected}</span> and <span class=\"name\">{expected_type}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options. The <span class=\"name\">{value}</span> is the value returned by the keyword and the <span class=\"name\">{expected}</span> is the expected value defined by the user, usually the value in the <code>assertion_expected</code> argument. The <span class=\"name\">{value_type}</span> and <span class=\"name\">{expected_type}</span> are the type definitions from <span class=\"name\">{value}</span> and <span class=\"name\">{expected}</span> arguments. In similar fashion as Python <a href=\"https://docs.python.org/3/library/functions.html#type\">type</a> returns type definition. Assertions will retry until <code>timeout</code> has expired if they do not pass.</p>\n<p>The assertion <code>assertion_expected</code> value is not converted by the library and is used as is. Therefore when assertion is made, the <code>assertion_expected</code> argument value and value returned the keyword must have the same type. If types are not the same, assertion will fail. Example <a href=\"#Get%20Text\" class=\"name\">Get Text</a> always returns a string and has to be compared with a string, even the returned value might look like a number.</p>\n<p>Other Keywords have other specific types they return. <a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a> always returns an integer. <a href=\"#Get%20BoundingBox\" class=\"name\">Get Bounding Box</a> and <a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a> can be filtered. They return a dictionary without a filter and a number when filtered. These Keywords do automatic conversion for the expected value if a number is returned.</p>\n<p>* &lt; less or greater &gt; With Strings* Comparisons of strings with <code>greater than</code> or <code>less than</code> compares each character, starting from 0 regarding where it stands in the code page. Example: <code>A &lt; Z</code>, <code>Z &lt; a</code>, <code>ac &lt; dc<span class=\"name\"> It does never compare the length of elements. Neither lists nor strings. The comparison stops at the first character that is different. Examples: </span>`'abcde' &lt; 'abd'</code>, <code>'100.000' &lt; '2'</code> In Python 3 and therefore also in Browser it is not possible to compare numbers with strings with a greater or less operator. On keywords that return numbers, the given expected value is automatically converted to a number before comparison.</p>\n<p>The getters <span class=\"name\">Get Page State</span> and <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a> return a dictionary. Values of the dictionary can directly asserted. Pay attention of possible types because they are evaluated in Python. For example:</p>\n<pre>\nGet Page State    validate    2020 &gt;= value['year']                     # Comparison of numbers\nGet Page State    validate    \"IMPORTANT MESSAGE!\" == value['message']  # Comparison of strings\n</pre>\n<h3 id=\"The 'then' or 'evaluate' closure\">The 'then' or 'evaluate' closure</h3>\n<p>Keywords that accept arguments <code>assertion_operator</code> and <code>assertion_expected</code> can optionally also use <code>then</code> or <code>evaluate</code> closure to modify the returned value with BuiltIn Evaluate. Actual value can be accessed with <code>value</code>.</p>\n<p>For example <code>Get Title  then  'TITLE: '+value</code>. See <a href=\"https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Evaluating%20expressions\">Builtin Evaluating expressions</a> for more info on the syntax.</p>\n<h3 id=\"Examples\">Examples</h3>\n<pre>\n# <b>Keyword</b>    <b>Selector</b>                    <b>Key</b>        <b>Assertion Operator</b>    <b>Assertion Expected</b>\nGet Title                                           equal                 Page Title\nGet Title                                           ^=                    Page\nGet Style    //*[@id=\"div-element\"]      width      &gt;                     100\nGet Title                                           matches               \\\\w+\\\\s\\\\w+\nGet Title                                           validate              value == \"Login Page\"\nGet Title                                           evaluate              value if value == \"some value\" else \"something else\"\n</pre>\n<h2 id=\"Implicit waiting\">Implicit waiting</h2>\n<p>Browser library and Playwright have many mechanisms to help in waiting for elements. Playwright will auto-wait before performing actions on elements. Please see <a href=\"https://playwright.dev/docs/actionability/\">Auto-waiting on Playwright documentation</a> for more information.</p>\n<p>On top of Playwright auto-waiting Browser assertions will wait and retry for specified time before failing any <a href=\"#Assertions\" class=\"name\">Assertions</a>. Time is specified in Browser library initialization with <code>retry_assertions_for</code>.</p>\n<p>Browser library also includes explicit waiting keywords such as <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait for Elements State</a> if more control for waiting is needed.</p>\n<h2 id=\"Experimental: Re-using same node process\">Experimental: Re-using same node process</h2>\n<p>Browser library integrated nodejs and python. The NodeJS side can be also executed as a standalone process. Browser libraries running on the same machine can talk to that instead of starting new node processes. This can speed execution when running tests parallel. To start node side run on the directory when the Browser package is <code>PLAYWRIGHT_BROWSERS_PATH=0 node Browser/wrapper/index.js PORT</code>.</p>\n<p><code>PORT</code> is the port you want to use for the node process. To execute tests then with pabot for example do <code>ROBOT_FRAMEWORK_BROWSER_NODE_PORT=PORT pabot ..</code>.</p>\n<h2 id=\"Experimental: Provide parameters to node process\">Experimental: Provide parameters to node process</h2>\n<p>Browser library is integrated with NodeJSand and Python. Browser library starts a node process, to communicate Playwright API in NodeJS side. It is possible to provide parameters for the started node process by defining ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS environment variable, before starting the test execution. Example: <code>ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS=--inspect;robot path/to/tests</code>. There can be multiple arguments defined in the environment variable and arguments must be separated with comma.</p>\n<h2 id=\"Scope Setting\">Scope Setting</h2>\n<p>Some keywords which manipulates library settings have a scope argument. With that scope argument one can set the \"live time\" of that setting. Available Scopes are: <span class=\"name\">Global</span>, <span class=\"name\">Suite</span> and <span class=\"name\">Test</span>/<span class=\"name\">Task</span> See <a href=\"#type-Scope\" class=\"name\">Scope</a>. Is a scope finished, this scoped setting, like timeout, will no longer be used.</p>\n<p>Live Times:</p>\n<ul>\n<li>A <span class=\"name\">Global</span> scope will live forever until it is overwritten by another <span class=\"name\">Global</span> scope. Or locally temporarily overridden by a more narrow scope.</li>\n<li>A <span class=\"name\">Suite</span> scope will locally override the <span class=\"name\">Global</span> scope and live until the end of the Suite within it is set, or if it is overwritten by a later setting with <span class=\"name\">Global</span> or same scope. Children suite does inherit the setting from the parent suite but also may have its own local <span class=\"name\">Suite</span> setting that then will be inherited to its children suites.</li>\n<li>A <span class=\"name\">Test</span> or <span class=\"name\">Task</span> scope will be inherited from its parent suite but when set, lives until the end of that particular test or task.</li>\n</ul>\n<p>A new set higher order scope will always remove the lower order scope which may be in charge. So the setting of a <span class=\"name\">Suite</span> scope from a test, will set that scope to the robot file suite where that test is and removes the <span class=\"name\">Test</span> scope that may have been in place.</p>\n<h2 id=\"Extending Browser library with a JavaScript module\">Extending Browser library with a JavaScript module</h2>\n<p>Browser library can be extended with JavaScript. The module must be in CommonJS format that Node.js uses. You can translate your ES6 module to Node.js CommonJS style with Babel. Many other languages can be also translated to modules that can be used from Node.js. For example TypeScript, PureScript and ClojureScript just to mention few.</p>\n<pre>\nasync function myGoToKeyword(url, args, page, logger, playwright) {\n  logger(args.toString())\n  playwright.coolNewFeature()\n  return await page.goto(url);\n}\n</pre>\n<p>Functions can contain any number of arguments and arguments may have default values.</p>\n<p>There are some reserved arguments that are not accessible from Robot Framework side. They are injected to the function if they are in the arguments:</p>\n<p><code>page</code>: <a href=\"https://playwright.dev/docs/api/class-page\">the playwright Page object</a>.</p>\n<p><code>args</code>: the rest of values from Robot Framework keyword call <code>*args</code>.</p>\n<p><code>logger</code>: callback function that takes strings as arguments and writes them to robot log. Can be called multiple times.</p>\n<p><code>playwright</code>: playwright module (* from 'playwright'). Useful for integrating with Playwright features that Browser library doesn't support with it's own keywords. <a href=\"https://playwright.dev/docs/api/class-playwright\">API docs</a></p>\n<p>also argument name <code>self</code> can not be used.</p>\n<h3 id=\"Example module.js\">Example module.js</h3>\n<pre>\nasync function myGoToKeyword(pageUrl, page) {\n  await page.goto(pageUrl);\n  return await page.title();\n}\nexports.__esModule = true;\nexports.myGoToKeyword = myGoToKeyword;\n</pre>\n<h3 id=\"Example Robot Framework side\">Example Robot Framework side</h3>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary   Browser  jsextension=${CURDIR}/module.js\n\n<b>*</b> Test Cases <b>*</b>\nHello\n  New Page\n  ${title}=  myGoToKeyword  <a href=\"https://playwright.dev\">https://playwright.dev</a>\n  Should be equal  ${title}  Playwright\n</pre>\n<p>Also selector syntax can be extended with a custom selector using a js module</p>\n<h3 id=\"Example module keyword for custom selector registering\">Example module keyword for custom selector registering</h3>\n<pre>\nasync function registerMySelector(playwright) {\nplaywright.selectors.register(\"myselector\", () =&gt; ({\n   // Returns the first element matching given selector in the root's subtree.\n   query(root, selector) {\n      return root.querySelector(<span class=\"name\">a[data-title=\"${selector}\"]</span>);\n    },\n\n    // Returns all elements matching given selector in the root's subtree.\n    queryAll(root, selector) {\n      return Array.from(root.querySelectorAll(<span class=\"name\">a[data-title=\"${selector}\"]</span>));\n    }\n}));\nreturn 1;\n}\nexports.__esModule = true;\nexports.registerMySelector = registerMySelector;\n</pre>\n<h2 id=\"Plugins\">Plugins</h2>\n<p>Browser library offers plugins as a way to modify and add library keywords and modify some of the internal functionality without creating a new library or hacking the source code. See plugin API <a href=\"https://github.com/MarketSquare/robotframework-browser/blob/main/docs/plugins/README.md\">documentation</a> for further details.</p>\n<h2 id=\"Language\">Language</h2>\n<p>Browser library offers possibility to translte keyword names and documentation to new language. If language is defined, Browser library will search from <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#module-search-path\">module search path</a> Python packages starting with <span class=\"name\">robotframework_browser_translation</span> by using <a href=\"https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/\">Python pluging API</a>. Library is using naming convention to find Python plugins.</p>\n<p>The package must implement single API call, <code>get_language</code> without any arguments. Method must return a dictionary containing two keys: <code>language</code> and <code>path</code>. The language key value defines which language the package contains. Also value should match (case insentive) the library <code>language</code> import parameter. The path parameter value should be full path to the translation file.</p>\n<h3 id=\"Translation file\">Translation file</h3>\n<p>The file name or extension is not important, but data must be in <a href=\"https://www.json.org/json-en.html\">json</a> format. The keys of json are the methods names, not the keyword names, which implements keywords. Value of key is json object which contains two keys: <code>name</code> and <code>doc</code>. The <code>name</code> key contains the keyword translated name and <span class=\"name\">doc</span> contains translated documentation. Providing doc and name are optional, example translation json file can only provide translations to keyword names or only to documentatin. But it is always recomended to provide translation to both name and doc. Special key <code>__intro__</code> is for class level documentation and <code>__init__</code> is for init level documentation. These special values <code>name</code> can not be translated, instead <code>name</code> should be kept the same.</p>\n<h3 id=\"Generating template translation file\">Generating template translation file</h3>\n<p>Template translation file, with English language can be created by running: <span class=\"name\">rfbrowser translation /path/to/translation.json</span> command. Command does not provide translations to other languages, it only provides easy way to create full list keywords and their documentation in correct format. It is also possible to add keywords from library plugins and js extensions by providing <span class=\"name\">--plugings</span> and <span class=\"name\">--jsextension</span> arguments to command. Example: <span class=\"name\">rfbrowser translation --plugings myplugin.SomePlugin --jsextension /path/ot/jsplugin.js /path/to/translation.json</span></p>\n<p>Example project for translation can be found from <a href=\"https://github.com/MarketSquare/robotframework-browser-translation-fi\">robotframework-browser-translation-fi</a> repository.</p>", "version": "18.4.0", "generated": "2024-05-02T16:39:26+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/__init__.py", "lineno": 113, "tags": ["Assertion", "BrowserControl", "Config", "Crawling", "Getter", "HTTP", "PageContent", "Setter", "Wait"], "inits": [{"name": "__init__", "args": [{"name": "_", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*_"}, {"name": "auto_closing_level", "type": {"name": "AutoClosingLevel", "typedoc": "AutoClosingLevel", "nested": [], "union": false}, "defaultValue": "TEST", "kind": "NAMED_ONLY", "required": false, "repr": "auto_closing_level: AutoClosingLevel = TEST"}, {"name": "enable_playwright_debug", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "PlaywrightLogTypes", "typedoc": "PlaywrightLogTypes", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "defaultValue": "library", "kind": "NAMED_ONLY", "required": false, "repr": "enable_playwright_debug: PlaywrightLogTypes | bool = library"}, {"name": "enable_presenter_mode", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HighLightElement", "typedoc": "HighLightElement", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "enable_presenter_mode: HighLightElement | bool = False"}, {"name": "external_browser_executable", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "external_browser_executable: Dict[SupportedBrowsers, str] | None = None"}, {"name": "jsextension", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "jsextension: List[str] | str | None = None"}, {"name": "playwright_process_port", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "playwright_process_port: int | None = None"}, {"name": "plugins", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "plugins: List[str] | str | None = None"}, {"name": "retry_assertions_for", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:01", "kind": "NAMED_ONLY", "required": false, "repr": "retry_assertions_for: timedelta = 0:00:01"}, {"name": "run_on_failure", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Take Screenshot \\ fail-screenshot-{index}", "kind": "NAMED_ONLY", "required": false, "repr": "run_on_failure: str = Take Screenshot \\ fail-screenshot-{index}"}, {"name": "selector_prefix", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "selector_prefix: str | None = None"}, {"name": "show_keyword_call_banner", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "show_keyword_call_banner: bool | None = None"}, {"name": "strict", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "strict: bool = True"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:10", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:10"}, {"name": "language", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "language: str | None = None"}], "returnType": null, "doc": "<p>Browser library can be taken into use with optional arguments:</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>auto_closing_level</code></td>\n<td>Configure context and page automatic closing. Default is <code>TEST</code>, for more details, see <a href=\"#type-AutoClosingLevel\" class=\"name\">AutoClosingLevel</a></td>\n</tr>\n<tr>\n<td><code>enable_playwright_debug</code></td>\n<td>Enable low level debug information from the playwright to playwright-log.txt file. For more details, see <a href=\"#type-PlaywrightLogTypes\" class=\"name\">PlaywrightLogTypes</a>.</td>\n</tr>\n<tr>\n<td><code>enable_presenter_mode</code></td>\n<td>Automatic highlights the interacted components, slowMo and a small pause at the end. Can be enabled by giving True or can be customized by giving a dictionary: <span class=\"name\">{\"duration\": \"2 seconds\", \"width\": \"2px\", \"style\": \"dotted\", \"color\": \"blue\"}</span> Where <span class=\"name\">duration</span> is time format in Robot Framework format, defaults to 2 seconds. <span class=\"name\">width</span> is width of the marker in pixels, defaults the <span class=\"name\">2px</span>. <span class=\"name\">style</span> is the style of border, defaults to <span class=\"name\">dotted</span>. <span class=\"name\">color</span> is the color of the marker, defaults to <span class=\"name\">blue</span>. By default, the call banner keyword is also enabled unless explicitly disabled.</td>\n</tr>\n<tr>\n<td><code>external_browser_executable</code></td>\n<td>Dict mapping name of browser to path of executable of a browser. Will make opening new browsers of the given type use the set executablePath. Currently only configuring of <span class=\"name\">chromium</span> to a separate executable (chrome, chromium and Edge executables all work with recent versions) works.</td>\n</tr>\n<tr>\n<td><code>jsextension</code></td>\n<td>Path to Javascript modules exposed as extra keywords. The modules must be in CommonJS. It can either be a single path, a comma-separated lists of path or a real list of strings</td>\n</tr>\n<tr>\n<td><code>playwright_process_port</code></td>\n<td>Experimental reusing of playwright process. <code>playwright_process_port</code> is preferred over environment variable <code>ROBOT_FRAMEWORK_BROWSER_NODE_PORT</code>. See <a href=\"#Experimental%3A%20Re-using%20same%20node%20process\" class=\"name\">Experimental: Re-using same node process</a> for more details.</td>\n</tr>\n<tr>\n<td><code>plugins</code></td>\n<td>Allows extending the Browser library with external Python classes. Can either be a single class/module, a comma-separated list or a real list of strings</td>\n</tr>\n<tr>\n<td><code>retry_assertions_for</code></td>\n<td>Timeout for retrying assertions on keywords before failing the keywords. This timeout starts counting from the first failure. Global <code>timeout</code> will still be in effect. This allows stopping execution faster to assertion failure when element is found fast.</td>\n</tr>\n<tr>\n<td><code>run_on_failure</code></td>\n<td>Sets the keyword to execute in case of a failing Browser keyword. It can be the name of any keyword. If the keyword has arguments those must be separated with two spaces for example <code>My keyword \\ arg1 \\ arg2</code>. If no extra action should be done after a failure, set it to <code>None</code> or any other robot falsy value. Run on failure is not applied when library methods are executed directly from Python.</td>\n</tr>\n<tr>\n<td><code>selector_prefix</code></td>\n<td>Prefix for all selectors. This is useful when you need to use add an iframe selector before each selector.</td>\n</tr>\n<tr>\n<td><code>show_keyword_call_banner</code></td>\n<td>If set to <code>True</code>, will show a banner with the keyword name and arguments before the keyword is executed at the bottom of the page. If set to <code>False</code>, will not show the banner. If set to None, which is the default, will show the banner only if the presenter mode is enabled. <a href=\"#Get%20Page%20Source\" class=\"name\">Get Page Source</a> and <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> will not show the banner, because that could negatively affect your test cases/tasks. This feature may be super helpful when you are debugging your tests and using tracing from <a href=\"#New%20Context\" class=\"name\">New Context</a> or <span class=\"name\">Video recording</span> features.</td>\n</tr>\n<tr>\n<td><code>strict</code></td>\n<td>If keyword selector points multiple elements and keywords should interact with one element, keyword will fail if <code>strict</code> mode is true. Strict mode can be changed individually in keywords or by <span class=\"name\">`</span>et Strict Mode`` keyword.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout for keywords that operate on elements. The keywords will wait for this time for the element to appear into the page. Defaults to \"10s\" =&gt; 10 seconds.</td>\n</tr>\n<tr>\n<td><code>language</code></td>\n<td>Defines language which is used to translate keyword names and documentation.</td>\n</tr>\n</table>", "shortdoc": "Browser library can be taken into use with optional arguments:", "tags": [], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/__init__.py", "lineno": 801}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "domain", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str | None = None"}, {"name": "path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str | None = None"}, {"name": "expires", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expires: str | None = None"}, {"name": "httpOnly", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "httpOnly: bool | None = None"}, {"name": "secure", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool | None = None"}, {"name": "sameSite", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "CookieSameSite", "typedoc": "CookieSameSite", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sameSite: CookieSameSite | None = None"}], "returnType": null, "doc": "<p>Adds a cookie to currently active browser context.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Name of the cookie.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Given value for the cookie.</td>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Given url for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>domain</code></td>\n<td>Given domain for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Given path for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>expires</code></td>\n<td>Given expiry for the cookie. Can be of date format or unix time. Supports the same formats as the <a href=\"http://robotframework.org/robotframework/latest/libraries/DateTime.html\">DateTime</a> library or an epoch timestamp. - example: 2027-09-28 16:21:35</td>\n</tr>\n<tr>\n<td><code>httpOnly</code></td>\n<td>Sets the httpOnly token.</td>\n</tr>\n<tr>\n<td><code>secure</code></td>\n<td>Sets the secure token.</td>\n</tr>\n<tr>\n<td><code>samesite</code></td>\n<td>Sets the samesite mode.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>                                     # Using url argument.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   domain=example.com                path=/foo/bar                     # Using domain and url arguments.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>   expires=2027-09-28 16:21:35       # Expires as timestamp.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>   expires=1822137695                # Expires as epoch seconds.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4233\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a cookie to currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 91}, {"name": "Add Style Tag", "args": [{"name": "content", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "content: str"}], "returnType": null, "doc": "<p>Adds a &lt;style type=\"text/css\"&gt; tag with the content.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>content</code></td>\n<td>Raw CSS content to be injected into frame.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Add%20Style%20Tag\" class=\"name\">Add Style Tag</a>    \\#username_field:focus {background-color: aqua;}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4234\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a <style type=\"text/css\"> tag with the content.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 131}, {"name": "Cancel Download", "args": [{"name": "download", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "download: DownloadInfo | str"}], "returnType": null, "doc": "<p>Cancels an active download.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>download</td>\n<td>A <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> object or id of the download to be canceled.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//6478\">Comment &gt;&gt;</a></p>", "shortdoc": "Cancels an active download.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1554}, {"name": "Check Checkbox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Checks the checkbox or selects radio button found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is already checked/selected.</p>\n<p><a href=\"https://forum.robotframework.org/t//4235\">Comment &gt;&gt;</a></p>", "shortdoc": "Checks the checkbox or selects radio button found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 647}, {"name": "Clear Permissions", "args": [], "returnType": null, "doc": "<p>Clears all permissions from the current context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4236\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears all permissions from the current context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 545}, {"name": "Clear Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Clears the text field found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4237\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 115}, {"name": "Click", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}], "returnType": null, "doc": "<p>Simulates mouse click on the element found by <code>selector</code>.</p>\n<p>This keyword clicks an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element matches selector. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> to click in the center of the element, or the specified position.</li>\n<li>Wait for initiated navigation to either succeed or fail.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>Defaults to <code>left</code> if invalid.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location    left\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location    right\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4238\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 290}, {"name": "Click With Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}, {"name": "clickCount", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "NAMED_ONLY", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "delay: timedelta | None = None"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_x: float | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_y: float | None = None"}, {"name": "trial", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "trial: bool = False"}], "returnType": null, "doc": "<p>Simulates mouse click on the element found by <code>selector</code>.</p>\n<p>This keyword clicks an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element matches selector. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> to click in the center of the element, or the specified position.</li>\n<li>Wait for initiated navigation to either succeed or fail, unless <code>noWaitAfter</code> option is set.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>Defaults to <code>left</code> if invalid.</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used. Modifiers can be specified in any order, and multiple modifiers can be specified. Valid modifier keys are <code>Control</code>, <code>Alt</code>, <code>Shift</code> and <code>Meta</code>. Due to the fact that the argument <span class=\"name\">*modifiers</span> is a positional only argument, all preceding keyword arguments have to be specified as positional arguments before <span class=\"name\">*modifiers</span>.</td>\n</tr>\n<tr>\n<td><code>clickCount</code></td>\n<td>Defaults to 1.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Time to wait between mouse-down and mouse-up. Defaults to 0.</td>\n</tr>\n<tr>\n<td><code>position_x</code> <code>position_y</code></td>\n<td>A point to click relative to the top-left corner of element bounding-box. Only positive values within the bounding-box are allowed. If not specified, clicks to some visible point of the element.</td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's Actionability checks (<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a>).</td>\n</tr>\n<tr>\n<td><code>noWaitAfter</code></td>\n<td>Actions that initiate navigation, are waiting for these navigation to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to <code>False</code>.</td>\n</tr>\n<tr>\n<td><code>trial</code></td>\n<td>When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.</td>\n</tr>\n</table>\n<p>Arguments <code>clickCount</code>, <code>delay</code>, <code>position_x</code>, <code>position_y</code>, <code>force</code>, <code>noWaitAfter</code> and <code>trial</code> are named-only arguments and must be specified using their names..</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=button_location\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=button_location    trial=True\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    \\#clickWithOptions    delay=100ms    clickCount=2\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=clickWithModifiers    left     Alt    Meta    Shift    clickCount=1    force=True\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=clickWithOptions    right    clickCount=2    force=True    noWaitAfter=True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5936\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 318}, {"name": "Close Browser", "args": [{"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": null, "doc": "<p>Closes the current browser.</p>\n<p>Active browser is set to the browser that was active before this one. Closes all context and pages belonging to this browser. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser to close. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    ALL        # Closes all browsers\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    CURRENT    # Close current browser\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>               # Close current browser\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    ${id}      # Close browser matching id\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4239\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes the current browser.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 118}, {"name": "Close Browser Server", "args": [{"name": "wsEndpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}], "returnType": null, "doc": "<p>Close a playwright Browser Server identified by its websocket endpoint (wsEndpoint).</p>\n<p>The wsEndpoint string is returned by <a href=\"#Launch%20Browser%20Server\" class=\"name\">Launch Browser Server</a> and is also used by <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n</table>\n<pre>\n<code>wsEndpoint</code> | Address of the browser server. Example: <span class=\"name\">`ws://127.0.0.1:63784/ca69bf0e9471391e8183d9ac1e90e1ba</span>`|\n</pre>", "shortdoc": "Close a playwright Browser Server identified by its websocket endpoint (wsEndpoint).", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 484}, {"name": "Close Context", "args": [{"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": null, "doc": "<p>Closes a Context.</p>\n<p>Active context is set to the context that was active before this one. Closes pages belonging to this context. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>Context to close. <code>CURRENT</code> selects the active context. <code>ALL</code> closes all contexts. When a context id is provided, that context is closed.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser where to close context. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>                          #  Closes current context and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    CURRENT    CURRENT    #  Closes current context and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    ALL        CURRENT    #  Closes all context from current browser and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    ALL        ALL        #  Closes all context from current browser and all browser\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4240\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes a Context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 162}, {"name": "Close Page", "args": [{"name": "page", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType | str = CURRENT"}, {"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}, {"name": "runBeforeUnload", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "runBeforeUnload: bool = False"}], "returnType": null, "doc": "<p>Closes the <code>page</code> in <code>context</code> in <code>browser</code>.</p>\n<p>Defaults to current for all three. Active page is set to the page that was active before this one. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<p><code>runBeforeUnload</code> defines where to run the <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event\">before unload</a> page handlers. Defaults to false.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>Page to close. <code>CURRENT</code> selects the active page. <code>ALL</code> closes all pages. When a page id is provided, that page is closed.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>Context where to close page. <code>CURRENT</code> selects the active context. <code>ALL</code> closes all contexts. When a context id is provided, that context is closed.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser where to close page. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Returns a list of dictionaries containing id, errors and console messages from the page.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>                                       # Closes current page, within the current context and browser\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>    CURRENT     CURRENT     CURRENT    # Closes current page, within the current context and browser\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>    ALL         ALL         ALL        # Closes all pages, within all contexts and browsers\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4241\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes the ``page`` in ``context`` in ``browser``.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 240}, {"name": "Connect To Browser", "args": [{"name": "wsEndpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "use_cdp", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "use_cdp: bool = False"}], "returnType": null, "doc": "<p>Connect to a Playwright browser server via playwright websocket or Chrome DevTools Protocol.</p>\n<p>See <a href=\"#Launch%20Browser%20Server\" class=\"name\">Launch Browser Server</a> for more information about how to launch a playwright browser server.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Returns a stable identifier for the connected browser.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>wsEndpoint</code></td>\n<td>Address to connect to. Either <code>ws://</code> or <code>http://</code> if cdp is used.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Opens the specified browser. Defaults to <code>chromium</code>.</td>\n</tr>\n<tr>\n<td><code>use_cdp</code></td>\n<td>Connect to browser via Chrome DevTools Protocol. Defaults to False. Works only with Chromium based browsers.</td>\n</tr>\n</table>\n<p>To Connect to a Browser viw Chrome DevTools Protocol, the browser must be started with this protocol enabled. This typically done by starting a Chrome browser with the argument <code>--remote-debugging-port=9222</code> or similar. When the browser is running with activated CDP, it is possible to connect to it either with websockets (<code>ws://</code>) or via HTTP (<code>http://</code>). The HTTP connection can be used when <code>use_cdp</code> is set to True. A typical address for a CDP connection is <code>http://127.0.0.1:9222</code>.</p>\n<p><a href=\"https://forum.robotframework.org/t//4242\">Comment &gt;&gt;</a></p>", "shortdoc": "Connect to a Playwright browser server via playwright websocket or Chrome DevTools Protocol.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 323}, {"name": "Crawl Site", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "page_crawl_keyword", "type": null, "defaultValue": "take_screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_crawl_keyword=take_screenshot"}, {"name": "max_number_of_page_to_crawl", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "max_number_of_page_to_crawl: int = 1000"}, {"name": "max_depth_to_crawl", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "50", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "max_depth_to_crawl: int = 50"}], "returnType": null, "doc": "<p>Web crawler is a tool to go through all the pages on a specific URL domain. This happens by finding all links going to the same site and opening those.</p>\n<p>returns list of crawled urls.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>is the page to start crawling from.</td>\n</tr>\n<tr>\n<td><code>page_crawl_keyword</code></td>\n<td>is the keyword that will be executed on every page.  By default it will take a screenshot on every page.</td>\n</tr>\n<tr>\n<td><code>max_number_of_page_to_crawl</code></td>\n<td>is the upper limit of pages to crawl. Crawling will stop if the number of crawled pages goes over this.</td>\n</tr>\n<tr>\n<td><code>max_depth_to_crawl</code></td>\n<td>is the upper limit of consecutive links followed from the start page. Crawling will stop if there are no more links under this depth.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4243\">Comment &gt;&gt;</a></p>", "shortdoc": "Web crawler is a tool to go through all the pages on a specific URL domain. This happens by finding all links going to the same site and opening those.", "tags": ["Crawling"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/crawling.py", "lineno": 14}, {"name": "Delete All Cookies", "args": [], "returnType": null, "doc": "<p>Deletes all cookies from the currently active browser context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4244\">Comment &gt;&gt;</a></p>", "shortdoc": "Deletes all cookies from the currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 150}, {"name": "Deselect Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Deselects all options from select element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the select tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>If you just want to select one or more specific options and currently more options are selected, use <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a> keyword with the options to be selected in the end.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4245\">Comment &gt;&gt;</a></p>", "shortdoc": "Deselects all options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 763}, {"name": "Download", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "saveAs", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}, {"name": "wait_for_finished", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_for_finished: bool = True"}, {"name": "download_timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "download_timeout: timedelta | None = None"}], "returnType": {"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, "doc": "<p>Download given url content.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>URL to the file that shall be downloaded.</td>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>Path where the file shall be saved persistently. If empty, generated unique path (GUID) is used and file is deleted when the context is closed.</td>\n</tr>\n<tr>\n<td><code>wait_for_finished</code></td>\n<td>If set to <code>False</code> keyword returns immediately after the download is started. Defaults to <code>True</code>.</td>\n</tr>\n<tr>\n<td><code>download_timeout</code></td>\n<td>Timeout for the download itself if <code>wait_for_finished</code> is set to <code>True</code>. By default no timeout is set.</td>\n</tr>\n</table>\n<p>Keyword returns dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a>.</p>\n<p>Example:</p>\n<pre>\n{\n  \"saveAs\": \"/tmp/robotframework-browser/downloads/2f1b3b7c-1b1b-4b1b-9b1b-1b1b1b1b1b1b\",\n  \"suggestedFilename\": \"downloaded_file.txt\"\n  \"state\": \"finished\",\n  \"downloadID\": None,\n}\n</pre>\n<p>If the download should be started by an interaction with an element on the page, <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> keyword may be a better choice.</p>\n<p>The keyword <a href=\"#New%20Browser\" class=\"name\">New Browser</a> has a <code>downloadsPath</code> setting which can be used to set the default download directory. If <span class=\"name\">saveAs</span> is set to a relative path, the file will be saved relative to the browser's <code>downloadsPath</code> setting or if that is not set, relative to the Playwright's working directory. If <code>saveAs</code> is set to an absolute path, the file will be saved to that absolute path independent of <code>downloadsPath</code>.</p>\n<p>To enable downloads context's <code>acceptDownloads</code> needs to be true. This keyword requires that there is currently an open page. The keyword uses the current pages local state (cookies, sessionstorage, localstorage) for the download to avoid authentication problems.</p>\n<p>Example:</p>\n<pre>\n${file_object}=    <a href=\"#Download\" class=\"name\">Download</a>    ${url}\n${actual_size}=    Get File Size    ${file_object.saveAs}\n</pre>\n<p>Example 2:</p>\n<pre>\n${href}=          <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    text=\"Download File\"    href\n<a href=\"#Download\" class=\"name\">Download</a>    ${href}    saveAs=${OUTPUT DIR}/downloads/downloaded_file.txt\nFile Should Exist    ${OUTPUT DIR}/downloads/downloaded_file.txt\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4246\">Comment &gt;&gt;</a></p>", "shortdoc": "Download given url content.", "tags": ["Page Content"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 147}, {"name": "Drag And Drop", "args": [{"name": "selector_from", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "selector_to", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_to: str"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from the element selected by <code>selector_from</code> to the element selected by <code>selector_to</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector_from</code></td>\n<td>Identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>selector_to</code></td>\n<td>Identifies the element, which center is the end-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>First it moves the mouse to the start-point, then presses the left mouse button, then moves to the end-point in specified number of steps, then releases the mouse button.</p>\n<p>Start- and end-point are defined by the center of the elements boundingbox.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Drag%20And%20Drop\" class=\"name\">Drag And Drop</a>    \"Circle\"    \"Goal\"\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4247\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to the element selected by ``selector_to``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 982}, {"name": "Drag And Drop By Coordinates", "args": [{"name": "from_x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_x: float"}, {"name": "from_y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_y: float"}, {"name": "to_x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_x: float"}, {"name": "to_y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_y: float"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from a coordinate to another coordinate.</p>\n<p>First it moves the mouse to the start-point, then presses the left mouse button, then moves to the end-point in specified number of steps, then releases the mouse button.</p>\n<p>Start- and end-point are defined by <code>x</code> and <code>y</code> coordinates relative to the top left corner of the pages viewport.</p>\n<table border=\"1\">\n<tr>\n<td><code>from_x</code> &amp; <code>from_y</code></td>\n<td>Identify the start-point on page.</td>\n</tr>\n<tr>\n<td><code>to_x</code> &amp; <code>to_y</code></td>\n<td>Identify the end-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Drag%20And%20Drop%20By%20Coordinates\" class=\"name\">Drag And Drop By Coordinates</a>\n...    from_x=30    from_y=30\n...    to_x=10    to_y=10    steps=20\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4248\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from a coordinate to another coordinate.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1021}, {"name": "Drag And Drop Relative To", "args": [{"name": "selector_from", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from the element selected by <code>selector_from</code> to coordinates relative to the center of that element.</p>\n<p>This keyword can be handy to simulate swipe actions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector_from</code></td>\n<td>identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>identifies the end-point which is relative to the start-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>First it moves the mouse to the start-point (center of boundingbox), then presses the left mouse button, then moves to the relative position with the given intermediate steps, then releases the mouse button.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Drag%20And%20Drop%20Relative%20To\" class=\"name\">Drag And Drop Relative to</a>    \"Circle\"    -20    0     # Slides the element 20 pixel to the left\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4249\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to coordinates relative to the center of that element.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1055}, {"name": "Eat All Cookies", "args": [], "returnType": null, "doc": "<p>Eat all cookies for all easter.</p>\n<p><a href=\"https://forum.robotframework.org/t//4250\">Comment &gt;&gt;</a></p>", "shortdoc": "Eat all cookies for all easter.", "tags": [], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 160}, {"name": "Evaluate JavaScript", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "function", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*function: str"}, {"name": "arg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "arg: Any | None = None"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "all_elements: bool = False"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Executes given javascript on the selected element(s) or on page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector to resolve and pass to the JavaScript function. This will be the first argument the function receives if not <code>${None}</code>. <code>selector</code> is optional and can be omitted. If given a selector, a function is necessary, with an argument to capture the elementHandle. For example <code>(element) =&gt; document.activeElement === element</code> See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*function</code></td>\n<td>A valid javascript function or a javascript function body. These arguments can be used to write readable multiline JavaScript.</td>\n</tr>\n<tr>\n<td><code>arg</code></td>\n<td>an additional argument that can be handed over to the JavaScript function. This argument must be JSON serializable. ElementHandles are not supported.</td>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>defines if only the single elementHandle found by <code>selector</code> is handed over to the function or if set to <code>True</code> all found elements are handed over as array.</td>\n</tr>\n</table>\n<p>Example with <code>all_elements=True</code>:</p>\n<pre>\n ${texts}=    Evaluate JavaScript    button\n ...    (elements, arg) =&gt; {\n ...        let text = []\n ...            for (e of elements) {\n ...                console.log(e.innerText)\n ...                text.push(e.innerText)\n ...            }\n ...        text.push(arg)\n ...        return text\n ...    }\n ...    all_elements=True\n ...    arg=Just another Text\n</pre>\n<p>Keyword uses strict mode if <code>all_elements</code> is <code>False</code>. See <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://github.com/MarketSquare/robotframework-browser/tree/main/atest/test/06_Examples/js_evaluation.robot\">Usage examples.</a></p>\n<p><a href=\"https://forum.robotframework.org/t//4251\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes given javascript on the selected element(s) or on page.", "tags": ["Getter", "PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 28}, {"name": "Fill Secret", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Fills the given secret from <code>variable_name</code> into the text field found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>secret</code></td>\n<td>The secret string that should be filled into the text field.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>This keyword does not log secret in Robot Framework logs, when keyword resolves the <code>secret</code> variable internally. When <code>secret</code> variable is prefixed with <span class=\"name\">$</span>, without the curly braces, library will resolve the corresponding Robot Framework variable.</p>\n<p>If <code>secret</code> variable is prefixed with <span class=\"name\">%</span>, library will resolve corresponding environment variable. Example <span class=\"name\">$Password</span>` will resolve to <code>${Password}</code> Robot Framework variable. Also <code>%ENV_PWD</code> will resolve to <code>%{ENV_PWD}</code> environment variable.</p>\n<p><b>Using normal Robot Framework variables like <code>${password}</code> will not work!</b></p>\n<p><b>Normal plain text will not work.</b> If you want to use plain text, use <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> keyword instead.</p>\n<p>This keyword will also work with a give cryptographic cipher text, that has been encrypted by Crypto library. See <a href=\"https://github.com/Snooz82/robotframework-crypto\">Crypto Library</a> for more details.</p>\n<p>If <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for other details.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    input#username_field    $username    # Keyword resolves variable value from Robot Framework variables\n<a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    input#username_field    %username    # Keyword resolves variable value from environment variables\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4253\">Comment &gt;&gt;</a></p>", "shortdoc": "Fills the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 198}, {"name": "Fill Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Clears and fills the given <code>txt</code> into the text field found by <code>selector</code>.</p>\n<p>This method waits for an element matching the <code>selector</code> to appear, waits for actionability checks, focuses the element, fills it and triggers an input event after filling.</p>\n<p>If the element matching selector is not an &lt;input&gt;, &lt;textarea&gt; or [contenteditable] element, this method throws an error. Note that you can pass an empty string as <code>txt</code> to clear the input field.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>txt</code></td>\n<td>Text for the text field.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for emulating typing text character by character.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Fill%20Text\" class=\"name\">Fill Text</a>    css=input#username_field    username\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4254\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears and fills the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 85}, {"name": "Focus", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Moves focus on to the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>If there's no element matching selector, the method waits until a matching element appears in the DOM. Timeouts after 10 seconds.</p>\n<p><a href=\"https://forum.robotframework.org/t//4255\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves focus on to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 531}, {"name": "Get Attribute", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns the HTML <code>attribute</code> of the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>attribute</code></td>\n<td>Requested attribute name.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the attribute value matches the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>When a attribute is selected that is not present and no assertion operator is set, the keyword fails. If an assertion operator is set and the attribute is not present, the returned value is <code>None</code>. This can be used to assert check the presents or the absents of an attribute.</p>\n<p>Example Element:</p>\n<pre>\n&lt;button class=\"login button active\" id=\"enabled_button\" something&gt;Login&lt;/button&gt;\n</pre>\n<p>Example Code:</p>\n<pre>\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled                   # FAIL =&gt; \"Attribute 'disabled' not found!\"\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled     ==    ${None}     # PASS =&gt; returns: None\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    something    evaluate    value is not None    # PASS =&gt;  returns: True\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled     evaluate    value is None        # PASS =&gt;  returns: True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4256\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the HTML ``attribute`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 271}, {"name": "Get Attribute Names", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all HTML attribute names of an element as a list.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that attribute names do match to the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a>    [name=\"readonly_input\"]    ==    type    name    value    readonly    # Has exactly these attribute names.\n<a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a>    [name=\"readonly_input\"]    contains    disabled    # Contains at least this attribute name.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4257\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all HTML attribute names of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 334}, {"name": "Get BoundingBox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "type": {"name": "BoundingBoxFields", "typedoc": "BoundingBoxFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: BoundingBoxFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "BoundingBox", "typedoc": "BoundingBox", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements size and location as an object <code>{x: float, y: float, width: float, height: float}</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the BoundingBox as Dictionary, otherwise it will just return the single value selected by the key. Note: If a single value is retrieved, an assertion does <b>not</b> need a <code>validate</code> combined with a cast of <code>value</code>.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example use:</p>\n<pre>\n${bounding_box}=    <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>    id=element                 # unfiltered\nLog                 ${bounding_box}                                 # {'x': 559.09375, 'y': 75.5, 'width': 188.796875, 'height': 18}\n${x}=               <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>    id=element    x            # filtered\nLog                 X: ${x}                                         # X: 559.09375\n# Assertions:\n<a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>     id=element         width         &gt;    180\n<a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>     id=element         ALL           validate    value['x'] &gt; value['y']*2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4258\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements size and location as an object ``{x: float, y: float, width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1127}, {"name": "Get Browser Catalog", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "BrowserInfo", "typedoc": "BrowserInfo", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all browsers, open contexts in them and open pages in these contexts.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about these concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n</table>\n<p>The data is parsed into a python list containing data representing the open Objects.</p>\n<p>On the root level the data contains a list of open browsers.</p>\n<p>Data can be manipulated also with <code>assertion_operator</code> for example to find a specific id based on index or page title with <code>then</code> operator.</p>\n<p>Return value can also be asserted against expected value.</p>\n<p>Sample:</p>\n<pre>\n[\n  {\n    \"type\": \"chromium\",\n    \"id\": \"browser=96207191-8147-44e7-b9ac-5e04f2709c1d\",\n    \"contexts\": [\n      {\n        \"type\": \"context\",\n        \"id\": \"context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089\",\n        \"activePage\": \"page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12\",\n        \"pages\": [\n          {\n            \"type\": \"page\",\n            \"title\": \"Robocorp\",\n            \"url\": \"<a href=\"https://robocorp.com/\">https://robocorp.com/</a>\",\n            \"id\": \"page=7ac15782-22d2-48b4-8591-ff17663fa737\",\n            \"timestamp\": 1598607713.858\n          },\n          {\n            \"type\": \"page\",\n            \"title\": \"Home - Reaktor\",\n            \"url\": \"<a href=\"https://www.reaktor.com/\">https://www.reaktor.com/</a>\",\n            \"id\": \"page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12\",\n            \"timestamp\": 1598607714.702\n          }\n        ]\n      }\n    ],\n    \"activeContext\": \"context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089\",\n    \"activeBrowser\": false\n  },\n  {\n    \"type\": \"firefox\",\n    \"id\": \"browser=ad99abac-17a9-472b-ac7f-d6352630834e\",\n    \"contexts\": [\n      {\n        \"type\": \"context\",\n        \"id\": \"context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0\",\n        \"activePage\": \"page=8baf2991-5eaf-444d-a318-8045f914e96a\",\n        \"pages\": [\n          {\n            \"type\": \"page\",\n            \"title\": \"Software-Qualit\u00e4tssicherung und Softwaretest\",\n            \"url\": \"<a href=\"https://www.imbus.de/\">https://www.imbus.de/</a>\",\n            \"id\": \"page=8baf2991-5eaf-444d-a318-8045f914e96a\",\n            \"timestamp\": 1598607716.828\n          }\n        ]\n      }\n    ],\n    \"activeContext\": \"context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0\",\n    \"activeBrowser\": true\n  }\n]\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4259\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all browsers, open contexts in them and open pages in these contexts.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 933}, {"name": "Get Browser Ids", "args": [{"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a list of ids from open browsers. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p><code>browser</code> Defaults to <code>ALL</code></p>\n<ul>\n<li><code>ALL</code> / <code>ANY</code> Returns all ids as a list.</li>\n<li><code>ACTIVE</code> / <code>CURRENT</code> Returns the id of the currently active browser as list.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the ids from. <code>ALL</code> for all open browsers, <code>ACTIVE</code> for the currently active browser or the id of the browser to get the ids from.</td>\n</tr>\n</table>\n<p>The ACTIVE browser is a synonym for the CURRENT Browser.</p>\n<p><a href=\"https://forum.robotframework.org/t//4260\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of ids from open browsers. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1344}, {"name": "Get Checkbox State", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "Unchecked", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: bool | str = Unchecked"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Returns the state of the checkbox found by <code>selector</code>.</p>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector which shall be examined. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td><code>==</code> and <code>!=</code> and equivalent are allowed on boolean values. Other operators are not accepted.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Boolean value of expected state. Strings are interpreted as booleans. All strings are <code>${True}</code> except of the following <span class=\"name\">FALSE, NO, OFF, 0, UNCHECKED, NONE, ${EMPTY}</span>` (case-insensitive). Defaults to unchecked.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<ul>\n<li><code>checked</code> =&gt; <code>True</code></li>\n<li><code>unchecked</code> =&gt; <code>False</code></li>\n</ul>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Checkbox%20State\" class=\"name\">Get Checkbox State</a>    [name=can_send_email]    ==    checked\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4261\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the state of the checkbox found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 555}, {"name": "Get Classes", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all classes of an element as a list.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected values for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Classes\" class=\"name\">Get Classes</a>    id=draggable    ==    react-draggable    box    # Element contains exactly this class name.\n<a href=\"#Get%20Classes\" class=\"name\">Get Classes</a>    id=draggable    validate    \"react-draggable-dragged\" not in value    # Element does not contain react-draggable-dragged class.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4262\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all classes of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 387}, {"name": "Get Client Size", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Dimensions", "typedoc": "Dimensions", "nested": [], "union": false}, "doc": "<p>Gets elements or pages client size (<code>clientHeight</code>, <code>clientWidth</code>) as object {width: float, height: float}.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the client size of the page itself is used (<code>document.scrollingElement</code>). See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll size as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> or <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> for examples.</p>\n<p><a href=\"https://forum.robotframework.org/t//4263\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages client size (``clientHeight``, ``clientWidth``) as object {width: float, height: float}.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1296}, {"name": "Get Console Log", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "full", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "full: bool = False"}, {"name": "last", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "last: int | timedelta | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns the console log of the active page.</p>\n<p>If assertions are used and fail, this keyword will fail immediately without retrying.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>full</td>\n<td>If true, returns the full console log. If false, returns only new entries that were added since last time.</td>\n</tr>\n<tr>\n<td>last</td>\n<td>If set, returns only the last n entries. Can be <span class=\"name\">int</span> for number of entries or <a href=\"#type-timedelta\" class=\"name\">timedelta</a> for time period.</td>\n</tr>\n</table>\n<p>The returned data is a <a href=\"#type-list\" class=\"name\">list</a> of log messages.</p>\n<p>A log message is a <span class=\"name\">dict</span> with the following structure:</p>\n<pre>\n{\n  \"type\": str,\n  \"text\": str,\n  \"location\": {\n    \"url\": str,\n    \"lineNumber\": int,\n    \"columnNumber\": int\n  },\n  \"time\": str\n}\n</pre>\n<p>Example:</p>\n<pre>\n[{\n  'type': 'log',\n  'text': 'Stuff loaded...',\n  'location': {\n    'url': '<a href=\"https://example.com/js/chunk-769742de.6a462276.js\">https://example.com/js/chunk-769742de.6a462276.js</a>',\n    'lineNumber': 60,\n    'columnNumber': 63771\n  },\n  'time': '2023-02-05T17:42:52.064Z'\n}]\n</pre>\n<p>Keys:</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>One of the following values: <code>log</code>, <code>debug</code>, <code>info</code>, <code>error</code>, <code>warning</code>, <code>dir</code>, <code>dirxml</code>, <code>table</code>, <code>trace</code>, <code>clear</code>, <code>startGroup</code>, <code>startGroupCollapsed</code>, <code>endGroup</code>, <code>assert</code>, <code>profile</code>, <code>profileEnd</code>, <code>count</code>, <code>timeEnd</code></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>The text of the console message.</td>\n</tr>\n<tr>\n<td><code>location.url</code></td>\n<td>The URL of the resource that generated this message.</td>\n</tr>\n<tr>\n<td><code>location.lineNumber</code></td>\n<td>The line number in the resource that generated this message (0-based).</td>\n</tr>\n<tr>\n<td><code>location.columnNumber</code></td>\n<td>The column number in the resource that generated this message (0-based).</td>\n</tr>\n<tr>\n<td><code>time</code></td>\n<td>The timestamp of the log message as ISO 8601 string.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//5267\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the console log of the active page.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1029}, {"name": "Get Context Ids", "args": [{"name": "context", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [], "union": false}, "doc": "<p>Returns a list of context ids based on the browser selection. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<p><code>ALL</code> and <code>ANY</code> are synonyms. <code>ACTIVE</code> and <code>CURRENT</code> are also synonyms.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context to get the ids from. <code>ALL</code> will return all ids from selected browser(s), <code>ACTIVE</code> for the one active context of each selected browser.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the context ids from. <code>ALL</code> Context ids from all open browsers shall be fetched. <code>ACTIVE</code> Only context ids from the active browser shall be fetched.</td>\n</tr>\n</table>\n<p>The ACTIVE context of the ACTIVE Browser is the <code>Current</code> Context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4264\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of context ids based on the browser selection. See `Browser, Context and Page` for more information about Context and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1369}, {"name": "Get Cookie", "args": [{"name": "cookie", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "cookie: str"}, {"name": "return_type", "type": {"name": "CookieType", "typedoc": "CookieType", "nested": [], "union": false}, "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns information of cookie with <code>name</code> as a Robot Framework dot dictionary or a string.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>cookie</code></td>\n<td>Name of the cookie to be retrieved.</td>\n</tr>\n<tr>\n<td><code>return_type</code></td>\n<td>Type of the return value. Can be either <code>dictionary</code> or <code>string</code>. Defaults to <code>dictionary</code>.</td>\n</tr>\n</table>\n<p>If <code>return_type</code> is <code>dictionary</code> or <code>dict</code> then keyword returns a of Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#accessing-list-and-dictionary-items\">dot dictionary</a> The dictionary contains all possible key value pairs of the cookie. If <code>return_type</code> is <code>string</code> or <code>str</code>, then keyword returns the cookie as a string in format: <code>name1=value1</code>. The return value contains only <code>name</code> and <code>value</code> keys of the cookie.</p>\n<p>If no cookie is found with <code>name</code> keyword fails. The cookie dictionary contains details about the cookie. Keys available in the dictionary are documented in the table below.</p>\n<table border=\"1\">\n<tr>\n<td><b>Value</b></td>\n<td><b>Explanation</b></td>\n</tr>\n<tr>\n<td>name</td>\n<td>The name of a cookie, mandatory.</td>\n</tr>\n<tr>\n<td>value</td>\n<td>Value of the cookie, mandatory.</td>\n</tr>\n<tr>\n<td>url</td>\n<td>Define the scope of the cookie, what URLs the cookies should be sent to.</td>\n</tr>\n<tr>\n<td>domain</td>\n<td>Specifies which hosts are allowed to receive the cookie.</td>\n</tr>\n<tr>\n<td>path</td>\n<td>Indicates a URL path that must exist in the requested URL, for example <span class=\"name\">/</span>.</td>\n</tr>\n<tr>\n<td>expires</td>\n<td>Lifetime of a cookie. Returned as datatime object or None if not valid time received.</td>\n</tr>\n<tr>\n<td>httpOnly</td>\n<td>When true, the cookie is not accessible via JavaScript.</td>\n</tr>\n<tr>\n<td>secure</td>\n<td>When true, the cookie is only used with HTTPS connections.</td>\n</tr>\n<tr>\n<td>sameSite</td>\n<td>Attribute lets servers require that a cookie shouldn't be sent with cross-origin requests.</td>\n</tr>\n</table>\n<p>See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browsercontextaddcookiescookies\">playwright documentation</a> for details about each attribute.</p>\n<p>Example:</p>\n<pre>\n${cookie}=        <a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a>              Foobar\nShould Be Equal   ${cookie.value}           Tidii\nShould Be Equal   ${cookie.expires.year}     ${2020}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4265\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns information of cookie with ``name`` as a Robot Framework dot dictionary or a string.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 179}, {"name": "Get Cookies", "args": [{"name": "return_type", "type": {"name": "CookieType", "typedoc": "CookieType", "nested": [], "union": false}, "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns cookies from the current active browser context.</p>\n<p>If <code>return_type</code> is <code>dictionary</code> or <code>dict</code> then keyword returns list of Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#accessing-list-and-dictionary-items\">dot dictionaries</a> The dictionary contains all possible key value pairs of the cookie. See <a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a> keyword documentation about the dictionary keys and values.</p>\n<p>If <code>return_type</code> is <code>string</code> or <code>str</code>, then keyword returns the cookie as a string in format: <code>name1=value1; name2=value2; name3=value3</code>. The return value contains only <code>name</code> and <code>value</code> keys of the cookie.</p>\n<p><a href=\"https://forum.robotframework.org/t//4266\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns cookies from the current active browser context.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 29}, {"name": "Get Device", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Get a single device descriptor with name exactly matching name.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Given name of the requested device. See Playwright's <a href=\"https://github.com/microsoft/playwright/blob/master/packages/playwright-core/src/server/deviceDescriptorsSource.json\">deviceDescriptorsSource.json</a> for a formatted list.</td>\n</tr>\n</table>\n<p>Allows a concise syntax to set website testing values to exact matches of specific mobile devices.</p>\n<p>Use by passing to a context. After creating a context with devicedescriptor, before using ensure your active page is on that context. Usage:</p>\n<pre>\n${device}=          <a href=\"#Get%20Device\" class=\"name\">Get Device</a>       iPhone X\n<a href=\"#New%20Context\" class=\"name\">New Context</a>         &amp;{device}\n<a href=\"#New%20Page\" class=\"name\">New Page</a>\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>   # returns { \"width\": 375, \"height\": 812 }\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4267\">Comment &gt;&gt;</a></p>", "shortdoc": "Get a single device descriptor with name exactly matching name.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/device_descriptors.py", "lineno": 40}, {"name": "Get Devices", "args": [], "returnType": {"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns a dict of all playwright device descriptors.</p>\n<p>See Playwright's <a href=\"https://github.com/microsoft/playwright/blob/master/packages/playwright-core/src/server/deviceDescriptorsSource.json\">deviceDescriptorsSource.json</a> for a formatted list.</p>\n<p><a href=\"https://forum.robotframework.org/t//4268\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a dict of all playwright device descriptors.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/device_descriptors.py", "lineno": 25}, {"name": "Get Download State", "args": [{"name": "download", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "download: DownloadInfo | str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, "doc": "<p>Gets the state of a download.</p>\n<p>Returns a dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> with the following keys:</p>\n<pre>\n{\n  saveAs: str\n  suggestedFilename: str\n  state: str\n  downloadID: Optional[str]\n}\n</pre>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>download</code></td>\n<td><a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> dictionary returned from <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> or download id as string.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected state of the download. Be aware that the returned value is a dictionary</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//6479\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets the state of a download.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1432}, {"name": "Get Element", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns a reference to a Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a>.</p>\n<p>The reference can be used in subsequent selectors.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved . See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n${element} =    <a href=\"#Get%20Element\" class=\"name\">Get Element</a>    \\#username_field\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${element} &gt;&gt; optionOne    value    # Locator is resolved from the page.\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${element} &gt;&gt; optionTwo    value    # Locator is resolved again from the page.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4269\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to a Playwright [https://playwright.dev/docs/api/class-locator|Locator].", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 837}, {"name": "Get Element By", "args": [{"name": "selection_strategy", "type": {"name": "SelectionStrategy", "typedoc": "SelectionStrategy", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selection_strategy: SelectionStrategy"}, {"name": "text", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str | RegExp"}, {"name": "exact", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact: bool = False"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "all_elements: bool = False"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Allows locating elements by their features.</p>\n<p>Selection strategies can be several Playwright strategies like AltText or Label. See <a href=\"https://playwright.dev/docs/locators\">Playwright Locators</a> for more information.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>locator_type</code></td>\n<td>SelectionStrategy to be used. Refers to Playwrights <code>page.getBy***</code> functions. See <a href=\"https://playwright.dev/docs/locators\">https://playwright.dev/docs/locators</a></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Text to locate the element for.</td>\n</tr>\n<tr>\n<td><code>exact</code></td>\n<td>Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace. This has no effect if RegExp is used or if TestID is used as strategy.</td>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>If True, returns all matched elements as a list.</td>\n</tr>\n</table>\n<p>This keywords implements the following Playwright functions:</p>\n<ul>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-alt-text\">page.getByAltText</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-label\">page.getByLabel</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-placeholder\">page.getByPlaceholder</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-test-id\">page.getByTestId</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-text\">page.getByText</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-title\">page.getByTitle</a></li>\n</ul>\n<p><code>page.getByRole</code> is supported by <a href=\"#Get%20Element%20By%20Role\" class=\"name\">Get Element By Role</a> keyword.</p>\n<p>If an element shall be fetched from an iframe, a selector prefix must be set using <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a> keyword including <code>&gt;&gt;&gt;</code> as ending.</p>\n<p><a href=\"https://forum.robotframework.org/t//5937\">Comment &gt;&gt;</a></p>", "shortdoc": "Allows locating elements by their features.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 994}, {"name": "Get Element By Role", "args": [{"name": "role", "type": {"name": "ElementRole", "typedoc": "ElementRole", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "role: ElementRole"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "all_elements: bool = False"}, {"name": "checked", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "checked: bool | None = None"}, {"name": "disabled", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "disabled: bool | None = None"}, {"name": "exact", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "exact: bool | None = None"}, {"name": "expanded", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "expanded: bool | None = None"}, {"name": "include_hidden", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "include_hidden: bool | None = None"}, {"name": "level", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "level: int | None = None"}, {"name": "name", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "name: str | RegExp | None = None"}, {"name": "pressed", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "pressed: bool | None = None"}, {"name": "selected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "selected: bool | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns a reference to Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a> for the matched element by <code>role</code> or a list of references if <code>all_elements</code> is set to <code>True</code>.</p>\n<p>Allows locating elements by their <a href=\"https://www.w3.org/TR/wai-aria-1.2/#roles\">ARIA role</a>, <a href=\"https://www.w3.org/TR/wai-aria-1.2/#aria-attributes\">ARIA attributes</a> and <a href=\"https://w3c.github.io/accname/#dfn-accessible-name\">accessible name</a>.</p>\n<p>Consider the following DOM structure.</p>\n<pre>\n&lt;h3&gt;Sign up&lt;/h3&gt;\n&lt;label&gt;\n  &lt;input type=\"checkbox\" /&gt; Subscribe\n&lt;/label&gt;\n&lt;br/&gt;\n&lt;button&gt;Submit&lt;/button&gt;\n</pre>\n<p>You can locate each element by it's implicit role:</p>\n<pre>\n${heading}    Get Element By Role    heading    name=Sign up\n${checkbox}   Get Element By Role    checkbox    name=Subscribe\n${button}     Get Element By Role    button    name=/submit/i\n</pre>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>If True, returns all matched elements as a list.</td>\n</tr>\n<tr>\n<td><code>role</code></td>\n<td>Role from which shall be retrieved.</td>\n</tr>\n<tr>\n<td><code>checked</code></td>\n<td>An attribute that is usually set by aria-checked or native &lt;input type=checkbox&gt; controls.</td>\n</tr>\n<tr>\n<td><code>disabled</code></td>\n<td>An attribute that is usually set by aria-disabled or disabled.</td>\n</tr>\n<tr>\n<td><code>exact</code></td>\n<td>Whether name is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when name is a regular expression. Note that exact match still trims whitespace.</td>\n</tr>\n<tr>\n<td><code>expanded</code></td>\n<td>An attribute that is usually set by aria-expanded.</td>\n</tr>\n<tr>\n<td><code>include_hidden</code></td>\n<td>Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.</td>\n</tr>\n<tr>\n<td><code>level</code></td>\n<td>A number attribute that is usually present for roles heading, list item, row, treeitem, with default values for &lt;h1&gt;-&lt;h6&gt; elements.</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.</td>\n</tr>\n<tr>\n<td><code>pressed</code></td>\n<td>An attribute that is usually set by aria-pressed.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>An attribute that is usually set by aria-selected.</td>\n</tr>\n</table>\n<p>If an element shall be fetched from an iframe, a selector prefix must be set using <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a> keyword including <code>&gt;&gt;&gt;</code> as ending.</p>\n<p><a href=\"https://forum.robotframework.org/t//5938\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to Playwright [https://playwright.dev/docs/api/class-locator|Locator] for the matched element by ``role`` or a list of references if ``all_elements`` is set to ``True``.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 898}, {"name": "Get Element Count", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the count of elements found with <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector which shall be counted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a>    label    &gt;    1\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4270\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the count of elements found with ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 605}, {"name": "Get Element States", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected: ElementState | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}, {"name": "return_names", "type": null, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "return_names=True"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}], "union": true}, "doc": "<p>Get the active states from the element found by <code>selector</code>.</p>\n<p>This Keyword returns a list of states that are valid for the selected element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected states</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n<tr>\n<td><code>return_names</code></td>\n<td>If set to <code>False</code> the keyword does return an IntFlag object (<a href=\"#type-ElementState\" class=\"name\">ElementState</a>) instead of a list. <a href=\"#type-ElementState\" class=\"name\">ElementState</a> may contain multiple states at the same time. Defaults to <code>True</code>.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default, assertion is not done.</p>\n<p>This keyword internally works with Python IntFlag. Flags can be processed using bitwise operators like &amp; (bitwise AND) and | (bitwise OR). When using the assertion operators <code>then</code>, <code>evaluate</code> or <code>validate</code> the <code>value</code> contain the states as <a href=\"#type-ElementState\" class=\"name\">ElementState</a>.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    validate    value &amp; visible   # Fails in case of an invisible element\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    then    value &amp; (visible | hidden)  # Returns either <code>['visible']</code> or <code>['hidden']</code>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    then    bool(value &amp; visible)  # Returns <code>${True}</code> if element is visible\n</pre>\n<p>The most typical use case would be to verify if an element contains a specific state or multiple states.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=checked_elem      *=    checked\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=checked_elem      not contains    checked\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=invisible_elem    contains    hidden    attached\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=disabled_elem     contains    visible    disabled    readonly\n</pre>\n<p>Elements do return the positive and negative values if applicable. As example, a checkbox does return either <code>checked</code> or <code>unchecked</code> while a text input element has none of those two states. Select elements have also either <code>selected</code> or <code>unselected</code>.</p>\n<p>The state of <code>animating</code> will be set if an element is not considered <code>stable</code> within 300 ms.</p>\n<p>If an element is not attached to the dom, so it can not be found within 250ms it is marked as <code>detached</code> as the only state.</p>\n<p><code>stable</code> state is not returned, because it would cause too high delay in that keyword.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4272\">Comment &gt;&gt;</a></p>", "shortdoc": "Get the active states from the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1346}, {"name": "Get Elements", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a reference to Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a> for all matched elements by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${elements} =    <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a>\n${elem} =    Get From List    ${elements}    0\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${elem} &gt;&gt; option    value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4273\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to Playwright [https://playwright.dev/docs/api/class-locator|Locator] for all matched elements by ``selector``.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 864}, {"name": "Get Page Errors", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "full", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "full: bool = False"}, {"name": "last", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "last: int | timedelta | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns the page errors of the active page.</p>\n<p>If assertions are used and fail, this keyword will fail immediately without retrying.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>full</td>\n<td>If true, returns the full console log. If false, returns only new entries that were added since last time.</td>\n</tr>\n<tr>\n<td>last</td>\n<td>If set, returns only the last n entries. Can be <span class=\"name\">int</span> for number of entries or <a href=\"#type-timedelta\" class=\"name\">timedelta</a> for time period.</td>\n</tr>\n</table>\n<p>The returned data is a <a href=\"#type-list\" class=\"name\">list</a> of error messages.</p>\n<p>An error message is a <span class=\"name\">dict</span> with the following structure:</p>\n<pre>\n{\n  \"name\": str,\n  \"message\": str,\n  \"stack\": str,\n  \"time\": str\n}\n</pre>\n<p>Example:</p>\n<pre>\n[{\n  'name': 'ReferenceError',\n  'message': 'YT is not defined',\n  'stack': 'ReferenceError: YT is not defined\\n    at HTMLIFrameElement.onload (<a href=\"https://example.com/:20:2245\">https://example.com/:20:2245</a>)',\n  'time': '2023-02-05T20:08:48.912Z'\n}]\n</pre>\n<p>Keys:</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>The name/type of the error.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>The human readable error message.</td>\n</tr>\n<tr>\n<td><code>stack</code></td>\n<td>The stack trace of the error, if given.</td>\n</tr>\n<tr>\n<td><code>time</code></td>\n<td>The timestamp of the error as ISO 8601 string.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//5268\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the page errors of the active page.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1101}, {"name": "Get Page Ids", "args": [{"name": "page", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType = ALL"}, {"name": "context", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [], "union": false}, "doc": "<p>Returns a list of page ids based on the context and browser selection. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<p><code>ALL</code> and <code>ANY</code> are synonyms. <code>ACTIVE</code> and <code>CURRENT</code> are also synonyms.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>The page to get the ids from. <code>ALL</code> Returns all page ids as a list. <code>ACTIVE</code> Returns the id of the active page as a list.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context to get the page ids from. <code>ALL</code> Page ids from all contexts shall be fetched. <code>ACTIVE</code> Only page ids from the active context shall be fetched.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the page ids from. <code>ALL</code> Page ids from all open browsers shall be fetched. <code>ACTIVE</code> Only page ids from the active browser shall be fetched.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nTest Case\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://www.imbus.de\">http://www.imbus.de</a>\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://www.reaktor.com\">http://www.reaktor.com</a>\n    ${current_page}=   <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>    ACTIVE    ACTIVE    ACTIVE\n    Log                Current page ID is: ${current_page}[0]\n    ${all_pages}=      <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>    CURRENT   CURRENT   ALL\n    Log Many           These are all Page IDs    @{all_pages}\n</pre>\n<p>The ACTIVE page of the ACTIVE context of the ACTIVE Browser is the <code>Current</code> Page.</p>\n<p><a href=\"https://forum.robotframework.org/t//4274\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of page ids based on the context and browser selection. See `Browser, Context and Page` for more information about Page and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1410}, {"name": "Get Page Source", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Gets pages HTML source as a string.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally does a string assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4275\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets pages HTML source as a string.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 89}, {"name": "Get Property", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "property", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "property: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Returns the <code>property</code> of the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>property</code></td>\n<td>Requested property name.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the property value matches the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>If <code>assertion_operator</code> is set and property is not found, <code>value</code> is <code>None</code> and Keyword does not fail. See <a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a> for examples.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Property\" class=\"name\">Get Property</a>    h1    innerText    ==    Login Page\n${property} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    h1    innerText\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4276\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the ``property`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 212}, {"name": "Get Scroll Position", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "AreaFields", "typedoc": "AreaFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: AreaFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "ScrollPosition", "typedoc": "ScrollPosition", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements or pages current scroll position as object <code>{top: float, left: float, bottom: float, right: float}</code>.</p>\n<p>It describes the rectangle which is visible of the scrollable content of that element. all values are measured from position {top: 0, left: 0}.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the client size of the page itself is used (<code>document.scrollingElement</code>). See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll position as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> or <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> for examples.</p>\n<p><a href=\"https://forum.robotframework.org/t//4277\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages current scroll position as object ``{top: float, left: float, bottom: float, right: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1240}, {"name": "Get Scroll Size", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dimensions", "typedoc": "Dimensions", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements or pages scrollable size as object <code>{width: float, height: float}</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the scroll size of the page itself is used. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll size as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> for more similar examples.</p>\n<p>Example use:</p>\n<pre>\n${height}=         <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a>    height                          # filtered page by height\nLog                Width: ${height}                                   # Height: 58425\n${scroll_size}=    <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a>    id=keyword-shortcuts-container  # unfiltered element\nLog                ${scroll_size}                                     # {'width': 253, 'height': 3036}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4278\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages scrollable size as object ``{width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1184}, {"name": "Get Select Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "SelectOptions", "typedoc": "SelectOptions", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns attributes of options of a <code>select</code> element as a list of dictionaries.</p>\n<p>Returned dictionaries have the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that these match the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a>     //select[2]    validate  [v[\"label\"] for v in value] == [\"Email\", \"Mobile\"]\n<a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a>   select#names     validate  any(v[\"label\"] == \"Mikko\" for v in value)\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4279\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns attributes of options of a ``select`` element as a list of dictionaries.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 434}, {"name": "Get Selected Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "option_attribute", "type": {"name": "SelectAttribute", "typedoc": "SelectAttribute", "nested": [], "union": false}, "defaultValue": "label", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "option_attribute: SelectAttribute = label"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}], "union": false}, "doc": "<p>Returns the specified attribute of selected options of the <code>select</code> element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>option_attribute</code></td>\n<td>Which attribute shall be returned/verified. Defaults to label.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that these match the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>      label                    //select[2]    Email      Mobile\n${selected_list}         <a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   //select[2]                                         # getter\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   //select[2]              label          <span class=\"name\">==</span>       Mobile             Mail   #assertion content\n<a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>      label                    select#names   2          4\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             index          <span class=\"name\">==</span>       2                  4      #assertion index\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             label          *=         Mikko                     #assertion contain\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             label          validate   len(value) == 3           #assertion length\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4280\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the specified attribute of selected options of the ``select`` element.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 493}, {"name": "Get Style", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: str | None = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "pseudo_element", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pseudo_element: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets the computed style properties of the element selected by <code>selector</code>.</p>\n<p>Optionally matches with any sequence assertion operator.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the style shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Key of the requested CSS property. Retrieves \"ALL\" styles as dictionary by default. All css settings can be used as keys even if they are not all returned in the dictionary.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n<tr>\n<td><code>pseudo_element</code></td>\n<td>Pseudo element to match. Defaults to None. Pseudo elements are special css</td>\n</tr>\n</table>\n<p><a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-elements\">Pseudo element</a> is a css fuctionality to add styles. Example <span class=\"name\">::before</span> or <span class=\"name\">::after</span>.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the style matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4281\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets the computed style properties of the element selected by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1056}, {"name": "Get Table Cell Element", "args": [{"name": "table", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "table: str"}, {"name": "column", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: str"}, {"name": "row", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the Web Element that has the same column index and same row index as the selected elements.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>table</code></td>\n<td>selector must select the <code>&lt;table&gt;</code> element that contains both selected elements</td>\n</tr>\n<tr>\n<td><code>column</code></td>\n<td>selector can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants.</td>\n</tr>\n<tr>\n<td><code>row</code></td>\n<td>selector can select any <code>&lt;tr&gt;</code> element or one of their descendant like <code>&lt;td&gt;</code> elements.</td>\n</tr>\n</table>\n<p><code>column</code> and <code>row</code> can also consume index numbers instead of selectors. Indexes are starting from <code>0</code> and <code>-1</code> is specific for the last element.</p>\n<p>Selectors for <code>column</code> and <code>row</code> are directly appended to <code>table</code> selector like this: <code>f\"{table} &gt;&gt; {row}\" .</code></p>\n<table border=\"1\">\n<tr>\n<th>GitHub</th>\n<th>Slack</th>\n<th>Real Name</th>\n</tr>\n<tr>\n<td>mkorpela</td>\n<td>@mkorpela</td>\n<td>Mikko Korpela</td>\n</tr>\n<tr>\n<td>aaltat</td>\n<td>@aaltat</td>\n<td>Tatu Aalto</td>\n</tr>\n<tr>\n<td>xylix</td>\n<td>@Kerkko Pelttari</td>\n<td>Kerkko Pelttari</td>\n</tr>\n<tr>\n<td>Snooz82</td>\n<td>@Ren\u00e9</td>\n<td>Ren\u00e9 Rohner</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    [id=\"Get Table Cell Element\"] &gt;&gt; div.kw-docs table &gt;&gt; nth=1\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"Real Name\"    \"aaltat\"   # Returns element with text <code>Tatu Aalto</code>\nGet Text    ${e}    ==    Tatu Aalto\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"Slack\"    \"Mikko Korpela\"   # Returns element with text <code>@mkorpela</code>\nGet Text    ${e}    ==    @mkorpela\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"mkorpela\"    \"Kerkko Pelttari\"   # column does not need to be in row 0\nGet Text    ${e}    ==    @mkorpela\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    2    -1   # Index is also directly possible\nGet Text    ${e}    ==    Ren\u00e9 Rohner\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4282\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the Web Element that has the same column index and same row index as the selected elements.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 696}, {"name": "Get Table Cell Index", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the index (0 based) of a table cell within its row.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    id=<a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a> &gt;&gt; div.kw-docs table   #Table of keyword <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>\n${idx}=    <a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a>    ${table} &gt;&gt; \"Real Name\"\nShould Be Equal    ${idx}    ${2}\n<a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a>    ${table} &gt;&gt; \"@aaltat\"    ==    1\n</pre>\n<p>Optionally asserts that the index matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4283\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the index (0 based) of a table cell within its row.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 751}, {"name": "Get Table Row Index", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the index (0 based) of a table row.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    id=<a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a> &gt;&gt; div.kw-docs table   #Table of keyword <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>\n${idx}=    <a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a>    ${table} &gt;&gt; \"@Ren\u00e9\"\nShould Be Equal    ${idx}    ${4}\n<a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a>    ${table} &gt;&gt; \"@aaltat\"    ==    2\n</pre>\n<p>Optionally asserts that the index matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4284\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the index (0 based) of a table row.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 794}, {"name": "Get Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns text attribute of the element found by <code>selector</code>.</p>\n<p>Keyword can also return <span class=\"name\">input</span> or <span class=\"name\">textarea</span> value property text. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the text matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default, assertion is not done.</p>\n<p>Example:</p>\n<pre>\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=important                            # Returns element text without assertion.\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=important    ==    Important text    # Returns element text with assertion.\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    //input         ==    root              # Returns input element text with assertion.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4285\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns text attribute of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 160}, {"name": "Get Title", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the title of the current page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that title matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4286\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the title of the current page.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 124}, {"name": "Get Url", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the current URL.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that it matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4287\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the current URL.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 59}, {"name": "Get Viewport Size", "args": [{"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns the current viewport dimensions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the viewport size as dictionary, otherwise it will just return the single value selected by the key. Note: If a single value is retrieved, an assertion does <b>not</b> need a <code>validate</code> combined with a cast of <code>value</code>.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>    ALL    ==    {'width':1280, 'height':720}\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>    width    &gt;=    1200\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4288\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the current viewport dimensions.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 645}, {"name": "Go Back", "args": [], "returnType": null, "doc": "<p>Navigates to the previous page in history.</p>\n<p><a href=\"https://forum.robotframework.org/t//4289\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the previous page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 51}, {"name": "Go Forward", "args": [], "returnType": null, "doc": "<p>Navigates to the next page in history.</p>\n<p><a href=\"https://forum.robotframework.org/t//4290\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the next page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 41}, {"name": "Go To", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": null, "doc": "<p>Navigates to the given <code>url</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>URL to be navigated to.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>time to wait page to load. If not defined will use the library default timeout.</td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Returns the HTTP status code for the navigation request as integer or 0 if non received.</p>\n<p><a href=\"https://forum.robotframework.org/t//4291\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the given ``url``.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 61}, {"name": "Grant Permissions", "args": [{"name": "permissions", "type": {"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*permissions: Permission"}, {"name": "origin", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "origin: str | None = None"}], "returnType": null, "doc": "<p>Grants permissions to the current context.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>permissions</code></td>\n<td>is a list of permissions to grant. Permissions can be one of the following: geolocation, notifications, camera, microphone,</td>\n</tr>\n<tr>\n<td><code>origin</code></td>\n<td>The origin to grant permissions to, e.g. \"<a href=\"https://example.com\">https://example.com</a>\".</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#Grant%20Permissions\" class=\"name\">Grant Permissions</a>    geolocation\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4292\">Comment &gt;&gt;</a></p>", "shortdoc": "Grants permissions to the current context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 523}, {"name": "Handle Future Dialogs", "args": [{"name": "action", "type": {"name": "DialogAction", "typedoc": "DialogAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}], "returnType": null, "doc": "<p>Handle next dialog on page with <code>action</code>.</p>\n<p>Dialog can be any of alert, beforeunload, confirm or prompt. Handling dialogue must be called before the action, like example click, that triggers the dialogue.</p>\n<p>If a handler is not set dialogs are dismissed by default.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>How to handle the alert. Can be <code>accept</code> or <code>dismiss</code>.</td>\n</tr>\n<tr>\n<td><code>prompt_input</code></td>\n<td>The value to enter into prompt. Only valid if <code>action</code> argument equals <code>accept</code>. Defaults to empty string.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a>    action=accept\n<a href=\"#Click\" class=\"name\">Click</a>                    \\#alerts\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4293\">Comment &gt;&gt;</a></p>", "shortdoc": "Handle next dialog on page with ``action``.", "tags": ["PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 827}, {"name": "Highlight Elements", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "duration", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:05", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration: timedelta = 0:00:05"}, {"name": "width", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "2px", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width: str = 2px"}, {"name": "style", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "dotted", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = dotted"}, {"name": "color", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "blue", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "color: str = blue"}], "returnType": null, "doc": "<p>Adds a highlight to elements matched by the <code>selector</code>. Provides a style adjustment.</p>\n<p>Returns the number of highlighted elements. Keyword does not fail, if <span class=\"name\">locator</span> matched zero elements in the page. Keyword does not scroll elements to viewport and highlighted element might be outside the viewport. Use <a href=\"#Scroll%20To%20Element\" class=\"name\">Scroll To Element</a> keyword to scroll element in viewport.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selectors which shall be highlighted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>duration</code></td>\n<td>Sets for how long the selector shall be highlighted. Defaults to <code>5s</code> =&gt; 5 seconds.</td>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>Sets the width of the higlight border. Defaults to 2px.</td>\n</tr>\n<tr>\n<td><code>style</code></td>\n<td>Sets the style of the border. Defaults to dotted.</td>\n</tr>\n<tr>\n<td><code>color</code></td>\n<td>Sets the color of the border. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></td>\n</tr>\n</table>\n<p>Keyword does not fail if selector resolves to multiple elements.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    input#login_button    duration=200ms\n${count} =    <a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    input#login_button    duration=200ms    width=4px    style=solid    color=\\#FF00FF\nShould Be Equal    ${count}    ${5}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4294\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a highlight to elements matched by the ``selector``. Provides a style adjustment.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 82}, {"name": "Hover", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_x: float | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_y: float | None = None"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}], "returnType": null, "doc": "<p>Moves the virtual mouse and scrolls to the element found by <code>selector</code>.</p>\n<p>This method hovers over an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element match matching <code>selector</code>. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a> to hover over the center of the element, or the specified <code>position</code>.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to hover. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>position_x</code> &amp; <code>position_y</code></td>\n<td>A point to hover relative to the top-left corner of element bounding box. If not specified, hovers over some visible point of the element. Only positive values within the bounding-box are allowed.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the hover, and then restores current modifiers back. If not specified, currently pressed modifiers are used.</td>\n<td></td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Hover\" class=\"name\">Hover</a>    h1\n<a href=\"#Hover\" class=\"name\">Hover</a>    h1    10   20    Alt\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4295\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves the virtual mouse and scrolls to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 480}, {"name": "Http", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "RequestMethod", "typedoc": "RequestMethod", "nested": [], "union": false}, "defaultValue": "GET", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "method: RequestMethod = GET"}, {"name": "body", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "body: str | None = None"}, {"name": "headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers: dict | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Performs an HTTP request in the current browser context</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>The request url, e.g. <code>/api/foo</code>.</td>\n</tr>\n<tr>\n<td><code>method</code></td>\n<td>The HTTP method for the request. Defaults to GET.</td>\n</tr>\n<tr>\n<td><code>body</code></td>\n<td>The request body. GET requests cannot have a body. If the body can be parsed as JSON, the <code>Content-Type</code> header for the request will be automatically set to <code>application/json</code>. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>headers</code></td>\n<td>A dictionary of additional request headers. Defaults to None.</td>\n</tr>\n</table>\n<p>The response is a Python dictionary with following attributes:</p>\n<ul>\n<li><code>status</code> &lt;int&gt; The status code of the response.</li>\n<li><code>statusText</code> &lt;str&gt; Status text corresponding to <code>status</code>, e.g OK or INTERNAL SERVER ERROR. This may not be available for all browser.</li>\n<li><code>body</code> &lt;dict&gt; | &lt;str&gt; The response body. If the body can be parsed as a JSON obejct, it will be returned as Python dictionary, otherwise it is returned as a string.</li>\n<li><code>headers</code> &lt;dict&gt; A dictionary containing all response headers.</li>\n<li><code>ok</code> &lt;bool&gt; Whether the request was successfull, i.e. the <code>status</code> is range 200-299.</li>\n</ul>\n<p>Here's an example of using Robot Framework dictionary variables and extended variable syntax to do assertions on the response object:</p>\n<pre>\n&amp;{res}=             <a href=\"#Http\" class=\"name\">HTTP</a>                       /api/endpoint\nShould Be Equal     ${res.status}              200\nShould Be Equal     ${res.body.some_field}     some value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4296\">Comment &gt;&gt;</a></p>", "shortdoc": "Performs an HTTP request in the current browser context", "tags": ["HTTP"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 59}, {"name": "Keyboard Input", "args": [{"name": "action", "type": {"name": "KeyboardInputAction", "typedoc": "KeyboardInputAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyboardInputAction"}, {"name": "input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input: str"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int | timedelta = 0:00:00"}], "returnType": null, "doc": "<p>Input text into page with virtual keyboard.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td><code>insertText</code>: Dispatches only input event, does not emit the keydown, keyup or keypress events. <code>type</code>: Sends a keydown, keypress/input, and keyup event for each character in the text.</td>\n</tr>\n<tr>\n<td><code>input</code></td>\n<td>The inputstring to be typed. <i>No special keys possible.</i></td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Time to wait between key presses in Robot Framework's time format. Defaults to 0.</td>\n</tr>\n</table>\n<p><b>Attention:</b> Argument type <span class=\"name\">int</span> for 'delay' in milliseconds has been changed to <a href=\"#type-timedelta\" class=\"name\">timedelta</a> in Browser 14.0.0. Use Robot Framework time format with units instead.</p>\n<p>Note: To press a special key, like Control or ArrowDown, use keyboard.press. Modifier keys DO NOT effect these methods. For testing modifier effects use single key presses with <code>Keyboard Key  press</code></p>\n<p>Example:</p>\n<pre>\n<a href=\"#Keyboard%20Input\" class=\"name\">Keyboard Input</a>    insertText    0123456789\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4297\">Comment &gt;&gt;</a></p>", "shortdoc": "Input text into page with virtual keyboard.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1211}, {"name": "Keyboard Key", "args": [{"name": "action", "type": {"name": "KeyAction", "typedoc": "KeyAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyAction"}, {"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "returnType": null, "doc": "<p>Press a keyboard key on the virtual keyboard or set a key up or down.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>Determine whether the key should be released (<code>up</code>), hold (<code>down</code>) or pressed once (<code>press</code>). <code>down</code> or <code>up</code> are useful for combinations i.e. with Shift.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The key to be pressed. An example of valid keys are: <code>F1</code> - <code>F12</code>, <code>Digit0</code> - <code>Digit9</code>, <code>KeyA</code> - <code>KeyZ</code>, <code>Backquote</code>, <code>Minus</code>, <code>Equal</code>, <code>Backslash</code>, <code>Backspace</code>, <code>Tab</code>, <code>Delete</code>, <code>Escape</code>, <code>ArrowDown</code>, <code>End</code>, <code>Enter</code>, <code>Home</code>, <code>Insert</code>, <code>PageDown</code>, <code>PageUp</code>, <code>ArrowRight</code>, <code>ArrowUp</code> , etc.</td>\n</tr>\n</table>\n<p>Useful keys for <code>down</code> and <code>up</code> for example are: <code>Shift</code>, <code>Control</code>, <code>Alt</code>, <code>Meta</code>, <code>ShiftLeft</code></p>\n<p>Example excecution:</p>\n<pre>\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    S\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    down     Shift\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    ArrowLeft\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    Delete\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    up       Shift\n</pre>\n<p>Note: Capital letters don't need to be written by the help of Shift. You can type them in directly.</p>\n<p><a href=\"https://forum.robotframework.org/t//4298\">Comment &gt;&gt;</a></p>", "shortdoc": "Press a keyboard key on the virtual keyboard or set a key up or down.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1182}, {"name": "Launch Browser Server", "args": [{"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "firefoxUserPrefs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "firefoxUserPrefs: Dict[str, str | int | float | bool] | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "port", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "port: int | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "reuse_existing", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "reuse_existing: bool = True"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "wsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "wsPath: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Launches a new playwright Browser server with specified options.</p>\n<p>Returns a websocket endpoint (wsEndpoint) string that can be used to connect to the server.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>port</code></td>\n<td>Port to use for the browser server. Defaults to 0, which results in a random free port being assigned.</td>\n</tr>\n<tr>\n<td><code>wsPath</code></td>\n<td>If set, Playwright will listen on the given path in addition to the main port. For security, this defaults to an unguessable string.</td>\n</tr>\n</table>\n<p>Check <a href=\"#New%20Browser\" class=\"name\">New Browser</a> for the other argument docs.</p>\n<p>The launched browser server can be used to connect to it with <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a> keyword. This keyword can also be used from command line with <code>rfbrowser launch-browser-server</code> command.</p>\n<p>see <a href=\"https://playwright.dev/docs/api/class-browserserver#browser-server\">Playwright documentation</a> for more information.</p>\n<p><a href=\"https://forum.robotframework.org/t//4306\">Comment &gt;&gt;</a></p>", "shortdoc": "Launches a new playwright Browser server with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 431}, {"name": "LocalStorage Clear", "args": [{"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove all saved data from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>      Foo    bar\n<a href=\"#LocalStorage%20Clear\" class=\"name\">LocalStorage Clear</a>\n${item} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Foo\nShould Be Equal    ${item}    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4299\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove all saved data from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 124}, {"name": "LocalStorage Get Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Get saved data from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Named key of the item in the storage.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>Assertion operator to use. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value to compare with.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Custom error message to use.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Key    ==    Value    My error\n${value} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Key\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4300\">Comment &gt;&gt;</a></p>", "shortdoc": "Get saved data from the local storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 42}, {"name": "LocalStorage Remove Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove saved data with key from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the item which shall be deleted.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>      Foo    bar\n<a href=\"#LocalStorage%20Remove%20Item\" class=\"name\">LocalStorage Remove Item</a>    Foo\n${item} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Foo\nShould Be Equal    ${item}    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4301\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove saved data with key from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 103}, {"name": "LocalStorage Set Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Save data to the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the key under which it should be saved.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>The value which shall be saved as a string.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>    Key    Value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4302\">Comment &gt;&gt;</a></p>", "shortdoc": "Save data to the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 81}, {"name": "Mouse Button", "args": [{"name": "action", "type": {"name": "MouseButtonAction", "typedoc": "MouseButtonAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: MouseButtonAction"}, {"name": "x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float | None = None"}, {"name": "y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float | None = None"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "clickCount", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int | timedelta = 0:00:00"}], "returnType": null, "doc": "<p>Clicks, presses or releases a mouse button.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>Defines if it is a mouseclick (<code>click</code>), holding down a button (<code>down</code>) or releasing it (<code>up</code>).</td>\n</tr>\n<tr>\n<td><code>x</code>, <code>y</code></td>\n<td>Coordinates to move before action is executed.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>One of <code>left</code>, <code>middle</code> or <code>up</code>. Defaults to <code>left</code>.</td>\n</tr>\n<tr>\n<td><code>clickCount</code></td>\n<td>Determine how often the button shall be clicked if action is equal to <code>click</code>. Defaults to 1.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay in Robot Framework time format between the mousedown and mouseup event. Can only be set if the action is <code>click</code>.</td>\n</tr>\n</table>\n<p><b>Attention:</b> Argument type <span class=\"name\">int</span> for 'delay' in milliseconds has been changed to <a href=\"#type-timedelta\" class=\"name\">timedelta</a> in Browser 14.0.0. Use Robot Framework time format instead. For refactoring just add 'ms' after the delay number.</p>\n<p>Delay Example:</p>\n<pre>\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>    click    100 ms\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>    click    ${dyn_delay} ms\n</pre>\n<p>Moving the mouse between holding down and releasing it, is possible with <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Hover\" class=\"name\">Hover</a>                     \"Obstacle\"           # Move mouse over the element\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>              down                 # Press mouse button down\n<a href=\"#Mouse%20Move%20Relative%20To\" class=\"name\">Mouse Move Relative To</a>    \"Obstacle\"    500    # Drag mouse\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>              up                   # Release mouse button\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4303\">Comment &gt;&gt;</a></p>", "shortdoc": "Clicks, presses or releases a mouse button.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 913}, {"name": "Mouse Move", "args": [{"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: float"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: float"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>Are absolute coordinates starting at the top left of the page.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Number of intermediate steps for the mouse event. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>    400    400\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4304\">Comment &gt;&gt;</a></p>", "shortdoc": "Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1142}, {"name": "Mouse Move Relative To", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Moves the mouse cursor relative to the selected element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>Are relative coordinates to the center of the elements bounding box.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Number of intermediate steps for the mouse event. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Mouse%20Move%20Relative%20To\" class=\"name\">Mouse Move Relative To</a>    id=indicator    -100\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4305\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves the mouse cursor relative to the selected element.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1102}, {"name": "Mouse Wheel", "args": [{"name": "deltaX", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deltaX: int"}, {"name": "deltaY", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deltaY: int"}], "returnType": null, "doc": "<p>Simulates the user rotation of a mouse wheel.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>deltaX</code> &amp; <code>deltaY</code></td>\n<td>Pixels that are scrolled horizontally &amp; vertically.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n# Before doing a mouse wheel interaction. A mouse needs to be posisioned on the browser window.\n<a href=\"#Hover\" class=\"name\">Hover</a>    body\n<a href=\"#Mouse%20Wheel\" class=\"name\">Mouse Wheel</a>    0    250\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5186\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates the user rotation of a mouse wheel.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1162}, {"name": "New Browser", "args": [{"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "firefoxUserPrefs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "firefoxUserPrefs: Dict[str, str | int | float | bool] | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "reuse_existing", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "reuse_existing: bool = True"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Create a new playwright Browser with specified options.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Returns a stable identifier for the created browser.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Opens the specified <a href=\"#type-SupportedBrowsers\">browser</a>. Defaults to chromium.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>Set to False if you want a GUI. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>args</code></td>\n<td>Additional arguments to pass to the browser instance. The list of Chromium flags can be found <a href=\"http://peter.sh/experiments/chromium-command-line-switches/\">here</a>. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>channel</code></td>\n<td>Allows to operate against the stock Google Chrome and Microsoft Edge browsers. For more details see: <a href=\"https://playwright.dev/docs/browsers#google-chrome--microsoft-edge\">Playwright documentation</a>.</td>\n</tr>\n<tr>\n<td><code>chromiumSandbox</code></td>\n<td>Enable Chromium sandboxing. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>devtools</code></td>\n<td>Chromium-only Whether to auto-open a Developer Tools panel for each tab.</td>\n</tr>\n<tr>\n<td><code>downloadsPath</code></td>\n<td>If specified, accepted downloads are downloaded into this folder. Otherwise, temporary folder is created and is deleted when browser is closed. Regarding file deletion, see the docs of <a href=\"#Download\" class=\"name\">Download</a> and <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a>.</td>\n</tr>\n<tr>\n<td><code>env</code></td>\n<td>Specifies environment variables that will be visible to the browser. Dictionary keys are variable names, values are the content. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>executablePath</code></td>\n<td>Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>firefoxUserPrefs</code> |Firefox user preferences. Learn more about the Firefox user preferences at <a href=\"https://support.mozilla.org/en-US/kb/about-config-editor-firefox\">about:config</a>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>handleSIGHUP</code></td>\n<td>Close the browser process on SIGHUP. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>handleSIGINT</code></td>\n<td>Close the browser process on Ctrl-C. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>handleSIGTERM</code></td>\n<td>Close the browser process on SIGTERM. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>ignoreDefaultArgs</code></td>\n<td>If True, Playwright does not pass its own configurations args and only uses the ones from args. If a list is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>proxy</code></td>\n<td>Network <a href=\"#type-Proxy\">Proxy</a> settings. Structure: <code>{'server': &lt;str&gt;, 'bypass': &lt;Optional[str]&gt;, 'username': &lt;Optional[str]&gt;, 'password': &lt;Optional[str]&gt;}</code></td>\n</tr>\n<tr>\n<td><code>reuse_existing</code></td>\n<td>If set to True, an existing browser instance, that matches the same arguments, will be reused. If no same configured Browser exist, a new one is started. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>slowMo</code></td>\n<td>Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to no delay.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Maximum time in Robot Framework time format to wait for the browser instance to start. Defaults to 30 seconds. Pass 0 to disable timeout.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4306\">Comment &gt;&gt;</a></p>", "shortdoc": "Create a new playwright Browser with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 360}, {"name": "New Context", "args": [{"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "acceptDownloads", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "acceptDownloads: bool = True"}, {"name": "baseURL", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "baseURL: str | None = None"}, {"name": "bypassCSP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "colorScheme", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ColorScheme", "typedoc": "ColorScheme", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "colorScheme: ColorScheme | None = None"}, {"name": "defaultBrowserType", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "defaultBrowserType: SupportedBrowsers | None = None"}, {"name": "deviceScaleFactor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "deviceScaleFactor: float | None = None"}, {"name": "extraHTTPHeaders", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] | None = None"}, {"name": "forcedColors", "type": {"name": "ForcedColors", "typedoc": "ForcedColors", "nested": [], "union": false}, "defaultValue": "none", "kind": "NAMED_ONLY", "required": false, "repr": "forcedColors: ForcedColors = none"}, {"name": "geolocation", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "GeoLocation", "typedoc": "GeoLocation", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "geolocation: GeoLocation | None = None"}, {"name": "hasTouch", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "hasTouch: bool | None = None"}, {"name": "httpCredentials", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HttpCredentials", "typedoc": "HttpCredentials", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "httpCredentials: HttpCredentials | None = None"}, {"name": "ignoreHTTPSErrors", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "isMobile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "isMobile: bool | None = None"}, {"name": "javaScriptEnabled", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "locale: str | None = None"}, {"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "offline: bool = False"}, {"name": "permissions", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "permissions: List[Permission] | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "recordHar", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordHar", "typedoc": "RecordHar", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordHar: RecordHar | None = None"}, {"name": "recordVideo", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordVideo", "typedoc": "RecordVideo", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordVideo: RecordVideo | None = None"}, {"name": "reducedMotion", "type": {"name": "ReduceMotion", "typedoc": "ReduceMotion", "nested": [], "union": false}, "defaultValue": "no_preference", "kind": "NAMED_ONLY", "required": false, "repr": "reducedMotion: ReduceMotion = no_preference"}, {"name": "screen", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "screen: Dict[str, int] | None = None"}, {"name": "serviceWorkers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ServiceWorkersPermissions", "typedoc": "ServiceWorkersPermissions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "allow", "kind": "NAMED_ONLY", "required": false, "repr": "serviceWorkers: ServiceWorkersPermissions | None = allow"}, {"name": "storageState", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "storageState: str | None = None"}, {"name": "timezoneId", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timezoneId: str | None = None"}, {"name": "tracing", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "tracing: str | None = None"}, {"name": "userAgent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "userAgent: str | None = None"}, {"name": "viewport", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "{'width': 1280, 'height': 720}", "kind": "NAMED_ONLY", "required": false, "repr": "viewport: ViewportDimensions | None = {'width': 1280, 'height': 720}"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Create a new BrowserContext with specified options.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about BrowserContext.</p>\n<p>Returns a stable identifier for the created context that can be used in <a href=\"#Switch%20Context\" class=\"name\">Switch Context</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>acceptDownloads</code></td>\n<td>Whether to automatically download all the attachments. Defaults to True where all the downloads are accepted.</td>\n</tr>\n<tr>\n<td><code>baseURL</code></td>\n<td>When using <a href=\"#Go%20To\" class=\"name\">Go To</a>, <a href=\"#Wait%20For%20Request\" class=\"name\">Wait For Request</a> or <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a> it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples: <code>baseURL=http://localhost:3000</code> and navigating to <code>/bar.html</code> results in <code>http://localhost:3000/bar.html</code>. <code>baseURL=http://localhost:3000/foo/</code> and navigating to <code>./bar.html</code> results in <code>http://localhost:3000/foo/bar.html</code>. <code>baseURL=http://localhost:3000/foo</code> (without trailing slash) and navigating to <code>./bar.html</code> results in <code>http://localhost:3000/bar.html</code>.</td>\n</tr>\n<tr>\n<td><code>bypassCSP</code></td>\n<td>Toggles bypassing page's Content-Security-Policy. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>colorScheme</code></td>\n<td>Emulates <span class=\"name\">'prefers-colors-scheme'</span> media feature, supported values are <span class=\"name\">'light'</span>, <span class=\"name\">'dark'</span>, <span class=\"name\">'no-preference'</span>.</td>\n</tr>\n<tr>\n<td><code>defaultBrowserType</code></td>\n<td>If no browser is open and <a href=\"#New%20Context\" class=\"name\">New Context</a> opens a new browser with defaults, it now uses this setting. Very useful together with <a href=\"#Get%20Device\" class=\"name\">Get Device</a> keyword.</td>\n</tr>\n<tr>\n<td><code>deviceScaleFactor</code></td>\n<td>Specify device scale factor (can be thought of as dpr). Defaults to <code>1</code>.</td>\n</tr>\n<tr>\n<td><code>extraHTTPHeaders</code></td>\n<td>A dictionary containing additional HTTP headers to be sent with every request. All header values must be strings.</td>\n</tr>\n<tr>\n<td><code>forcedColors</code></td>\n<td>Emulates <span class=\"name\">forced-colors</span> media feature, supported values are <span class=\"name\">active</span> and <a href=\"#type-None\" class=\"name\">none</a>.</td>\n</tr>\n<tr>\n<td><code>geolocation</code></td>\n<td>A dictionary containing <code>latitude</code> and <code>longitude</code> or <code>accuracy</code> to emulate. If <code>latitude</code> or <code>longitude</code> is not specified, the device geolocation won't be overriden.</td>\n</tr>\n<tr>\n<td><code>hasTouch</code></td>\n<td>Specifies if viewport supports touch events. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>httpCredentials</code></td>\n<td>Credentials for <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication\">HTTP authentication</a>.</td>\n</tr>\n<tr>\n<td><code>ignoreHTTPSErrors</code></td>\n<td>Whether to ignore HTTPS errors during navigation. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>isMobile</code></td>\n<td>Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>javaScriptEnabled</code></td>\n<td>Whether or not to enable JavaScript in the context. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>locale</code></td>\n<td>Specify user locale, for example <code>en-GB</code>, <code>de-DE</code>, etc.</td>\n</tr>\n<tr>\n<td><code>offline</code></td>\n<td>Toggles browser's offline mode. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>permissions</code></td>\n<td>A list containing permissions to grant to all pages in this context. All permissions that are not listed here will be automatically denied.</td>\n</tr>\n<tr>\n<td><code>proxy</code></td>\n<td>Network proxy settings to use with this context. Defaults to None. <b>NOTE:</b> For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example <code>proxy={ server: '<a href=\"http://per-context\">http://per-context</a>' }</code>.</td>\n</tr>\n<tr>\n<td><code>recordHar</code></td>\n<td>Enables <a href=\"http://www.softwareishard.com/blog/har-12-spec/\">HAR</a> recording for all pages into to a file. Must be path to file, example ${OUTPUT_DIR}/har.file. If not specified, the HAR is not recorded. Make sure to await context to close for the to be saved.</td>\n</tr>\n<tr>\n<td><code>recordVideo</code></td>\n<td>Enables video recording for all pages into a folder. If not specified videos are not recorded. Make sure to close context for videos to be saved. Video is not support in remote browsers.</td>\n</tr>\n<tr>\n<td><code>reduceMotion</code></td>\n<td>Emulates <span class=\"name\">prefers-reduced-motion</span> media feature, supported values are <span class=\"name\">reduce</span>, <span class=\"name\">no-preference</span>.</td>\n</tr>\n<tr>\n<td><code>screen</code></td>\n<td>Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set. Example {'width': 414, 'height': 896}</td>\n</tr>\n<tr>\n<td><code>serviceWorkers</code></td>\n<td>Whether to allow sites to register Service workers. Defaults to 'allow'.</td>\n</tr>\n<tr>\n<td><code>storageState</code></td>\n<td>Restores the storage stated created by the <a href=\"#Save%20Storage%20State\" class=\"name\">Save Storage State</a> keyword. Must mbe full path to the file.</td>\n</tr>\n<tr>\n<td><code>timezoneId</code></td>\n<td>Changes the timezone of the context. See <a href=\"https://source.chromium.org/chromium/chromium/src/+/master:third_party/icu/source/data/misc/metaZones.txt\">ICU`s metaZones.txt</a> for a list of supported timezone IDs.</td>\n</tr>\n<tr>\n<td><code>tracing</code></td>\n<td>File name where the <a href=\"https://playwright.dev/docs/api/class-tracing/\">tracing</a> file is saved. Example trace.zip will be saved to ${OUTPUT_DIR}/traces.zip. Temporary trace files will be saved to ${OUTPUT_DIR}/Browser/traces. If file name is defined, tracing will be enabled for all pages in the context. Tracing is automatically closed when context is closed. Temporary trace files will be automatically deleted at start of each test execution. Trace file can be opened after the test execution by running command from shell: <code>rfbrowser show-trace /path/to/trace.zip</code>.</td>\n</tr>\n<tr>\n<td><code>userAgent</code></td>\n<td>Specific user agent to use in this context.</td>\n</tr>\n<tr>\n<td><code>viewport</code></td>\n<td>A dictionary containing <code>width</code> and <code>height</code>. Emulates consistent viewport for each page. Defaults to 1280x720. null disables the default viewport. If <code>width</code> and <code>height</code> is  <code>0</code>, the viewport will scale with the window.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nTest an iPhone\n    ${device}=    <a href=\"#Get%20Device\" class=\"name\">Get Device</a>    iPhone X\n    <a href=\"#New%20Context\" class=\"name\">New Context</a>    &amp;{device}        # unpacking here with &amp;\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://example.com\">http://example.com</a>\n</pre>\n<p>A BrowserContext is the Playwright object that controls a single browser profile. Within a context caches and cookies are shared. See <a href=\"https://playwright.dev/docs/api/class-browser#browsernewcontextoptions\">Playwright browser.newContext</a> for a list of supported options.</p>\n<p>If there's no open Browser this keyword will open one. Does not create pages.</p>\n<p><a href=\"https://forum.robotframework.org/t//4307\">Comment &gt;&gt;</a></p>", "shortdoc": "Create a new BrowserContext with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 517}, {"name": "New Page", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": {"name": "NewPageDetails", "typedoc": "NewPageDetails", "nested": [], "union": false}, "doc": "<p>Open a new Page.</p>\n<p>A Page is the Playwright equivalent to a tab. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page concept.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Optional URL to navigate the page to. The url should include protocol, e.g. <span class=\"name\">https://</span></td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Returns <a href=\"#type-NewPageDetails\" class=\"name\">NewPageDetails</a> as dictionary for created page. <a href=\"#type-NewPageDetails\" class=\"name\">NewPageDetails</a> (dict) contains the keys <code>page_id</code> and <code>video_path</code>. <code>page_id</code> is a stable identifier for the created page. <code>video_path</code> is path to the created video or empty if video is not created.</p>\n<p>When a <a href=\"#New%20Page\" class=\"name\">New Page</a> is called without an open browser, <a href=\"#New%20Browser\" class=\"name\">New Browser</a> and <a href=\"#New%20Context\" class=\"name\">New Context</a> are executed with default values first.</p>\n<p><a href=\"https://forum.robotframework.org/t//4308\">Comment &gt;&gt;</a></p>", "shortdoc": "Open a new Page.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 861}, {"name": "New Persistent Context", "args": [{"name": "userDataDir", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "userDataDir: str = "}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "acceptDownloads", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "acceptDownloads: bool = True"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "baseURL", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "baseURL: str | None = None"}, {"name": "bypassCSP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "colorScheme", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ColorScheme", "typedoc": "ColorScheme", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "colorScheme: ColorScheme | None = None"}, {"name": "defaultBrowserType", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "defaultBrowserType: SupportedBrowsers | None = None"}, {"name": "deviceScaleFactor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "deviceScaleFactor: float | None = None"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "extraHTTPHeaders", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] | None = None"}, {"name": "forcedColors", "type": {"name": "ForcedColors", "typedoc": "ForcedColors", "nested": [], "union": false}, "defaultValue": "none", "kind": "NAMED_ONLY", "required": false, "repr": "forcedColors: ForcedColors = none"}, {"name": "geolocation", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "GeoLocation", "typedoc": "GeoLocation", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "geolocation: GeoLocation | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "hasTouch", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "hasTouch: bool | None = None"}, {"name": "httpCredentials", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HttpCredentials", "typedoc": "HttpCredentials", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "httpCredentials: HttpCredentials | None = None"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "ignoreHTTPSErrors", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "isMobile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "isMobile: bool | None = None"}, {"name": "javaScriptEnabled", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "locale: str | None = None"}, {"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "offline: bool = False"}, {"name": "permissions", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "permissions: List[Permission] | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "recordHar", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordHar", "typedoc": "RecordHar", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordHar: RecordHar | None = None"}, {"name": "recordVideo", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordVideo", "typedoc": "RecordVideo", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordVideo: RecordVideo | None = None"}, {"name": "reducedMotion", "type": {"name": "ReduceMotion", "typedoc": "ReduceMotion", "nested": [], "union": false}, "defaultValue": "no_preference", "kind": "NAMED_ONLY", "required": false, "repr": "reducedMotion: ReduceMotion = no_preference"}, {"name": "screen", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "screen: Dict[str, int] | None = None"}, {"name": "serviceWorkers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ServiceWorkersPermissions", "typedoc": "ServiceWorkersPermissions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "allow", "kind": "NAMED_ONLY", "required": false, "repr": "serviceWorkers: ServiceWorkersPermissions | None = allow"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "timezoneId", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timezoneId: str | None = None"}, {"name": "tracing", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "tracing: str | None = None"}, {"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "url: str | None = None"}, {"name": "userAgent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "userAgent: str | None = None"}, {"name": "viewport", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "{'width': 1280, 'height': 720}", "kind": "NAMED_ONLY", "required": false, "repr": "viewport: ViewportDimensions | None = {'width': 1280, 'height': 720}"}], "returnType": null, "doc": "<p>Open a new <a href=\"https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context\">persistent context</a>.</p>\n<p><a href=\"#New%20Persistent%20Context\" class=\"name\">New Persistent Context</a> does basically executes <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> in one step with setting a profile at the same time.</p>\n<p>This keyword returns a tuple of browser id, context id and page details. (New in Browser 15.0.0)</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>userDataDir</code></td>\n<td>Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox. Note that Chromium's user data directory is the parent directory of the \"Profile Path\" seen at <a href=\"chrome://version\">chrome://version</a>. Pass an empty string to use a temporary directory instead.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser type to use. Default is Chromium.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>Whether to run browser in headless mode. Defaults to <code>True</code>.</td>\n</tr>\n<tr>\n<td>other arguments</td>\n<td>Please see <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> for more information about the other arguments.</td>\n</tr>\n</table>\n<p>If you want to use extensions you need to download the extension as a .zip, enable loading the extension, and load the extensions using chromium arguments like below. Extensions only work with chromium and with a headful browser.</p>\n<pre>\n${launch_args}=  Set Variable  [\"--disable-extensions-except=./ublock/uBlock0.chromium\", \"--load-extension=./ublock/uBlock0.chromium\"]\n${browserId}  ${contextId}  ${pageDetails}=  <a href=\"#New%20Persistent%20Context\" class=\"name\">New Persistent Context</a>  browser=chromium  headless=False  url=https://robocon,io  args=${launch_args}\n</pre>\n<p>Check <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> for the specific argument docs.</p>\n<p><a href=\"https://forum.robotframework.org/t//4309\">Comment &gt;&gt;</a></p>", "shortdoc": "Open a new [https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context | persistent context].", "tags": [], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 634}, {"name": "Open Browser", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = False"}, {"name": "pause_on_failure", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pause_on_failure: bool = True"}, {"name": "bypassCSP", "type": null, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bypassCSP=True"}], "returnType": null, "doc": "<p>Opens a new browser instance. Use this keyword for quick experiments or debugging sessions.</p>\n<p>Use <a href=\"#New%20Page\" class=\"name\">New Page</a> directly instead of <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> for production and automated execution. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Creates a new browser, context and page with specified settings.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Navigates to URL if provided. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Specifies which browser to use. The supported browsers are listed in the table below.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>If set to False, a GUI is provided otherwise it is hidden. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>pause_on_failure</code></td>\n<td>Stop execution when failure detected and leave browser open. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>bypassCSP</code></td>\n<td>Defaults to bypassing CSP and enabling custom script attach to the page.</td>\n</tr>\n</table>\n<p>Browsers:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td><a href=\"https://www.mozilla.org/en-US/firefox/new\">Firefox</a></td>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td><a href=\"https://www.chromium.org/Home\">Chromium</a></td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td><a href=\"https://webkit.org/\">webkit</a></td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4310\">Comment &gt;&gt;</a></p>", "shortdoc": "Opens a new browser instance. Use this keyword for quick experiments or debugging sessions.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 76}, {"name": "Press Keys", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "keys", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "returnType": null, "doc": "<p>Types the given key combination into element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*keys</code></td>\n<td>Keys to be press after each other. Using + to chain combine modifiers with a single keypress <code>Control+Shift+T</code> is supported.</td>\n</tr>\n</table>\n<p>Supports values like \"a, b\" which will be automatically typed.</p>\n<p>Also supports identifiers for keys like <code>ArrowLeft</code> or <code>Backspace</code>.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See playwright's documentation for a more comprehensive list of supported input keys. <a href=\"https://playwright.dev/docs/api/class-page#page-press\">Playwright docs for press.</a></p>\n<p>Example:</p>\n<pre>\n# Keyword         Selector                    *Keys\n<a href=\"#Press%20Keys\" class=\"name\">Press Keys</a>      //*[@id=\"username_field\"]    h    e   l   o   ArrowLeft   l\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4311\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given key combination into element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 255}, {"name": "Promise To", "args": [{"name": "kw", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kw: str"}, {"name": "args", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "returnType": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Wrap a Browser library keyword and make it a promise.</p>\n<p>Promised keyword is executed and started on background. Test execution continues without waiting for <code>kw</code> to finish.</p>\n<p>Returns reference to the promised keyword.</p>\n<p><code>kw</code> Keyword that will work async on background.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>kw</code></td>\n<td>Keyword that will work async on background.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>Keyword arguments as normally used.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${promise}=     <a href=\"#Promise%20To\" class=\"name\">Promise To</a>            Wait For Response     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>           \\#delayed_request\n${body}=        <a href=\"#Wait%20For\" class=\"name\">Wait For</a>              ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4312\">Comment &gt;&gt;</a></p>", "shortdoc": "Wrap a Browser library keyword and make it a promise.", "tags": ["Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 39}, {"name": "Promise To Upload File", "args": [{"name": "path", "type": {"name": "PathLike", "typedoc": "Path", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "returnType": null, "doc": "<p>Returns a promise that resolves when file from <code>path</code> has been uploaded.</p>\n<p>Fails if the upload has not happened during timeout.</p>\n<p>Upload file from <code>path</code> into next file chooser dialog on page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Path to file to be uploaded.</td>\n</tr>\n</table>\n<p>Example use:</p>\n<pre>\n${promise}=    <a href=\"#Promise%20To%20Upload%20File\" class=\"name\">Promise To Upload File</a>    ${CURDIR}/test_upload_file.txt\n<a href=\"#Click\" class=\"name\">Click</a>          id=open_file_chooser_button\n${upload_result}=    <a href=\"#Wait%20For\" class=\"name\">Wait For</a>    ${promise}\n</pre>\n<p>Alternatively, you can use <a href=\"#Upload%20File%20By%20Selector\" class=\"name\">Upload File By Selector</a> keyword.</p>\n<p><a href=\"https://forum.robotframework.org/t//4313\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise that resolves when file from ``path`` has been uploaded.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 268}, {"name": "Promise To Wait For Download", "args": [{"name": "saveAs", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}, {"name": "wait_for_finished", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_for_finished: bool = True"}, {"name": "download_timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "download_timeout: timedelta | None = None"}], "returnType": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Returns a promise that waits for next download event on page.</p>\n<p>To enable downloads context's <code>acceptDownloads</code> needs to be true.</p>\n<p>With default filepath downloaded files are deleted when Context the download happened in is closed.</p>\n<p>If browser is connected remotely with <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a> then <code>saveAs</code> must be set to store it locally where the browser runs!</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>Defines path where the file is saved persistently. File will also temporarily be saved in playwright context's default download location. If empty, generated unique path (GUID) is used and file is deleted when the context is closed.</td>\n</tr>\n<tr>\n<td><code>wait_for_finished</code></td>\n<td>If true, promise will wait for download to finish. If false, promise will resolve immediately after download has started.</td>\n</tr>\n<tr>\n<td><code>download_timeout</code></td>\n<td>Maximum time to wait for download to finish, if <code>wait_for_finished</code> is set to <code>True</code>. If download is not finished during this time, keyword will be fail.</td>\n</tr>\n</table>\n<p>Keyword returns dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> which contains downloaded file path and suggested filename as well as state and downloadID. Example:</p>\n<pre>\n{\n  \"saveAs\": \"/tmp/robotframework-browser/downloads/2f1b3b7c-1b1b-4b1b-9b1b-1b1b1b1b1b1b\",\n  \"suggestedFilename\": \"downloaded_file.txt\"\n}\n</pre>\n<p>The keyword <a href=\"#New%20Browser\" class=\"name\">New Browser</a> has a <code>downloadsPath</code> setting which can be used to set the default download directory. If <span class=\"name\">saveAs</span> is set to a relative path, the file will be saved relative to the browser's <code>downloadsPath</code> setting or if that is not set, relative to the Playwright's working directory. If <code>saveAs</code> is set to an absolute path, the file will be saved to that absolute path independent of <code>downloadsPath</code>.</p>\n<p>If the URL for the file to download shall be used, <a href=\"#Download\" class=\"name\">Download</a> keyword may be a simpler alternative way to download the file.</p>\n<p>Waited promise returns a dictionary which contains saveAs and suggestedFilename as keys. The saveAs contains where the file is downloaded and suggestedFilename contains the name suggested name for the download. The suggestedFilename is typically computed by the browser from the Content-Disposition response header or the download attribute. See the spec on <a href=\"https://html.spec.whatwg.org/#downloading-resources\">whatwg</a>. Different browsers can use different logic for computing it.</p>\n<p>Example usage:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>            acceptDownloads=True\n<a href=\"#New%20Page\" class=\"name\">New Page</a>               ${LOGIN_URL}\n${dl_promise}          <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a>    /path/to/download/file.name\n<a href=\"#Click\" class=\"name\">Click</a>                  id=file_download\n${file_obj}=           <a href=\"#Wait%20For\" class=\"name\">Wait For</a>    ${dl_promise}\nFile Should Exist      ${file_obj}[saveAs]\nShould Be True         ${file_obj.suggestedFilename}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4314\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise that waits for next download event on page.", "tags": ["BrowserControl", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 140}, {"name": "Record Selector", "args": [{"name": "label", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label: str | None = None"}], "returnType": null, "doc": "<p>Record the selector that is under mouse.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>label</code></td>\n<td>text to show when on the box in the page while recording.</td>\n</tr>\n</table>\n<p>Focus on the page and move mouse over the element you want to select.</p>\n<p>Example:</p>\n<pre>\n${selector} =    <a href=\"#Record%20Selector\" class=\"name\">Record Selector</a>   Button\n<a href=\"#Click\" class=\"name\">Click</a>  ${selector}\n${selector2} =    <a href=\"#Record%20Selector\" class=\"name\">Record Selector</a>  Page header\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>  ${selector2}  ==  Expected text\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4315\">Comment &gt;&gt;</a></p>", "shortdoc": "Record the selector that is under mouse.", "tags": ["PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 450}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}, {"name": "args", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args: str"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Global", "kind": "NAMED_ONLY", "required": false, "repr": "scope: Scope = Global"}], "returnType": {"name": "DelayedKeyword", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Sets the keyword to execute, when a Browser keyword fails.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>keyword</code></td>\n<td>The name of a keyword that will be executed if a Browser keyword fails. It is possible to use any available keyword, including user keywords or keywords from other libraries.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>The arguments to the keyword if any.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of this setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <span class=\"name\">Scope Settings</span> for more details.</td>\n</tr>\n</table>\n<p>The initial keyword to use is set when <a href=\"#Importing\" class=\"name\">importing</a> the library, and the keyword that is used by default is <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.</p>\n<p>It is possible to use string <code>NONE</code> or any other robot falsy name, case-insensitively, as well as Python <code>None</code> to disable this feature altogether.</p>\n<p>This keyword returns an object which contains the the previously registered failure keyword. The return value can be always used to restore the original value later. The returned object contains keyword name and the possible arguments used to for the keyword.</p>\n<p>If <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> keyword, without arguments, is register as run on failure keyword, then filename argument default value is not used as screenshot file name. Instead, ${TEST NAME}_FAILURE_SCREENSHOT_{index} is used as file name. If there is need to use the filename argument default value, use robotframework-browser-screenshot-{index} as filename argument value.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    # Uses ${TEST NAME}_FAILURE_SCREENSHOT_{index} as filename\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    robotframework-browser-screenshot-{index}    # Uses robotframework-browser-screenshot-{index} as filename\n${previous kw}=    <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    NONE    # Disables run on failure functionality.\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    ${previous kw}\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    fullPage=True\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    failure-{index}    fullPage=True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4316\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the keyword to execute, when a Browser keyword fails.", "tags": ["Config"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/runonfailure.py", "lineno": 31}, {"name": "Reload", "args": [], "returnType": null, "doc": "<p>Reloads current active page.</p>\n<p><a href=\"https://forum.robotframework.org/t//4317\">Comment &gt;&gt;</a></p>", "shortdoc": "Reloads current active page.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 513}, {"name": "Save Storage State", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Saves the current active context storage state to a file.</p>\n<p>Web apps use cookie-based or token-based authentication, where authenticated state is stored as <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies\">cookies</a> or in <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Storage\">local storage</a>. Keyword retrieves the storage state from authenticated contexts and save it to disk. Then <a href=\"#New%20Context\" class=\"name\">New Context</a> can be created with prepopulated state.</p>\n<p>Please note state file may contains secrets and should not be shared with people outside of your organisation.</p>\n<p>The file is created in ${OUTPUTDIR}/browser/state folder and file(s) are automatically deleted when new test execution starts. File path is returned by the keyword.</p>\n<p>Example:</p>\n<pre>\nTest Case\n    <a href=\"#New%20Context\" class=\"name\">New context</a>\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"https://login.page.html\">https://login.page.html</a>\n    #  Perform login\n    <a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    id=username    $username\n    <a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    id=password    $password\n    <a href=\"#Click\" class=\"name\">Click</a>    id=button\n    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=header    ==    Something\n    #  Save storage to disk\n    ${state_file} =    <a href=\"#Save%20Storage%20State\" class=\"name\">Save Storage State</a>\n    #  Create new context with saved state\n    <a href=\"#New%20Context\" class=\"name\">New context</a>    storageState=${state_file}\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"https://login.page.html\">https://login.page.html</a>\n    #  Login is not needed because authentication is read from state file\n    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=header    ==    Something\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4318\">Comment &gt;&gt;</a></p>", "shortdoc": "Saves the current active context storage state to a file.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1493}, {"name": "Scroll By", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "vertical", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "height", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = height"}, {"name": "horizontal", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = 0"}, {"name": "behavior", "type": {"name": "ScrollBehavior", "typedoc": "ScrollBehavior", "nested": [], "union": false}, "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "returnType": null, "doc": "<p>Scrolls an element or the page relative from current position by the given values.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. If the selector is <code>${None}</code> or <code>${Empty}</code> the page itself is scrolled. To ensure an element is in view use <a href=\"#Hover\" class=\"name\">Hover</a> instead. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>vertical</code></td>\n<td>defines how far and in which direction to scroll vertically. It can be a positive or negative number. Positive scrolls down, like <code>50</code>, negative scrolls up, like <code>-50</code>. It can be a percentage value of the absolute scrollable size, like <code>9.95%</code> or negative like <code>-10%</code>. It can be the string <code>height</code> to defining to scroll exactly one visible height down or up with <code>-height</code>. <i>Be aware that some pages do lazy loading and load more content once you scroll down.</i> The percentage of the current scrollable height is used and may change.</td>\n</tr>\n<tr>\n<td><code>horizontal</code></td>\n<td>defines where to scroll horizontally. Works same as vertical but defines positive values for right and negative values for left. <code>width</code> defines to scroll exactly one visible range to the right.</td>\n</tr>\n<tr>\n<td><code>behavior</code></td>\n<td>defines whether the scroll happens directly or it scrolls smoothly.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4319\">Comment &gt;&gt;</a></p>", "shortdoc": "Scrolls an element or the page relative from current position by the given values.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 589}, {"name": "Scroll To", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "vertical", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "top", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = top"}, {"name": "horizontal", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = left"}, {"name": "behavior", "type": {"name": "ScrollBehavior", "typedoc": "ScrollBehavior", "nested": [], "union": false}, "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "returnType": null, "doc": "<p>Scrolls an element or the page to an absolute position based on given coordinates.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. If the selector is <code>${None}</code> or <code>${Empty}</code> the page itself is scrolled. To ensure an element is in view use <a href=\"#Hover\" class=\"name\">Hover</a> instead. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>vertical</code></td>\n<td>defines where to scroll vertically. It can be a positive number, like <code>300</code>. It can be a percentage value of the absolute scrollable size, like <code>50%</code>. It can be a string defining that top or the bottom of the scroll area. &lt; <code>top</code></td>\n<td><code>bottom</code> &gt; <i>Be aware that some pages do lazy loading and load more content once you scroll down.</i> Bottom defines the current known bottom coordinate.</td>\n</tr>\n<tr>\n<td><code>horizontal</code></td>\n<td>defines where to scroll horizontally. Works same as vertical but defines &lt; <code>left</code></td>\n<td><code>right</code> &gt; as start and end.</td>\n</tr>\n<tr>\n<td><code>behavior</code></td>\n<td>defines whether the scroll happens directly or it scrolls smoothly.</td>\n<td></td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4320\">Comment &gt;&gt;</a></p>", "shortdoc": "Scrolls an element or the page to an absolute position based on given coordinates.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 552}, {"name": "Scroll To Element", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is already visible.</p>\n<p><a href=\"https://forum.robotframework.org/t//4321\">Comment &gt;&gt;</a></p>", "shortdoc": "This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 626}, {"name": "Select Options By", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "type": {"name": "SelectAttribute", "typedoc": "SelectAttribute", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: SelectAttribute"}, {"name": "values", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "doc": "<p>Selects options from select element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the <code>&lt;select&gt;</code> tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>attribute</code></td>\n<td>Attribute to select options by. Can be <code>value</code>, <code>label</code>, <code>text</code> or <code>index</code>. Where <code>label</code> and <code>text</code> are same.</td>\n</tr>\n<tr>\n<td><code>*values</code></td>\n<td>Values to select.</td>\n</tr>\n</table>\n<p>Returns list of options which keyword was able to select. The type of list item matches to <code>attribute</code> definition. Example if <code>attribute</code> equals to <span class=\"name\">label</span> returned list contains label values. Or in case of <span class=\"name\">index</span> it contains list of selected indexes.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>If no values to select are passed will deselect options in element.</p>\n<p>Example:</p>\n<pre>\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=preferred_channel]    label    Direct mail\nList Should Contain Value    ${selected}    Direct mail\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=interests]    value    males    females    others\nList Should Contain Value    ${selected}    males\nList Should Contain Value    ${selected}    females\nList Should Contain Value    ${selected}    others\nLength Should Be    ${selected}    3\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=possible_channels]    index    0    2\nList Should Contain Value    ${selected}    0\nList Should Contain Value    ${selected}    2\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=interests]    text     Males    Females\nList Should Contain Value    ${selected}    Males\nList Should Contain Value    ${selected}    Females\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4322\">Comment &gt;&gt;</a></p>", "shortdoc": "Selects options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 693}, {"name": "SessionStorage Clear", "args": [{"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove all saved data from the session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    mykey3    myvalue3\n <a href=\"#SessionStorage%20Clear\" class=\"name\">SessionStorage Clear</a>\n<a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>    mykey3    ==    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4323\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove all saved data from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 229}, {"name": "SessionStorage Get Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Get saved data from from session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Named key of the item in the storage.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>Assertion operator to use. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value to compare with.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Custom error message to use.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    key2    value2\n${item} =    <a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>    key1\nShould Be Equal    ${item}    value2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4324\">Comment &gt;&gt;</a></p>", "shortdoc": "Get saved data from from session storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 146}, {"name": "SessionStorage Remove Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove saved data with key from the session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the item which shall be deleted.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>       mykey2    myvalue2\n<a href=\"#SessionStorage%20Remove%20Item\" class=\"name\">SessionStorage Remove Item</a>    mykey2\n<a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>       mykey2    ==    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4325\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove saved data with key from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 206}, {"name": "SessionStorage Set Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Save data to session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the key under which it should be saved.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>The value which shall be saved as a string.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    key2    value2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4326\">Comment &gt;&gt;</a></p>", "shortdoc": "Save data to session storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 185}, {"name": "Set Assertion Formatters", "args": [{"name": "formatters", "type": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "FormatterKeywords", "typedoc": "FormatterKeywords", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "FormatingRules", "typedoc": "FormatingRules", "nested": [], "union": false}, {"name": "LambdaFunction", "typedoc": "LambdaFunction", "nested": [], "union": false}], "union": true}], "union": false}], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "formatters: Dict[FormatterKeywords, List[FormatingRules | LambdaFunction]]"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": false}, "doc": "<p>Set keywords formatters for assertions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>formatters</code></td>\n<td>Dictionary of keywords and formatters, where key is the keyword name where formatters are applied. Dictionary value is a list of formatter which are applied. Formatters for a defined keyword are always overwritten. An empty list will clear all formatters for the keyword. If <code>formatters</code> is empty dictionary, then all formatters are cleared from all keywords.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Defines the lifetime of the formatter, possible values are Global, Suite and Test.</td>\n</tr>\n</table>\n<p>See type documentation of <span class=\"name\">FormatterTypes</span> for more information.</p>\n<p>It is possible to define own formatters as lambda functions.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Set%20Assertion%20Formatters\" class=\"name\">Set Assertion Formatters</a>    {\"Get Text\": [\"strip\", \"normalize spaces\"]}  # This will convert all kind of spaces to single space and removes spaces from start and end of the string.\n<a href=\"#Set%20Assertion%20Formatters\" class=\"name\">Set Assertion Formatters</a>    {\"Get Title\": [\"apply to expected\",\"lambda x: x.replace(' ', '')\"]}  # This will remove all spaces from the string.\n${value} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    //div    ==    ${SPACE}Expected${SPACE * 2}Text\nShould Be Equal    ${value}    Expected Text\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4327\">Comment &gt;&gt;</a></p>", "shortdoc": "Set keywords formatters for assertions.", "tags": ["Config"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/formatter.py", "lineno": 98}, {"name": "Set Browser Timeout", "args": [{"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the timeout used by most input and getter keywords.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout of it is for current playwright context and for new contexts. Supports Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">time format</a> . Returns the previous value of the timeout.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <span class=\"name\">Scope Settings</span> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${old_timeout} =    <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    1m 30 seconds\nClick     //button\n<a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    ${old_timeout}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4328\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the timeout used by most input and getter keywords.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 316}, {"name": "Set Default Run Before Unload", "args": [{"name": "runBeforeUnload", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "runBeforeUnload: bool"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Set default runBeforeUnload value when <a href=\"#Close%20Page\" class=\"name\">Close Page</a> is called indirectly.</p>\n<p>Close Page is called indirectly when <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html#Automatic%20page%20and%20context%20closing\">automatic page closing</a> is done. The default value is false and this keyword can be used to change value. Returns the old runBeforeUnload value.</p>\n<p><a href=\"https://forum.robotframework.org/t/6203\">Comment &gt;&gt;</a></p>", "shortdoc": "Set default runBeforeUnload value when `Close Page` is called indirectly.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 308}, {"name": "Set Geolocation", "args": [{"name": "latitude", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude: float"}, {"name": "longitude", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude: float"}, {"name": "accuracy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "accuracy: float | None = None"}], "returnType": null, "doc": "<p>Updated the correct Context's geolocation.</p>\n<p>Latitude can be between -90 and 90 and longitude can be between -180 and 180. Accuracy of the location must be positive number and defaults to 0. When creating context, grant <code>geolocation</code> permission for pages to read its geolocation.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>latitude</code></td>\n<td>Latitude between -90 and 90.</td>\n</tr>\n<tr>\n<td><code>longitude</code></td>\n<td>Longitude between -180 and 180.</td>\n</tr>\n<tr>\n<td><code>accuracy</code></td>\n<td>Non-negative accuracy value. Defaults to 0.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${permissions} =    Create List    geolocation\n<a href=\"#New%20Context\" class=\"name\">New Context</a>    permissions=${permissions}\n<a href=\"#Set%20Geolocation\" class=\"name\">Set Geolocation</a>    60.173708, 24.982263    3    # Points to Korkeasaari in Helsinki.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4329\">Comment &gt;&gt;</a></p>", "shortdoc": "Updated the correct Context's geolocation.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 482}, {"name": "Set Offline", "args": [{"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "offline: bool = True"}], "returnType": null, "doc": "<p>Toggles current Context's offline emulation.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>offline</code></td>\n<td>Toggles the offline mode. Set to False to switch back to online mode. Defaults to True.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4330\">Comment &gt;&gt;</a></p>", "shortdoc": "Toggles current Context's offline emulation.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 469}, {"name": "Set Retry Assertions For", "args": [{"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the timeout used in retrying assertions when they fail.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Assertion retry timeout will determine how long Browser library will retry an assertion to be true.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>The other keyword <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser timeout</a> controls how long Playwright will perform waiting in the node side for Elements to fulfill the requirements of the specific keyword.</p>\n<p>Returns the previous value of the assertion retry timeout.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    10 seconds\n${old} =    <a href=\"#Set%20Retry%20Assertions%20For\" class=\"name\">Set Retry Assertions For</a>    30s\n<a href=\"#Get%20Title\" class=\"name\">Get Title</a>    ==    Login Page\n<a href=\"#Set%20Retry%20Assertions%20For\" class=\"name\">Set Retry Assertions For</a>    ${old}\n</pre>\n<p>Example waits 10 seconds on Playwright to get the page title and library will retry 30 seconds to make sure that title is correct.</p>\n<p><a href=\"https://forum.robotframework.org/t//4331\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the timeout used in retrying assertions when they fail.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 348}, {"name": "Set Selector Prefix", "args": [{"name": "prefix", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "prefix: str | None"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the prefix for all selectors in the given scope.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>prefix</code></td>\n<td>Prefix for all selectors. Prefix and selector will be separated by a single space. Use <code>${None}</code> or <code>${EMPTY}</code> to disable the prefix.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Returns the previous value of the prefix.</p>\n<p>Example:</p>\n<pre>\n${old} =    <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>    iframe#embedded_page &gt;&gt;&gt;\n<a href=\"#Click\" class=\"name\">Click</a>    button#login_btn       # Clicks on button inside iframe with the selector <code>iframe#embedded_page &gt;&gt;&gt; button#login_btn</code>\n<a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>    ${old}\n</pre>\n<p>Example will click on button with id <code>login_btn</code> inside iframe with id <code>embedded_page</code>. The resulting selector will be <code>iframe#embedded_page &gt;&gt;&gt; button#login_btn</code>.</p>\n<p>The effect of this prefix can be disable by prefixing any selector with <code>!prefix </code>, with a trailing space, for single keyword calls. i.e. <code>!prefix id=btn_outside_a_frame</code></p>\n<p><a href=\"#Get%20Element\" class=\"name\">Get Element</a>, <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a>, <a href=\"#Get%20Element%20By\" class=\"name\">Get Element By</a> and <a href=\"#Get%20Element%20By%20Role\" class=\"name\">Get Element By Role</a> do automatically prefix the returned selector with <code>!prefix </code> so that it is possible to use them directly without setting the prefix to <code>${None}</code> before usage.</p>\n<p><a href=\"https://forum.robotframework.org/t//4741\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the prefix for all selectors in the given scope.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 379}, {"name": "Set Strict Mode", "args": [{"name": "mode", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "mode: bool"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": null, "doc": "<p>Controls library strict mode.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>mode</code></td>\n<td>When set to <code>True</code>, keywords that are searching elements will use Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-query-selector\">strict mode</a>. Keyword changes library strict mode value and keyword also return the previous strict mode value.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${old_mode} =      Set Strict Mode    False\nGet Text           //input            # Does not fail if selector points to one or more elements\nSet Strict Mode    ${old_mode}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4332\">Comment &gt;&gt;</a></p>", "shortdoc": "Controls library strict mode.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/strict_mode.py", "lineno": 20}, {"name": "Set Viewport Size", "args": [{"name": "width", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}], "returnType": null, "doc": "<p>Sets current Pages viewport size to specified dimensions.</p>\n<p>In the case of multiple pages in a single browser, each page can have its own viewport size. However, <a href=\"#New%20Context\" class=\"name\">New Context</a> allows to set viewport size (and more) for all later opened pages in the context at once.</p>\n<p><a href=\"#Set%20Viewport%20Size\" class=\"name\">Set Viewport Size</a> will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport size before navigating to the page with <a href=\"#New%20Context\" class=\"name\">New Context</a> before opening the page itself.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>Sets the width size.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>Sets the height size.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4333\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets current Pages viewport size to specified dimensions.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 443}, {"name": "Show Keyword Banner", "args": [{"name": "show", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "show: bool = True"}, {"name": "style", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = "}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}], "union": false}, "doc": "<p>Controls if the keyword banner is shown on page or not.</p>\n<p>Keyword call banner is a css overlay that shows the currently executed keyword directly on page. This is useful for debugging and for showing the test execution on video recordings. By default, the banner is not shown on page except when running in presenter mode.</p>\n<p>The banner can be controlled by an import setting of Browser library. (see <a href=\"#Importing\" class=\"name\">Importing</a> section)</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>show</code></td>\n<td>If <span class=\"name\">True</span> banner is shown on page. If <span class=\"name\">False</span> banner is not shown on page. If <a href=\"#type-None\" class=\"name\">None</a> banner is shown on page only when running in presenter mode.</td>\n</tr>\n<tr>\n<td><code>style</code></td>\n<td>Additional css styles to be applied to the banner. These styles are css settings and may override the existing ones for the banner.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nShow Keyword Banner     True    top: 5px; bottom: auto; left: 5px; background-color: #00909077; font-size: 9px; color: black;   # Show banner on top left corner with custom styles\nShow Keyword Banner     False   # Hide banner\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4716\">Comment &gt;&gt;</a></p>", "shortdoc": "Controls if the keyword banner is shown on page or not.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 412}, {"name": "Switch Browser", "args": [{"name": "id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the currently active Browser to another open Browser.</p>\n<p>Returns a stable identifier for the previous browser. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>id</td>\n<td>The id of the browser to switch to. Example: <code>browser=96207191-8147-44e7-b9ac-5e04f2709c1d</code>. A browser id is returned by <a href=\"#New%20Browser\" class=\"name\">New Browser</a> when it is started or can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4334\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the currently active Browser to another open Browser.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1181}, {"name": "Switch Context", "args": [{"name": "id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the active BrowserContext to another open context.</p>\n<p>Returns a stable identifier for the previous context. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The id of the context to switch to. Example: <code>context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089</code>. A context id is returned by <a href=\"#New%20Context\" class=\"name\">New Context</a> when it is started or can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser in which to search for that context. <code>CURRENT</code> for the currently active browser, <code>ALL</code> to search in all open browsers or the id of the browser where to switch context.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${first_context} =     <a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#New%20Page\" class=\"name\">New Page</a>             ${URL1}\n${second_context} =    <a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#New%20Page\" class=\"name\">New Page</a>             ${URL2}\n<a href=\"#Switch%20Context\" class=\"name\">Switch Context</a>       ${first_context}    # Switches back to first context and page.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4335\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the active BrowserContext to another open context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1199}, {"name": "Switch Page", "args": [{"name": "id", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "NewPageDetails", "typedoc": "NewPageDetails", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: NewPageDetails | str"}, {"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the active browser page to another open page by <code>id</code> or <code>NEW</code>.</p>\n<p>Returns a stable identifier <code>id</code> for the previous page. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The id or alias of the page to switch to. Example: <code>page=8baf2991-5eaf-444d-a318-8045f914e96a</code> or <code>NEW</code>. Can be a string or a dictionary returned by <a href=\"#New%20Page\" class=\"name\">New Page</a> Keyword. A page id can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>. <code>NEW</code> can be used to switch to a pop-up that just has been opened by the webpage, <code>CURRENT</code> can be used to switch to the active page of a different context or browser, identified by their id.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context in which to search for that page. <code>CURRENT</code> for the currently active context, <code>ALL</code> to search in all open contexts or the id of the context where to switch page.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser in which to search for that page. <code>CURRENT</code> for the currently active browser, <code>ALL</code> to search in all open browsers or the id of the browser where to switch page.</td>\n</tr>\n</table>\n<p><code>New</code> may timeout if no new pages exists before library timeout.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>           button#pops_up    # Open new page\n${previous} =    <a href=\"#Switch%20Page\" class=\"name\">Switch Page</a>      NEW\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4336\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the active browser page to another open page by ``id`` or ``NEW``.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1255}, {"name": "Take Screenshot", "args": [{"name": "filename", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "robotframework-browser-screenshot-{index}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str | None = robotframework-browser-screenshot-{index}"}, {"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "crop", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "BoundingBox", "typedoc": "BoundingBox", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "crop: BoundingBox | None = None"}, {"name": "disableAnimations", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "disableAnimations: bool = False"}, {"name": "fileType", "type": {"name": "ScreenshotFileTypes", "typedoc": "ScreenshotFileTypes", "nested": [], "union": false}, "defaultValue": "png", "kind": "NAMED_ONLY", "required": false, "repr": "fileType: ScreenshotFileTypes = png"}, {"name": "fullPage", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "fullPage: bool = False"}, {"name": "log_screenshot", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "log_screenshot: bool = True"}, {"name": "mask", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "NAMED_ONLY", "required": false, "repr": "mask: List[str] | str = "}, {"name": "maskColor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "maskColor: str | None = None"}, {"name": "omitBackground", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "omitBackground: bool = False"}, {"name": "quality", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "quality: int | None = None"}, {"name": "scale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Scale", "typedoc": "Scale", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "scale: Scale | None = None"}, {"name": "return_as", "type": {"name": "ScreenshotReturnType", "typedoc": "ScreenshotReturnType", "nested": [], "union": false}, "defaultValue": "path_string", "kind": "NAMED_ONLY", "required": false, "repr": "return_as: ScreenshotReturnType = path_string"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bytes", "typedoc": "bytes", "nested": [], "union": false}, {"name": "Path", "typedoc": "Path", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Takes a screenshot of the current window or element and saves it to disk.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>filename</code></td>\n<td>Filename into which to save. The file will be saved into the robot framework  ${OUTPUTDIR}/browser/screenshot directory by default, but it can be overwritten by providing custom path or filename. String <code>{index}</code> in filename will be replaced with a rolling  number. Use this to not override filenames. If filename equals to EMBED (case insensitive) or ${NONE},  then screenshot is embedded as Base64 image to the log.html. The image is saved temporally  to the disk and warning is displayed if removing the temporary file fails. The ${OUTPUTDIR}/browser/ is removed at the first suite startup.</td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Take a screenshot of the element matched by selector. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors. If not provided take a screenshot of current viewport.</td>\n</tr>\n<tr>\n<td><code>crop</code></td>\n<td>Crops the taken screenshot to the given box. It takes same dictionary as returned from <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>. Cropping only works on page screenshot, so if no selector is given.</td>\n</tr>\n<tr>\n<td><code>disableAnimations</code></td>\n<td>When set to <code>True</code>, stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:  - finite animations are fast-forwarded to completion, so they'll fire transitionend event.  - infinite animations are canceled to initial state, and then played over after the screenshot.</td>\n</tr>\n<tr>\n<td><code>fileType</code></td>\n<td><code>png</code> or <code>jpeg</code> Specify screenshot type, defaults to <code>png</code> .</td>\n</tr>\n<tr>\n<td><code>fullPage</code></td>\n<td>When True, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>log_screenshot</code></td>\n<td>When set to <code>False</code> the screenshot is taken but not logged into log.html.</td>\n</tr>\n<tr>\n<td><code>mask</code></td>\n<td>Specify selectors that should be masked when the screenshot is taken. Masked elements will be overlayed with a pink box <code>#FF00FF</code> that completely covers its bounding box. Argument can take a single selector string or a list of selector strings if multiple different elements should be masked.</td>\n</tr>\n<tr>\n<td><code>maskColor</code></td>\n<td>Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink #FF00FF.</td>\n</tr>\n<tr>\n<td><code>omitBackground</code></td>\n<td>Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images.</td>\n</tr>\n<tr>\n<td><code>quality</code></td>\n<td>The quality of the image, between 0-100. Not applicable to png images.</td>\n</tr>\n<tr>\n<td><code>scale</code></td>\n<td><code>css</code> or <code>device</code>. <code>css</code> will reduce the image size and <code>device</code> keeps image in original size. Defaults to <code>device</code>.</td>\n</tr>\n<tr>\n<td><code>return_as</code></td>\n<td>Defines what this keyword returns. Possible values are documented in <a href=\"#type-ScreenshotReturnType\" class=\"name\">ScreenshotReturnType</a>. It can be either a path to the screenshot file as string or Path object, or the image data as bytes or base64 encoded string.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Maximum time how long taking screenshot can last, defaults to library timeout. Supports Robot Framework time format, like 10s or 1 min, pass 0 to disable timeout. The default value can be changed by using the <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a> keyword.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode if selector is defined. See <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>                                 # Takes screenshot from page with default filename\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   selector=id=username_field    # Captures element in image\n# Takes screenshot with jpeg extension, defines image quality and timeout how long taking screenhost should last\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   fullPage=True    fileType=jpeg    quality=50    timeout=10s\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   EMBED                         # Screenshot is embedded as Base64 image to the log.html.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4337\">Comment &gt;&gt;</a></p>", "shortdoc": "Takes a screenshot of the current window or element and saves it to disk.", "tags": ["PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 123}, {"name": "Tap", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_x: int | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_y: int | None = None"}, {"name": "trial", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "trial: bool = False"}], "returnType": null, "doc": "<p>Simulates tap on the element found by <code>selector</code>.</p>\n<p>Requires that the <code>hasTouch</code> option of the <a href=\"#New%20Context\" class=\"name\">New Context</a> be set to true. This method taps the element by performing the following steps:</p>\n<ul>\n<li>Wait for actionability checks on the element, unless force option is set.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use page.touchscreen to tap the center of the element, or the specified position.</li>\n<li>Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used. Modifiers can be specified in any order, and multiple modifiers can be specified. Valid modifier keys are <code>Control</code>, <code>Alt</code>, <code>Shift</code> and <code>Meta</code>.</td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Whether to bypass the actionability checks. Defaults to false.</td>\n</tr>\n<tr>\n<td><code>noWaitAfter</code></td>\n<td>Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to <code>False</code>.</td>\n</tr>\n<tr>\n<td><code>position_x</code> <code>position_y</code></td>\n<td>A point to click relative to the top-left corner of element bounding-box. Only positive values within the bounding-box are allowed. If not specified, clicks to some visible point of the element.</td>\n</tr>\n<tr>\n<td><code>trial</code></td>\n<td>When set, this method only performs the actionability checks and skips the action. Defaults to <code>False</code>.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nNew Context    hasTouch=${False}\nNew Page    ${URL}\nTap    css=input#login_button\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5939\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates tap on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 394}, {"name": "Type Secret", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "delay", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given secret from <code>variable_name</code> into the text field found by <code>selector</code>.</p>\n<p>This keyword does not log secret in Robot Framework logs, if keyword resolves the variable value internally. If <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>secret</code></td>\n<td>Environment variable name with % prefix or a local variable with $ prefix that has the secret text value. Variable names can be used with and without curly braces.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay between the single key strokes. It may be either a number or a Robot Framework time string. Time strings are fully explained in an appendix of Robot Framework User Guide. Defaults to <code>0 ms</code>. Example: <code>50 ms</code></td>\n</tr>\n<tr>\n<td><code>clear</code></td>\n<td>Set to false, if the field shall not be cleared before typing. Defaults to true.</td>\n</tr>\n</table>\n<p>This keyword does not log secret in Robot Framework logs, when keyword resolves the <code>secret</code> variable internally. When <code>secret</code> variable is prefixed with <span class=\"name\">$</span>, without the curly braces, library will resolve the corresponding Robot Framework variable.</p>\n<p>If <code>secret</code> variable is prefixed with <span class=\"name\">%</span>, library will resolve corresponding environment variable. Example <span class=\"name\">$Password</span>` will resolve to <code>${Password}</code> Robot Framework variable. Also <code>%ENV_PWD</code> will resolve to <code>%{ENV_PWD}</code> environment variable.</p>\n<p><b>Using normal Robot Framework variables like <code>${password}</code> will not work!</b></p>\n<p><b>Normal plain text will not work.</b> If you want to use plain text, use <a href=\"#Type%20Text\" class=\"name\">Type Text</a> keyword instead.</p>\n<p>This keyword will also work with a give cryptographic cipher text, that has been encrypted by Crypto library. See <a href=\"https://github.com/Snooz82/robotframework-crypto\">Crypto Library</a> for more details.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for details.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    $username      # Keyword resolves ${username} variable value from Robot Framework variables\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    %username      # Keyword resolves $USERNAME/%USERNAME% variable value from environment variables\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    ${username}    # Robot Framework resolves the variable value, but secrect can leak to Robot framework output files.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4338\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 133}, {"name": "Type Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "delay", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given <code>txt</code> into the text field found by <code>selector</code>.</p>\n<p>Sends a <code>keydown</code>, <code>keypress/input</code>, and <code>keyup</code> event for each character in the text.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>txt</code></td>\n<td>Text for the text field.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay between the single key strokes. It may be either a number or a Robot Framework time string. Time strings are fully explained in an appendix of Robot Framework User Guide. Defaults to <code>0 ms</code>. Example: <code>50 ms</code></td>\n</tr>\n<tr>\n<td><code>clear</code></td>\n<td>Set to false, if the field shall not be cleared before typing. Defaults to true.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for direct filling of the full text at once.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Type%20Text\" class=\"name\">Type Text</a>    input#username_field    user\n<a href=\"#Type%20Text\" class=\"name\">Type Text</a>    input#username_field    user    delay=10 ms    clear=No\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4339\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 47}, {"name": "Uncheck Checkbox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Unchecks the checkbox found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is not checked/selected.</p>\n<p><a href=\"https://forum.robotframework.org/t//4340\">Comment &gt;&gt;</a></p>", "shortdoc": "Unchecks the checkbox found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 670}, {"name": "Upload File By Selector", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "path", "type": {"name": "PathLike", "typedoc": "Path", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "returnType": null, "doc": "<p>Uploads file from <a href=\"#type-Path\" class=\"name\">path</a> to file input element matched by selector.</p>\n<p>Fails if upload is not done before library timeout. Therefor it may be necessary to increase the timeout with <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Identifies the file input element.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Path to the file to be uploaded.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Upload%20File%20By%20Selector\" class=\"name\">Upload File By Selector</a>    //input[@type='file']    big_file.zip\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4341\">Comment &gt;&gt;</a></p>", "shortdoc": "Uploads file from `path` to file input element matched by selector.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1259}, {"name": "Wait For", "args": [{"name": "promises", "type": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*promises: Future"}], "returnType": null, "doc": "<p>Waits for promises to finish and returns results from them.</p>\n<p>Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.</p>\n<p>See <a href=\"#Promise%20To\" class=\"name\">Promise To</a> for more information about promises.</p>\n<p>For general waiting of elements please see <a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>promises</code></td>\n<td>Promises to wait for.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${promise}=    <a href=\"#Promise%20To\" class=\"name\">Promise To</a>            <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>         \\#delayed_request\n${body}=       <a href=\"#Wait%20For\" class=\"name\">Wait For</a>              ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4342\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for promises to finish and returns results from them.", "tags": ["Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 227}, {"name": "Wait For Alert", "args": [{"name": "action", "type": {"name": "DialogAction", "typedoc": "DialogAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}, {"name": "text", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Returns a promise to wait for next dialog on page, handles it with <code>action</code> and optionally verifies the dialogs text.</p>\n<p>Dialog/alert can be any of alert, beforeunload, confirm or prompt.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>How to handle the alert. Can be <code>accept</code> or <code>dismiss</code>.</td>\n</tr>\n<tr>\n<td><code>prompt_input</code></td>\n<td>The value to enter into prompt. Only valid if <code>action</code> argument equals <code>accept</code>. Defaults to empty string.</td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Optional text to verify the dialogs text.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Optional timeout in Robot Framework time format.</td>\n</tr>\n</table>\n<p>The main difference between this keyword and <a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a> is that <a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a> keyword is automatically set as promise. But this keyword must be called as argument to <a href=\"#Promise%20To\" class=\"name\">Promise To</a> keyword. Also this keyword can optionally verify the dialogue text and return it. If <code>text</code> is argument <code>None</code> or is not set, dialogue text is not verified.</p>\n<p>Example with returning text:</p>\n<pre>\n${promise} =         <a href=\"#Promise%20To\" class=\"name\">Promise To</a>    <a href=\"#Wait%20For%20Alert\" class=\"name\">Wait For Alert</a>    action=accept\n<a href=\"#Click\" class=\"name\">Click</a>              id=alerts\n${text} =            <a href=\"#Wait%20For\" class=\"name\">Wait For</a>      ${promise}\nShould Be Equal      ${text}         Am an alert\n</pre>\n<p>Example with text verify:</p>\n<pre>\n${promise} =       Promise To    Wait For Alert    action=accept    text=Am an alert\nClick              id=alerts\n${text} =          Wait For      ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4343\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise to wait for next dialog on page, handles it with ``action`` and optionally verifies the dialogs text.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 856}, {"name": "Wait For All Promises", "args": [], "returnType": null, "doc": "<p>Waits for all promises to finish.</p>\n<p>If one promises fails, then this keyword will fail.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Promise%20To\" class=\"name\">Promise To</a>               Wait For Response     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>                    \\#delayed_request\n<a href=\"#Wait%20For%20All%20Promises\" class=\"name\">Wait For All Promises</a>\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4344\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for all promises to finish.", "tags": ["Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 253}, {"name": "Wait For Condition", "args": [{"name": "condition", "type": {"name": "ConditionInputs", "typedoc": "ConditionInputs", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "condition: ConditionInputs"}, {"name": "args", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args: Any"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Waits for a condition, defined with Browser getter keywords to become True.</p>\n<p>This Keyword is basically just a wrapper around our assertion keywords, but with a timeout. It can be used to wait for anything that also can be asserted with our keywords.</p>\n<p>In comparison to Robot Frameworks <span class=\"name\">Wait Until Keywords Succeeds</span> this keyword is more readable and easier to use but is limited to Browser libraries assertion keywords.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>condition</code></td>\n<td>A condition, defined with Browser getter keywords, without the word <code>Get</code>.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>Arguments to pass to the condition keyword.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timout to wait for the condition to become True. Uses default timeout of the library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Overrides the default error message.</td>\n</tr>\n</table>\n<p>The easiest way to use this keyword is first starting with an assertion keyword with assertion like: <a href=\"#Get%20Text\" class=\"name\">Get Text</a></p>\n<p>Start:</p>\n<pre>\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=status_bar   contains    Done\n</pre>\n<p>Then you replace the word <span class=\"name\">Get</span> with <a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition    </a> and if necessary add the timeout argument.</p>\n<p>End:</p>\n<pre>\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Text    id=status_bar   contains    Done\n</pre>\n<p>Example usage:</p>\n<pre>\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Element States    id=cdk-overlay-0    ==    detached\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Element States     //h1    contains    visible    editable    enabled    timeout=2 s\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Title    should start with    Robot\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Url    should end with    robotframework.org\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5269\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for a condition, defined with Browser getter keywords to become True.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 231}, {"name": "Wait For Elements State", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "state", "type": {"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}, "defaultValue": "visible", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: ElementState = visible"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Waits for the element found by <code>selector</code> to satisfy state option.</p>\n<p>Note that Browser library has <a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a> mechanisms. Depending on the situation you might not need to use <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait for Elements State</a>.</p>\n<p>State options could be either appear/disappear from dom, or become visible/hidden. If at the moment of calling the keyword, the selector already satisfies the condition, the keyword will return immediately.</p>\n<p>If the selector doesn't satisfy the condition within the timeout the keyword will FAIL.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>See <a href=\"#type-ElementState\" class=\"name\">ElementState</a> for explanation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>uses default timeout from library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message. The <code>message</code> argument accepts <span class=\"name\">{selector}</span>, <span class=\"name\">{function}</span>, and <span class=\"name\">{timeout}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options. The <span class=\"name\">{function}</span> formatter is same <code>state</code> argument value.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a>    //h1    visible    timeout=2 s\n<a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a>    //hi    focused    1s\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4345\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for the element found by ``selector`` to satisfy state option.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 39}, {"name": "Wait For Function", "args": [{"name": "function", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: str"}, {"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}, {"name": "polling", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "raf", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "polling: str | timedelta = raf"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>function</code></td>\n<td>A valid javascript function or a javascript function body. For example <code>() =&gt; true</code> and <code>true</code> will behave similarly.</td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector to resolve and pass to the JavaScript function. This will be the first argument the function receives. If given a selector a function is necessary, with an argument to capture the elementhandle. For example <code>(element) =&gt; document.activeElement === element</code> See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>polling</code></td>\n<td>Default polling value of \"raf\" polls in a callback for <code>requestAnimationFrame</code>. Any other value for polling will be parsed as a robot framework time for interval between polls.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Uses default timeout of the library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message. The <code>message</code> argument accepts <span class=\"name\">{selector}</span>, <span class=\"name\">{function}</span>, and <span class=\"name\">{timeout}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example usage:</p>\n<pre>\n${promise}      <a href=\"#Promise%20To\" class=\"name\">Promise To</a>      <a href=\"#Wait%20For%20Function\" class=\"name\">Wait For Function</a>    element =&gt; element.style.width==\"100%\"    selector=\\#progress_bar    timeout=4s\n<a href=\"#Click\" class=\"name\">Click</a>         \\#progress_bar\n<a href=\"#Wait%20For\" class=\"name\">Wait For</a>      ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4346\">Comment &gt;&gt;</a></p>", "shortdoc": "Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 155}, {"name": "Wait For Load State", "args": [{"name": "state", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: PageLoadStates = load"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Waits that the page reaches the required load state.</p>\n<p>This resolves when the page reaches a required load state, load by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>State to wait for, defaults to <span class=\"name\">load</span>. Possible values are <span class=\"name\">load|domcontentloaded|networkidle</span></td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses browser timeout if not set.</td>\n</tr>\n</table>\n<p>If the state has been already reached while loading current document, the underlying Playwright will resolve immediately. Can be one of:</p>\n<pre>\n'load' - wait for the load event to be fired.\n'domcontentloaded' - wait for the DOMContentLoaded event to be fired.\n'networkidle' - DISCOURAGED wait until there are no network connections for at least 500 ms.\n</pre>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                         ${URL}\n<a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a>    domcontentloaded    timeout=3s\n</pre>", "shortdoc": "Waits that the page reaches the required load state.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 300}, {"name": "Wait For Navigation", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str | RegExp"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": null, "doc": "<p>Waits until page has navigated to given <code>url</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Expected navigation target address either the exact match or a JavaScript-like regex wrapped in <code>/</code> symbols.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Keyword works only when page is loaded and does not work if URL fragment changes. Example if <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html\">https://marketsquare.github.io/robotframework-browser/Browser.html</a> changes to <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html#Wait%20For%20Navigation\">https://marketsquare.github.io/robotframework-browser/Browser.html#Wait%20For%20Navigation</a> keyword will fail.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                  ${ROOT_URL}/redirector.html\n<a href=\"#Wait%20For%20Navigation\" class=\"name\">Wait for navigation</a>    ${ROOT_URL}/posted.html    wait_until=${wait_until}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4347\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits until page has navigated to given ``url``.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 265}, {"name": "Wait For Request", "args": [{"name": "matcher", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str | RegExp = "}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Waits for request matching matcher to be made.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>matcher</code></td>\n<td>Request URL matcher. Can be a string (Glob-Pattern), JavaScript RegExp (encapsulated in / with following flags) or JavaScript arrow-function that receives the <a href=\"https://playwright.dev/docs/api/class-request\">Request</a> object and returns a boolean. By default (with empty string) matches first available request. For additional information, see the Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-wait-for-request\">waitForRequest</a> documentation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n</table>\n<p>See <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a> for more details.</p>\n<p><b>CAUTION:</b> Before Browser library 17.0.0, the <code>matcher</code> argument was always either a regex or JS function. But the regex did not needed to be in slashes. The most simple way to migrate to the new syntax is to add slashes around the matcher. So <code>/api/get/json</code> becomes <code>//api/get/json/</code>.</p>\n<p><a href=\"https://forum.robotframework.org/t//4348\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for request matching matcher to be made.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 129}, {"name": "Wait For Response", "args": [{"name": "matcher", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str | RegExp = "}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": true}, "doc": "<p>Waits for response matching matcher and returns the response as robot dict.</p>\n<p>The response, which is returned by this keyword, is a robot dictionary with following attributes:</p>\n<ul>\n<li><code>status</code> &lt;int&gt; The status code of the response.</li>\n<li><code>statusText</code> &lt;str&gt; Status text corresponding to <code>status</code>, e.g OK or INTERNAL SERVER ERROR. This may not be available for all browser.</li>\n<li><code>body</code> &lt;dict | str&gt; The response body. If the body can be parsed as a JSON object, it will be returned as Python dictionary, otherwise it is returned as a string.</li>\n<li><code>headers</code> &lt;dict&gt; A dictionary containing all response headers.</li>\n<li><code>ok</code> &lt;bool&gt; Whether the request was successful, i.e. the <code>status</code> is range 200-299.</li>\n<li><code>request</code> &lt;dict&gt; containing <code>method</code> &lt;str&gt;, <code>headers</code> &lt;dict&gt; and <code>postData</code> &lt;dict&gt; | &lt;str&gt;</li>\n<li><code>url</code> &lt;str&gt; url of the request.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>matcher</code></td>\n<td>Request URL matcher. Can be a string (Glob-Pattern), JavaScript RegExp (encapsulated in / with following flags) or JavaScript arrow-function that receives the Response object and returns a boolean. By default (with empty string) matches first available request. For additional information, see the Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-wait-for-response\">page.waitForResponse</a> documentation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n</table>\n<p><b>CAUTION:</b> Before Browser library 17.0.0, the <code>matcher</code> argument was always either a regex or JS function. But the regex did not needed to be in slashes. The most simple way to migrate to the new syntax is to add slashes around the matcher. So <code>/api/get/json</code> becomes <code>//api/get/json/</code>.</p>\n<h3>Matcher Examples:</h3>\n<h4>Glob-Pattern:</h4>\n<p>Glob-Patterns are strings that can contain wildcards. The following wildcards are supported:</p>\n<p>Possible wildcards/patterns are:</p>\n<ul>\n<li><code>*</code> matches any number of characters, except <code>/</code></li>\n<li><code>**</code> matches any number of characters, including <code>/</code></li>\n<li><code>?</code> matches one character, except <code>/</code></li>\n<li><code>[abc]</code> matches one character in the brackets (in this example <code>a</code>, <code>b</code> or <code>c</code>)</li>\n<li><code>[a-z]</code> matches one character in the range (in this example <code>a</code> to <code>z</code>)</li>\n<li><code>{foo,bar,baz}</code> matches one of the strings in the braces (in this example <code>foo</code>, <code>bar</code> or <code>baz</code>)</li>\n</ul>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    **/api/get/text    # matches any request with url ending with /api/get/text. example: <a href=\"https://browser.fi/api/get/text\">https://browser.fi/api/get/text</a>\n</pre>\n<h4>RegExp:</h4>\n<p>Regular Expressions are JavaScript regular expressions encapsulated in <code>/</code> with optional following flags: Be aware that backslashes need to be escaped in Robot Framework, e.g. <code>\\\\w</code> instead of <code>\\w</code>. See <a href=\"https://regex101.com\">regex101</a> for more information on Regular Expressions.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    /http://\\\\w+:\\\\d+/api/get/text/i    # matches any request with url ending with /api/get/text and containing http:// followed by any word and port. example: <a href=\"http://localhost:8080/api/get/text\">http://localhost:8080/api/get/text</a>\n</pre>\n<h4>JavaScript Arrow-Function:</h4>\n<p>JavaScript Arrow-Functions are anonymous JavaScript functions that receive the <a href=\"https://playwright.dev/docs/api/class-response\">Response</a> object and return a boolean.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    response =&gt; response.url() === '<a href=\"http://localhost/api/post\">http://localhost/api/post</a>' &amp;&amp; response.status() === 200    # matches any response with url <a href=\"http://localhost/api/post\">http://localhost/api/post</a> and status code 200\n</pre>\n<h3>Robot Examples:</h3>\n<p>Synchronous Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>                \\#delayed_request    # Creates response which should be waited before next actions\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    matcher=/http://\\\\w+:\\\\d+/api/get/text/i\n<a href=\"#Click\" class=\"name\">Click</a>                \\#save\n</pre>\n<p>Asynchronous Example:</p>\n<pre>\n${promise} =    <a href=\"#Promise%20To\" class=\"name\">Promise To</a>    <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    timeout=60s\n<a href=\"#Click\" class=\"name\">Click</a>           \\#delayed_request    # Creates response which should be waited before pressing save.\n<a href=\"#Click\" class=\"name\">Click</a>           \\#next\n<a href=\"#Wait%20For\" class=\"name\">Wait For</a>        ${promise}            # Waits for the response\n<a href=\"#Click\" class=\"name\">Click</a>           \\#save\n</pre>\n<p>JavaScript Function Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>               \\#delayed_request    # Creates response which should be waited before pressing save.\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>   <a href=\"https://playwright.dev/docs/api/class-response/\">response</a> =&gt; response.url().endsWith('json') &amp;&amp; response.request().method() === 'GET'\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4349\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for response matching matcher and returns the response as robot dict.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 155}, {"name": "Wait Until Network Is Idle", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED!!</b> Use <a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a> instead. rfbrowser transform --wait-until-network-is-idle path/to/test command automatically transforms keyword to new format.</p>\n<p>If you have:</p>\n<pre>\n<a href=\"#Wait%20Until%20Network%20Is%20Idle\" class=\"name\">Wait Until Network Is Idle</a>    timeout=3s\n</pre>\n<p>then chnnage it to:</p>\n<pre>\n<a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a>    networkidle    timeout=3s\n</pre>\n<p>Waits until there has been at least one instance of 500 ms of no network traffic on the page after loading.</p>\n<p>Doesn't wait for network traffic that wasn't initiated within 500ms of page load.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses browser timeout if not set.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                         ${URL}\n<a href=\"#Wait%20Until%20Network%20Is%20Idle\" class=\"name\">Wait Until Network Is Idle</a>    timeout=3s\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4350\">Comment &gt;&gt;</a></p>", "shortdoc": "*DEPRECATED!!* Use `Wait For Load State` instead. rfbrowser transform --wait-until-network-is-idle path/to/test command automatically transforms keyword to new format.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 241, "deprecated": true}], "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Evaluate JavaScript", "Get Attribute", "Get BoundingBox", "Get Browser Catalog", "Get Client Size", "Get Console Log", "Get Download State", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Style", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Http", "LocalStorage Get Item", "Select Options By", "SessionStorage Get Item", "Wait For Condition", "Wait For Request", "Wait For Response"], "accepts": ["Any"]}, {"type": "Enum", "name": "AreaFields", "doc": "<p>Enumeration that defines which coordinates of an area should be selected.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "usages": ["Get Scroll Position"], "accepts": ["string"], "members": [{"name": "top", "value": "1"}, {"name": "left", "value": "2"}, {"name": "bottom", "value": "3"}, {"name": "right", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"type": "Enum", "name": "AssertionOperator", "doc": "<p>Currently supported assertion operators are:</p>\n<table border=\"1\">\n<tr>\n<th>Operator</th>\n<th>Alternative Operators</th>\n<th>Description</th>\n<th>Validate Equivalent</th>\n</tr>\n<tr>\n<td><code>==</code></td>\n<td><code>equal</code>, <code>equals</code>, <code>should be</code></td>\n<td>Checks if returned value is equal to expected value.</td>\n<td><code>value == expected</code></td>\n</tr>\n<tr>\n<td><code>!=</code></td>\n<td><code>inequal</code>, <code>should not be</code></td>\n<td>Checks if returned value is not equal to expected value.</td>\n<td><code>value != expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;</code></td>\n<td><code>greater than</code></td>\n<td>Checks if returned value is greater than expected value.</td>\n<td><code>value &gt; expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;=</code></td>\n<td></td>\n<td>Checks if returned value is greater than or equal to expected value.</td>\n<td><code>value &gt;= expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;</code></td>\n<td><code>less than</code></td>\n<td>Checks if returned value is less than expected value.</td>\n<td><code>value &lt; expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;=</code></td>\n<td></td>\n<td>Checks if returned value is less than or equal to expected value.</td>\n<td><code>value &lt;= expected</code></td>\n</tr>\n<tr>\n<td><code>*=</code></td>\n<td><code>contains</code></td>\n<td>Checks if returned value contains expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td></td>\n<td><code>not contains</code></td>\n<td>Checks if returned value does not contain expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td><code>^=</code></td>\n<td><code>should start with</code>, <code>starts</code></td>\n<td>Checks if returned value starts with expected value.</td>\n<td><code>re.search(f\"^{expected}\", value)</code></td>\n</tr>\n<tr>\n<td><code>$=</code></td>\n<td><code>should end with</code>, <code>ends</code></td>\n<td>Checks if returned value ends with expected value.</td>\n<td><code>re.search(f\"{expected}$\", value)</code></td>\n</tr>\n<tr>\n<td><code>matches</code></td>\n<td></td>\n<td>Checks if given RegEx matches minimum once in returned value.</td>\n<td><code>re.search(expected, value)</code></td>\n</tr>\n<tr>\n<td><code>validate</code></td>\n<td></td>\n<td>Checks if given Python expression evaluates to <code>True</code>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>evaluate</code></td>\n<td><code>then</code></td>\n<td>When using this operator, the keyword does return the evaluated Python expression.</td>\n<td></td>\n</tr>\n</table>\n<p>Currently supported formatters for assertions are:</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Substitutes multiple spaces to single space from the value</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from the beginning and end of the value</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts value to lower case before comparing</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies rules also for the expected value</td>\n</tr>\n</table>\n<p>Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If <code>apply to expected</code> formatter is defined, then formatters are then formatter are also applied to expected value.</p>", "usages": ["Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Download State", "Get Element Count", "Get Element States", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "LocalStorage Get Item", "SessionStorage Get Item"], "accepts": ["string"], "members": [{"name": "equal", "value": "=="}, {"name": "equals", "value": "=="}, {"name": "==", "value": "=="}, {"name": "should be", "value": "=="}, {"name": "inequal", "value": "!="}, {"name": "!=", "value": "!="}, {"name": "should not be", "value": "!="}, {"name": "less than", "value": "<"}, {"name": "<", "value": "<"}, {"name": "greater than", "value": ">"}, {"name": ">", "value": ">"}, {"name": "<=", "value": "<="}, {"name": ">=", "value": ">="}, {"name": "contains", "value": "*="}, {"name": "not contains", "value": "not contains"}, {"name": "*=", "value": "*="}, {"name": "starts", "value": "^="}, {"name": "^=", "value": "^="}, {"name": "should start with", "value": "^="}, {"name": "ends", "value": "$="}, {"name": "should end with", "value": "$="}, {"name": "$=", "value": "$="}, {"name": "matches", "value": "$"}, {"name": "validate", "value": "validate"}, {"name": "then", "value": "then"}, {"name": "evaluate", "value": "then"}]}, {"type": "Enum", "name": "AutoClosingLevel", "doc": "<p>Controls when contexts and pages are closed during the test execution.</p>\n<p>If automatic closing level is <span class=\"name\">TEST</span>, contexts and pages that are created during a single test are automatically closed when the test ends. Contexts and pages that are created during suite setup are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">SUITE</span>, all contexts and pages that are created during the test suite are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">MANUAL</span>, nothing is closed automatically while the test execution is ongoing. All browsers, context and pages are automatically closed when test execution ends.</p>\n<p>If automatic closing level is <span class=\"name\">KEEP</span>, nothing is closed automatically while the test execution is ongoing. Also, nothing is closed when test execution ends, including the node process. Therefore, it is users responsibility to close all browsers, context and pages and ensure that all process that are left running after the test execution end are closed. This level is only intended for test case development and must not be used when running tests in CI or similar environments.</p>\n<p>Automatic closing can be configured or switched off with the auto_closing_level library import parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "SUITE", "value": "1"}, {"name": "TEST", "value": "2"}, {"name": "MANUAL", "value": "3"}, {"name": "KEEP", "value": "4"}]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__", "Add Cookie", "Check Checkbox", "Click With Options", "Close Page", "Connect To Browser", "Download", "Evaluate JavaScript", "Fill Secret", "Fill Text", "Get Checkbox State", "Get Console Log", "Get Element By", "Get Element By Role", "Get Page Errors", "Hover", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Open Browser", "Promise To Wait For Download", "Set Default Run Before Unload", "Set Offline", "Set Strict Mode", "Show Keyword Banner", "Take Screenshot", "Tap", "Type Secret", "Type Text", "Uncheck Checkbox"], "accepts": ["string", "integer", "float", "None"]}, {"type": "TypedDict", "name": "BoundingBox", "doc": "<p>Bounding box of an element.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>x</code></td>\n<td>The amount of pixel between the left border of the page and the left border of the element.</td>\n</tr>\n<tr>\n<td><code>y</code></td>\n<td>The amount of pixel between the top border of the page and the top border of the element.</td>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>The width of the element, excluding margins.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>The height of the element, excluding margins.</td>\n</tr>\n</table>", "usages": ["Get BoundingBox", "Take Screenshot"], "accepts": ["string", "Mapping"], "items": [{"key": "x", "type": "float", "required": false}, {"key": "y", "type": "float", "required": false}, {"key": "width", "type": "float", "required": false}, {"key": "height", "type": "float", "required": false}]}, {"type": "Enum", "name": "BoundingBoxFields", "doc": "<p>Enumeration that defines which location information of an element should be selected.</p>\n<p><code>x</code> / <code>y</code> defines the position of the top left corner of an element.</p>\n<p><code>width</code> / <code>height</code> defines the size of an elements bounding box.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "usages": ["Get BoundingBox"], "accepts": ["string"], "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "x", "value": "3"}, {"name": "y", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"type": "TypedDict", "name": "BrowserInfo", "doc": "<p>Dictionary that contains information about a browser instance.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>The browser type. e.g. chromium, firefox or webkit.</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The unique id of the browser instance.</td>\n</tr>\n<tr>\n<td><code>contexts</code></td>\n<td>List of context information opened by the browser.</td>\n</tr>\n<tr>\n<td><code>activeContext</code></td>\n<td>The id of the active context.</td>\n</tr>\n<tr>\n<td><code>activeBrowser</code></td>\n<td>Boolean if the browser is the currently active browser.</td>\n</tr>\n</table>\n<p>Structure:</p>\n<pre>\n{\n  'type': <span class=\"name\">str</span>,\n  'id': <span class=\"name\">str</span>,\n  'contexts': [\n      {\n          'type': <span class=\"name\">str</span>,\n          'id': <span class=\"name\">str</span>,\n          'activePage': <span class=\"name\">str</span>,\n          'pages': [\n              {\n                  'type': <span class=\"name\">str</span>,\n                  'title': <span class=\"name\">str</span>,\n                  'url': <span class=\"name\">str</span>,\n                  'id': <span class=\"name\">str</span>,\n                  'timestamp': <a href=\"#type-float\" class=\"name\">float</a>\n              },\n              ...\n          ]\n      },\n      ...\n  ],\n  'activeContext': <span class=\"name\">str</span>,\n  'activeBrowser': <span class=\"name\">bool</span>\n}\n</pre>", "usages": ["Get Browser Catalog"], "accepts": ["string", "Mapping"], "items": [{"key": "type", "type": "str", "required": true}, {"key": "id", "type": "str", "required": true}, {"key": "contexts", "type": "typing.List[Browser.utils.data_types.ContextInfo]", "required": true}, {"key": "activeContext", "type": "str", "required": true}, {"key": "activeBrowser", "type": "bool", "required": true}]}, {"type": "Standard", "name": "bytes", "doc": "<p>Strings are converted to bytes so that each Unicode code point below 256 is directly mapped to a matching byte. Higher code points are not allowed. Robot Framework's <code>\\xHH</code> escape syntax is convenient with bytes having non-printable values.</p>\n<p>Examples: <code>good</code>, <code>hyv\u00e4</code> (same as <code>hyv\\xE4</code>), <code>\\x00</code> (the null byte)</p>", "usages": ["Take Screenshot"], "accepts": ["string", "bytearray"]}, {"type": "Enum", "name": "ColorScheme", "doc": "<p>Emulates 'prefers-colors-scheme' media feature.</p>\n<p>See <a href=\"https://playwright.dev/docs/api/class-page?_highlight=emulatemedia#pageemulatemediaparams\">emulateMedia(options)</a> for more details.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "dark", "value": "1"}, {"name": "light", "value": "2"}, {"name": "no-preference", "value": "3"}]}, {"type": "Enum", "name": "ConditionInputs", "doc": "<p>Following values are allowed and represent the assertion keywords to use:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Keyword</th>\n</tr>\n<tr>\n<td><code>Attribute</code></td>\n<td><a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a></td>\n</tr>\n<tr>\n<td><code>Attribute Names</code></td>\n<td><a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a></td>\n</tr>\n<tr>\n<td><code>BoundingBox</code></td>\n<td><a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a></td>\n</tr>\n<tr>\n<td><code>Browser Catalog</code></td>\n<td><a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a></td>\n</tr>\n<tr>\n<td><code>Checkbox State</code></td>\n<td><a href=\"#Get%20Checkbox%20State\" class=\"name\">Get Checkbox State</a></td>\n</tr>\n<tr>\n<td><code>Classes</code></td>\n<td><a href=\"#Get%20Classes\" class=\"name\">Get Classes</a></td>\n</tr>\n<tr>\n<td><code>Client Size</code></td>\n<td><a href=\"#Get%20Client%20Size\" class=\"name\">Get Client Size</a></td>\n</tr>\n<tr>\n<td><code>Download State</code></td>\n<td><a href=\"#Get%20Download%20State\" class=\"name\">Get Download State</a></td>\n</tr>\n<tr>\n<td><code>Element Count</code></td>\n<td><a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a></td>\n</tr>\n<tr>\n<td><code>Element States</code></td>\n<td><a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a></td>\n</tr>\n<tr>\n<td><code>Page Source</code></td>\n<td><a href=\"#Get%20Page%20Source\" class=\"name\">Get Page Source</a></td>\n</tr>\n<tr>\n<td><code>Property</code></td>\n<td><a href=\"#Get%20Property\" class=\"name\">Get Property</a></td>\n</tr>\n<tr>\n<td><code>Scroll Position</code></td>\n<td><a href=\"#Get%20Scroll%20Position\" class=\"name\">Get Scroll Position</a></td>\n</tr>\n<tr>\n<td><code>Scroll Size</code></td>\n<td><a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a></td>\n</tr>\n<tr>\n<td><code>Select Options</code></td>\n<td><a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a></td>\n</tr>\n<tr>\n<td><code>Selected Options</code></td>\n<td><a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a></td>\n</tr>\n<tr>\n<td><code>Style</code></td>\n<td><a href=\"#Get%20Style\" class=\"name\">Get Style</a></td>\n</tr>\n<tr>\n<td><code>Table Cell Index</code></td>\n<td><a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a></td>\n</tr>\n<tr>\n<td><code>Table Row Index</code></td>\n<td><a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a></td>\n</tr>\n<tr>\n<td><code>Text</code></td>\n<td><a href=\"#Get%20Text\" class=\"name\">Get Text</a></td>\n</tr>\n<tr>\n<td><code>Title</code></td>\n<td><a href=\"#Get%20Title\" class=\"name\">Get Title</a></td>\n</tr>\n<tr>\n<td><code>Url</code></td>\n<td><a href=\"#Get%20Url\" class=\"name\">Get Url</a></td>\n</tr>\n<tr>\n<td><code>Viewport Size</code></td>\n<td><a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a></td>\n</tr>\n</table>", "usages": ["Wait For Condition"], "accepts": ["string"], "members": [{"name": "attribute", "value": "get_attribute"}, {"name": "attribute_names", "value": "get_attribute_names"}, {"name": "bounding_box", "value": "get_bounding_box"}, {"name": "browser_catalog", "value": "get_browser_catalog"}, {"name": "checkbox_state", "value": "get_checkbox_state"}, {"name": "classes", "value": "get_classes"}, {"name": "client_size", "value": "get_client_size"}, {"name": "download_state", "value": "get_download_state"}, {"name": "element_count", "value": "get_element_count"}, {"name": "element_states", "value": "get_element_states"}, {"name": "page_source", "value": "get_page_source"}, {"name": "property", "value": "get_property"}, {"name": "scroll_position", "value": "get_scroll_position"}, {"name": "scroll_size", "value": "get_scroll_size"}, {"name": "select_options", "value": "get_select_options"}, {"name": "selected_options", "value": "get_selected_options"}, {"name": "style", "value": "get_style"}, {"name": "table_cell_index", "value": "get_table_cell_index"}, {"name": "table_row_index", "value": "get_table_row_index"}, {"name": "text", "value": "get_text"}, {"name": "title", "value": "get_title"}, {"name": "url", "value": "get_url"}, {"name": "viewport_size", "value": "get_viewport_size"}]}, {"type": "Enum", "name": "CookieSameSite", "doc": "<p>Enum that defines the Cookie SameSite type.</p>\n<p>It controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).</p>\n<p>The possible attribute values are:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>Strict</code></td>\n<td>Means that the browser sends the cookie only for same-site requests, that is, requests originating from the same site that set the cookie. If a request originates from a different domain or scheme (even with the same domain), no cookies with the SameSite=Strict attribute are sent.</td>\n</tr>\n<tr>\n<td><code>Lax</code></td>\n<td>Means that the cookie is not sent on cross-site requests, such as on requests to load images or frames, but is sent when a user is navigating to the origin site from an external site (for example, when following a link). This is the default behavior if the SameSite attribute is not specified.</td>\n</tr>\n<tr>\n<td><code>None</code></td>\n<td>means that the browser sends the cookie with both cross-site and same-site requests. The Secure attribute must also be set when setting this value.</td>\n</tr>\n</table>\n<p>See <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie\">MDN Set-Cookie</a> for more information.</p>", "usages": ["Add Cookie"], "accepts": ["string"], "members": [{"name": "Strict", "value": "Strict"}, {"name": "Lax", "value": "Lax"}, {"name": "None", "value": "None"}]}, {"type": "Enum", "name": "CookieType", "doc": "<p>Enum that defines the Cookie type.</p>", "usages": ["Get Cookie", "Get Cookies"], "accepts": ["string"], "members": [{"name": "dictionary", "value": "1"}, {"name": "dict", "value": "1"}, {"name": "string", "value": "2"}, {"name": "str", "value": "2"}]}, {"type": "Enum", "name": "DialogAction", "doc": "<p>Enum that defines how to handle a dialog.</p>", "usages": ["Handle Future Dialogs", "Wait For Alert"], "accepts": ["string"], "members": [{"name": "accept", "value": "1"}, {"name": "dismiss", "value": "2"}]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["__init__", "Get Console Log", "Get Cookie", "Get Cookies", "Get Device", "Get Devices", "Get Page Errors", "Get Style", "Http", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Set Assertion Formatters", "Show Keyword Banner", "Wait For Response"], "accepts": ["string", "Mapping"]}, {"type": "TypedDict", "name": "Dimensions", "doc": "<p>Dimensions of an object in pixels.</p>", "usages": ["Get Client Size", "Get Scroll Size"], "accepts": ["string", "Mapping"], "items": [{"key": "width", "type": "int", "required": true}, {"key": "height", "type": "int", "required": true}]}, {"type": "TypedDict", "name": "DownloadInfo", "doc": "<p>Downloaded file information.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>is the path where downloaded file is saved. empty string if the file is not yet fully downloaded.</td>\n</tr>\n<tr>\n<td><code>suggestedFilename</code></td>\n<td>is the suggested filename that was computed from the <code>Content-Disposition</code> response header.</td>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>is the state of the download. i.e. <code>in_progress</code>, <code>finished</code> or <code>canceled</code>.</td>\n</tr>\n<tr>\n<td><code>downloadID</code></td>\n<td>is the unique id of the download.</td>\n</tr>\n</table>", "usages": ["Cancel Download", "Download", "Get Download State"], "accepts": ["string", "Mapping"], "items": [{"key": "saveAs", "type": "str", "required": true}, {"key": "suggestedFilename", "type": "str", "required": true}, {"key": "state", "type": "str", "required": true}, {"key": "downloadID", "type": "typing.Union[str, NoneType]", "required": true}]}, {"type": "Enum", "name": "ElementRole", "doc": "<p>Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.</p>\n<p>Many html elements have an implicitly <a href=\"https://w3c.github.io/html-aam/#html-element-role-mappings\">defined role</a> that is recognized by the role selector. You can find all the <a href=\"https://www.w3.org/TR/wai-aria-1.2/#role_definitions\">supported roles</a> here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.</p>", "usages": ["Get Element By Role"], "accepts": ["string"], "members": [{"name": "ALERT", "value": "1"}, {"name": "ALERTDIALOG", "value": "2"}, {"name": "APPLICATION", "value": "3"}, {"name": "ARTICLE", "value": "4"}, {"name": "BANNER", "value": "5"}, {"name": "BLOCKQUOTE", "value": "6"}, {"name": "BUTTON", "value": "7"}, {"name": "CAPTION", "value": "8"}, {"name": "CELL", "value": "9"}, {"name": "CHECKBOX", "value": "10"}, {"name": "CODE", "value": "11"}, {"name": "COLUMNHEADER", "value": "12"}, {"name": "COMBOBOX", "value": "13"}, {"name": "COMPLEMENTARY", "value": "14"}, {"name": "CONTENTINFO", "value": "15"}, {"name": "DEFINITION", "value": "16"}, {"name": "DELETION", "value": "17"}, {"name": "DIALOG", "value": "18"}, {"name": "DIRECTORY", "value": "19"}, {"name": "DOCUMENT", "value": "20"}, {"name": "EMPHASIS", "value": "21"}, {"name": "FEED", "value": "22"}, {"name": "FIGURE", "value": "23"}, {"name": "FORM", "value": "24"}, {"name": "GENERIC", "value": "25"}, {"name": "GRID", "value": "26"}, {"name": "GRIDCELL", "value": "27"}, {"name": "GROUP", "value": "28"}, {"name": "HEADING", "value": "29"}, {"name": "IMG", "value": "30"}, {"name": "INSERTION", "value": "31"}, {"name": "LINK", "value": "32"}, {"name": "LIST", "value": "33"}, {"name": "LISTBOX", "value": "34"}, {"name": "LISTITEM", "value": "35"}, {"name": "LOG", "value": "36"}, {"name": "MAIN", "value": "37"}, {"name": "MARQUEE", "value": "38"}, {"name": "MATH", "value": "39"}, {"name": "METER", "value": "40"}, {"name": "MENU", "value": "41"}, {"name": "MENUBAR", "value": "42"}, {"name": "MENUITEM", "value": "43"}, {"name": "MENUITEMCHECKBOX", "value": "44"}, {"name": "MENUITEMRADIO", "value": "45"}, {"name": "NAVIGATION", "value": "46"}, {"name": "NONE", "value": "47"}, {"name": "NOTE", "value": "48"}, {"name": "OPTION", "value": "49"}, {"name": "PARAGRAPH", "value": "50"}, {"name": "PRESENTATION", "value": "51"}, {"name": "PROGRESSBAR", "value": "52"}, {"name": "RADIO", "value": "53"}, {"name": "RADIOGROUP", "value": "54"}, {"name": "REGION", "value": "55"}, {"name": "ROW", "value": "56"}, {"name": "ROWGROUP", "value": "57"}, {"name": "ROWHEADER", "value": "58"}, {"name": "SCROLLBAR", "value": "59"}, {"name": "SEARCH", "value": "60"}, {"name": "SEARCHBOX", "value": "61"}, {"name": "SEPARATOR", "value": "62"}, {"name": "SLIDER", "value": "63"}, {"name": "SPINBUTTON", "value": "64"}, {"name": "STATUS", "value": "65"}, {"name": "STRONG", "value": "66"}, {"name": "SUBSCRIPT", "value": "67"}, {"name": "SUPERSCRIPT", "value": "68"}, {"name": "SWITCH", "value": "69"}, {"name": "TAB", "value": "70"}, {"name": "TABLE", "value": "71"}, {"name": "TABLIST", "value": "72"}, {"name": "TABPANEL", "value": "73"}, {"name": "TERM", "value": "74"}, {"name": "TEXTBOX", "value": "75"}, {"name": "TIME", "value": "76"}, {"name": "TIMER", "value": "77"}, {"name": "TOOLBAR", "value": "78"}, {"name": "TOOLTIP", "value": "79"}, {"name": "TREE", "value": "80"}, {"name": "TREEGRID", "value": "81"}, {"name": "TREEITEM", "value": "82"}]}, {"type": "Enum", "name": "ElementState", "doc": "<p>Enum that defines the state an element can have.</p>\n<p>The following <code>states</code> are possible:</p>\n<table border=\"1\">\n<tr>\n<th>State</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>attached</code></td>\n<td>to be present in DOM.</td>\n</tr>\n<tr>\n<td><code>detached</code></td>\n<td>to not be present in DOM.</td>\n</tr>\n<tr>\n<td><code>visible</code></td>\n<td>to have non or empty bounding box and no visibility:hidden.</td>\n</tr>\n<tr>\n<td><code>hidden</code></td>\n<td>to be detached from DOM, or have an empty bounding box or visibility:hidden.</td>\n</tr>\n<tr>\n<td><code>enabled</code></td>\n<td>to not be <code>disabled</code>.</td>\n</tr>\n<tr>\n<td><code>disabled</code></td>\n<td>to be <code>disabled</code>. Can be used on &lt;button&gt;, &lt;fieldset&gt;, &lt;input&gt;, &lt;optgroup&gt;, &lt;option&gt;, &lt;select&gt; and &lt;textarea&gt;.</td>\n</tr>\n<tr>\n<td><code>editable</code></td>\n<td>to not be <code>readOnly</code>.</td>\n</tr>\n<tr>\n<td><code>readonly</code></td>\n<td>to be <code>readOnly</code>. Can be used on &lt;input&gt; and &lt;textarea&gt;.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>to be <code>selected</code>. Can be used on &lt;option&gt;.</td>\n</tr>\n<tr>\n<td><code>deselected</code></td>\n<td>to not be <code>selected</code>.</td>\n</tr>\n<tr>\n<td><code>focused</code></td>\n<td>to be the <code>activeElement</code>.</td>\n</tr>\n<tr>\n<td><code>defocused</code></td>\n<td>to not be the <code>activeElement</code>.</td>\n</tr>\n<tr>\n<td><code>checked</code></td>\n<td>to be <code>checked</code>. Can be used on &lt;input&gt;.</td>\n</tr>\n<tr>\n<td><code>unchecked</code></td>\n<td>to not be <code>checked</code>.</td>\n</tr>\n<tr>\n<td><code>stable</code></td>\n<td>to be both <code>visible</code> and <code>stable</code>.</td>\n</tr>\n</table>", "usages": ["Get Element States", "Wait For Elements State"], "accepts": ["string", "integer"], "members": [{"name": "attached", "value": "1"}, {"name": "detached", "value": "2"}, {"name": "visible", "value": "4"}, {"name": "hidden", "value": "8"}, {"name": "enabled", "value": "16"}, {"name": "disabled", "value": "32"}, {"name": "editable", "value": "64"}, {"name": "readonly", "value": "128"}, {"name": "selected", "value": "256"}, {"name": "deselected", "value": "512"}, {"name": "focused", "value": "1024"}, {"name": "defocused", "value": "2048"}, {"name": "checked", "value": "4096"}, {"name": "unchecked", "value": "8192"}, {"name": "stable", "value": "16384"}]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Click With Options", "Drag And Drop By Coordinates", "Drag And Drop Relative To", "Get BoundingBox", "Get Scroll Position", "Get Scroll Size", "Hover", "Launch Browser Server", "Mouse Button", "Mouse Move", "Mouse Move Relative To", "New Browser", "New Context", "New Persistent Context", "Set Geolocation"], "accepts": ["string", "Real"]}, {"type": "Enum", "name": "ForcedColors", "doc": "<p>Emulates <span class=\"name\">forced-colors</span> media feature, supported values are <span class=\"name\">active</span>, <a href=\"#type-None\" class=\"name\">none</a>.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "active", "value": "1"}, {"name": "none", "value": "2"}]}, {"type": "Enum", "name": "FormatingRules", "doc": "<p>Enum that defines the available formatters.</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Replaces all kind of spaces with a single space.</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from start and end of the string.</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies the formatter also to the expected value.</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts the string to lower case.</td>\n</tr>\n</table>", "usages": ["Set Assertion Formatters"], "accepts": ["string"], "members": [{"name": "normalize spaces", "value": "1"}, {"name": "strip", "value": "2"}, {"name": "apply to expected", "value": "3"}, {"name": "case insensitive", "value": "4"}]}, {"type": "Enum", "name": "FormatterKeywords", "doc": "<p>Enum that defines the available keywords for formatters.</p>\n<p>Keywords that are not listed here, do not support formatters.</p>", "usages": ["Set Assertion Formatters"], "accepts": ["string"], "members": [{"name": "Get Url", "value": "1"}, {"name": "Get Page Source", "value": "2"}, {"name": "Get Title", "value": "3"}, {"name": "Get Text", "value": "4"}, {"name": "Get Property", "value": "5"}, {"name": "Get Attribute", "value": "6"}, {"name": "Get Select Options", "value": "7"}, {"name": "Get Style", "value": "8"}, {"name": "Get Browser Catalog", "value": "9"}, {"name": "LocalStorage Get Item", "value": "10"}, {"name": "SessionStorage Get Item", "value": "11"}]}, {"type": "TypedDict", "name": "GeoLocation", "doc": "<p>Defines the geolocation.</p>\n<ul>\n<li><code>latitude</code> Latitude between -90 and 90.</li>\n<li><code>longitude</code> Longitude between -180 and 180.</li>\n<li><code>accuracy</code> <b>Optional</b> Non-negative accuracy value. Defaults to 0.</li>\n</ul>\n<p>Example usage: <code>{'latitude': 59.95, 'longitude': 30.31667}</code></p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "longitude", "type": "float", "required": true}, {"key": "latitude", "type": "float", "required": true}, {"key": "accuracy", "type": "float", "required": false}]}, {"type": "TypedDict", "name": "HighLightElement", "doc": "<p>Presenter mode configuration options.</p>\n<p><code>duration</code> Sets for how long the selector shall be highlighted. Defaults to <code>5s</code> =&gt; 5 seconds.</p>\n<p><code>width</code> Sets the width of the higlight border. Defaults to 2px.</p>\n<p><code>style</code> Sets the style of the border. Defaults to dotted.</p>\n<p><code>color</code> Sets the color of the border, default is blue. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></p>", "usages": ["__init__"], "accepts": ["string", "Mapping"], "items": [{"key": "duration", "type": "timedelta", "required": true}, {"key": "width", "type": "str", "required": true}, {"key": "style", "type": "str", "required": true}, {"key": "color", "type": "str", "required": true}]}, {"type": "TypedDict", "name": "HttpCredentials", "doc": "<p>Sets the credentials for http basic-auth.</p>\n<p><code>origin</code>: Restrain sending http credentials on specific origin (<a href=\"scheme://host:port\">scheme://host:port</a>). Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.</p>\n<p>Can be defined as robot dictionary or as string literal. Does not reveal secrets in Robot Framework logs. Instead, username and password values are resolved internally. Please note that if <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<p>Example as literal:</p>\n<pre>\n${pwd} =    Set Variable    1234\n${username} =    Set Variable    admin\n<a href=\"#New%20Context\" class=\"name\">New Context</a>\n...    httpCredentials={'username': '$username', 'password': '$pwd'}\n</pre>\n<p>Example as robot variable</p>\n<pre>\n<b>***</b> <b>Variables</b> <b>***</b>\n${username}=       admin\n${pwd}=            1234\n${credentials}=    username=$username    password=$pwd\n\n<b>***</b> <b>Keywords</b> <b>***</b>\nOpen Context\n   <a href=\"#New%20Context\" class=\"name\">New Context</a>    httpCredentials=${credentials}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "username", "type": "str", "required": true}, {"key": "password", "type": "str", "required": true}, {"key": "origin", "type": "str", "required": false}]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__", "Click With Options", "Crawl Site", "Drag And Drop", "Drag And Drop By Coordinates", "Drag And Drop Relative To", "Get BoundingBox", "Get Console Log", "Get Element By Role", "Get Element Count", "Get Page Errors", "Get Scroll Size", "Get Selected Options", "Get Table Cell Index", "Get Table Row Index", "Keyboard Input", "Launch Browser Server", "Mouse Button", "Mouse Move", "Mouse Move Relative To", "Mouse Wheel", "New Browser", "New Context", "New Persistent Context", "Set Viewport Size", "Take Screenshot", "Tap"], "accepts": ["string", "float"]}, {"type": "Enum", "name": "KeyAction", "doc": "<p>Enum that defines which <a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a> action to perform.</p>", "usages": ["Keyboard Key"], "accepts": ["string"], "members": [{"name": "down", "value": "1"}, {"name": "up", "value": "2"}, {"name": "press", "value": "3"}]}, {"type": "Enum", "name": "KeyboardInputAction", "doc": "<p>Enum that defines how <a href=\"#Keyboard%20Input\" class=\"name\">Keyboard Input</a> adds the text into the page.</p>\n<p><code>insertText</code> is mostly similar to pasting of text.</p>\n<p><code>type</code> is similar to typing by pressing keys on the keyboard.</p>", "usages": ["Keyboard Input"], "accepts": ["string"], "members": [{"name": "insertText", "value": "1"}, {"name": "type", "value": "2"}]}, {"type": "Enum", "name": "KeyboardModifier", "doc": "<p>Modifier keys to press while doing other actions.</p>\n<p>Modifiers that are pressed during the <a href=\"#Hover\" class=\"name\">Hover</a> or <a href=\"#Click\" class=\"name\">Click</a>.</p>", "usages": ["Click With Options", "Hover", "Tap"], "accepts": ["string"], "members": [{"name": "Alt", "value": "1"}, {"name": "Control", "value": "2"}, {"name": "Meta", "value": "3"}, {"name": "Shift", "value": "4"}]}, {"type": "Custom", "name": "LambdaFunction", "doc": "<p>Python lambda function.</p>\n<p>The string must start with <code>lambda</code> and the function must accept one argument.</p>\n<p>Example: <code>lambda value: value.lower().replace(' ', '')</code></p>", "usages": ["Set Assertion Formatters"], "accepts": ["string"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["__init__", "Get Attribute Names", "Get Browser Catalog", "Get Browser Ids", "Get Classes", "Get Context Ids", "Get Cookies", "Get Element States", "Get Elements", "Get Page Ids", "Get Select Options", "Get Selected Options", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Select Options By", "Set Assertion Formatters", "Take Screenshot"], "accepts": ["string", "Sequence"]}, {"type": "Enum", "name": "MouseButton", "doc": "<p>Enum that defines which mouse button to use.</p>", "usages": ["Click", "Click With Options", "Mouse Button"], "accepts": ["string"], "members": [{"name": "left", "value": "1"}, {"name": "middle", "value": "2"}, {"name": "right", "value": "3"}]}, {"type": "Enum", "name": "MouseButtonAction", "doc": "<p>Enum that defines which <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> action to perform.</p>", "usages": ["Mouse Button"], "accepts": ["string"], "members": [{"name": "click", "value": "1"}, {"name": "down", "value": "2"}, {"name": "up", "value": "3"}]}, {"type": "TypedDict", "name": "NewPageDetails", "doc": "<p>Return value of <a href=\"#New%20Page\" class=\"name\">New Page</a> keyword.</p>\n<p><code>page_id</code> is the UUID of the opened page. <code>video_path</code> path to the video or empty string if video is not created.</p>", "usages": ["New Page", "Switch Page"], "accepts": ["string", "Mapping"], "items": [{"key": "page_id", "type": "str", "required": true}, {"key": "video_path", "type": "str", "required": true}]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__", "Add Cookie", "Click With Options", "Crawl Site", "Download", "Evaluate JavaScript", "Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Download State", "Get Element By Role", "Get Element Count", "Get Element States", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Go To", "Grant Permissions", "Hover", "Http", "Launch Browser Server", "LocalStorage Clear", "LocalStorage Get Item", "LocalStorage Remove Item", "LocalStorage Set Item", "Mouse Button", "New Browser", "New Context", "New Page", "New Persistent Context", "Open Browser", "Promise To Wait For Download", "Record Selector", "Register Keyword To Run On Failure", "Scroll By", "Scroll To", "SessionStorage Clear", "SessionStorage Get Item", "SessionStorage Remove Item", "SessionStorage Set Item", "Set Geolocation", "Set Selector Prefix", "Show Keyword Banner", "Take Screenshot", "Tap", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Load State", "Wait For Navigation", "Wait For Request", "Wait For Response", "Wait Until Network Is Idle"], "accepts": ["string"]}, {"type": "Enum", "name": "PageLoadStates", "doc": "<p>Enum that defines available page load states.</p>", "usages": ["Go To", "New Page", "Wait For Load State", "Wait For Navigation"], "accepts": ["string"], "members": [{"name": "load", "value": "1"}, {"name": "domcontentloaded", "value": "2"}, {"name": "networkidle", "value": "3"}, {"name": "commit", "value": "4"}]}, {"type": "Standard", "name": "Path", "doc": "<p>Strings are converted <a href=\"https://docs.python.org/library/pathlib.html\">Path</a> objects. On Windows <code>/</code> is converted to <code>\\</code> automatically.</p>\n<p>Examples: <code>/tmp/absolute/path</code>, <code>relative/path/to/file.ext</code>, <code>name.txt</code></p>", "usages": ["Promise To Upload File", "Take Screenshot", "Upload File By Selector"], "accepts": ["string", "PurePath"]}, {"type": "Enum", "name": "Permission", "doc": "<p>Enum that defines the permission to grant to a context.</p>\n<p>See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions\">grantPermissions(permissions)</a> for more details.</p>", "usages": ["Grant Permissions", "New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "geolocation", "value": "geolocation"}, {"name": "midi", "value": "midi"}, {"name": "midi_sysex", "value": "midi-sysex"}, {"name": "midi-sysex", "value": "midi-sysex"}, {"name": "notifications", "value": "notifications"}, {"name": "camera", "value": "camera"}, {"name": "microphone", "value": "microphone"}, {"name": "background_sync", "value": "background-sync"}, {"name": "background-sync", "value": "background-sync"}, {"name": "ambient_light_sensor", "value": "ambient-light-sensor"}, {"name": "ambient-light-sensor", "value": "ambient-light-sensor"}, {"name": "accelerometer", "value": "accelerometer"}, {"name": "gyroscope", "value": "gyroscope"}, {"name": "magnetometer", "value": "magnetometer"}, {"name": "accessibility_events", "value": "accessibility-events"}, {"name": "accessibility-events", "value": "accessibility-events"}, {"name": "clipboard_read", "value": "clipboard-read"}, {"name": "clipboard-read", "value": "clipboard-read"}, {"name": "clipboard_write", "value": "clipboard-write"}, {"name": "clipboard-write", "value": "clipboard-write"}, {"name": "payment_handler", "value": "payment-handler"}, {"name": "payment-handler", "value": "payment-handler"}]}, {"type": "Enum", "name": "PlaywrightLogTypes", "doc": "<p>Enable low level debug information from the playwright to playwright-log.txt file.</p>\n<p>It is possible to disable the creation of playwright-log.txt totally. Mainly useful for the library developers and for debugging purposes. Will log everything as plain text, also including secrets. If playwright-log.txt file can not be deleted, time.time_ns() is added at the end of file name. Example playwright-log-12345.txt</p>\n<p><code>disabled</code>: playwright-log.txt is not created at all. All node side logging is lost. <code>library</code>: Default, only logging from Browser library node side is written to the playwright-log.txt file. <code>playwright</code>: Also includes Playwright log messages to the playwright-log.txt file. <code>false</code>: Same as <span class=\"name\">library</span> and for backwards compatability. <code>true</code>: Same as <span class=\"name\">playwright</span> and for backwards compatibility.</p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "disabled", "value": "1"}, {"name": "library", "value": "2"}, {"name": "playwright", "value": "3"}, {"name": "false", "value": "2"}, {"name": "true", "value": "3"}]}, {"type": "TypedDict", "name": "Proxy", "doc": "<p>Network proxy settings.</p>\n<p><code>server</code> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example <a href=\"http://myproxy.com:3128\">http://myproxy.com:3128</a> or <a href=\"socks5://myproxy.com:3128\">socks5://myproxy.com:3128</a>. Short form myproxy.com:3128 is considered an HTTP proxy.</p>\n<p><code>bypass</code> <b>Optional</b> coma-separated domains to bypass proxy, for example \".com, chromium.org, .domain.com\".</p>\n<p><code>username</code> <b>Optional</b> username to use if HTTP proxy requires authentication.</p>\n<p><code>password</code> <b>Optional</b> password to use if HTTP proxy requires authentication.</p>", "usages": ["Launch Browser Server", "New Browser", "New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "server", "type": "str", "required": true}, {"key": "bypass", "type": "str", "required": false}, {"key": "username", "type": "str", "required": false}, {"key": "password", "type": "str", "required": false}]}, {"type": "TypedDict", "name": "RecordHar", "doc": "<p>Enables HAR recording for all pages into to a file.</p>\n<p>If not specified, the HAR is not recorded. Make sure to await context to close for the <a href=\"http://www.softwareishard.com/blog/har-12-spec/\">HAR</a> to be saved.</p>\n<p><span class=\"name\">omitContent</span>: Optional setting to control whether to omit request content from the HAR. Default is False</p>\n<p><a href=\"#type-Path\" class=\"name\">path</a>: Path on the filesystem to write the HAR file to.</p>\n<p>Example:</p>\n<pre>\n${har} =    Create Dictionary     path=/path/to/har.file    omitContent=True\nNew Context    recordHar=${har}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "omitContent", "type": "bool", "required": false}, {"key": "path", "type": "str", "required": false}]}, {"type": "TypedDict", "name": "RecordVideo", "doc": "<p>Enables Video recording</p>\n<p>Examples:</p>\n<pre>\n New Context  recordVideo={'dir':'videos', 'size':{'width':400, 'height':200}}\n New Context  recordVideo={'dir': 'd:/automation/video'}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "dir", "type": "str", "required": false}, {"key": "size", "type": "ViewportDimensions", "required": false}]}, {"type": "Enum", "name": "ReduceMotion", "doc": "<p>Emulates <span class=\"name\">prefers-reduced-motion</span> media feature, supported values are <span class=\"name\">reduce</span>, <span class=\"name\">no-preference</span>.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "reduce", "value": "1"}, {"name": "no_preference", "value": "2"}]}, {"type": "Custom", "name": "RegExp", "doc": "<p>Create a (JavaScript) RegExp object from a string.</p>\n<p>The matcher must start with a slash and end with a slash and can be followed by flags.</p>\n<p>Example: <code>/hello world/gi</code> Which is equivalent to <code>new RegExp(\"hello world\", \"gi\")</code> in JavaScript.</p>\n<p>Following flags are supported:</p>\n<table border=\"1\">\n<tr>\n<th>Flag</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>g</td>\n<td>Global search.</td>\n</tr>\n<tr>\n<td>i</td>\n<td>Case-insensitive search.</td>\n</tr>\n<tr>\n<td>m</td>\n<td>Allows <code>^</code> and <code>$</code> to match newline characters.</td>\n</tr>\n<tr>\n<td>s</td>\n<td>Allows <code>.</code> to match newline characters.</td>\n</tr>\n<tr>\n<td>u</td>\n<td>\"unicode\"; treat a pattern as a sequence of unicode code points.</td>\n</tr>\n<tr>\n<td>y</td>\n<td>Perform a \"sticky\" search that matches starting at the current position in the target string.</td>\n</tr>\n</table>\n<p>See <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp\">RegExp Object</a> and <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions\">RegExp Guide</a> for more information.</p>", "usages": ["Get Element By", "Get Element By Role", "Wait For Navigation", "Wait For Request", "Wait For Response"], "accepts": ["string"]}, {"type": "Enum", "name": "RequestMethod", "doc": "<p>Enum that defines the request type.</p>", "usages": ["Http"], "accepts": ["string"], "members": [{"name": "HEAD", "value": "1"}, {"name": "GET", "value": "2"}, {"name": "POST", "value": "3"}, {"name": "PUT", "value": "4"}, {"name": "PATCH", "value": "5"}, {"name": "DELETE", "value": "6"}]}, {"type": "Enum", "name": "Scale", "doc": "<p>Enum that defines the scale of the screenshot.</p>\n<p>When set to \"css\", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using \"device\" option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger.</p>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "css", "value": "1"}, {"name": "device", "value": "2"}]}, {"type": "Enum", "name": "Scope", "doc": "<p>Some keywords which manipulates library settings have a scope argument. With that scope argument one can set the \"live time\" of that setting. Available Scopes are: <code>Global</code>, <code>Suite</code> and <code>Test</code> / <code>Task</code>. Is a scope finished, this scoped setting, like timeout, will no longer be used and the previous higher scope setting applies again.</p>\n<p>Live Times:</p>\n<ul>\n<li>A <code>Global</code> scope will live forever until it is overwritten by another Global scope. Or locally temporarily overridden by a more narrow scope.</li>\n<li>A <code>Suite</code> scope will locally override the Global scope and live until the end of the Suite within it is set, or if it is overwritten by a later setting with Global or same scope. Children suite does inherit the setting from the parent suite but also may have its own local Suite setting that then will be inherited to its children suites.</li>\n<li>A <code>Test</code> or <code>Task</code> scope will be inherited from its parent suite but when set, lives until the end of that particular test or task.</li>\n</ul>\n<p>A new set higher order scope will always remove the lower order scope which may be in charge. So the setting of a Suite scope from a test, will set that scope to the robot file suite where that test is and removes the Test scope that may have been in place.</p>", "usages": ["Register Keyword To Run On Failure", "Set Assertion Formatters", "Set Browser Timeout", "Set Retry Assertions For", "Set Selector Prefix", "Set Strict Mode", "Show Keyword Banner"], "accepts": ["string"], "members": [{"name": "Global", "value": "1"}, {"name": "Suite", "value": "2"}, {"name": "Test", "value": "3"}, {"name": "Task", "value": "3"}]}, {"type": "Enum", "name": "ScreenshotFileTypes", "doc": "<p>Enum that defines available file types for screenshots.</p>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "png", "value": "1"}, {"name": "jpeg", "value": "2"}]}, {"type": "Enum", "name": "ScreenshotReturnType", "doc": "<p>Enum that defines what <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> keyword returns.</p>\n<ul>\n<li><code>path</code> returns the path to the screenshot file as <code>pathlib.Path</code> object.</li>\n<li><code>path_string</code> returns the path to the screenshot file as string.</li>\n<li><code>bytes</code> returns the screenshot itself as bytes.</li>\n<li><code>base64</code> returns the screenshot itself as base64 encoded string.</li>\n</ul>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "path", "value": "1"}, {"name": "path_string", "value": "2"}, {"name": "bytes", "value": "3"}, {"name": "base64", "value": "4"}]}, {"type": "Enum", "name": "ScrollBehavior", "doc": "<p>Enum that controls the behavior of scrolling.</p>\n<p><code>smooth</code></p>", "usages": ["Scroll By", "Scroll To"], "accepts": ["string"], "members": [{"name": "auto", "value": "1"}, {"name": "smooth", "value": "2"}]}, {"type": "TypedDict", "name": "ScrollPosition", "doc": "<p>Scroll position of an element.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>top</code></td>\n<td>The amount of pixel between the top border of the page and the top border of visible area.</td>\n</tr>\n<tr>\n<td><code>left</code></td>\n<td>The amount of pixel between the left border of the page and the left border of visible area.</td>\n</tr>\n<tr>\n<td><code>bottom</code></td>\n<td>The amount of pixel between the top border of the page and the bottom border of visible area.</td>\n</tr>\n<tr>\n<td><code>right</code></td>\n<td>The amount of pixel between the left border of the page and the right border of visible area.</td>\n</tr>\n</table>", "usages": ["Get Scroll Position"], "accepts": ["string", "Mapping"], "items": [{"key": "top", "type": "float", "required": true}, {"key": "left", "type": "float", "required": true}, {"key": "bottom", "type": "float", "required": true}, {"key": "right", "type": "float", "required": true}]}, {"type": "Enum", "name": "SelectAttribute", "doc": "<p>Enum that defines the attribute of an &lt;option&gt; element in a &lt;select&gt;-list.</p>\n<p>This defines by what attribute an option is selected/chosen.</p>\n<pre>\n&lt;select class=\"my_drop_down\"&gt;\n  &lt;option value=\"0: Object\"&gt;None&lt;/option&gt;\n  &lt;option value=\"1: Object\"&gt;Some&lt;/option&gt;\n  &lt;option value=\"2: Object\"&gt;Other&lt;/option&gt;\n&lt;/select&gt;\n</pre>\n<p><code>value</code> of the first option would be <code>0: Object</code>.</p>\n<p><code>label</code> / <code>text</code> both defines the innerText which would be <code>None</code> for first element.</p>\n<p><code>index</code> 0 indexed number of an option. Would be <code>0</code> for the first element.</p>", "usages": ["Get Selected Options", "Select Options By"], "accepts": ["string"], "members": [{"name": "value", "value": "1"}, {"name": "label", "value": "2"}, {"name": "text", "value": "2"}, {"name": "index", "value": "3"}]}, {"type": "Enum", "name": "SelectionStrategy", "doc": "<p>SelectionStrategy to be used. Refers to Playwrights <code>page.getBy***</code> functions. See <a href=\"https://playwright.dev/docs/locators\">Playwright Locators</a></p>\n<h3>AltText</h3>\n<p>All images should have an alt attribute that describes the image. You can locate an image based on the text alternative using page.getByAltText().</p>\n<p>For example, consider the following DOM structure.</p>\n<pre>\n&lt;img alt=\"playwright logo\" src=\"/img/playwright-logo.svg\" width=\"100\" /&gt;\n</pre>\n<h3>Label</h3>\n<p>Allows locating input elements by the text of the associated <code>&lt;label&gt;</code> or <code>aria-labelledby</code> element, or by the <code>aria-label</code> attribute.</p>\n<p>For example, this method will find inputs by label \"Username\" and \"Password\" in the following DOM:</p>\n<pre>\n&lt;input aria-label=\"Username\"&gt;\n&lt;label for=\"password-input\"&gt;Password:&lt;/label&gt;\n&lt;input id=\"password-input\"&gt;\n</pre>\n<h3>Placeholder</h3>\n<p>Allows locating input elements by the placeholder text.</p>\n<p>Example:</p>\n<pre>\n&lt;input type=\"email\" placeholder=\"name@example.com\" /&gt;\n</pre>\n<h3>TestId</h3>\n<p>Locate element by the test id.</p>\n<p>Currently only the exact attribute <code>data-testid</code> is supported.</p>\n<p>Example:</p>\n<pre>\n&lt;button data-testid=\"directions\"&gt;Itin\u00e9raire&lt;/button&gt;\n</pre>\n<h3>Text</h3>\n<p>Allows locating elements that contain given text.</p>\n<p>Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace. Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text \"Log in\" matches &lt;input type=button value=\"Log in\"&gt;.</p>\n<h3>Title</h3>\n<p>Allows locating elements by their title attribute.</p>\n<p>Example:</p>\n<pre>\n&lt;img alt=\"playwright logo\" src=\"/img/playwright-logo.svg\" title=\"Playwright\" width=\"100\" /&gt;\n</pre>", "usages": ["Get Element By"], "accepts": ["string"], "members": [{"name": "AltText", "value": "AltText"}, {"name": "Label", "value": "Label"}, {"name": "Placeholder", "value": "Placeholder"}, {"name": "TestID", "value": "TestId"}, {"name": "Text", "value": "Text"}, {"name": "Title", "value": "Title"}]}, {"type": "Enum", "name": "SelectionType", "doc": "<p>Enum that defines if the current id or all ids shall be returned.</p>\n<p><code>ACTIVE</code> / <code>CURRENT</code> defines to return only the id of the currently active instance of a Browser/Context/Page.</p>\n<p><code>ALL</code> / <code>ANY</code> defines to return ids of all instances.</p>", "usages": ["Close Browser", "Close Context", "Close Page", "Get Browser Ids", "Get Context Ids", "Get Page Ids", "Switch Context", "Switch Page"], "accepts": ["string"], "members": [{"name": "CURRENT", "value": "CURRENT"}, {"name": "ACTIVE", "value": "CURRENT"}, {"name": "ALL", "value": "ALL"}, {"name": "ANY", "value": "ALL"}]}, {"type": "TypedDict", "name": "SelectOptions", "doc": "<p>Dictionary with the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<table border=\"1\">\n<tr>\n<th>Keys</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>index</code></td>\n<td>0 based index of the option.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Value attribute of the option.</td>\n</tr>\n<tr>\n<td><code>label</code></td>\n<td>Label/Text of the option.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>Boolean if the option is selected.</td>\n</tr>\n</table>", "usages": ["Get Select Options"], "accepts": ["string", "Mapping"], "items": [{"key": "index", "type": "int", "required": true}, {"key": "value", "type": "str", "required": true}, {"key": "label", "type": "str", "required": true}, {"key": "selected", "type": "bool", "required": true}]}, {"type": "Enum", "name": "ServiceWorkersPermissions", "doc": "<p>Whether to allow sites to register Service workers.</p>\n<p><code>allow</code>: Service Workers can be registered.</p>\n<p><code>block</code>: Playwright will block all registration of Service Workers.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "allow", "value": "1"}, {"name": "block", "value": "2"}]}, {"type": "Enum", "name": "SizeFields", "doc": "<p>Enum that defines how the returned size is filtered.</p>\n<p><code>ALL</code> defines that the size is returned as a dictionary. <code>{'width': &lt;float&gt;, 'height': &lt;float&gt;}.</code></p>\n<p><code>width</code> / <code>height</code> will return a single float value of the chosen dimension.</p>", "usages": ["Get Client Size", "Get Scroll Size", "Get Viewport Size"], "accepts": ["string"], "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "ALL", "value": "3"}]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Add Cookie", "Add Style Tag", "Cancel Download", "Check Checkbox", "Clear Text", "Click", "Click With Options", "Close Browser", "Close Browser Server", "Close Context", "Close Page", "Connect To Browser", "Crawl Site", "Deselect Options", "Download", "Drag And Drop", "Drag And Drop Relative To", "Evaluate JavaScript", "Fill Secret", "Fill Text", "Focus", "Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Browser Ids", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Cookie", "Get Cookies", "Get Device", "Get Download State", "Get Element", "Get Element By", "Get Element By Role", "Get Element Count", "Get Element States", "Get Elements", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Element", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Go To", "Grant Permissions", "Handle Future Dialogs", "Highlight Elements", "Hover", "Http", "Keyboard Input", "Keyboard Key", "Launch Browser Server", "LocalStorage Clear", "LocalStorage Get Item", "LocalStorage Remove Item", "LocalStorage Set Item", "Mouse Move Relative To", "New Browser", "New Context", "New Page", "New Persistent Context", "Open Browser", "Press Keys", "Promise To", "Promise To Wait For Download", "Record Selector", "Register Keyword To Run On Failure", "Save Storage State", "Scroll By", "Scroll To", "Scroll To Element", "Select Options By", "SessionStorage Clear", "SessionStorage Get Item", "SessionStorage Remove Item", "SessionStorage Set Item", "Set Assertion Formatters", "Set Browser Timeout", "Set Retry Assertions For", "Set Selector Prefix", "Show Keyword Banner", "Switch Browser", "Switch Context", "Switch Page", "Take Screenshot", "Tap", "Type Secret", "Type Text", "Uncheck Checkbox", "Upload File By Selector", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Navigation", "Wait For Request", "Wait For Response"], "accepts": ["Any"]}, {"type": "Enum", "name": "SupportedBrowsers", "doc": "<p>Defines which browser shall be started.</p>\n<table border=\"1\">\n<tr>\n<th>Browser</th>\n<th>Browser with this engine</th>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td>Google Chrome, Microsoft Edge (since 2020), Opera</td>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td>Mozilla Firefox</td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td>Apple Safari, Mail, AppStore on MacOS and iOS</td>\n</tr>\n</table>\n<p>Since <a href=\"https://github.com/microsoft/playwright\">Playwright</a> comes with a pack of builtin binaries for all browsers, no additional drivers e.g. geckodriver are needed.</p>\n<p>All these browsers that cover more than 85% of the world wide used browsers, can be tested on Windows, Linux and MacOS. Theres is not need for dedicated machines anymore.</p>", "usages": ["__init__", "Connect To Browser", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Open Browser"], "accepts": ["string"], "members": [{"name": "chromium", "value": "1"}, {"name": "firefox", "value": "2"}, {"name": "webkit", "value": "3"}]}, {"type": "Standard", "name": "timedelta", "doc": "<p>Strings are expected to represent a time interval in one of the time formats Robot Framework supports:</p>\n<ul>\n<li>a number representing seconds like <code>42</code> or <code>10.5</code></li>\n<li>a time string like <code>1 hour 2 seconds</code> or <code>1h 2s</code></li>\n<li>a \"timer\" string like <code>01:02</code> (1 minute 2 seconds) or <code>01:00:03</code> (1 hour 3 seconds)</li>\n</ul>\n<p>Integers and floats are considered to be seconds.</p>\n<p>See the <a href=\"https://robotframework.org/robotframework/\">Robot Framework User Guide</a> for more details about the supported time formats.</p>", "usages": ["__init__", "Click With Options", "Download", "Get Console Log", "Get Page Errors", "Go To", "Highlight Elements", "Keyboard Input", "Launch Browser Server", "Mouse Button", "New Browser", "New Persistent Context", "Promise To Wait For Download", "Set Browser Timeout", "Set Retry Assertions For", "Take Screenshot", "Type Secret", "Type Text", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Load State", "Wait For Navigation", "Wait For Request", "Wait For Response", "Wait Until Network Is Idle"], "accepts": ["string", "integer", "float"]}, {"type": "TypedDict", "name": "ViewportDimensions", "doc": "<p>Viewport dimensions.</p>\n<p>Viewport is the browsers inner window size that is used to display the page.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>page width in pixels.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>page height in pixels.</td>\n</tr>\n</table>", "usages": ["Get Viewport Size", "New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "width", "type": "int", "required": true}, {"key": "height", "type": "int", "required": true}]}]}
+libdoc = {"specversion": 3, "name": "Browser", "doc": "<p>Browser library is a browser automation library for Robot Framework.</p>\n<p>This is the keyword documentation for Browser library. For information about installation, support, and more please visit the <a href=\"https://github.com/MarketSquare/robotframework-playwright\">project pages</a>. For more information about Robot Framework itself, see <a href=\"https://robotframework.org\">robotframework.org</a>.</p>\n<p>Browser library uses <a href=\"https://github.com/microsoft/playwright\">Playwright Node module</a> to automate <a href=\"https://www.chromium.org/Home\">Chromium</a>, <a href=\"https://www.mozilla.org/en-US/firefox/new/\">Firefox</a> and <a href=\"https://webkit.org/\">WebKit</a> with a single library.</p>\n<h3 id=\"Table of contents\">Table of contents</h3>\n<ul>\n<li><a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a></li>\n<li><a href=\"#Automatic%20page%20and%20context%20closing\" class=\"name\">Automatic page and context closing</a></li>\n<li><a href=\"#Finding%20elements\" class=\"name\">Finding elements</a></li>\n<li><a href=\"#Assertions\" class=\"name\">Assertions</a></li>\n<li><a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a></li>\n<li><a href=\"#Experimental%3A%20Re-using%20same%20node%20process\" class=\"name\">Experimental: Re-using same node process</a></li>\n<li><a href=\"#Experimental%3A%20Provide%20parameters%20to%20node%20process\" class=\"name\">Experimental: Provide parameters to node process</a></li>\n<li><a href=\"#Scope%20Setting\" class=\"name\">Scope Setting</a></li>\n<li><a href=\"#Extending%20Browser%20library%20with%20a%20JavaScript%20module\" class=\"name\">Extending Browser library with a JavaScript module</a></li>\n<li><a href=\"#Plugins\" class=\"name\">Plugins</a></li>\n<li><a href=\"#Language\" class=\"name\">Language</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Browser, Context and Page\">Browser, Context and Page</h2>\n<p>Browser library works with three different layers that build on each other: <b>Browser</b>, <b>Context</b> and <b>Page</b>.</p>\n<h3 id=\"Browsers\">Browsers</h3>\n<p>A <b>browser</b> can be started with one of the three different engines Chromium, Firefox or Webkit.</p>\n<h4 id=\"Supported Browsers\">Supported Browsers</h4>\n<table border=\"1\">\n<tr>\n<td>Browser</td>\n<td>Browser with this engine</td>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td>Google Chrome, Microsoft Edge (since 2020), Opera</td>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td>Mozilla Firefox</td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td>Apple Safari, Mail, AppStore on MacOS and iOS</td>\n</tr>\n</table>\n<p>Since <a href=\"https://github.com/microsoft/playwright\">Playwright</a> comes with a pack of builtin binaries for all browsers, no additional drivers e.g. geckodriver are needed.</p>\n<p>All these browsers that cover more than 85% of the world wide used browsers, can be tested on Windows, Linux and MacOS. There is no need for dedicated machines anymore.</p>\n<p>A browser process is started <code>headless</code> (without a GUI) by default. Run <a href=\"#New%20Browser\" class=\"name\">New Browser</a> with specified arguments if a browser with a GUI is requested or if a proxy has to be configured. A browser process can contain several contexts.</p>\n<h3 id=\"Contexts\">Contexts</h3>\n<p>A <b>context</b> corresponds to a set of independent incognito pages in a browser that share cookies, sessions or profile settings. Pages in two separate contexts do not share cookies, sessions or profile settings. Compared to Selenium, these do <b>not</b> require their own browser process. To get a clean environment a test can just open a new context. Due to this new independent browser sessions can be opened with Robot Framework Browser about 10 times faster than with Selenium by just opening a <a href=\"#New%20Context\" class=\"name\">New Context</a> within the opened browser.</p>\n<p>To make pages in the same suite share state, use the same context by opening the context with <a href=\"#New%20Context\" class=\"name\">New Context</a> on suite setup.</p>\n<p>The context layer is useful e.g. for testing different user sessions on the same webpage without opening a whole new browser context. Contexts can also have detailed configurations, such as geo-location, language settings, the viewport size or color scheme. Contexts do also support http credentials to be set, so that basic authentication can also be tested. To be able to download files within the test, the <code>acceptDownloads</code> argument must be set to <code>True</code> in <a href=\"#New%20Context\" class=\"name\">New Context</a> keyword. A context can contain different pages.</p>\n<h3 id=\"Pages\">Pages</h3>\n<p>A <b>page</b> does contain the content of the loaded web site and has a browsing history. Pages and browser tabs are the same.</p>\n<p>Typical usage could be:</p>\n<pre>\n<b>*</b> Test Cases <b>*</b>\nStarting a browser with a page\n    New Browser    chromium    headless=false\n    New Context    viewport={'width': 1920, 'height': 1080}\n    New Page       <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html\">https://marketsquare.github.io/robotframework-browser/Browser.html</a>\n    Get Title      ==    Browser\n</pre>\n<p>The <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword opens a new browser, a new context and a new page. This keyword is useful for quick experiments or debugging sessions.</p>\n<p>When a <a href=\"#New%20Page\" class=\"name\">New Page</a> is called without an open browser, <a href=\"#New%20Browser\" class=\"name\">New Browser</a> and <a href=\"#New%20Context\" class=\"name\">New Context</a> are executed with default values first.</p>\n<p>Each Browser, Context and Page has a unique ID with which they can be addressed. A full catalog of what is open can be received by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a> as a dictionary.</p>\n<h2 id=\"Automatic page and context closing\">Automatic page and context closing</h2>\n<p>Controls when contexts and pages are closed during the test execution.</p>\n<p>If automatic closing level is <span class=\"name\">TEST</span>, contexts and pages that are created during a single test are automatically closed when the test ends. Contexts and pages that are created during suite setup are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">SUITE</span>, all contexts and pages that are created during the test suite are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">MANUAL</span>, nothing is closed automatically while the test execution is ongoing. All browsers, context and pages are automatically closed when test execution ends.</p>\n<p>If automatic closing level is <span class=\"name\">KEEP</span>, nothing is closed automatically while the test execution is ongoing. Also, nothing is closed when test execution ends, including the node process. Therefore, it is users responsibility to close all browsers, context and pages and ensure that all process that are left running after the test execution end are closed. This level is only intended for test case development and must not be used when running tests in CI or similar environments.</p>\n<p>Automatic closing can be configured or switched off with the auto_closing_level library import parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>\n<h2 id=\"Finding elements\">Finding elements</h2>\n<p>All keywords in the library that need to interact with an element on a web page take an argument typically named <code>selector</code> that specifies how to find the element. Keywords can find elements with strict mode. If strict mode is true and locator finds multiple elements from the page, keyword will fail. If keyword finds one element, keyword does not fail because of strict mode. If strict mode is false, keyword does not fail if selector points many elements. Strict mode is enabled by default, but can be changed in library <a href=\"#Importing\" class=\"name\">importing</a> or <a href=\"#Set%20Strict%20Mode\" class=\"name\">Set Strict Mode</a> keyword. Keyword documentation states if keyword uses strict mode. If keyword does not state that strict mode is used, then strict mode is not applied for the keyword. For more details, see Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-query-selector\">strict documentation</a>.</p>\n<p>Selector strategies that are supported by default are listed in the table below.</p>\n<table border=\"1\">\n<tr>\n<th>Strategy</th>\n<th>Match based on</th>\n<th>Example</th>\n</tr>\n<tr>\n<td><code>css</code></td>\n<td>CSS selector.</td>\n<td><code>css=.class &gt; \\#login_btn</code></td>\n</tr>\n<tr>\n<td><code>xpath</code></td>\n<td>XPath expression.</td>\n<td><code>xpath=//input[@id=\"login_btn\"]</code></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Browser text engine.</td>\n<td><code>text=Login</code></td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>Element ID Attribute.</td>\n<td><code>id=login_btn</code></td>\n</tr>\n</table>\n<p>CSS Selectors can also be recorded with <a href=\"#Record%20Selector\" class=\"name\">Record selector</a> keyword.</p>\n<h3 id=\"Explicit Selector Strategy\">Explicit Selector Strategy</h3>\n<p>The explicit selector strategy is specified with a prefix using syntax <code>strategy=value</code>. Spaces around the separator are ignored, so <code>css=foo</code>, <code>css= foo</code> and <code>css = foo</code> are all equivalent.</p>\n<h3 id=\"Implicit Selector Strategy\">Implicit Selector Strategy</h3>\n<p><b>The default selector strategy is <a href=\"#CSS\" class=\"name\">css</a>.</b></p>\n<p>If selector does not contain one of the know explicit selector strategies, it is assumed to contain css selector.</p>\n<p>Selectors that are starting with <code>//</code> or <code>..</code> are considered as xpath selectors.</p>\n<p>Selectors that are in quotes are considered as text selectors.</p>\n<p>Examples:</p>\n<pre>\n# CSS selectors are default.\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class         # This is equivalent\n<a href=\"#Click\" class=\"name\">Click</a>  css=span &gt; button.some_class     # to this.\n\n# // or .. leads to xpath selector strategy\n<a href=\"#Click\" class=\"name\">Click</a>  //span/button[@class=\"some_class\"]\n<a href=\"#Click\" class=\"name\">Click</a>  xpath=//span/button[@class=\"some_class\"]\n\n# \"text\" in quotes leads to exact text selector strategy\n<a href=\"#Click\" class=\"name\">Click</a>  \"Login\"\n<a href=\"#Click\" class=\"name\">Click</a>  text=\"Login\"\n</pre>\n<h3 id=\"CSS\">CSS</h3>\n<p>As written before, the default selector strategy is <a href=\"#CSS\" class=\"name\">css</a>. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\">css selector</a> for more information.</p>\n<p>Any malformed selector not starting with <code>//</code> or <code>..</code> nor starting and ending with a quote is assumed to be a css selector.</p>\n<p>Note that <code>#</code> is a comment character in <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#ignored-data\">Robot Framework syntax</a> and needs to be escaped like <code>\\#</code> to work as a <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors\">css ID selector</a>.</p>\n<p>Examples:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>  \\#username_field  ==  George\n</pre>\n<h3 id=\"XPath\">XPath</h3>\n<p>XPath engine is equivalent to <a href=\"https://developer.mozilla.org/en/docs/Web/API/Document/evaluate\">Document.evaluate</a>. Example: <code>xpath=//html/body//span[text()=\"Hello World\"]</code>.</p>\n<p>Malformed selector starting with <code>//</code> or <code>..</code> is assumed to be an xpath selector. For example, <code>//html/body</code> is converted to <code>xpath=//html/body</code>. More examples are displayed in <a href=\"#Examples\" class=\"name\">Examples</a>.</p>\n<p>Note that xpath does not pierce <a href=\"https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM\">shadow_roots</a>.</p>\n<h3 id=\"Text\">Text</h3>\n<p>Text engine finds an element that contains a text node with the passed text. For example, <code>Click    text=Login</code> clicks on a login button, and <code>Wait For Elements State   text=\"lazy loaded text\"</code> waits for the \"lazy loaded text\" to appear in the page.</p>\n<p>Text engine finds fields based on their labels in text inserting keywords.</p>\n<p>Malformed selector starting and ending with a quote (either <code>\"</code> or <code>'</code>) is assumed to be a text selector. For example, <code>Click    \"Login\"</code> is converted to <code>Click    text=\"Login\"</code>. Be aware that these leads to exact matches only! More examples are displayed in <a href=\"#Examples\" class=\"name\">Examples</a>.</p>\n<h4 id=\"Insensitive match\">Insensitive match</h4>\n<p>By default, the match is case-insensitive, ignores leading/trailing whitespace and searches for a substring. This means <code>text= Login</code> matches <code>&lt;button&gt;Button loGIN (click me)&lt;/button&gt;</code>.</p>\n<h4 id=\"Exact match\">Exact match</h4>\n<p>Text body can be escaped with single or double quotes for precise matching, insisting on exact match, including specified whitespace and case. This means <code>text=\"Login \"</code> will only match <code>&lt;button&gt;Login &lt;/button&gt;</code> with exactly one space after \"Login\". Quoted text follows the usual escaping rules, e.g. use <code>\\\"</code> to escape double quote in a double-quoted string: <code>text=\"foo\\\"bar\"</code>.</p>\n<h4 id=\"RegEx\">RegEx</h4>\n<p>Text body can also be a JavaScript-like regex wrapped in / symbols. This means <code>text=/^hello .*!$/i</code> or <code>text=/^Hello .*!$/</code> will match <code>&lt;span&gt;Hello Peter Parker!&lt;/span&gt;</code> with any name after <code>Hello</code>, ending with <code>!</code>. The first one flagged with <code>i</code> for case-insensitive. See <a href=\"https://regex101.com/\">https://regex101.com</a> for more information about RegEx.</p>\n<h4 id=\"Button and Submit Values\">Button and Submit Values</h4>\n<p>Input elements of the type button and submit are rendered with their value as text, and text engine finds them. For example, <code>text=Login</code> matches <code>&lt;input type=button value=\"Login\"&gt;</code>.</p>\n<h3 id=\"Cascaded selector syntax\">Cascaded selector syntax</h3>\n<p>Browser library supports the same selector strategies as the underlying Playwright node module: xpath, css, id and text. The strategy can either be explicitly specified with a prefix or the strategy can be implicit.</p>\n<p>A major advantage of Browser is that multiple selector engines can be used within one selector. It is possible to mix XPath, CSS and Text selectors while selecting a single element.</p>\n<p>Selectors are strings that consists of one or more clauses separated by <code>&gt;&gt;</code> token, e.g. <code>clause1 &gt;&gt; clause2 &gt;&gt; clause3</code>. When multiple clauses are present, next one is queried relative to the previous one's result. Browser library supports concatenation of different selectors separated by <code>&gt;&gt;</code>.</p>\n<p>For example:</p>\n<pre>\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    \"Hello\" &gt;&gt; ../.. &gt;&gt; .select_button\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    text=Hello &gt;&gt; xpath=../.. &gt;&gt; css=.select_button\n</pre>\n<p>Each clause contains a selector engine name and selector body, e.g. <code>engine=body</code>. Here <code>engine</code> is one of the supported engines (e.g. css or a custom one). Selector <code>body</code> follows the format of the particular engine, e.g. for css engine it should be a <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\">css selector</a>. Body format is assumed to ignore leading and trailing white spaces, so that extra whitespace can be added for readability. If the selector engine needs to include <code>&gt;&gt;</code> in the body, it should be escaped inside a string to not be confused with clause separator, e.g. <code>text=\"some &gt;&gt; text\"</code>.</p>\n<p>Selector engine name can be prefixed with <code>*</code> to capture an element that matches the particular clause instead of the last one. For example, <code>css=article &gt;&gt; text=Hello</code> captures the element with the text <code>Hello</code>, and <code>*css=article &gt;&gt; text=Hello</code> (note the *) captures the article element that contains some element with the text Hello.</p>\n<p>For convenience, selectors in the wrong format are heuristically converted to the right format. See <a href=\"#Implicit%20Selector%20Strategy\" class=\"name\">Implicit Selector Strategy</a></p>\n<h3 id=\"Examples\">Examples</h3>\n<pre>\n# queries 'div' css selector\nGet Element    css=div\n\n# queries '//html/body/div' xpath selector\nGet Element    //html/body/div\n\n# queries '\"foo\"' text selector\nGet Element    text=foo\n\n# queries 'span' css selector inside the result of '//html/body/div' xpath selector\nGet Element    xpath=//html/body/div &gt;&gt; css=span\n\n# converted to 'css=div'\nGet Element    div\n\n# converted to 'xpath=//html/body/div'\nGet Element    //html/body/div\n\n# converted to 'text=\"foo\"'\nGet Element    \"foo\"\n\n# queries the div element of every 2nd span element inside an element with the id foo\nGet Element    \\#foo &gt;&gt; css=span:nth-child(2n+1) &gt;&gt; div\nGet Element    id=foo &gt;&gt; css=span:nth-child(2n+1) &gt;&gt; div\n</pre>\n<p>Be aware that using <code>#</code> as a starting character in Robot Framework would be interpreted as comment. Due to that fact a <code>#id</code> must be escaped as <code>\\#id</code>.</p>\n<h3 id=\"iFrames\">iFrames</h3>\n<p>By default, selector chains do not cross frame boundaries. It means that a simple CSS selector is not able to select an element located inside an iframe or a frameset. For this use case, there is a special selector <code>&gt;&gt;&gt;</code> which can be used to combine a selector for the frame and a selector for an element inside a frame.</p>\n<p>Given this simple pseudo html snippet:</p>\n<pre>\n&lt;iframe id=\"iframe\" src=\"src.html\"&gt;\n  #document\n    &lt;!DOCTYPE html&gt;\n    &lt;html&gt;\n      &lt;head&gt;&lt;/head&gt;\n      &lt;body&gt;\n        &lt;button id=\"btn\"&gt;Click Me&lt;/button&gt;\n      &lt;/body&gt;\n    &lt;/html&gt;\n&lt;/iframe&gt;\n</pre>\n<p>Here's a keyword call that clicks the button inside the frame.</p>\n<pre>\nClick   id=iframe &gt;&gt;&gt; id=btn\n</pre>\n<p>The selectors on the left and right side of <code>&gt;&gt;&gt;</code> can be any valid selectors. The selector clause directly before the frame opener <code>&gt;&gt;&gt;</code> must select the frame element itself. Frame selection is the only place where Browser Library modifies the selector, as explained in above. In all cases, the library does not alter the selector in any way, instead it is passed as is to the Playwright side.</p>\n<p>If multiple keyword shall be performed inside a frame, it is possible to define a selector prefix with <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>. If this prefix is set to a frame/iframe it has similar behavior as SeleniumLibrary keyword <span class=\"name\">Select Frame</span>.</p>\n<h3 id=\"WebComponents and Shadow DOM\">WebComponents and Shadow DOM</h3>\n<p>Playwright and so also Browser are able to do automatic piercing of Shadow DOMs and therefore are the best automation technology when working with WebComponents.</p>\n<p>Also other technologies claim that they can handle <a href=\"https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM\">Shadow DOM and Web Components</a>. However, none of them do pierce shadow roots automatically, which may be inconvenient when working with Shadow DOM and Web Components.</p>\n<p>For that reason, the css engine pierces shadow roots. More specifically, every <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/Descendant_combinator\">Descendant combinator</a> pierces an arbitrary number of open shadow roots, including the implicit descendant combinator at the start of the selector.</p>\n<p>That means, it is not necessary to select each shadow host, open its shadow root and select the next shadow host until you reach the element that should be controlled.</p>\n<h4 id=\"CSS:light\">CSS:light</h4>\n<p><code>css:light</code> engine is equivalent to <a href=\"https://developer.mozilla.org/en/docs/Web/API/Document/querySelector\">Document.querySelector</a> and behaves according to the CSS spec. However, it does not pierce shadow roots.</p>\n<p><code>css</code> engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.</p>\n<p>Examples:</p>\n<pre>\n&lt;article&gt;\n  &lt;div&gt;In the light dom&lt;/div&gt;\n  &lt;div slot='myslot'&gt;In the light dom, but goes into the shadow slot&lt;/div&gt;\n  &lt;open mode shadow root&gt;\n      &lt;div class='in-the-shadow'&gt;\n          &lt;span class='content'&gt;\n              In the shadow dom\n              &lt;open mode shadow root&gt;\n                  &lt;li id='target'&gt;Deep in the shadow&lt;/li&gt;\n              &lt;/open mode shadow root&gt;\n          &lt;/span&gt;\n      &lt;/div&gt;\n      &lt;slot name='myslot'&gt;&lt;/slot&gt;\n  &lt;/open mode shadow root&gt;\n&lt;/article&gt;\n</pre>\n<p>Note that <code>&lt;open mode shadow root&gt;</code> is not an html element, but rather a shadow root created with <code>element.attachShadow({mode: 'open'})</code>.</p>\n<ul>\n<li>Both <code>\"css=article div\"</code> and <code>\"css:light=article div\"</code> match the first <code>&lt;div&gt;In the light dom&lt;/div&gt;</code>.</li>\n<li>Both <code>\"css=article &gt; div\"</code> and <code>\"css:light=article &gt; div\"</code> match two <code>div</code> elements that are direct children of the <code>article</code>.</li>\n<li><code>\"css=article .in-the-shadow\"</code> matches the <code>&lt;div class='in-the-shadow'&gt;</code>, piercing the shadow root, while <code>\"css:light=article .in-the-shadow\"</code> does not match anything.</li>\n<li><code>\"css:light=article div &gt; span\"</code> does not match anything, because both light-dom <code>div</code> elements do not contain a <code>span</code>.</li>\n<li><code>\"css=article div &gt; span\"</code> matches the <code>&lt;span class='content'&gt;</code>, piercing the shadow root.</li>\n<li><code>\"css=article &gt; .in-the-shadow\"</code> does not match anything, because <code>&lt;div class='in-the-shadow'&gt;</code> is not a direct child of <code>article</code></li>\n<li><code>\"css:light=article &gt; .in-the-shadow\"</code> does not match anything.</li>\n<li><code>\"css=article li#target\"</code> matches the <code>&lt;li id='target'&gt;Deep in the shadow&lt;/li&gt;</code>, piercing two shadow roots.</li>\n</ul>\n<h4 id=\"text:light\">text:light</h4>\n<p><code>text</code> engine open pierces shadow roots similarly to <code>css</code>, while <code>text:light</code> does not. Text engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.</p>\n<h4 id=\"id, data-testid, data-test-id, data-test and their :light counterparts\">id, data-testid, data-test-id, data-test and their :light counterparts</h4>\n<p>Attribute engines are selecting based on the corresponding attribute value. For example: <code>data-test-id=foo</code> is equivalent to <code>css=[data-test-id=\"foo\"]</code>, and <code>id:light=foo</code> is equivalent to <code>css:light=[id=\"foo\"]</code>.</p>\n<h3 id=\"Element reference syntax\">Element reference syntax</h3>\n<p>It is possible to get a reference to a Locator by using <a href=\"#Get%20Element\" class=\"name\">Get Element</a> and <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a> keywords. Keywords do not save reference to an element in the HTML document, instead it saves reference to a Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a>. In nutshell Locator captures the logic of how to retrieve that element from the page. Each time an action is performed, the locator re-searches the elements in the page. This reference can be used as a <b>first</b> part of a selector by using a special selector syntax <span class=\"name\">element=</span>. like this:</p>\n<pre>\n${ref}=    Get Element    .some_class\n           Click          ${ref} &gt;&gt; .some_child     # Locator searches an element from the page.\n           Click          ${ref} &gt;&gt; .other_child    # Locator searches again an element from the page.\n</pre>\n<p>The <span class=\"name\">.some_child</span> and <span class=\"name\">.other_child</span> selectors in the example are relative to the element referenced by ${ref}. Please note that frame piercing is not possible with element reference.</p>\n<h2 id=\"Assertions\">Assertions</h2>\n<p>Keywords that accept arguments <code>assertion_operator</code> &lt;<a href=\"#type-AssertionOperator\" class=\"name\">AssertionOperator</a>&gt; and <code>assertion_expected</code> can optionally assert that a specified condition holds. Keywords will return the value even when the assertion is performed by the keyword.</p>\n<p>Assert will retry and fail only after a specified timeout. See <a href=\"#Importing\" class=\"name\">Importing</a> and <code>retry_assertions_for</code> (default is 1 second) for configuring this timeout.</p>\n<p>Currently supported assertion operators are:</p>\n<table border=\"1\">\n<tr>\n<th>Operator</th>\n<th>Alternative Operators</th>\n<th>Description</th>\n<th>Validate Equivalent</th>\n</tr>\n<tr>\n<td><code>==</code></td>\n<td><code>equal</code>, <code>equals</code>, <code>should be</code></td>\n<td>Checks if returned value is equal to expected value.</td>\n<td><code>value == expected</code></td>\n</tr>\n<tr>\n<td><code>!=</code></td>\n<td><code>inequal</code>, <code>should not be</code></td>\n<td>Checks if returned value is not equal to expected value.</td>\n<td><code>value != expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;</code></td>\n<td><code>greater than</code></td>\n<td>Checks if returned value is greater than expected value.</td>\n<td><code>value &gt; expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;=</code></td>\n<td></td>\n<td>Checks if returned value is greater than or equal to expected value.</td>\n<td><code>value &gt;= expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;</code></td>\n<td><code>less than</code></td>\n<td>Checks if returned value is less than expected value.</td>\n<td><code>value &lt; expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;=</code></td>\n<td></td>\n<td>Checks if returned value is less than or equal to expected value.</td>\n<td><code>value &lt;= expected</code></td>\n</tr>\n<tr>\n<td><code>*=</code></td>\n<td><code>contains</code></td>\n<td>Checks if returned value contains expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td></td>\n<td><code>not contains</code></td>\n<td>Checks if returned value does not contain expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td><code>^=</code></td>\n<td><code>should start with</code>, <code>starts</code></td>\n<td>Checks if returned value starts with expected value.</td>\n<td><code>re.search(f\"^{expected}\", value)</code></td>\n</tr>\n<tr>\n<td><code>$=</code></td>\n<td><code>should end with</code>, <code>ends</code></td>\n<td>Checks if returned value ends with expected value.</td>\n<td><code>re.search(f\"{expected}$\", value)</code></td>\n</tr>\n<tr>\n<td><code>matches</code></td>\n<td></td>\n<td>Checks if given RegEx matches minimum once in returned value.</td>\n<td><code>re.search(expected, value)</code></td>\n</tr>\n<tr>\n<td><code>validate</code></td>\n<td></td>\n<td>Checks if given Python expression evaluates to <code>True</code>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>evaluate</code></td>\n<td><code>then</code></td>\n<td>When using this operator, the keyword does return the evaluated Python expression.</td>\n<td></td>\n</tr>\n</table>\n<p>Currently supported formatters for assertions are:</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Substitutes multiple spaces to single space from the value</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from the beginning and end of the value</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts value to lower case before comparing</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies rules also for the expected value</td>\n</tr>\n</table>\n<p>Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If <code>apply to expected</code> formatter is defined, then formatters are then formatter are also applied to expected value.</p>\n<p>By default, keywords will provide an error message if an assertion fails. Default error messages can be overwritten with a <code>message</code> argument. The <code>message</code> argument accepts <span class=\"name\">{value}</span>, <span class=\"name\">{value_type}</span>, <span class=\"name\">{expected}</span> and <span class=\"name\">{expected_type}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options. The <span class=\"name\">{value}</span> is the value returned by the keyword and the <span class=\"name\">{expected}</span> is the expected value defined by the user, usually the value in the <code>assertion_expected</code> argument. The <span class=\"name\">{value_type}</span> and <span class=\"name\">{expected_type}</span> are the type definitions from <span class=\"name\">{value}</span> and <span class=\"name\">{expected}</span> arguments. In similar fashion as Python <a href=\"https://docs.python.org/3/library/functions.html#type\">type</a> returns type definition. Assertions will retry until <code>timeout</code> has expired if they do not pass.</p>\n<p>The assertion <code>assertion_expected</code> value is not converted by the library and is used as is. Therefore when assertion is made, the <code>assertion_expected</code> argument value and value returned the keyword must have the same type. If types are not the same, assertion will fail. Example <a href=\"#Get%20Text\" class=\"name\">Get Text</a> always returns a string and has to be compared with a string, even the returned value might look like a number.</p>\n<p>Other Keywords have other specific types they return. <a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a> always returns an integer. <a href=\"#Get%20BoundingBox\" class=\"name\">Get Bounding Box</a> and <a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a> can be filtered. They return a dictionary without a filter and a number when filtered. These Keywords do automatic conversion for the expected value if a number is returned.</p>\n<p>* &lt; less or greater &gt; With Strings* Comparisons of strings with <code>greater than</code> or <code>less than</code> compares each character, starting from 0 regarding where it stands in the code page. Example: <code>A &lt; Z</code>, <code>Z &lt; a</code>, <code>ac &lt; dc<span class=\"name\"> It does never compare the length of elements. Neither lists nor strings. The comparison stops at the first character that is different. Examples: </span>`'abcde' &lt; 'abd'</code>, <code>'100.000' &lt; '2'</code> In Python 3 and therefore also in Browser it is not possible to compare numbers with strings with a greater or less operator. On keywords that return numbers, the given expected value is automatically converted to a number before comparison.</p>\n<p>The getters <span class=\"name\">Get Page State</span> and <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a> return a dictionary. Values of the dictionary can directly asserted. Pay attention of possible types because they are evaluated in Python. For example:</p>\n<pre>\nGet Page State    validate    2020 &gt;= value['year']                     # Comparison of numbers\nGet Page State    validate    \"IMPORTANT MESSAGE!\" == value['message']  # Comparison of strings\n</pre>\n<h3 id=\"The 'then' or 'evaluate' closure\">The 'then' or 'evaluate' closure</h3>\n<p>Keywords that accept arguments <code>assertion_operator</code> and <code>assertion_expected</code> can optionally also use <code>then</code> or <code>evaluate</code> closure to modify the returned value with BuiltIn Evaluate. Actual value can be accessed with <code>value</code>.</p>\n<p>For example <code>Get Title  then  'TITLE: '+value</code>. See <a href=\"https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Evaluating%20expressions\">Builtin Evaluating expressions</a> for more info on the syntax.</p>\n<h3 id=\"Examples\">Examples</h3>\n<pre>\n# <b>Keyword</b>    <b>Selector</b>                    <b>Key</b>        <b>Assertion Operator</b>    <b>Assertion Expected</b>\nGet Title                                           equal                 Page Title\nGet Title                                           ^=                    Page\nGet Style    //*[@id=\"div-element\"]      width      &gt;                     100\nGet Title                                           matches               \\\\w+\\\\s\\\\w+\nGet Title                                           validate              value == \"Login Page\"\nGet Title                                           evaluate              value if value == \"some value\" else \"something else\"\n</pre>\n<h2 id=\"Implicit waiting\">Implicit waiting</h2>\n<p>Browser library and Playwright have many mechanisms to help in waiting for elements. Playwright will auto-wait before performing actions on elements. Please see <a href=\"https://playwright.dev/docs/actionability/\">Auto-waiting on Playwright documentation</a> for more information.</p>\n<p>On top of Playwright auto-waiting Browser assertions will wait and retry for specified time before failing any <a href=\"#Assertions\" class=\"name\">Assertions</a>. Time is specified in Browser library initialization with <code>retry_assertions_for</code>.</p>\n<p>Browser library also includes explicit waiting keywords such as <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait for Elements State</a> if more control for waiting is needed.</p>\n<h2 id=\"Experimental: Re-using same node process\">Experimental: Re-using same node process</h2>\n<p>Browser library integrated nodejs and python. The NodeJS side can be also executed as a standalone process. Browser libraries running on the same machine can talk to that instead of starting new node processes. This can speed execution when running tests parallel. To start node side run on the directory when the Browser package is <code>PLAYWRIGHT_BROWSERS_PATH=0 node Browser/wrapper/index.js PORT</code>.</p>\n<p><code>PORT</code> is the port you want to use for the node process. To execute tests then with pabot for example do <code>ROBOT_FRAMEWORK_BROWSER_NODE_PORT=PORT pabot ..</code>.</p>\n<h2 id=\"Experimental: Provide parameters to node process\">Experimental: Provide parameters to node process</h2>\n<p>Browser library is integrated with NodeJSand and Python. Browser library starts a node process, to communicate Playwright API in NodeJS side. It is possible to provide parameters for the started node process by defining ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS environment variable, before starting the test execution. Example: <code>ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS=--inspect;robot path/to/tests</code>. There can be multiple arguments defined in the environment variable and arguments must be separated with comma.</p>\n<h2 id=\"Scope Setting\">Scope Setting</h2>\n<p>Some keywords which manipulates library settings have a scope argument. With that scope argument one can set the \"live time\" of that setting. Available Scopes are: <span class=\"name\">Global</span>, <span class=\"name\">Suite</span> and <span class=\"name\">Test</span>/<span class=\"name\">Task</span> See <a href=\"#type-Scope\" class=\"name\">Scope</a>. Is a scope finished, this scoped setting, like timeout, will no longer be used.</p>\n<p>Live Times:</p>\n<ul>\n<li>A <span class=\"name\">Global</span> scope will live forever until it is overwritten by another <span class=\"name\">Global</span> scope. Or locally temporarily overridden by a more narrow scope.</li>\n<li>A <span class=\"name\">Suite</span> scope will locally override the <span class=\"name\">Global</span> scope and live until the end of the Suite within it is set, or if it is overwritten by a later setting with <span class=\"name\">Global</span> or same scope. Children suite does inherit the setting from the parent suite but also may have its own local <span class=\"name\">Suite</span> setting that then will be inherited to its children suites.</li>\n<li>A <span class=\"name\">Test</span> or <span class=\"name\">Task</span> scope will be inherited from its parent suite but when set, lives until the end of that particular test or task.</li>\n</ul>\n<p>A new set higher order scope will always remove the lower order scope which may be in charge. So the setting of a <span class=\"name\">Suite</span> scope from a test, will set that scope to the robot file suite where that test is and removes the <span class=\"name\">Test</span> scope that may have been in place.</p>\n<h2 id=\"Extending Browser library with a JavaScript module\">Extending Browser library with a JavaScript module</h2>\n<p>Browser library can be extended with JavaScript. The module must be in CommonJS format that Node.js uses. You can translate your ES6 module to Node.js CommonJS style with Babel. Many other languages can be also translated to modules that can be used from Node.js. For example TypeScript, PureScript and ClojureScript just to mention few.</p>\n<pre>\nasync function myGoToKeyword(url, args, page, logger, playwright) {\n  logger(args.toString())\n  playwright.coolNewFeature()\n  return await page.goto(url);\n}\n</pre>\n<p>Functions can contain any number of arguments and arguments may have default values.</p>\n<p>There are some reserved arguments that are not accessible from Robot Framework side. They are injected to the function if they are in the arguments:</p>\n<p><code>page</code>: <a href=\"https://playwright.dev/docs/api/class-page\">the playwright Page object</a>.</p>\n<p><code>args</code>: the rest of values from Robot Framework keyword call <code>*args</code>.</p>\n<p><code>logger</code>: callback function that takes strings as arguments and writes them to robot log. Can be called multiple times.</p>\n<p><code>playwright</code>: playwright module (* from 'playwright'). Useful for integrating with Playwright features that Browser library doesn't support with it's own keywords. <a href=\"https://playwright.dev/docs/api/class-playwright\">API docs</a></p>\n<p>also argument name <code>self</code> can not be used.</p>\n<h3 id=\"Example module.js\">Example module.js</h3>\n<pre>\nasync function myGoToKeyword(pageUrl, page) {\n  await page.goto(pageUrl);\n  return await page.title();\n}\nexports.__esModule = true;\nexports.myGoToKeyword = myGoToKeyword;\n</pre>\n<h3 id=\"Example Robot Framework side\">Example Robot Framework side</h3>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary   Browser  jsextension=${CURDIR}/module.js\n\n<b>*</b> Test Cases <b>*</b>\nHello\n  New Page\n  ${title}=  myGoToKeyword  <a href=\"https://playwright.dev\">https://playwright.dev</a>\n  Should be equal  ${title}  Playwright\n</pre>\n<p>Also selector syntax can be extended with a custom selector using a js module</p>\n<h3 id=\"Example module keyword for custom selector registering\">Example module keyword for custom selector registering</h3>\n<pre>\nasync function registerMySelector(playwright) {\nplaywright.selectors.register(\"myselector\", () =&gt; ({\n   // Returns the first element matching given selector in the root's subtree.\n   query(root, selector) {\n      return root.querySelector(<span class=\"name\">a[data-title=\"${selector}\"]</span>);\n    },\n\n    // Returns all elements matching given selector in the root's subtree.\n    queryAll(root, selector) {\n      return Array.from(root.querySelectorAll(<span class=\"name\">a[data-title=\"${selector}\"]</span>));\n    }\n}));\nreturn 1;\n}\nexports.__esModule = true;\nexports.registerMySelector = registerMySelector;\n</pre>\n<h2 id=\"Plugins\">Plugins</h2>\n<p>Browser library offers plugins as a way to modify and add library keywords and modify some of the internal functionality without creating a new library or hacking the source code. See plugin API <a href=\"https://github.com/MarketSquare/robotframework-browser/blob/main/docs/plugins/README.md\">documentation</a> for further details.</p>\n<h2 id=\"Language\">Language</h2>\n<p>Browser library offers possibility to translte keyword names and documentation to new language. If language is defined, Browser library will search from <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#module-search-path\">module search path</a> Python packages starting with <span class=\"name\">robotframework_browser_translation</span> by using <a href=\"https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/\">Python pluging API</a>. Library is using naming convention to find Python plugins.</p>\n<p>The package must implement single API call, <code>get_language</code> without any arguments. Method must return a dictionary containing two keys: <code>language</code> and <code>path</code>. The language key value defines which language the package contains. Also value should match (case insentive) the library <code>language</code> import parameter. The path parameter value should be full path to the translation file.</p>\n<h3 id=\"Translation file\">Translation file</h3>\n<p>The file name or extension is not important, but data must be in <a href=\"https://www.json.org/json-en.html\">json</a> format. The keys of json are the methods names, not the keyword names, which implements keywords. Value of key is json object which contains two keys: <code>name</code> and <code>doc</code>. The <code>name</code> key contains the keyword translated name and <span class=\"name\">doc</span> contains translated documentation. Providing doc and name are optional, example translation json file can only provide translations to keyword names or only to documentatin. But it is always recomended to provide translation to both name and doc. Special key <code>__intro__</code> is for class level documentation and <code>__init__</code> is for init level documentation. These special values <code>name</code> can not be translated, instead <code>name</code> should be kept the same.</p>\n<h3 id=\"Generating template translation file\">Generating template translation file</h3>\n<p>Template translation file, with English language can be created by running: <span class=\"name\">rfbrowser translation /path/to/translation.json</span> command. Command does not provide translations to other languages, it only provides easy way to create full list keywords and their documentation in correct format. It is also possible to add keywords from library plugins and js extensions by providing <span class=\"name\">--plugings</span> and <span class=\"name\">--jsextension</span> arguments to command. Example: <span class=\"name\">rfbrowser translation --plugings myplugin.SomePlugin --jsextension /path/ot/jsplugin.js /path/to/translation.json</span></p>\n<p>Example project for translation can be found from <a href=\"https://github.com/MarketSquare/robotframework-browser-translation-fi\">robotframework-browser-translation-fi</a> repository.</p>", "version": "18.5.0", "generated": "2024-05-16T15:38:13+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/__init__.py", "lineno": 113, "tags": ["Assertion", "BrowserControl", "Config", "Crawling", "Getter", "HTTP", "PageContent", "Setter", "Wait"], "inits": [{"name": "__init__", "args": [{"name": "_", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*_"}, {"name": "auto_closing_level", "type": {"name": "AutoClosingLevel", "typedoc": "AutoClosingLevel", "nested": [], "union": false}, "defaultValue": "TEST", "kind": "NAMED_ONLY", "required": false, "repr": "auto_closing_level: AutoClosingLevel = TEST"}, {"name": "enable_playwright_debug", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "PlaywrightLogTypes", "typedoc": "PlaywrightLogTypes", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "defaultValue": "library", "kind": "NAMED_ONLY", "required": false, "repr": "enable_playwright_debug: PlaywrightLogTypes | bool = library"}, {"name": "enable_presenter_mode", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HighLightElement", "typedoc": "HighLightElement", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "enable_presenter_mode: HighLightElement | bool = False"}, {"name": "external_browser_executable", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "external_browser_executable: Dict[SupportedBrowsers, str] | None = None"}, {"name": "jsextension", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "jsextension: List[str] | str | None = None"}, {"name": "playwright_process_port", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "playwright_process_port: int | None = None"}, {"name": "plugins", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "plugins: List[str] | str | None = None"}, {"name": "retry_assertions_for", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:01", "kind": "NAMED_ONLY", "required": false, "repr": "retry_assertions_for: timedelta = 0:00:01"}, {"name": "run_on_failure", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Take Screenshot \\ fail-screenshot-{index}", "kind": "NAMED_ONLY", "required": false, "repr": "run_on_failure: str = Take Screenshot \\ fail-screenshot-{index}"}, {"name": "selector_prefix", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "selector_prefix: str | None = None"}, {"name": "show_keyword_call_banner", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "show_keyword_call_banner: bool | None = None"}, {"name": "strict", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "strict: bool = True"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:10", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:10"}, {"name": "language", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "language: str | None = None"}], "returnType": null, "doc": "<p>Browser library can be taken into use with optional arguments:</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>auto_closing_level</code></td>\n<td>Configure context and page automatic closing. Default is <code>TEST</code>, for more details, see <a href=\"#type-AutoClosingLevel\" class=\"name\">AutoClosingLevel</a></td>\n</tr>\n<tr>\n<td><code>enable_playwright_debug</code></td>\n<td>Enable low level debug information from the playwright to playwright-log.txt file. For more details, see <a href=\"#type-PlaywrightLogTypes\" class=\"name\">PlaywrightLogTypes</a>.</td>\n</tr>\n<tr>\n<td><code>enable_presenter_mode</code></td>\n<td>Automatic highlights the interacted components, slowMo and a small pause at the end. Can be enabled by giving True or can be customized by giving a dictionary: <span class=\"name\">{\"duration\": \"2 seconds\", \"width\": \"2px\", \"style\": \"dotted\", \"color\": \"blue\"}</span> Where <span class=\"name\">duration</span> is time format in Robot Framework format, defaults to 2 seconds. <span class=\"name\">width</span> is width of the marker in pixels, defaults the <span class=\"name\">2px</span>. <span class=\"name\">style</span> is the style of border, defaults to <span class=\"name\">dotted</span>. <span class=\"name\">color</span> is the color of the marker, defaults to <span class=\"name\">blue</span>. By default, the call banner keyword is also enabled unless explicitly disabled.</td>\n</tr>\n<tr>\n<td><code>external_browser_executable</code></td>\n<td>Dict mapping name of browser to path of executable of a browser. Will make opening new browsers of the given type use the set executablePath. Currently only configuring of <span class=\"name\">chromium</span> to a separate executable (chrome, chromium and Edge executables all work with recent versions) works.</td>\n</tr>\n<tr>\n<td><code>jsextension</code></td>\n<td>Path to Javascript modules exposed as extra keywords. The modules must be in CommonJS. It can either be a single path, a comma-separated lists of path or a real list of strings</td>\n</tr>\n<tr>\n<td><code>playwright_process_port</code></td>\n<td>Experimental reusing of playwright process. <code>playwright_process_port</code> is preferred over environment variable <code>ROBOT_FRAMEWORK_BROWSER_NODE_PORT</code>. See <a href=\"#Experimental%3A%20Re-using%20same%20node%20process\" class=\"name\">Experimental: Re-using same node process</a> for more details.</td>\n</tr>\n<tr>\n<td><code>plugins</code></td>\n<td>Allows extending the Browser library with external Python classes. Can either be a single class/module, a comma-separated list or a real list of strings</td>\n</tr>\n<tr>\n<td><code>retry_assertions_for</code></td>\n<td>Timeout for retrying assertions on keywords before failing the keywords. This timeout starts counting from the first failure. Global <code>timeout</code> will still be in effect. This allows stopping execution faster to assertion failure when element is found fast.</td>\n</tr>\n<tr>\n<td><code>run_on_failure</code></td>\n<td>Sets the keyword to execute in case of a failing Browser keyword. It can be the name of any keyword. If the keyword has arguments those must be separated with two spaces for example <code>My keyword \\ arg1 \\ arg2</code>. If no extra action should be done after a failure, set it to <code>None</code> or any other robot falsy value. Run on failure is not applied when library methods are executed directly from Python.</td>\n</tr>\n<tr>\n<td><code>selector_prefix</code></td>\n<td>Prefix for all selectors. This is useful when you need to use add an iframe selector before each selector.</td>\n</tr>\n<tr>\n<td><code>show_keyword_call_banner</code></td>\n<td>If set to <code>True</code>, will show a banner with the keyword name and arguments before the keyword is executed at the bottom of the page. If set to <code>False</code>, will not show the banner. If set to None, which is the default, will show the banner only if the presenter mode is enabled. <a href=\"#Get%20Page%20Source\" class=\"name\">Get Page Source</a> and <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> will not show the banner, because that could negatively affect your test cases/tasks. This feature may be super helpful when you are debugging your tests and using tracing from <a href=\"#New%20Context\" class=\"name\">New Context</a> or <span class=\"name\">Video recording</span> features.</td>\n</tr>\n<tr>\n<td><code>strict</code></td>\n<td>If keyword selector points multiple elements and keywords should interact with one element, keyword will fail if <code>strict</code> mode is true. Strict mode can be changed individually in keywords or by <span class=\"name\">`</span>et Strict Mode`` keyword.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout for keywords that operate on elements. The keywords will wait for this time for the element to appear into the page. Defaults to \"10s\" =&gt; 10 seconds.</td>\n</tr>\n<tr>\n<td><code>language</code></td>\n<td>Defines language which is used to translate keyword names and documentation.</td>\n</tr>\n</table>", "shortdoc": "Browser library can be taken into use with optional arguments:", "tags": [], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/__init__.py", "lineno": 801}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "domain", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str | None = None"}, {"name": "path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str | None = None"}, {"name": "expires", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expires: str | None = None"}, {"name": "httpOnly", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "httpOnly: bool | None = None"}, {"name": "secure", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool | None = None"}, {"name": "sameSite", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "CookieSameSite", "typedoc": "CookieSameSite", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sameSite: CookieSameSite | None = None"}], "returnType": null, "doc": "<p>Adds a cookie to currently active browser context.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Name of the cookie.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Given value for the cookie.</td>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Given url for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>domain</code></td>\n<td>Given domain for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Given path for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>expires</code></td>\n<td>Given expiry for the cookie. Can be of date format or unix time. Supports the same formats as the <a href=\"http://robotframework.org/robotframework/latest/libraries/DateTime.html\">DateTime</a> library or an epoch timestamp. - example: 2027-09-28 16:21:35</td>\n</tr>\n<tr>\n<td><code>httpOnly</code></td>\n<td>Sets the httpOnly token.</td>\n</tr>\n<tr>\n<td><code>secure</code></td>\n<td>Sets the secure token.</td>\n</tr>\n<tr>\n<td><code>samesite</code></td>\n<td>Sets the samesite mode.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>                                     # Using url argument.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   domain=example.com                path=/foo/bar                     # Using domain and url arguments.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>   expires=2027-09-28 16:21:35       # Expires as timestamp.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>   expires=1822137695                # Expires as epoch seconds.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4233\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a cookie to currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 91}, {"name": "Add Style Tag", "args": [{"name": "content", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "content: str"}], "returnType": null, "doc": "<p>Adds a &lt;style type=\"text/css\"&gt; tag with the content.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>content</code></td>\n<td>Raw CSS content to be injected into frame.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Add%20Style%20Tag\" class=\"name\">Add Style Tag</a>    \\#username_field:focus {background-color: aqua;}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4234\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a <style type=\"text/css\"> tag with the content.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 131}, {"name": "Cancel Download", "args": [{"name": "download", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "download: DownloadInfo | str"}], "returnType": null, "doc": "<p>Cancels an active download.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>download</td>\n<td>A <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> object or id of the download to be canceled.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//6478\">Comment &gt;&gt;</a></p>", "shortdoc": "Cancels an active download.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1554}, {"name": "Check Checkbox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Checks the checkbox or selects radio button found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is already checked/selected.</p>\n<p><a href=\"https://forum.robotframework.org/t//4235\">Comment &gt;&gt;</a></p>", "shortdoc": "Checks the checkbox or selects radio button found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 647}, {"name": "Clear Permissions", "args": [], "returnType": null, "doc": "<p>Clears all permissions from the current context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4236\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears all permissions from the current context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 545}, {"name": "Clear Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Clears the text field found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4237\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 115}, {"name": "Click", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}], "returnType": null, "doc": "<p>Simulates mouse click on the element found by <code>selector</code>.</p>\n<p>This keyword clicks an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element matches selector. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> to click in the center of the element, or the specified position.</li>\n<li>Wait for initiated navigation to either succeed or fail.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>Defaults to <code>left</code> if invalid.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location    left\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location    right\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4238\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 290}, {"name": "Click With Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}, {"name": "clickCount", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "NAMED_ONLY", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "delay: timedelta | None = None"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_x: float | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_y: float | None = None"}, {"name": "trial", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "trial: bool = False"}], "returnType": null, "doc": "<p>Simulates mouse click on the element found by <code>selector</code>.</p>\n<p>This keyword clicks an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element matches selector. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> to click in the center of the element, or the specified position.</li>\n<li>Wait for initiated navigation to either succeed or fail, unless <code>noWaitAfter</code> option is set.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>Defaults to <code>left</code> if invalid.</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used. Modifiers can be specified in any order, and multiple modifiers can be specified. Valid modifier keys are <code>Control</code>, <code>Alt</code>, <code>Shift</code> and <code>Meta</code>. Due to the fact that the argument <span class=\"name\">*modifiers</span> is a positional only argument, all preceding keyword arguments have to be specified as positional arguments before <span class=\"name\">*modifiers</span>.</td>\n</tr>\n<tr>\n<td><code>clickCount</code></td>\n<td>Defaults to 1.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Time to wait between mouse-down and mouse-up. Defaults to 0.</td>\n</tr>\n<tr>\n<td><code>position_x</code> <code>position_y</code></td>\n<td>A point to click relative to the top-left corner of element bounding-box. Only positive values within the bounding-box are allowed. If not specified, clicks to some visible point of the element.</td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's Actionability checks (<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a>).</td>\n</tr>\n<tr>\n<td><code>noWaitAfter</code></td>\n<td>Actions that initiate navigation, are waiting for these navigation to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to <code>False</code>.</td>\n</tr>\n<tr>\n<td><code>trial</code></td>\n<td>When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.</td>\n</tr>\n</table>\n<p>Arguments <code>clickCount</code>, <code>delay</code>, <code>position_x</code>, <code>position_y</code>, <code>force</code>, <code>noWaitAfter</code> and <code>trial</code> are named-only arguments and must be specified using their names..</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=button_location\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=button_location    trial=True\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    \\#clickWithOptions    delay=100ms    clickCount=2\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=clickWithModifiers    left     Alt    Meta    Shift    clickCount=1    force=True\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=clickWithOptions    right    clickCount=2    force=True    noWaitAfter=True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5936\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 318}, {"name": "Close Browser", "args": [{"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": null, "doc": "<p>Closes the current browser.</p>\n<p>Active browser is set to the browser that was active before this one. Closes all context and pages belonging to this browser. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser to close. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    ALL        # Closes all browsers\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    CURRENT    # Close current browser\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>               # Close current browser\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    ${id}      # Close browser matching id\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4239\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes the current browser.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 118}, {"name": "Close Browser Server", "args": [{"name": "wsEndpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}], "returnType": null, "doc": "<p>Close a playwright Browser Server identified by its websocket endpoint (wsEndpoint).</p>\n<p>The wsEndpoint string is returned by <a href=\"#Launch%20Browser%20Server\" class=\"name\">Launch Browser Server</a> and is also used by <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n</table>\n<pre>\n<code>wsEndpoint</code> | Address of the browser server. Example: <span class=\"name\">`ws://127.0.0.1:63784/ca69bf0e9471391e8183d9ac1e90e1ba</span>`|\n</pre>", "shortdoc": "Close a playwright Browser Server identified by its websocket endpoint (wsEndpoint).", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 484}, {"name": "Close Context", "args": [{"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": null, "doc": "<p>Closes a Context.</p>\n<p>Active context is set to the context that was active before this one. Closes pages belonging to this context. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>Context to close. <code>CURRENT</code> selects the active context. <code>ALL</code> closes all contexts. When a context id is provided, that context is closed.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser where to close context. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>                          #  Closes current context and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    CURRENT    CURRENT    #  Closes current context and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    ALL        CURRENT    #  Closes all context from current browser and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    ALL        ALL        #  Closes all context from current browser and all browser\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4240\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes a Context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 162}, {"name": "Close Page", "args": [{"name": "page", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType | str = CURRENT"}, {"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}, {"name": "runBeforeUnload", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "runBeforeUnload: bool = False"}], "returnType": null, "doc": "<p>Closes the <code>page</code> in <code>context</code> in <code>browser</code>.</p>\n<p>Defaults to current for all three. Active page is set to the page that was active before this one. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<p><code>runBeforeUnload</code> defines where to run the <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event\">before unload</a> page handlers. Defaults to false.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>Page to close. <code>CURRENT</code> selects the active page. <code>ALL</code> closes all pages. When a page id is provided, that page is closed.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>Context where to close page. <code>CURRENT</code> selects the active context. <code>ALL</code> closes all contexts. When a context id is provided, that context is closed.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser where to close page. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Returns a list of dictionaries containing id, errors and console messages from the page.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>                                       # Closes current page, within the current context and browser\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>    CURRENT     CURRENT     CURRENT    # Closes current page, within the current context and browser\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>    ALL         ALL         ALL        # Closes all pages, within all contexts and browsers\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4241\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes the ``page`` in ``context`` in ``browser``.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 240}, {"name": "Connect To Browser", "args": [{"name": "wsEndpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "use_cdp", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "use_cdp: bool = False"}], "returnType": null, "doc": "<p>Connect to a Playwright browser server via playwright websocket or Chrome DevTools Protocol.</p>\n<p>See <a href=\"#Launch%20Browser%20Server\" class=\"name\">Launch Browser Server</a> for more information about how to launch a playwright browser server.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Returns a stable identifier for the connected browser.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>wsEndpoint</code></td>\n<td>Address to connect to. Either <code>ws://</code> or <code>http://</code> if cdp is used.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Opens the specified browser. Defaults to <code>chromium</code>.</td>\n</tr>\n<tr>\n<td><code>use_cdp</code></td>\n<td>Connect to browser via Chrome DevTools Protocol. Defaults to False. Works only with Chromium based browsers.</td>\n</tr>\n</table>\n<p>To Connect to a Browser viw Chrome DevTools Protocol, the browser must be started with this protocol enabled. This typically done by starting a Chrome browser with the argument <code>--remote-debugging-port=9222</code> or similar. When the browser is running with activated CDP, it is possible to connect to it either with websockets (<code>ws://</code>) or via HTTP (<code>http://</code>). The HTTP connection can be used when <code>use_cdp</code> is set to True. A typical address for a CDP connection is <code>http://127.0.0.1:9222</code>.</p>\n<p><a href=\"https://forum.robotframework.org/t//4242\">Comment &gt;&gt;</a></p>", "shortdoc": "Connect to a Playwright browser server via playwright websocket or Chrome DevTools Protocol.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 323}, {"name": "Crawl Site", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "page_crawl_keyword", "type": null, "defaultValue": "take_screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_crawl_keyword=take_screenshot"}, {"name": "max_number_of_page_to_crawl", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "max_number_of_page_to_crawl: int = 1000"}, {"name": "max_depth_to_crawl", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "50", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "max_depth_to_crawl: int = 50"}], "returnType": null, "doc": "<p>Web crawler is a tool to go through all the pages on a specific URL domain. This happens by finding all links going to the same site and opening those.</p>\n<p>returns list of crawled urls.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>is the page to start crawling from.</td>\n</tr>\n<tr>\n<td><code>page_crawl_keyword</code></td>\n<td>is the keyword that will be executed on every page.  By default it will take a screenshot on every page.</td>\n</tr>\n<tr>\n<td><code>max_number_of_page_to_crawl</code></td>\n<td>is the upper limit of pages to crawl. Crawling will stop if the number of crawled pages goes over this.</td>\n</tr>\n<tr>\n<td><code>max_depth_to_crawl</code></td>\n<td>is the upper limit of consecutive links followed from the start page. Crawling will stop if there are no more links under this depth.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4243\">Comment &gt;&gt;</a></p>", "shortdoc": "Web crawler is a tool to go through all the pages on a specific URL domain. This happens by finding all links going to the same site and opening those.", "tags": ["Crawling"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/crawling.py", "lineno": 14}, {"name": "Delete All Cookies", "args": [], "returnType": null, "doc": "<p>Deletes all cookies from the currently active browser context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4244\">Comment &gt;&gt;</a></p>", "shortdoc": "Deletes all cookies from the currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 150}, {"name": "Deselect Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Deselects all options from select element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the select tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>If you just want to select one or more specific options and currently more options are selected, use <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a> keyword with the options to be selected in the end.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4245\">Comment &gt;&gt;</a></p>", "shortdoc": "Deselects all options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 763}, {"name": "Download", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "saveAs", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}, {"name": "wait_for_finished", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_for_finished: bool = True"}, {"name": "download_timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "download_timeout: timedelta | None = None"}], "returnType": {"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, "doc": "<p>Download given url content.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>URL to the file that shall be downloaded.</td>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>Path where the file shall be saved persistently. If empty, generated unique path (GUID) is used and file is deleted when the context is closed.</td>\n</tr>\n<tr>\n<td><code>wait_for_finished</code></td>\n<td>If set to <code>False</code> keyword returns immediately after the download is started. Defaults to <code>True</code>.</td>\n</tr>\n<tr>\n<td><code>download_timeout</code></td>\n<td>Timeout for the download itself if <code>wait_for_finished</code> is set to <code>True</code>. By default no timeout is set.</td>\n</tr>\n</table>\n<p>Keyword returns dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a>.</p>\n<p>Example:</p>\n<pre>\n{\n  \"saveAs\": \"/tmp/robotframework-browser/downloads/2f1b3b7c-1b1b-4b1b-9b1b-1b1b1b1b1b1b\",\n  \"suggestedFilename\": \"downloaded_file.txt\"\n  \"state\": \"finished\",\n  \"downloadID\": None,\n}\n</pre>\n<p>If the download should be started by an interaction with an element on the page, <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> keyword may be a better choice.</p>\n<p>The keyword <a href=\"#New%20Browser\" class=\"name\">New Browser</a> has a <code>downloadsPath</code> setting which can be used to set the default download directory. If <span class=\"name\">saveAs</span> is set to a relative path, the file will be saved relative to the browser's <code>downloadsPath</code> setting or if that is not set, relative to the Playwright's working directory. If <code>saveAs</code> is set to an absolute path, the file will be saved to that absolute path independent of <code>downloadsPath</code>.</p>\n<p>To enable downloads context's <code>acceptDownloads</code> needs to be true. This keyword requires that there is currently an open page. The keyword uses the current pages local state (cookies, sessionstorage, localstorage) for the download to avoid authentication problems.</p>\n<p>Example:</p>\n<pre>\n${file_object}=    <a href=\"#Download\" class=\"name\">Download</a>    ${url}\n${actual_size}=    Get File Size    ${file_object.saveAs}\n</pre>\n<p>Example 2:</p>\n<pre>\n${href}=          <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    text=\"Download File\"    href\n<a href=\"#Download\" class=\"name\">Download</a>    ${href}    saveAs=${OUTPUT DIR}/downloads/downloaded_file.txt\nFile Should Exist    ${OUTPUT DIR}/downloads/downloaded_file.txt\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4246\">Comment &gt;&gt;</a></p>", "shortdoc": "Download given url content.", "tags": ["Page Content"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 147}, {"name": "Drag And Drop", "args": [{"name": "selector_from", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "selector_to", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_to: str"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from the element selected by <code>selector_from</code> to the element selected by <code>selector_to</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector_from</code></td>\n<td>Identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>selector_to</code></td>\n<td>Identifies the element, which center is the end-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>First it moves the mouse to the start-point, then presses the left mouse button, then moves to the end-point in specified number of steps, then releases the mouse button.</p>\n<p>Start- and end-point are defined by the center of the elements boundingbox.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Drag%20And%20Drop\" class=\"name\">Drag And Drop</a>    \"Circle\"    \"Goal\"\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4247\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to the element selected by ``selector_to``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 982}, {"name": "Drag And Drop By Coordinates", "args": [{"name": "from_x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_x: float"}, {"name": "from_y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_y: float"}, {"name": "to_x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_x: float"}, {"name": "to_y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_y: float"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from a coordinate to another coordinate.</p>\n<p>First it moves the mouse to the start-point, then presses the left mouse button, then moves to the end-point in specified number of steps, then releases the mouse button.</p>\n<p>Start- and end-point are defined by <code>x</code> and <code>y</code> coordinates relative to the top left corner of the pages viewport.</p>\n<table border=\"1\">\n<tr>\n<td><code>from_x</code> &amp; <code>from_y</code></td>\n<td>Identify the start-point on page.</td>\n</tr>\n<tr>\n<td><code>to_x</code> &amp; <code>to_y</code></td>\n<td>Identify the end-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Drag%20And%20Drop%20By%20Coordinates\" class=\"name\">Drag And Drop By Coordinates</a>\n...    from_x=30    from_y=30\n...    to_x=10    to_y=10    steps=20\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4248\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from a coordinate to another coordinate.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1021}, {"name": "Drag And Drop Relative To", "args": [{"name": "selector_from", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from the element selected by <code>selector_from</code> to coordinates relative to the center of that element.</p>\n<p>This keyword can be handy to simulate swipe actions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector_from</code></td>\n<td>identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>identifies the end-point which is relative to the start-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>First it moves the mouse to the start-point (center of boundingbox), then presses the left mouse button, then moves to the relative position with the given intermediate steps, then releases the mouse button.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Drag%20And%20Drop%20Relative%20To\" class=\"name\">Drag And Drop Relative to</a>    \"Circle\"    -20    0     # Slides the element 20 pixel to the left\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4249\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to coordinates relative to the center of that element.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1055}, {"name": "Eat All Cookies", "args": [], "returnType": null, "doc": "<p>Eat all cookies for all easter.</p>\n<p><a href=\"https://forum.robotframework.org/t//4250\">Comment &gt;&gt;</a></p>", "shortdoc": "Eat all cookies for all easter.", "tags": [], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 160}, {"name": "Evaluate JavaScript", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "function", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*function: str"}, {"name": "arg", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "arg: Any | None = None"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "all_elements: bool = False"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Executes given javascript on the selected element(s) or on page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector to resolve and pass to the JavaScript function. This will be the first argument the function receives if not <code>${None}</code>. <code>selector</code> is optional and can be omitted. If given a selector, a function is necessary, with an argument to capture the elementHandle. For example <code>(element) =&gt; document.activeElement === element</code> See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*function</code></td>\n<td>A valid javascript function or a javascript function body. These arguments can be used to write readable multiline JavaScript.</td>\n</tr>\n<tr>\n<td><code>arg</code></td>\n<td>an additional argument that can be handed over to the JavaScript function. This argument must be JSON serializable. ElementHandles are not supported.</td>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>defines if only the single elementHandle found by <code>selector</code> is handed over to the function or if set to <code>True</code> all found elements are handed over as array.</td>\n</tr>\n</table>\n<p>Example with <code>all_elements=True</code>:</p>\n<pre>\n ${texts}=    Evaluate JavaScript    button\n ...    (elements, arg) =&gt; {\n ...        let text = []\n ...            for (e of elements) {\n ...                console.log(e.innerText)\n ...                text.push(e.innerText)\n ...            }\n ...        text.push(arg)\n ...        return text\n ...    }\n ...    all_elements=True\n ...    arg=Just another Text\n</pre>\n<p>Keyword uses strict mode if <code>all_elements</code> is <code>False</code>. See <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://github.com/MarketSquare/robotframework-browser/tree/main/atest/test/06_Examples/js_evaluation.robot\">Usage examples.</a></p>\n<p><a href=\"https://forum.robotframework.org/t//4251\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes given javascript on the selected element(s) or on page.", "tags": ["Getter", "PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 28}, {"name": "Fill Secret", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Fills the given secret from <code>variable_name</code> into the text field found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>secret</code></td>\n<td>The secret string that should be filled into the text field.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>This keyword does not log secret in Robot Framework logs, when keyword resolves the <code>secret</code> variable internally. When <code>secret</code> variable is prefixed with <span class=\"name\">$</span>, without the curly braces, library will resolve the corresponding Robot Framework variable.</p>\n<p>If <code>secret</code> variable is prefixed with <span class=\"name\">%</span>, library will resolve corresponding environment variable. Example <span class=\"name\">$Password</span>` will resolve to <code>${Password}</code> Robot Framework variable. Also <code>%ENV_PWD</code> will resolve to <code>%{ENV_PWD}</code> environment variable.</p>\n<p><b>Using normal Robot Framework variables like <code>${password}</code> will not work!</b></p>\n<p><b>Normal plain text will not work.</b> If you want to use plain text, use <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> keyword instead.</p>\n<p>This keyword will also work with a give cryptographic cipher text, that has been encrypted by Crypto library. See <a href=\"https://github.com/Snooz82/robotframework-crypto\">Crypto Library</a> for more details.</p>\n<p>If <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for other details.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    input#username_field    $username    # Keyword resolves variable value from Robot Framework variables\n<a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    input#username_field    %username    # Keyword resolves variable value from environment variables\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4253\">Comment &gt;&gt;</a></p>", "shortdoc": "Fills the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 198}, {"name": "Fill Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Clears and fills the given <code>txt</code> into the text field found by <code>selector</code>.</p>\n<p>This method waits for an element matching the <code>selector</code> to appear, waits for actionability checks, focuses the element, fills it and triggers an input event after filling.</p>\n<p>If the element matching selector is not an &lt;input&gt;, &lt;textarea&gt; or [contenteditable] element, this method throws an error. Note that you can pass an empty string as <code>txt</code> to clear the input field.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>txt</code></td>\n<td>Text for the text field.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for emulating typing text character by character.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Fill%20Text\" class=\"name\">Fill Text</a>    css=input#username_field    username\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4254\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears and fills the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 85}, {"name": "Focus", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Moves focus on to the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>If there's no element matching selector, the method waits until a matching element appears in the DOM. Timeouts after 10 seconds.</p>\n<p><a href=\"https://forum.robotframework.org/t//4255\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves focus on to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 531}, {"name": "Get Attribute", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns the HTML <code>attribute</code> of the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>attribute</code></td>\n<td>Requested attribute name.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the attribute value matches the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>When a attribute is selected that is not present and no assertion operator is set, the keyword fails. If an assertion operator is set and the attribute is not present, the returned value is <code>None</code>. This can be used to assert check the presents or the absents of an attribute.</p>\n<p>Example Element:</p>\n<pre>\n&lt;button class=\"login button active\" id=\"enabled_button\" something&gt;Login&lt;/button&gt;\n</pre>\n<p>Example Code:</p>\n<pre>\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled                   # FAIL =&gt; \"Attribute 'disabled' not found!\"\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled     ==    ${None}     # PASS =&gt; returns: None\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    something    evaluate    value is not None    # PASS =&gt;  returns: True\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled     evaluate    value is None        # PASS =&gt;  returns: True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4256\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the HTML ``attribute`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 271}, {"name": "Get Attribute Names", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all HTML attribute names of an element as a list.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that attribute names do match to the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a>    [name=\"readonly_input\"]    ==    type    name    value    readonly    # Has exactly these attribute names.\n<a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a>    [name=\"readonly_input\"]    contains    disabled    # Contains at least this attribute name.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4257\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all HTML attribute names of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 334}, {"name": "Get BoundingBox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "type": {"name": "BoundingBoxFields", "typedoc": "BoundingBoxFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: BoundingBoxFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "BoundingBox", "typedoc": "BoundingBox", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements size and location as an object <code>{x: float, y: float, width: float, height: float}</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the BoundingBox as Dictionary, otherwise it will just return the single value selected by the key. Note: If a single value is retrieved, an assertion does <b>not</b> need a <code>validate</code> combined with a cast of <code>value</code>.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example use:</p>\n<pre>\n${bounding_box}=    <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>    id=element                 # unfiltered\nLog                 ${bounding_box}                                 # {'x': 559.09375, 'y': 75.5, 'width': 188.796875, 'height': 18}\n${x}=               <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>    id=element    x            # filtered\nLog                 X: ${x}                                         # X: 559.09375\n# Assertions:\n<a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>     id=element         width         &gt;    180\n<a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>     id=element         ALL           validate    value['x'] &gt; value['y']*2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4258\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements size and location as an object ``{x: float, y: float, width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1127}, {"name": "Get Browser Catalog", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "BrowserInfo", "typedoc": "BrowserInfo", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all browsers, open contexts in them and open pages in these contexts.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about these concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n</table>\n<p>The data is parsed into a python list containing data representing the open Objects.</p>\n<p>On the root level the data contains a list of open browsers.</p>\n<p>Data can be manipulated also with <code>assertion_operator</code> for example to find a specific id based on index or page title with <code>then</code> operator.</p>\n<p>Return value can also be asserted against expected value.</p>\n<p>Sample:</p>\n<pre>\n[\n  {\n    \"type\": \"chromium\",\n    \"id\": \"browser=96207191-8147-44e7-b9ac-5e04f2709c1d\",\n    \"contexts\": [\n      {\n        \"type\": \"context\",\n        \"id\": \"context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089\",\n        \"activePage\": \"page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12\",\n        \"pages\": [\n          {\n            \"type\": \"page\",\n            \"title\": \"Robocorp\",\n            \"url\": \"<a href=\"https://robocorp.com/\">https://robocorp.com/</a>\",\n            \"id\": \"page=7ac15782-22d2-48b4-8591-ff17663fa737\",\n            \"timestamp\": 1598607713.858\n          },\n          {\n            \"type\": \"page\",\n            \"title\": \"Home - Reaktor\",\n            \"url\": \"<a href=\"https://www.reaktor.com/\">https://www.reaktor.com/</a>\",\n            \"id\": \"page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12\",\n            \"timestamp\": 1598607714.702\n          }\n        ]\n      }\n    ],\n    \"activeContext\": \"context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089\",\n    \"activeBrowser\": false\n  },\n  {\n    \"type\": \"firefox\",\n    \"id\": \"browser=ad99abac-17a9-472b-ac7f-d6352630834e\",\n    \"contexts\": [\n      {\n        \"type\": \"context\",\n        \"id\": \"context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0\",\n        \"activePage\": \"page=8baf2991-5eaf-444d-a318-8045f914e96a\",\n        \"pages\": [\n          {\n            \"type\": \"page\",\n            \"title\": \"Software-Qualit\u00e4tssicherung und Softwaretest\",\n            \"url\": \"<a href=\"https://www.imbus.de/\">https://www.imbus.de/</a>\",\n            \"id\": \"page=8baf2991-5eaf-444d-a318-8045f914e96a\",\n            \"timestamp\": 1598607716.828\n          }\n        ]\n      }\n    ],\n    \"activeContext\": \"context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0\",\n    \"activeBrowser\": true\n  }\n]\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4259\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all browsers, open contexts in them and open pages in these contexts.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 933}, {"name": "Get Browser Ids", "args": [{"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a list of ids from open browsers. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p><code>browser</code> Defaults to <code>ALL</code></p>\n<ul>\n<li><code>ALL</code> / <code>ANY</code> Returns all ids as a list.</li>\n<li><code>ACTIVE</code> / <code>CURRENT</code> Returns the id of the currently active browser as list.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the ids from. <code>ALL</code> for all open browsers, <code>ACTIVE</code> for the currently active browser or the id of the browser to get the ids from.</td>\n</tr>\n</table>\n<p>The ACTIVE browser is a synonym for the CURRENT Browser.</p>\n<p><a href=\"https://forum.robotframework.org/t//4260\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of ids from open browsers. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1344}, {"name": "Get Checkbox State", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "Unchecked", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: bool | str = Unchecked"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Returns the state of the checkbox found by <code>selector</code>.</p>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector which shall be examined. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td><code>==</code> and <code>!=</code> and equivalent are allowed on boolean values. Other operators are not accepted.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Boolean value of expected state. Strings are interpreted as booleans. All strings are <code>${True}</code> except of the following <span class=\"name\">FALSE, NO, OFF, 0, UNCHECKED, NONE, ${EMPTY}</span>` (case-insensitive). Defaults to unchecked.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<ul>\n<li><code>checked</code> =&gt; <code>True</code></li>\n<li><code>unchecked</code> =&gt; <code>False</code></li>\n</ul>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Checkbox%20State\" class=\"name\">Get Checkbox State</a>    [name=can_send_email]    ==    checked\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4261\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the state of the checkbox found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 555}, {"name": "Get Classes", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all classes of an element as a list.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected values for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Classes\" class=\"name\">Get Classes</a>    id=draggable    ==    react-draggable    box    # Element contains exactly this class name.\n<a href=\"#Get%20Classes\" class=\"name\">Get Classes</a>    id=draggable    validate    \"react-draggable-dragged\" not in value    # Element does not contain react-draggable-dragged class.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4262\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all classes of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 387}, {"name": "Get Client Size", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Dimensions", "typedoc": "Dimensions", "nested": [], "union": false}, "doc": "<p>Gets elements or pages client size (<code>clientHeight</code>, <code>clientWidth</code>) as object {width: float, height: float}.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the client size of the page itself is used (<code>document.scrollingElement</code>). See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll size as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> or <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> for examples.</p>\n<p><a href=\"https://forum.robotframework.org/t//4263\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages client size (``clientHeight``, ``clientWidth``) as object {width: float, height: float}.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1296}, {"name": "Get Console Log", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "full", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "full: bool = False"}, {"name": "last", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "last: int | timedelta | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns the console log of the active page.</p>\n<p>If assertions are used and fail, this keyword will fail immediately without retrying.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>full</td>\n<td>If true, returns the full console log. If false, returns only new entries that were added since last time.</td>\n</tr>\n<tr>\n<td>last</td>\n<td>If set, returns only the last n entries. Can be <span class=\"name\">int</span> for number of entries or <a href=\"#type-timedelta\" class=\"name\">timedelta</a> for time period.</td>\n</tr>\n</table>\n<p>The returned data is a <a href=\"#type-list\" class=\"name\">list</a> of log messages.</p>\n<p>A log message is a <span class=\"name\">dict</span> with the following structure:</p>\n<pre>\n{\n  \"type\": str,\n  \"text\": str,\n  \"location\": {\n    \"url\": str,\n    \"lineNumber\": int,\n    \"columnNumber\": int\n  },\n  \"time\": str\n}\n</pre>\n<p>Example:</p>\n<pre>\n[{\n  'type': 'log',\n  'text': 'Stuff loaded...',\n  'location': {\n    'url': '<a href=\"https://example.com/js/chunk-769742de.6a462276.js\">https://example.com/js/chunk-769742de.6a462276.js</a>',\n    'lineNumber': 60,\n    'columnNumber': 63771\n  },\n  'time': '2023-02-05T17:42:52.064Z'\n}]\n</pre>\n<p>Keys:</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>One of the following values: <code>log</code>, <code>debug</code>, <code>info</code>, <code>error</code>, <code>warning</code>, <code>dir</code>, <code>dirxml</code>, <code>table</code>, <code>trace</code>, <code>clear</code>, <code>startGroup</code>, <code>startGroupCollapsed</code>, <code>endGroup</code>, <code>assert</code>, <code>profile</code>, <code>profileEnd</code>, <code>count</code>, <code>timeEnd</code></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>The text of the console message.</td>\n</tr>\n<tr>\n<td><code>location.url</code></td>\n<td>The URL of the resource that generated this message.</td>\n</tr>\n<tr>\n<td><code>location.lineNumber</code></td>\n<td>The line number in the resource that generated this message (0-based).</td>\n</tr>\n<tr>\n<td><code>location.columnNumber</code></td>\n<td>The column number in the resource that generated this message (0-based).</td>\n</tr>\n<tr>\n<td><code>time</code></td>\n<td>The timestamp of the log message as ISO 8601 string.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//5267\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the console log of the active page.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1029}, {"name": "Get Context Ids", "args": [{"name": "context", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [], "union": false}, "doc": "<p>Returns a list of context ids based on the browser selection. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<p><code>ALL</code> and <code>ANY</code> are synonyms. <code>ACTIVE</code> and <code>CURRENT</code> are also synonyms.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context to get the ids from. <code>ALL</code> will return all ids from selected browser(s), <code>ACTIVE</code> for the one active context of each selected browser.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the context ids from. <code>ALL</code> Context ids from all open browsers shall be fetched. <code>ACTIVE</code> Only context ids from the active browser shall be fetched.</td>\n</tr>\n</table>\n<p>The ACTIVE context of the ACTIVE Browser is the <code>Current</code> Context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4264\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of context ids based on the browser selection. See `Browser, Context and Page` for more information about Context and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1369}, {"name": "Get Cookie", "args": [{"name": "cookie", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "cookie: str"}, {"name": "return_type", "type": {"name": "CookieType", "typedoc": "CookieType", "nested": [], "union": false}, "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns information of cookie with <code>name</code> as a Robot Framework dot dictionary or a string.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>cookie</code></td>\n<td>Name of the cookie to be retrieved.</td>\n</tr>\n<tr>\n<td><code>return_type</code></td>\n<td>Type of the return value. Can be either <code>dictionary</code> or <code>string</code>. Defaults to <code>dictionary</code>.</td>\n</tr>\n</table>\n<p>If <code>return_type</code> is <code>dictionary</code> or <code>dict</code> then keyword returns a of Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#accessing-list-and-dictionary-items\">dot dictionary</a> The dictionary contains all possible key value pairs of the cookie. If <code>return_type</code> is <code>string</code> or <code>str</code>, then keyword returns the cookie as a string in format: <code>name1=value1</code>. The return value contains only <code>name</code> and <code>value</code> keys of the cookie.</p>\n<p>If no cookie is found with <code>name</code> keyword fails. The cookie dictionary contains details about the cookie. Keys available in the dictionary are documented in the table below.</p>\n<table border=\"1\">\n<tr>\n<td><b>Value</b></td>\n<td><b>Explanation</b></td>\n</tr>\n<tr>\n<td>name</td>\n<td>The name of a cookie, mandatory.</td>\n</tr>\n<tr>\n<td>value</td>\n<td>Value of the cookie, mandatory.</td>\n</tr>\n<tr>\n<td>url</td>\n<td>Define the scope of the cookie, what URLs the cookies should be sent to.</td>\n</tr>\n<tr>\n<td>domain</td>\n<td>Specifies which hosts are allowed to receive the cookie.</td>\n</tr>\n<tr>\n<td>path</td>\n<td>Indicates a URL path that must exist in the requested URL, for example <span class=\"name\">/</span>.</td>\n</tr>\n<tr>\n<td>expires</td>\n<td>Lifetime of a cookie. Returned as datatime object or None if not valid time received.</td>\n</tr>\n<tr>\n<td>httpOnly</td>\n<td>When true, the cookie is not accessible via JavaScript.</td>\n</tr>\n<tr>\n<td>secure</td>\n<td>When true, the cookie is only used with HTTPS connections.</td>\n</tr>\n<tr>\n<td>sameSite</td>\n<td>Attribute lets servers require that a cookie shouldn't be sent with cross-origin requests.</td>\n</tr>\n</table>\n<p>See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browsercontextaddcookiescookies\">playwright documentation</a> for details about each attribute.</p>\n<p>Example:</p>\n<pre>\n${cookie}=        <a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a>              Foobar\nShould Be Equal   ${cookie.value}           Tidii\nShould Be Equal   ${cookie.expires.year}     ${2020}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4265\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns information of cookie with ``name`` as a Robot Framework dot dictionary or a string.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 179}, {"name": "Get Cookies", "args": [{"name": "return_type", "type": {"name": "CookieType", "typedoc": "CookieType", "nested": [], "union": false}, "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns cookies from the current active browser context.</p>\n<p>If <code>return_type</code> is <code>dictionary</code> or <code>dict</code> then keyword returns list of Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#accessing-list-and-dictionary-items\">dot dictionaries</a> The dictionary contains all possible key value pairs of the cookie. See <a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a> keyword documentation about the dictionary keys and values.</p>\n<p>If <code>return_type</code> is <code>string</code> or <code>str</code>, then keyword returns the cookie as a string in format: <code>name1=value1; name2=value2; name3=value3</code>. The return value contains only <code>name</code> and <code>value</code> keys of the cookie.</p>\n<p><a href=\"https://forum.robotframework.org/t//4266\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns cookies from the current active browser context.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/cookie.py", "lineno": 29}, {"name": "Get Device", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Get a single device descriptor with name exactly matching name.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Given name of the requested device. See Playwright's <a href=\"https://github.com/microsoft/playwright/blob/master/packages/playwright-core/src/server/deviceDescriptorsSource.json\">deviceDescriptorsSource.json</a> for a formatted list.</td>\n</tr>\n</table>\n<p>Allows a concise syntax to set website testing values to exact matches of specific mobile devices.</p>\n<p>Use by passing to a context. After creating a context with devicedescriptor, before using ensure your active page is on that context. Usage:</p>\n<pre>\n${device}=          <a href=\"#Get%20Device\" class=\"name\">Get Device</a>       iPhone X\n<a href=\"#New%20Context\" class=\"name\">New Context</a>         &amp;{device}\n<a href=\"#New%20Page\" class=\"name\">New Page</a>\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>   # returns { \"width\": 375, \"height\": 812 }\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4267\">Comment &gt;&gt;</a></p>", "shortdoc": "Get a single device descriptor with name exactly matching name.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/device_descriptors.py", "lineno": 40}, {"name": "Get Devices", "args": [], "returnType": {"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns a dict of all playwright device descriptors.</p>\n<p>See Playwright's <a href=\"https://github.com/microsoft/playwright/blob/master/packages/playwright-core/src/server/deviceDescriptorsSource.json\">deviceDescriptorsSource.json</a> for a formatted list.</p>\n<p><a href=\"https://forum.robotframework.org/t//4268\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a dict of all playwright device descriptors.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/device_descriptors.py", "lineno": 25}, {"name": "Get Download State", "args": [{"name": "download", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "download: DownloadInfo | str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, "doc": "<p>Gets the state of a download.</p>\n<p>Returns a dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> with the following keys:</p>\n<pre>\n{\n  saveAs: str\n  suggestedFilename: str\n  state: str\n  downloadID: Optional[str]\n}\n</pre>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>download</code></td>\n<td><a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> dictionary returned from <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> or download id as string.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected state of the download. Be aware that the returned value is a dictionary</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//6479\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets the state of a download.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1432}, {"name": "Get Element", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns a reference to a Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a>.</p>\n<p>The reference can be used in subsequent selectors.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved . See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n${element} =    <a href=\"#Get%20Element\" class=\"name\">Get Element</a>    \\#username_field\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${element} &gt;&gt; optionOne    value    # Locator is resolved from the page.\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${element} &gt;&gt; optionTwo    value    # Locator is resolved again from the page.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4269\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to a Playwright [https://playwright.dev/docs/api/class-locator|Locator].", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 837}, {"name": "Get Element By", "args": [{"name": "selection_strategy", "type": {"name": "SelectionStrategy", "typedoc": "SelectionStrategy", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selection_strategy: SelectionStrategy"}, {"name": "text", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str | RegExp"}, {"name": "exact", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact: bool = False"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "all_elements: bool = False"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Allows locating elements by their features.</p>\n<p>Selection strategies can be several Playwright strategies like AltText or Label. See <a href=\"https://playwright.dev/docs/locators\">Playwright Locators</a> for more information.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>locator_type</code></td>\n<td>SelectionStrategy to be used. Refers to Playwrights <code>page.getBy***</code> functions. See <a href=\"https://playwright.dev/docs/locators\">https://playwright.dev/docs/locators</a></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Text to locate the element for.</td>\n</tr>\n<tr>\n<td><code>exact</code></td>\n<td>Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace. This has no effect if RegExp is used or if TestID is used as strategy.</td>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>If True, returns all matched elements as a list.</td>\n</tr>\n</table>\n<p>This keywords implements the following Playwright functions:</p>\n<ul>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-alt-text\">page.getByAltText</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-label\">page.getByLabel</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-placeholder\">page.getByPlaceholder</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-test-id\">page.getByTestId</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-text\">page.getByText</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-title\">page.getByTitle</a></li>\n</ul>\n<p><code>page.getByRole</code> is supported by <a href=\"#Get%20Element%20By%20Role\" class=\"name\">Get Element By Role</a> keyword.</p>\n<p>If an element shall be fetched from an iframe, a selector prefix must be set using <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a> keyword including <code>&gt;&gt;&gt;</code> as ending.</p>\n<p><a href=\"https://forum.robotframework.org/t//5937\">Comment &gt;&gt;</a></p>", "shortdoc": "Allows locating elements by their features.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 994}, {"name": "Get Element By Role", "args": [{"name": "role", "type": {"name": "ElementRole", "typedoc": "ElementRole", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "role: ElementRole"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "all_elements: bool = False"}, {"name": "checked", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "checked: bool | None = None"}, {"name": "disabled", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "disabled: bool | None = None"}, {"name": "exact", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "exact: bool | None = None"}, {"name": "expanded", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "expanded: bool | None = None"}, {"name": "include_hidden", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "include_hidden: bool | None = None"}, {"name": "level", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "level: int | None = None"}, {"name": "name", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "name: str | RegExp | None = None"}, {"name": "pressed", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "pressed: bool | None = None"}, {"name": "selected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "selected: bool | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns a reference to Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a> for the matched element by <code>role</code> or a list of references if <code>all_elements</code> is set to <code>True</code>.</p>\n<p>Allows locating elements by their <a href=\"https://www.w3.org/TR/wai-aria-1.2/#roles\">ARIA role</a>, <a href=\"https://www.w3.org/TR/wai-aria-1.2/#aria-attributes\">ARIA attributes</a> and <a href=\"https://w3c.github.io/accname/#dfn-accessible-name\">accessible name</a>.</p>\n<p>Consider the following DOM structure.</p>\n<pre>\n&lt;h3&gt;Sign up&lt;/h3&gt;\n&lt;label&gt;\n  &lt;input type=\"checkbox\" /&gt; Subscribe\n&lt;/label&gt;\n&lt;br/&gt;\n&lt;button&gt;Submit&lt;/button&gt;\n</pre>\n<p>You can locate each element by it's implicit role:</p>\n<pre>\n${heading}    Get Element By Role    heading    name=Sign up\n${checkbox}   Get Element By Role    checkbox    name=Subscribe\n${button}     Get Element By Role    button    name=/submit/i\n</pre>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>If True, returns all matched elements as a list.</td>\n</tr>\n<tr>\n<td><code>role</code></td>\n<td>Role from which shall be retrieved.</td>\n</tr>\n<tr>\n<td><code>checked</code></td>\n<td>An attribute that is usually set by aria-checked or native &lt;input type=checkbox&gt; controls.</td>\n</tr>\n<tr>\n<td><code>disabled</code></td>\n<td>An attribute that is usually set by aria-disabled or disabled.</td>\n</tr>\n<tr>\n<td><code>exact</code></td>\n<td>Whether name is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when name is a regular expression. Note that exact match still trims whitespace.</td>\n</tr>\n<tr>\n<td><code>expanded</code></td>\n<td>An attribute that is usually set by aria-expanded.</td>\n</tr>\n<tr>\n<td><code>include_hidden</code></td>\n<td>Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.</td>\n</tr>\n<tr>\n<td><code>level</code></td>\n<td>A number attribute that is usually present for roles heading, list item, row, treeitem, with default values for &lt;h1&gt;-&lt;h6&gt; elements.</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.</td>\n</tr>\n<tr>\n<td><code>pressed</code></td>\n<td>An attribute that is usually set by aria-pressed.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>An attribute that is usually set by aria-selected.</td>\n</tr>\n</table>\n<p>If an element shall be fetched from an iframe, a selector prefix must be set using <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a> keyword including <code>&gt;&gt;&gt;</code> as ending.</p>\n<p><a href=\"https://forum.robotframework.org/t//5938\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to Playwright [https://playwright.dev/docs/api/class-locator|Locator] for the matched element by ``role`` or a list of references if ``all_elements`` is set to ``True``.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 898}, {"name": "Get Element Count", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the count of elements found with <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector which shall be counted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a>    label    &gt;    1\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4270\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the count of elements found with ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 605}, {"name": "Get Element States", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected: ElementState | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}, {"name": "return_names", "type": null, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "return_names=True"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}], "union": true}, "doc": "<p>Get the active states from the element found by <code>selector</code>.</p>\n<p>This Keyword returns a list of states that are valid for the selected element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected states</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n<tr>\n<td><code>return_names</code></td>\n<td>If set to <code>False</code> the keyword does return an IntFlag object (<a href=\"#type-ElementState\" class=\"name\">ElementState</a>) instead of a list. <a href=\"#type-ElementState\" class=\"name\">ElementState</a> may contain multiple states at the same time. Defaults to <code>True</code>.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default, assertion is not done.</p>\n<p>This keyword internally works with Python IntFlag. Flags can be processed using bitwise operators like &amp; (bitwise AND) and | (bitwise OR). When using the assertion operators <code>then</code>, <code>evaluate</code> or <code>validate</code> the <code>value</code> contain the states as <a href=\"#type-ElementState\" class=\"name\">ElementState</a>.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    validate    value &amp; visible   # Fails in case of an invisible element\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    then    value &amp; (visible | hidden)  # Returns either <code>['visible']</code> or <code>['hidden']</code>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    then    bool(value &amp; visible)  # Returns <code>${True}</code> if element is visible\n</pre>\n<p>The most typical use case would be to verify if an element contains a specific state or multiple states.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=checked_elem      *=    checked\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=checked_elem      not contains    checked\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=invisible_elem    contains    hidden    attached\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=disabled_elem     contains    visible    disabled    readonly\n</pre>\n<p>Elements do return the positive and negative values if applicable. As example, a checkbox does return either <code>checked</code> or <code>unchecked</code> while a text input element has none of those two states. Select elements have also either <code>selected</code> or <code>unselected</code>.</p>\n<p>The state of <code>animating</code> will be set if an element is not considered <code>stable</code> within 300 ms.</p>\n<p>If an element is not attached to the dom, so it can not be found within 250ms it is marked as <code>detached</code> as the only state.</p>\n<p><code>stable</code> state is not returned, because it would cause too high delay in that keyword.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4272\">Comment &gt;&gt;</a></p>", "shortdoc": "Get the active states from the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1346}, {"name": "Get Elements", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a reference to Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a> for all matched elements by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${elements} =    <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a>\n${elem} =    Get From List    ${elements}    0\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${elem} &gt;&gt; option    value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4273\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to Playwright [https://playwright.dev/docs/api/class-locator|Locator] for all matched elements by ``selector``.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 864}, {"name": "Get Page Errors", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "full", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "full: bool = False"}, {"name": "last", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "last: int | timedelta | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns the page errors of the active page.</p>\n<p>If assertions are used and fail, this keyword will fail immediately without retrying.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>full</td>\n<td>If true, returns the full console log. If false, returns only new entries that were added since last time.</td>\n</tr>\n<tr>\n<td>last</td>\n<td>If set, returns only the last n entries. Can be <span class=\"name\">int</span> for number of entries or <a href=\"#type-timedelta\" class=\"name\">timedelta</a> for time period.</td>\n</tr>\n</table>\n<p>The returned data is a <a href=\"#type-list\" class=\"name\">list</a> of error messages.</p>\n<p>An error message is a <span class=\"name\">dict</span> with the following structure:</p>\n<pre>\n{\n  \"name\": str,\n  \"message\": str,\n  \"stack\": str,\n  \"time\": str\n}\n</pre>\n<p>Example:</p>\n<pre>\n[{\n  'name': 'ReferenceError',\n  'message': 'YT is not defined',\n  'stack': 'ReferenceError: YT is not defined\\n    at HTMLIFrameElement.onload (<a href=\"https://example.com/:20:2245\">https://example.com/:20:2245</a>)',\n  'time': '2023-02-05T20:08:48.912Z'\n}]\n</pre>\n<p>Keys:</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>The name/type of the error.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>The human readable error message.</td>\n</tr>\n<tr>\n<td><code>stack</code></td>\n<td>The stack trace of the error, if given.</td>\n</tr>\n<tr>\n<td><code>time</code></td>\n<td>The timestamp of the error as ISO 8601 string.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//5268\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the page errors of the active page.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1101}, {"name": "Get Page Ids", "args": [{"name": "page", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType = ALL"}, {"name": "context", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [], "union": false}, "doc": "<p>Returns a list of page ids based on the context and browser selection. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<p><code>ALL</code> and <code>ANY</code> are synonyms. <code>ACTIVE</code> and <code>CURRENT</code> are also synonyms.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>The page to get the ids from. <code>ALL</code> Returns all page ids as a list. <code>ACTIVE</code> Returns the id of the active page as a list.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context to get the page ids from. <code>ALL</code> Page ids from all contexts shall be fetched. <code>ACTIVE</code> Only page ids from the active context shall be fetched.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the page ids from. <code>ALL</code> Page ids from all open browsers shall be fetched. <code>ACTIVE</code> Only page ids from the active browser shall be fetched.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nTest Case\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://www.imbus.de\">http://www.imbus.de</a>\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://www.reaktor.com\">http://www.reaktor.com</a>\n    ${current_page}=   <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>    ACTIVE    ACTIVE    ACTIVE\n    Log                Current page ID is: ${current_page}[0]\n    ${all_pages}=      <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>    CURRENT   CURRENT   ALL\n    Log Many           These are all Page IDs    @{all_pages}\n</pre>\n<p>The ACTIVE page of the ACTIVE context of the ACTIVE Browser is the <code>Current</code> Page.</p>\n<p><a href=\"https://forum.robotframework.org/t//4274\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of page ids based on the context and browser selection. See `Browser, Context and Page` for more information about Page and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1410}, {"name": "Get Page Source", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Gets pages HTML source as a string.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally does a string assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4275\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets pages HTML source as a string.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 89}, {"name": "Get Property", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "property", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "property: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Returns the <code>property</code> of the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>property</code></td>\n<td>Requested property name.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the property value matches the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>If <code>assertion_operator</code> is set and property is not found, <code>value</code> is <code>None</code> and Keyword does not fail. See <a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a> for examples.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Property\" class=\"name\">Get Property</a>    h1    innerText    ==    Login Page\n${property} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    h1    innerText\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4276\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the ``property`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 212}, {"name": "Get Scroll Position", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "AreaFields", "typedoc": "AreaFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: AreaFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "ScrollPosition", "typedoc": "ScrollPosition", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements or pages current scroll position as object <code>{top: float, left: float, bottom: float, right: float}</code>.</p>\n<p>It describes the rectangle which is visible of the scrollable content of that element. all values are measured from position {top: 0, left: 0}.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the client size of the page itself is used (<code>document.scrollingElement</code>). See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll position as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> or <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> for examples.</p>\n<p><a href=\"https://forum.robotframework.org/t//4277\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages current scroll position as object ``{top: float, left: float, bottom: float, right: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1240}, {"name": "Get Scroll Size", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dimensions", "typedoc": "Dimensions", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements or pages scrollable size as object <code>{width: float, height: float}</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the scroll size of the page itself is used. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll size as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> for more similar examples.</p>\n<p>Example use:</p>\n<pre>\n${height}=         <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a>    height                          # filtered page by height\nLog                Width: ${height}                                   # Height: 58425\n${scroll_size}=    <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a>    id=keyword-shortcuts-container  # unfiltered element\nLog                ${scroll_size}                                     # {'width': 253, 'height': 3036}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4278\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages scrollable size as object ``{width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1184}, {"name": "Get Select Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "SelectOptions", "typedoc": "SelectOptions", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns attributes of options of a <code>select</code> element as a list of dictionaries.</p>\n<p>Returned dictionaries have the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that these match the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a>     //select[2]    validate  [v[\"label\"] for v in value] == [\"Email\", \"Mobile\"]\n<a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a>   select#names     validate  any(v[\"label\"] == \"Mikko\" for v in value)\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4279\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns attributes of options of a ``select`` element as a list of dictionaries.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 434}, {"name": "Get Selected Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "option_attribute", "type": {"name": "SelectAttribute", "typedoc": "SelectAttribute", "nested": [], "union": false}, "defaultValue": "label", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "option_attribute: SelectAttribute = label"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}], "union": false}, "doc": "<p>Returns the specified attribute of selected options of the <code>select</code> element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>option_attribute</code></td>\n<td>Which attribute shall be returned/verified. Defaults to label.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that these match the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>      label                    //select[2]    Email      Mobile\n${selected_list}         <a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   //select[2]                                         # getter\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   //select[2]              label          <span class=\"name\">==</span>       Mobile             Mail   #assertion content\n<a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>      label                    select#names   2          4\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             index          <span class=\"name\">==</span>       2                  4      #assertion index\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             label          *=         Mikko                     #assertion contain\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             label          validate   len(value) == 3           #assertion length\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4280\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the specified attribute of selected options of the ``select`` element.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 493}, {"name": "Get Style", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: str | None = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "pseudo_element", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pseudo_element: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets the computed style properties of the element selected by <code>selector</code>.</p>\n<p>Optionally matches with any sequence assertion operator.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the style shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Key of the requested CSS property. Retrieves \"ALL\" styles as dictionary by default. All css settings can be used as keys even if they are not all returned in the dictionary.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n<tr>\n<td><code>pseudo_element</code></td>\n<td>Pseudo element to match. Defaults to None. Pseudo elements are special css</td>\n</tr>\n</table>\n<p><a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-elements\">Pseudo element</a> is a css fuctionality to add styles. Example <span class=\"name\">::before</span> or <span class=\"name\">::after</span>.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the style matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4281\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets the computed style properties of the element selected by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 1056}, {"name": "Get Table Cell Element", "args": [{"name": "table", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "table: str"}, {"name": "column", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: str"}, {"name": "row", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the Web Element that has the same column index and same row index as the selected elements.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>table</code></td>\n<td>selector must select the <code>&lt;table&gt;</code> element that contains both selected elements</td>\n</tr>\n<tr>\n<td><code>column</code></td>\n<td>selector can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants.</td>\n</tr>\n<tr>\n<td><code>row</code></td>\n<td>selector can select any <code>&lt;tr&gt;</code> element or one of their descendant like <code>&lt;td&gt;</code> elements.</td>\n</tr>\n</table>\n<p><code>column</code> and <code>row</code> can also consume index numbers instead of selectors. Indexes are starting from <code>0</code> and <code>-1</code> is specific for the last element.</p>\n<p>Selectors for <code>column</code> and <code>row</code> are directly appended to <code>table</code> selector like this: <code>f\"{table} &gt;&gt; {row}\" .</code></p>\n<table border=\"1\">\n<tr>\n<th>GitHub</th>\n<th>Slack</th>\n<th>Real Name</th>\n</tr>\n<tr>\n<td>mkorpela</td>\n<td>@mkorpela</td>\n<td>Mikko Korpela</td>\n</tr>\n<tr>\n<td>aaltat</td>\n<td>@aaltat</td>\n<td>Tatu Aalto</td>\n</tr>\n<tr>\n<td>xylix</td>\n<td>@Kerkko Pelttari</td>\n<td>Kerkko Pelttari</td>\n</tr>\n<tr>\n<td>Snooz82</td>\n<td>@Ren\u00e9</td>\n<td>Ren\u00e9 Rohner</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    [id=\"Get Table Cell Element\"] &gt;&gt; div.kw-docs table &gt;&gt; nth=1\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"Real Name\"    \"aaltat\"   # Returns element with text <code>Tatu Aalto</code>\nGet Text    ${e}    ==    Tatu Aalto\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"Slack\"    \"Mikko Korpela\"   # Returns element with text <code>@mkorpela</code>\nGet Text    ${e}    ==    @mkorpela\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"mkorpela\"    \"Kerkko Pelttari\"   # column does not need to be in row 0\nGet Text    ${e}    ==    @mkorpela\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    2    -1   # Index is also directly possible\nGet Text    ${e}    ==    Ren\u00e9 Rohner\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4282\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the Web Element that has the same column index and same row index as the selected elements.", "tags": ["Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 696}, {"name": "Get Table Cell Index", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the index (0 based) of a table cell within its row.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    id=<a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a> &gt;&gt; div.kw-docs table   #Table of keyword <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>\n${idx}=    <a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a>    ${table} &gt;&gt; \"Real Name\"\nShould Be Equal    ${idx}    ${2}\n<a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a>    ${table} &gt;&gt; \"@aaltat\"    ==    1\n</pre>\n<p>Optionally asserts that the index matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4283\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the index (0 based) of a table cell within its row.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 751}, {"name": "Get Table Row Index", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the index (0 based) of a table row.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    id=<a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a> &gt;&gt; div.kw-docs table   #Table of keyword <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>\n${idx}=    <a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a>    ${table} &gt;&gt; \"@Ren\u00e9\"\nShould Be Equal    ${idx}    ${4}\n<a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a>    ${table} &gt;&gt; \"@aaltat\"    ==    2\n</pre>\n<p>Optionally asserts that the index matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4284\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the index (0 based) of a table row.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 794}, {"name": "Get Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns text attribute of the element found by <code>selector</code>.</p>\n<p>Keyword can also return <span class=\"name\">input</span> or <span class=\"name\">textarea</span> value property text. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the text matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default, assertion is not done.</p>\n<p>Example:</p>\n<pre>\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=important                            # Returns element text without assertion.\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=important    ==    Important text    # Returns element text with assertion.\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    //input         ==    root              # Returns input element text with assertion.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4285\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns text attribute of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 160}, {"name": "Get Title", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the title of the current page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that title matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4286\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the title of the current page.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 124}, {"name": "Get Url", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the current URL.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that it matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4287\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the current URL.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 59}, {"name": "Get Viewport Size", "args": [{"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns the current viewport dimensions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the viewport size as dictionary, otherwise it will just return the single value selected by the key. Note: If a single value is retrieved, an assertion does <b>not</b> need a <code>validate</code> combined with a cast of <code>value</code>.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>    ALL    ==    {'width':1280, 'height':720}\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>    width    &gt;=    1200\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4288\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the current viewport dimensions.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/getters.py", "lineno": 645}, {"name": "Go Back", "args": [], "returnType": null, "doc": "<p>Navigates to the previous page in history.</p>\n<p><a href=\"https://forum.robotframework.org/t//4289\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the previous page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 51}, {"name": "Go Forward", "args": [], "returnType": null, "doc": "<p>Navigates to the next page in history.</p>\n<p><a href=\"https://forum.robotframework.org/t//4290\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the next page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 41}, {"name": "Go To", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": null, "doc": "<p>Navigates to the given <code>url</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>URL to be navigated to.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>time to wait page to load. If not defined will use the library default timeout.</td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Returns the HTTP status code for the navigation request as integer or 0 if non received.</p>\n<p><a href=\"https://forum.robotframework.org/t//4291\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the given ``url``.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 61}, {"name": "Grant Permissions", "args": [{"name": "permissions", "type": {"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*permissions: Permission"}, {"name": "origin", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "origin: str | None = None"}], "returnType": null, "doc": "<p>Grants permissions to the current context.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>permissions</code></td>\n<td>is a list of permissions to grant. Permissions can be one of the following: geolocation, notifications, camera, microphone,</td>\n</tr>\n<tr>\n<td><code>origin</code></td>\n<td>The origin to grant permissions to, e.g. \"<a href=\"https://example.com\">https://example.com</a>\".</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#Grant%20Permissions\" class=\"name\">Grant Permissions</a>    geolocation\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4292\">Comment &gt;&gt;</a></p>", "shortdoc": "Grants permissions to the current context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 523}, {"name": "Handle Future Dialogs", "args": [{"name": "action", "type": {"name": "DialogAction", "typedoc": "DialogAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}], "returnType": null, "doc": "<p>Handle next dialog on page with <code>action</code>.</p>\n<p>Dialog can be any of alert, beforeunload, confirm or prompt. Handling dialogue must be called before the action, like example click, that triggers the dialogue.</p>\n<p>If a handler is not set dialogs are dismissed by default.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>How to handle the alert. Can be <code>accept</code> or <code>dismiss</code>.</td>\n</tr>\n<tr>\n<td><code>prompt_input</code></td>\n<td>The value to enter into prompt. Only valid if <code>action</code> argument equals <code>accept</code>. Defaults to empty string.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a>    action=accept\n<a href=\"#Click\" class=\"name\">Click</a>                    \\#alerts\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4293\">Comment &gt;&gt;</a></p>", "shortdoc": "Handle next dialog on page with ``action``.", "tags": ["PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 827}, {"name": "Highlight Elements", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "duration", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:05", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration: timedelta = 0:00:05"}, {"name": "width", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "2px", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width: str = 2px"}, {"name": "style", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "dotted", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = dotted"}, {"name": "color", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "blue", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "color: str = blue"}], "returnType": null, "doc": "<p>Adds a highlight to elements matched by the <code>selector</code>. Provides a style adjustment.</p>\n<p>Returns the number of highlighted elements. Keyword does not fail, if <span class=\"name\">locator</span> matched zero elements in the page. Keyword does not scroll elements to viewport and highlighted element might be outside the viewport. Use <a href=\"#Scroll%20To%20Element\" class=\"name\">Scroll To Element</a> keyword to scroll element in viewport.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selectors which shall be highlighted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>duration</code></td>\n<td>Sets for how long the selector shall be highlighted. Defaults to <code>5s</code> =&gt; 5 seconds.</td>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>Sets the width of the higlight border. Defaults to 2px.</td>\n</tr>\n<tr>\n<td><code>style</code></td>\n<td>Sets the style of the border. Defaults to dotted.</td>\n</tr>\n<tr>\n<td><code>color</code></td>\n<td>Sets the color of the border. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></td>\n</tr>\n</table>\n<p>Keyword does not fail if selector resolves to multiple elements.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    input#login_button    duration=200ms\n${count} =    <a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    input#login_button    duration=200ms    width=4px    style=solid    color=\\#FF00FF\nShould Be Equal    ${count}    ${5}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4294\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a highlight to elements matched by the ``selector``. Provides a style adjustment.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 82}, {"name": "Hover", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_x: float | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_y: float | None = None"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}], "returnType": null, "doc": "<p>Moves the virtual mouse and scrolls to the element found by <code>selector</code>.</p>\n<p>This method hovers over an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element match matching <code>selector</code>. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a> to hover over the center of the element, or the specified <code>position</code>.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to hover. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>position_x</code> &amp; <code>position_y</code></td>\n<td>A point to hover relative to the top-left corner of element bounding box. If not specified, hovers over some visible point of the element. Only positive values within the bounding-box are allowed.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the hover, and then restores current modifiers back. If not specified, currently pressed modifiers are used.</td>\n<td></td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Hover\" class=\"name\">Hover</a>    h1\n<a href=\"#Hover\" class=\"name\">Hover</a>    h1    10   20    Alt\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4295\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves the virtual mouse and scrolls to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 480}, {"name": "Http", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "RequestMethod", "typedoc": "RequestMethod", "nested": [], "union": false}, "defaultValue": "GET", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "method: RequestMethod = GET"}, {"name": "body", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "body: str | None = None"}, {"name": "headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers: dict | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Performs an HTTP request in the current browser context</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>The request url, e.g. <code>/api/foo</code>.</td>\n</tr>\n<tr>\n<td><code>method</code></td>\n<td>The HTTP method for the request. Defaults to GET.</td>\n</tr>\n<tr>\n<td><code>body</code></td>\n<td>The request body. GET requests cannot have a body. If the body can be parsed as JSON, the <code>Content-Type</code> header for the request will be automatically set to <code>application/json</code>. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>headers</code></td>\n<td>A dictionary of additional request headers. Defaults to None.</td>\n</tr>\n</table>\n<p>The response is a Python dictionary with following attributes:</p>\n<ul>\n<li><code>status</code> &lt;int&gt; The status code of the response.</li>\n<li><code>statusText</code> &lt;str&gt; Status text corresponding to <code>status</code>, e.g OK or INTERNAL SERVER ERROR. This may not be available for all browser.</li>\n<li><code>body</code> &lt;dict&gt; | &lt;str&gt; The response body. If the body can be parsed as a JSON obejct, it will be returned as Python dictionary, otherwise it is returned as a string.</li>\n<li><code>headers</code> &lt;dict&gt; A dictionary containing all response headers.</li>\n<li><code>ok</code> &lt;bool&gt; Whether the request was successfull, i.e. the <code>status</code> is range 200-299.</li>\n</ul>\n<p>Here's an example of using Robot Framework dictionary variables and extended variable syntax to do assertions on the response object:</p>\n<pre>\n&amp;{res}=             <a href=\"#Http\" class=\"name\">HTTP</a>                       /api/endpoint\nShould Be Equal     ${res.status}              200\nShould Be Equal     ${res.body.some_field}     some value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4296\">Comment &gt;&gt;</a></p>", "shortdoc": "Performs an HTTP request in the current browser context", "tags": ["HTTP"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 60}, {"name": "Keyboard Input", "args": [{"name": "action", "type": {"name": "KeyboardInputAction", "typedoc": "KeyboardInputAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyboardInputAction"}, {"name": "input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input: str"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int | timedelta = 0:00:00"}], "returnType": null, "doc": "<p>Input text into page with virtual keyboard.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td><code>insertText</code>: Dispatches only input event, does not emit the keydown, keyup or keypress events. <code>type</code>: Sends a keydown, keypress/input, and keyup event for each character in the text.</td>\n</tr>\n<tr>\n<td><code>input</code></td>\n<td>The inputstring to be typed. <i>No special keys possible.</i></td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Time to wait between key presses in Robot Framework's time format. Defaults to 0.</td>\n</tr>\n</table>\n<p><b>Attention:</b> Argument type <span class=\"name\">int</span> for 'delay' in milliseconds has been changed to <a href=\"#type-timedelta\" class=\"name\">timedelta</a> in Browser 14.0.0. Use Robot Framework time format with units instead.</p>\n<p>Note: To press a special key, like Control or ArrowDown, use keyboard.press. Modifier keys DO NOT effect these methods. For testing modifier effects use single key presses with <code>Keyboard Key  press</code></p>\n<p>Example:</p>\n<pre>\n<a href=\"#Keyboard%20Input\" class=\"name\">Keyboard Input</a>    insertText    0123456789\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4297\">Comment &gt;&gt;</a></p>", "shortdoc": "Input text into page with virtual keyboard.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1211}, {"name": "Keyboard Key", "args": [{"name": "action", "type": {"name": "KeyAction", "typedoc": "KeyAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyAction"}, {"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "returnType": null, "doc": "<p>Press a keyboard key on the virtual keyboard or set a key up or down.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>Determine whether the key should be released (<code>up</code>), hold (<code>down</code>) or pressed once (<code>press</code>). <code>down</code> or <code>up</code> are useful for combinations i.e. with Shift.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The key to be pressed. An example of valid keys are: <code>F1</code> - <code>F12</code>, <code>Digit0</code> - <code>Digit9</code>, <code>KeyA</code> - <code>KeyZ</code>, <code>Backquote</code>, <code>Minus</code>, <code>Equal</code>, <code>Backslash</code>, <code>Backspace</code>, <code>Tab</code>, <code>Delete</code>, <code>Escape</code>, <code>ArrowDown</code>, <code>End</code>, <code>Enter</code>, <code>Home</code>, <code>Insert</code>, <code>PageDown</code>, <code>PageUp</code>, <code>ArrowRight</code>, <code>ArrowUp</code> , etc.</td>\n</tr>\n</table>\n<p>Useful keys for <code>down</code> and <code>up</code> for example are: <code>Shift</code>, <code>Control</code>, <code>Alt</code>, <code>Meta</code>, <code>ShiftLeft</code></p>\n<p>Example excecution:</p>\n<pre>\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    S\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    down     Shift\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    ArrowLeft\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    Delete\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    up       Shift\n</pre>\n<p>Note: Capital letters don't need to be written by the help of Shift. You can type them in directly.</p>\n<p><a href=\"https://forum.robotframework.org/t//4298\">Comment &gt;&gt;</a></p>", "shortdoc": "Press a keyboard key on the virtual keyboard or set a key up or down.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1182}, {"name": "Launch Browser Server", "args": [{"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "firefoxUserPrefs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "firefoxUserPrefs: Dict[str, str | int | float | bool] | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "port", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "port: int | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "reuse_existing", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "reuse_existing: bool = True"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "wsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "wsPath: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Launches a new playwright Browser server with specified options.</p>\n<p>Returns a websocket endpoint (wsEndpoint) string that can be used to connect to the server.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>port</code></td>\n<td>Port to use for the browser server. Defaults to 0, which results in a random free port being assigned.</td>\n</tr>\n<tr>\n<td><code>wsPath</code></td>\n<td>If set, Playwright will listen on the given path in addition to the main port. For security, this defaults to an unguessable string.</td>\n</tr>\n</table>\n<p>Check <a href=\"#New%20Browser\" class=\"name\">New Browser</a> for the other argument docs.</p>\n<p>The launched browser server can be used to connect to it with <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a> keyword. This keyword can also be used from command line with <code>rfbrowser launch-browser-server</code> command.</p>\n<p>see <a href=\"https://playwright.dev/docs/api/class-browserserver#browser-server\">Playwright documentation</a> for more information.</p>\n<p><a href=\"https://forum.robotframework.org/t//4306\">Comment &gt;&gt;</a></p>", "shortdoc": "Launches a new playwright Browser server with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 431}, {"name": "LocalStorage Clear", "args": [{"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove all saved data from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>      Foo    bar\n<a href=\"#LocalStorage%20Clear\" class=\"name\">LocalStorage Clear</a>\n${item} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Foo\nShould Be Equal    ${item}    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4299\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove all saved data from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 124}, {"name": "LocalStorage Get Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Get saved data from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Named key of the item in the storage.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>Assertion operator to use. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value to compare with.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Custom error message to use.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Key    ==    Value    My error\n${value} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Key\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4300\">Comment &gt;&gt;</a></p>", "shortdoc": "Get saved data from the local storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 42}, {"name": "LocalStorage Remove Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove saved data with key from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the item which shall be deleted.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>      Foo    bar\n<a href=\"#LocalStorage%20Remove%20Item\" class=\"name\">LocalStorage Remove Item</a>    Foo\n${item} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Foo\nShould Be Equal    ${item}    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4301\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove saved data with key from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 103}, {"name": "LocalStorage Set Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Save data to the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the key under which it should be saved.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>The value which shall be saved as a string.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>    Key    Value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4302\">Comment &gt;&gt;</a></p>", "shortdoc": "Save data to the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 81}, {"name": "Mouse Button", "args": [{"name": "action", "type": {"name": "MouseButtonAction", "typedoc": "MouseButtonAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: MouseButtonAction"}, {"name": "x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float | None = None"}, {"name": "y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float | None = None"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "clickCount", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int | timedelta = 0:00:00"}], "returnType": null, "doc": "<p>Clicks, presses or releases a mouse button.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>Defines if it is a mouseclick (<code>click</code>), holding down a button (<code>down</code>) or releasing it (<code>up</code>).</td>\n</tr>\n<tr>\n<td><code>x</code>, <code>y</code></td>\n<td>Coordinates to move before action is executed.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>One of <code>left</code>, <code>middle</code> or <code>up</code>. Defaults to <code>left</code>.</td>\n</tr>\n<tr>\n<td><code>clickCount</code></td>\n<td>Determine how often the button shall be clicked if action is equal to <code>click</code>. Defaults to 1.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay in Robot Framework time format between the mousedown and mouseup event. Can only be set if the action is <code>click</code>.</td>\n</tr>\n</table>\n<p><b>Attention:</b> Argument type <span class=\"name\">int</span> for 'delay' in milliseconds has been changed to <a href=\"#type-timedelta\" class=\"name\">timedelta</a> in Browser 14.0.0. Use Robot Framework time format instead. For refactoring just add 'ms' after the delay number.</p>\n<p>Delay Example:</p>\n<pre>\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>    click    100 ms\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>    click    ${dyn_delay} ms\n</pre>\n<p>Moving the mouse between holding down and releasing it, is possible with <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Hover\" class=\"name\">Hover</a>                     \"Obstacle\"           # Move mouse over the element\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>              down                 # Press mouse button down\n<a href=\"#Mouse%20Move%20Relative%20To\" class=\"name\">Mouse Move Relative To</a>    \"Obstacle\"    500    # Drag mouse\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>              up                   # Release mouse button\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4303\">Comment &gt;&gt;</a></p>", "shortdoc": "Clicks, presses or releases a mouse button.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 913}, {"name": "Mouse Move", "args": [{"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: float"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: float"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>Are absolute coordinates starting at the top left of the page.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Number of intermediate steps for the mouse event. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>    400    400\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4304\">Comment &gt;&gt;</a></p>", "shortdoc": "Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1142}, {"name": "Mouse Move Relative To", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Moves the mouse cursor relative to the selected element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>Are relative coordinates to the center of the elements bounding box.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Number of intermediate steps for the mouse event. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Mouse%20Move%20Relative%20To\" class=\"name\">Mouse Move Relative To</a>    id=indicator    -100\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4305\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves the mouse cursor relative to the selected element.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1102}, {"name": "Mouse Wheel", "args": [{"name": "deltaX", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deltaX: int"}, {"name": "deltaY", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deltaY: int"}], "returnType": null, "doc": "<p>Simulates the user rotation of a mouse wheel.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>deltaX</code> &amp; <code>deltaY</code></td>\n<td>Pixels that are scrolled horizontally &amp; vertically.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n# Before doing a mouse wheel interaction. A mouse needs to be posisioned on the browser window.\n<a href=\"#Hover\" class=\"name\">Hover</a>    body\n<a href=\"#Mouse%20Wheel\" class=\"name\">Mouse Wheel</a>    0    250\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5186\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates the user rotation of a mouse wheel.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1162}, {"name": "New Browser", "args": [{"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "firefoxUserPrefs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "firefoxUserPrefs: Dict[str, str | int | float | bool] | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "reuse_existing", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "reuse_existing: bool = True"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Create a new playwright Browser with specified options.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Returns a stable identifier for the created browser.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Opens the specified <a href=\"#type-SupportedBrowsers\">browser</a>. Defaults to chromium.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>Set to False if you want a GUI. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>args</code></td>\n<td>Additional arguments to pass to the browser instance. The list of Chromium flags can be found <a href=\"http://peter.sh/experiments/chromium-command-line-switches/\">here</a>. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>channel</code></td>\n<td>Allows to operate against the stock Google Chrome and Microsoft Edge browsers. For more details see: <a href=\"https://playwright.dev/docs/browsers#google-chrome--microsoft-edge\">Playwright documentation</a>.</td>\n</tr>\n<tr>\n<td><code>chromiumSandbox</code></td>\n<td>Enable Chromium sandboxing. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>devtools</code></td>\n<td>Chromium-only Whether to auto-open a Developer Tools panel for each tab.</td>\n</tr>\n<tr>\n<td><code>downloadsPath</code></td>\n<td>If specified, accepted downloads are downloaded into this folder. Otherwise, temporary folder is created and is deleted when browser is closed. Regarding file deletion, see the docs of <a href=\"#Download\" class=\"name\">Download</a> and <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a>.</td>\n</tr>\n<tr>\n<td><code>env</code></td>\n<td>Specifies environment variables that will be visible to the browser. Dictionary keys are variable names, values are the content. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>executablePath</code></td>\n<td>Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>firefoxUserPrefs</code> |Firefox user preferences. Learn more about the Firefox user preferences at <a href=\"https://support.mozilla.org/en-US/kb/about-config-editor-firefox\">about:config</a>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>handleSIGHUP</code></td>\n<td>Close the browser process on SIGHUP. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>handleSIGINT</code></td>\n<td>Close the browser process on Ctrl-C. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>handleSIGTERM</code></td>\n<td>Close the browser process on SIGTERM. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>ignoreDefaultArgs</code></td>\n<td>If True, Playwright does not pass its own configurations args and only uses the ones from args. If a list is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>proxy</code></td>\n<td>Network <a href=\"#type-Proxy\">Proxy</a> settings. Structure: <code>{'server': &lt;str&gt;, 'bypass': &lt;Optional[str]&gt;, 'username': &lt;Optional[str]&gt;, 'password': &lt;Optional[str]&gt;}</code></td>\n</tr>\n<tr>\n<td><code>reuse_existing</code></td>\n<td>If set to True, an existing browser instance, that matches the same arguments, will be reused. If no same configured Browser exist, a new one is started. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>slowMo</code></td>\n<td>Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to no delay.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Maximum time in Robot Framework time format to wait for the browser instance to start. Defaults to 30 seconds. Pass 0 to disable timeout.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4306\">Comment &gt;&gt;</a></p>", "shortdoc": "Create a new playwright Browser with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 360}, {"name": "New Context", "args": [{"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "acceptDownloads", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "acceptDownloads: bool = True"}, {"name": "baseURL", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "baseURL: str | None = None"}, {"name": "bypassCSP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "colorScheme", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ColorScheme", "typedoc": "ColorScheme", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "colorScheme: ColorScheme | None = None"}, {"name": "defaultBrowserType", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "defaultBrowserType: SupportedBrowsers | None = None"}, {"name": "deviceScaleFactor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "deviceScaleFactor: float | None = None"}, {"name": "extraHTTPHeaders", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] | None = None"}, {"name": "forcedColors", "type": {"name": "ForcedColors", "typedoc": "ForcedColors", "nested": [], "union": false}, "defaultValue": "none", "kind": "NAMED_ONLY", "required": false, "repr": "forcedColors: ForcedColors = none"}, {"name": "geolocation", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "GeoLocation", "typedoc": "GeoLocation", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "geolocation: GeoLocation | None = None"}, {"name": "hasTouch", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "hasTouch: bool | None = None"}, {"name": "httpCredentials", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HttpCredentials", "typedoc": "HttpCredentials", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "httpCredentials: HttpCredentials | None = None"}, {"name": "ignoreHTTPSErrors", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "isMobile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "isMobile: bool | None = None"}, {"name": "javaScriptEnabled", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "locale: str | None = None"}, {"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "offline: bool = False"}, {"name": "permissions", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "permissions: List[Permission] | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "recordHar", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordHar", "typedoc": "RecordHar", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordHar: RecordHar | None = None"}, {"name": "recordVideo", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordVideo", "typedoc": "RecordVideo", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordVideo: RecordVideo | None = None"}, {"name": "reducedMotion", "type": {"name": "ReduceMotion", "typedoc": "ReduceMotion", "nested": [], "union": false}, "defaultValue": "no_preference", "kind": "NAMED_ONLY", "required": false, "repr": "reducedMotion: ReduceMotion = no_preference"}, {"name": "screen", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "screen: Dict[str, int] | None = None"}, {"name": "serviceWorkers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ServiceWorkersPermissions", "typedoc": "ServiceWorkersPermissions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "allow", "kind": "NAMED_ONLY", "required": false, "repr": "serviceWorkers: ServiceWorkersPermissions | None = allow"}, {"name": "storageState", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "storageState: str | None = None"}, {"name": "timezoneId", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timezoneId: str | None = None"}, {"name": "tracing", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "tracing: str | None = None"}, {"name": "userAgent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "userAgent: str | None = None"}, {"name": "viewport", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "{'width': 1280, 'height': 720}", "kind": "NAMED_ONLY", "required": false, "repr": "viewport: ViewportDimensions | None = {'width': 1280, 'height': 720}"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Create a new BrowserContext with specified options.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about BrowserContext.</p>\n<p>Returns a stable identifier for the created context that can be used in <a href=\"#Switch%20Context\" class=\"name\">Switch Context</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>acceptDownloads</code></td>\n<td>Whether to automatically download all the attachments. Defaults to True where all the downloads are accepted.</td>\n</tr>\n<tr>\n<td><code>baseURL</code></td>\n<td>When using <a href=\"#Go%20To\" class=\"name\">Go To</a>, <a href=\"#Wait%20For%20Request\" class=\"name\">Wait For Request</a> or <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a> it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples: <code>baseURL=http://localhost:3000</code> and navigating to <code>/bar.html</code> results in <code>http://localhost:3000/bar.html</code>. <code>baseURL=http://localhost:3000/foo/</code> and navigating to <code>./bar.html</code> results in <code>http://localhost:3000/foo/bar.html</code>. <code>baseURL=http://localhost:3000/foo</code> (without trailing slash) and navigating to <code>./bar.html</code> results in <code>http://localhost:3000/bar.html</code>.</td>\n</tr>\n<tr>\n<td><code>bypassCSP</code></td>\n<td>Toggles bypassing page's Content-Security-Policy. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>colorScheme</code></td>\n<td>Emulates <span class=\"name\">'prefers-colors-scheme'</span> media feature, supported values are <span class=\"name\">'light'</span>, <span class=\"name\">'dark'</span>, <span class=\"name\">'no-preference'</span>.</td>\n</tr>\n<tr>\n<td><code>defaultBrowserType</code></td>\n<td>If no browser is open and <a href=\"#New%20Context\" class=\"name\">New Context</a> opens a new browser with defaults, it now uses this setting. Very useful together with <a href=\"#Get%20Device\" class=\"name\">Get Device</a> keyword.</td>\n</tr>\n<tr>\n<td><code>deviceScaleFactor</code></td>\n<td>Specify device scale factor (can be thought of as dpr). Defaults to <code>1</code>.</td>\n</tr>\n<tr>\n<td><code>extraHTTPHeaders</code></td>\n<td>A dictionary containing additional HTTP headers to be sent with every request. All header values must be strings.</td>\n</tr>\n<tr>\n<td><code>forcedColors</code></td>\n<td>Emulates <span class=\"name\">forced-colors</span> media feature, supported values are <span class=\"name\">active</span> and <a href=\"#type-None\" class=\"name\">none</a>.</td>\n</tr>\n<tr>\n<td><code>geolocation</code></td>\n<td>A dictionary containing <code>latitude</code> and <code>longitude</code> or <code>accuracy</code> to emulate. If <code>latitude</code> or <code>longitude</code> is not specified, the device geolocation won't be overriden.</td>\n</tr>\n<tr>\n<td><code>hasTouch</code></td>\n<td>Specifies if viewport supports touch events. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>httpCredentials</code></td>\n<td>Credentials for <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication\">HTTP authentication</a>.</td>\n</tr>\n<tr>\n<td><code>ignoreHTTPSErrors</code></td>\n<td>Whether to ignore HTTPS errors during navigation. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>isMobile</code></td>\n<td>Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>javaScriptEnabled</code></td>\n<td>Whether or not to enable JavaScript in the context. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>locale</code></td>\n<td>Specify user locale, for example <code>en-GB</code>, <code>de-DE</code>, etc.</td>\n</tr>\n<tr>\n<td><code>offline</code></td>\n<td>Toggles browser's offline mode. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>permissions</code></td>\n<td>A list containing permissions to grant to all pages in this context. All permissions that are not listed here will be automatically denied.</td>\n</tr>\n<tr>\n<td><code>proxy</code></td>\n<td>Network proxy settings to use with this context. Defaults to None. <b>NOTE:</b> For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example <code>proxy={ server: '<a href=\"http://per-context\">http://per-context</a>' }</code>.</td>\n</tr>\n<tr>\n<td><code>recordHar</code></td>\n<td>Enables <a href=\"http://www.softwareishard.com/blog/har-12-spec/\">HAR</a> recording for all pages into to a file. Must be path to file, example ${OUTPUT_DIR}/har.file. If not specified, the HAR is not recorded. Make sure to await context to close for the to be saved.</td>\n</tr>\n<tr>\n<td><code>recordVideo</code></td>\n<td>Enables video recording for all pages into a folder. If not specified videos are not recorded. Make sure to close context for videos to be saved. Video is not support in remote browsers.</td>\n</tr>\n<tr>\n<td><code>reduceMotion</code></td>\n<td>Emulates <span class=\"name\">prefers-reduced-motion</span> media feature, supported values are <span class=\"name\">reduce</span>, <span class=\"name\">no-preference</span>.</td>\n</tr>\n<tr>\n<td><code>screen</code></td>\n<td>Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set. Example {'width': 414, 'height': 896}</td>\n</tr>\n<tr>\n<td><code>serviceWorkers</code></td>\n<td>Whether to allow sites to register Service workers. Defaults to 'allow'.</td>\n</tr>\n<tr>\n<td><code>storageState</code></td>\n<td>Restores the storage stated created by the <a href=\"#Save%20Storage%20State\" class=\"name\">Save Storage State</a> keyword. Must mbe full path to the file.</td>\n</tr>\n<tr>\n<td><code>timezoneId</code></td>\n<td>Changes the timezone of the context. See <a href=\"https://source.chromium.org/chromium/chromium/src/+/master:third_party/icu/source/data/misc/metaZones.txt\">ICU`s metaZones.txt</a> for a list of supported timezone IDs.</td>\n</tr>\n<tr>\n<td><code>tracing</code></td>\n<td>File name where the <a href=\"https://playwright.dev/docs/api/class-tracing/\">tracing</a> file is saved. Example trace.zip will be saved to ${OUTPUT_DIR}/traces.zip. Temporary trace files will be saved to ${OUTPUT_DIR}/Browser/traces. If file name is defined, tracing will be enabled for all pages in the context. Tracing is automatically closed when context is closed. Temporary trace files will be automatically deleted at start of each test execution. Trace file can be opened after the test execution by running command from shell: <code>rfbrowser show-trace /path/to/trace.zip</code>.</td>\n</tr>\n<tr>\n<td><code>userAgent</code></td>\n<td>Specific user agent to use in this context.</td>\n</tr>\n<tr>\n<td><code>viewport</code></td>\n<td>A dictionary containing <code>width</code> and <code>height</code>. Emulates consistent viewport for each page. Defaults to 1280x720. null disables the default viewport. If <code>width</code> and <code>height</code> is  <code>0</code>, the viewport will scale with the window.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nTest an iPhone\n    ${device}=    <a href=\"#Get%20Device\" class=\"name\">Get Device</a>    iPhone X\n    <a href=\"#New%20Context\" class=\"name\">New Context</a>    &amp;{device}        # unpacking here with &amp;\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://example.com\">http://example.com</a>\n</pre>\n<p>A BrowserContext is the Playwright object that controls a single browser profile. Within a context caches and cookies are shared. See <a href=\"https://playwright.dev/docs/api/class-browser#browsernewcontextoptions\">Playwright browser.newContext</a> for a list of supported options.</p>\n<p>If there's no open Browser this keyword will open one. Does not create pages.</p>\n<p><a href=\"https://forum.robotframework.org/t//4307\">Comment &gt;&gt;</a></p>", "shortdoc": "Create a new BrowserContext with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 517}, {"name": "New Page", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": {"name": "NewPageDetails", "typedoc": "NewPageDetails", "nested": [], "union": false}, "doc": "<p>Open a new Page.</p>\n<p>A Page is the Playwright equivalent to a tab. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page concept.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Optional URL to navigate the page to. The url should include protocol, e.g. <span class=\"name\">https://</span></td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Returns <a href=\"#type-NewPageDetails\" class=\"name\">NewPageDetails</a> as dictionary for created page. <a href=\"#type-NewPageDetails\" class=\"name\">NewPageDetails</a> (dict) contains the keys <code>page_id</code> and <code>video_path</code>. <code>page_id</code> is a stable identifier for the created page. <code>video_path</code> is path to the created video or empty if video is not created.</p>\n<p>When a <a href=\"#New%20Page\" class=\"name\">New Page</a> is called without an open browser, <a href=\"#New%20Browser\" class=\"name\">New Browser</a> and <a href=\"#New%20Context\" class=\"name\">New Context</a> are executed with default values first.</p>\n<p><a href=\"https://forum.robotframework.org/t//4308\">Comment &gt;&gt;</a></p>", "shortdoc": "Open a new Page.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 861}, {"name": "New Persistent Context", "args": [{"name": "userDataDir", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "userDataDir: str = "}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "acceptDownloads", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "acceptDownloads: bool = True"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "baseURL", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "baseURL: str | None = None"}, {"name": "bypassCSP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "colorScheme", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ColorScheme", "typedoc": "ColorScheme", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "colorScheme: ColorScheme | None = None"}, {"name": "defaultBrowserType", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "defaultBrowserType: SupportedBrowsers | None = None"}, {"name": "deviceScaleFactor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "deviceScaleFactor: float | None = None"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "extraHTTPHeaders", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] | None = None"}, {"name": "forcedColors", "type": {"name": "ForcedColors", "typedoc": "ForcedColors", "nested": [], "union": false}, "defaultValue": "none", "kind": "NAMED_ONLY", "required": false, "repr": "forcedColors: ForcedColors = none"}, {"name": "geolocation", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "GeoLocation", "typedoc": "GeoLocation", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "geolocation: GeoLocation | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "hasTouch", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "hasTouch: bool | None = None"}, {"name": "httpCredentials", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HttpCredentials", "typedoc": "HttpCredentials", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "httpCredentials: HttpCredentials | None = None"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "ignoreHTTPSErrors", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "isMobile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "isMobile: bool | None = None"}, {"name": "javaScriptEnabled", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "locale: str | None = None"}, {"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "offline: bool = False"}, {"name": "permissions", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "permissions: List[Permission] | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "recordHar", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordHar", "typedoc": "RecordHar", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordHar: RecordHar | None = None"}, {"name": "recordVideo", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordVideo", "typedoc": "RecordVideo", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordVideo: RecordVideo | None = None"}, {"name": "reducedMotion", "type": {"name": "ReduceMotion", "typedoc": "ReduceMotion", "nested": [], "union": false}, "defaultValue": "no_preference", "kind": "NAMED_ONLY", "required": false, "repr": "reducedMotion: ReduceMotion = no_preference"}, {"name": "screen", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "screen: Dict[str, int] | None = None"}, {"name": "serviceWorkers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ServiceWorkersPermissions", "typedoc": "ServiceWorkersPermissions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "allow", "kind": "NAMED_ONLY", "required": false, "repr": "serviceWorkers: ServiceWorkersPermissions | None = allow"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "timezoneId", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timezoneId: str | None = None"}, {"name": "tracing", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "tracing: str | None = None"}, {"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "url: str | None = None"}, {"name": "userAgent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "userAgent: str | None = None"}, {"name": "viewport", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "{'width': 1280, 'height': 720}", "kind": "NAMED_ONLY", "required": false, "repr": "viewport: ViewportDimensions | None = {'width': 1280, 'height': 720}"}], "returnType": null, "doc": "<p>Open a new <a href=\"https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context\">persistent context</a>.</p>\n<p><a href=\"#New%20Persistent%20Context\" class=\"name\">New Persistent Context</a> does basically executes <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> in one step with setting a profile at the same time.</p>\n<p>This keyword returns a tuple of browser id, context id and page details. (New in Browser 15.0.0)</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>userDataDir</code></td>\n<td>Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox. Note that Chromium's user data directory is the parent directory of the \"Profile Path\" seen at <a href=\"chrome://version\">chrome://version</a>. Pass an empty string to use a temporary directory instead.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser type to use. Default is Chromium.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>Whether to run browser in headless mode. Defaults to <code>True</code>.</td>\n</tr>\n<tr>\n<td>other arguments</td>\n<td>Please see <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> for more information about the other arguments.</td>\n</tr>\n</table>\n<p>If you want to use extensions you need to download the extension as a .zip, enable loading the extension, and load the extensions using chromium arguments like below. Extensions only work with chromium and with a headful browser.</p>\n<pre>\n${launch_args}=  Set Variable  [\"--disable-extensions-except=./ublock/uBlock0.chromium\", \"--load-extension=./ublock/uBlock0.chromium\"]\n${browserId}  ${contextId}  ${pageDetails}=  <a href=\"#New%20Persistent%20Context\" class=\"name\">New Persistent Context</a>  browser=chromium  headless=False  url=https://robocon,io  args=${launch_args}\n</pre>\n<p>Check <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> for the specific argument docs.</p>\n<p><a href=\"https://forum.robotframework.org/t//4309\">Comment &gt;&gt;</a></p>", "shortdoc": "Open a new [https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context | persistent context].", "tags": [], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 634}, {"name": "Open Browser", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = False"}, {"name": "pause_on_failure", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pause_on_failure: bool = True"}, {"name": "bypassCSP", "type": null, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bypassCSP=True"}], "returnType": null, "doc": "<p>Opens a new browser instance. Use this keyword for quick experiments or debugging sessions.</p>\n<p>Use <a href=\"#New%20Page\" class=\"name\">New Page</a> directly instead of <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> for production and automated execution. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Creates a new browser, context and page with specified settings.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Navigates to URL if provided. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Specifies which browser to use. The supported browsers are listed in the table below.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>If set to False, a GUI is provided otherwise it is hidden. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>pause_on_failure</code></td>\n<td>Stop execution when failure detected and leave browser open. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>bypassCSP</code></td>\n<td>Defaults to bypassing CSP and enabling custom script attach to the page.</td>\n</tr>\n</table>\n<p>Browsers:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td><a href=\"https://www.mozilla.org/en-US/firefox/new\">Firefox</a></td>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td><a href=\"https://www.chromium.org/Home\">Chromium</a></td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td><a href=\"https://webkit.org/\">webkit</a></td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4310\">Comment &gt;&gt;</a></p>", "shortdoc": "Opens a new browser instance. Use this keyword for quick experiments or debugging sessions.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 76}, {"name": "Press Keys", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "keys", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "returnType": null, "doc": "<p>Types the given key combination into element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*keys</code></td>\n<td>Keys to be press after each other. Using + to chain combine modifiers with a single keypress <code>Control+Shift+T</code> is supported.</td>\n</tr>\n</table>\n<p>Supports values like \"a, b\" which will be automatically typed.</p>\n<p>Also supports identifiers for keys like <code>ArrowLeft</code> or <code>Backspace</code>.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See playwright's documentation for a more comprehensive list of supported input keys. <a href=\"https://playwright.dev/docs/api/class-page#page-press\">Playwright docs for press.</a></p>\n<p>Example:</p>\n<pre>\n# Keyword         Selector                    *Keys\n<a href=\"#Press%20Keys\" class=\"name\">Press Keys</a>      //*[@id=\"username_field\"]    h    e   l   o   ArrowLeft   l\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4311\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given key combination into element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 255}, {"name": "Promise To", "args": [{"name": "kw", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kw: str"}, {"name": "args", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "returnType": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Wrap a Browser library keyword and make it a promise.</p>\n<p>Promised keyword is executed and started on background. Test execution continues without waiting for <code>kw</code> to finish.</p>\n<p>Returns reference to the promised keyword.</p>\n<p><code>kw</code> Keyword that will work async on background.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>kw</code></td>\n<td>Keyword that will work async on background.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>Keyword arguments as normally used.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${promise}=     <a href=\"#Promise%20To\" class=\"name\">Promise To</a>            Wait For Response     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>           \\#delayed_request\n${body}=        <a href=\"#Wait%20For\" class=\"name\">Wait For</a>              ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4312\">Comment &gt;&gt;</a></p>", "shortdoc": "Wrap a Browser library keyword and make it a promise.", "tags": ["Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 39}, {"name": "Promise To Upload File", "args": [{"name": "path", "type": {"name": "PathLike", "typedoc": "Path", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "returnType": null, "doc": "<p>Returns a promise that resolves when file from <code>path</code> has been uploaded.</p>\n<p>Fails if the upload has not happened during timeout.</p>\n<p>Upload file from <code>path</code> into next file chooser dialog on page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Path to file to be uploaded.</td>\n</tr>\n</table>\n<p>Example use:</p>\n<pre>\n${promise}=    <a href=\"#Promise%20To%20Upload%20File\" class=\"name\">Promise To Upload File</a>    ${CURDIR}/test_upload_file.txt\n<a href=\"#Click\" class=\"name\">Click</a>          id=open_file_chooser_button\n${upload_result}=    <a href=\"#Wait%20For\" class=\"name\">Wait For</a>    ${promise}\n</pre>\n<p>Alternatively, you can use <a href=\"#Upload%20File%20By%20Selector\" class=\"name\">Upload File By Selector</a> keyword.</p>\n<p><a href=\"https://forum.robotframework.org/t//4313\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise that resolves when file from ``path`` has been uploaded.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 268}, {"name": "Promise To Wait For Download", "args": [{"name": "saveAs", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}, {"name": "wait_for_finished", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_for_finished: bool = True"}, {"name": "download_timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "download_timeout: timedelta | None = None"}], "returnType": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Returns a promise that waits for next download event on page.</p>\n<p>To enable downloads context's <code>acceptDownloads</code> needs to be true.</p>\n<p>With default filepath downloaded files are deleted when Context the download happened in is closed.</p>\n<p>If browser is connected remotely with <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a> then <code>saveAs</code> must be set to store it locally where the browser runs!</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>Defines path where the file is saved persistently. File will also temporarily be saved in playwright context's default download location. If empty, generated unique path (GUID) is used and file is deleted when the context is closed.</td>\n</tr>\n<tr>\n<td><code>wait_for_finished</code></td>\n<td>If true, promise will wait for download to finish. If false, promise will resolve immediately after download has started.</td>\n</tr>\n<tr>\n<td><code>download_timeout</code></td>\n<td>Maximum time to wait for download to finish, if <code>wait_for_finished</code> is set to <code>True</code>. If download is not finished during this time, keyword will be fail.</td>\n</tr>\n</table>\n<p>Keyword returns dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> which contains downloaded file path and suggested filename as well as state and downloadID. Example:</p>\n<pre>\n{\n  \"saveAs\": \"/tmp/robotframework-browser/downloads/2f1b3b7c-1b1b-4b1b-9b1b-1b1b1b1b1b1b\",\n  \"suggestedFilename\": \"downloaded_file.txt\"\n}\n</pre>\n<p>The keyword <a href=\"#New%20Browser\" class=\"name\">New Browser</a> has a <code>downloadsPath</code> setting which can be used to set the default download directory. If <span class=\"name\">saveAs</span> is set to a relative path, the file will be saved relative to the browser's <code>downloadsPath</code> setting or if that is not set, relative to the Playwright's working directory. If <code>saveAs</code> is set to an absolute path, the file will be saved to that absolute path independent of <code>downloadsPath</code>.</p>\n<p>If the URL for the file to download shall be used, <a href=\"#Download\" class=\"name\">Download</a> keyword may be a simpler alternative way to download the file.</p>\n<p>Waited promise returns a dictionary which contains saveAs and suggestedFilename as keys. The saveAs contains where the file is downloaded and suggestedFilename contains the name suggested name for the download. The suggestedFilename is typically computed by the browser from the Content-Disposition response header or the download attribute. See the spec on <a href=\"https://html.spec.whatwg.org/#downloading-resources\">whatwg</a>. Different browsers can use different logic for computing it.</p>\n<p>Example usage:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>            acceptDownloads=True\n<a href=\"#New%20Page\" class=\"name\">New Page</a>               ${LOGIN_URL}\n${dl_promise}          <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a>    /path/to/download/file.name\n<a href=\"#Click\" class=\"name\">Click</a>                  id=file_download\n${file_obj}=           <a href=\"#Wait%20For\" class=\"name\">Wait For</a>    ${dl_promise}\nFile Should Exist      ${file_obj}[saveAs]\nShould Be True         ${file_obj.suggestedFilename}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4314\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise that waits for next download event on page.", "tags": ["BrowserControl", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 140}, {"name": "Record Selector", "args": [{"name": "label", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label: str | None = None"}], "returnType": null, "doc": "<p>Record the selector that is under mouse.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>label</code></td>\n<td>text to show when on the box in the page while recording.</td>\n</tr>\n</table>\n<p>Focus on the page and move mouse over the element you want to select.</p>\n<p>Example:</p>\n<pre>\n${selector} =    <a href=\"#Record%20Selector\" class=\"name\">Record Selector</a>   Button\n<a href=\"#Click\" class=\"name\">Click</a>  ${selector}\n${selector2} =    <a href=\"#Record%20Selector\" class=\"name\">Record Selector</a>  Page header\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>  ${selector2}  ==  Expected text\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4315\">Comment &gt;&gt;</a></p>", "shortdoc": "Record the selector that is under mouse.", "tags": ["PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 450}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}, {"name": "args", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args: str"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Global", "kind": "NAMED_ONLY", "required": false, "repr": "scope: Scope = Global"}], "returnType": {"name": "DelayedKeyword", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Sets the keyword to execute, when a Browser keyword fails.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>keyword</code></td>\n<td>The name of a keyword that will be executed if a Browser keyword fails. It is possible to use any available keyword, including user keywords or keywords from other libraries.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>The arguments to the keyword if any.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of this setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <span class=\"name\">Scope Settings</span> for more details.</td>\n</tr>\n</table>\n<p>The initial keyword to use is set when <a href=\"#Importing\" class=\"name\">importing</a> the library, and the keyword that is used by default is <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.</p>\n<p>It is possible to use string <code>NONE</code> or any other robot falsy name, case-insensitively, as well as Python <code>None</code> to disable this feature altogether.</p>\n<p>This keyword returns an object which contains the the previously registered failure keyword. The return value can be always used to restore the original value later. The returned object contains keyword name and the possible arguments used to for the keyword.</p>\n<p>If <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> keyword, without arguments, is register as run on failure keyword, then filename argument default value is not used as screenshot file name. Instead, ${TEST NAME}_FAILURE_SCREENSHOT_{index} is used as file name. If there is need to use the filename argument default value, use robotframework-browser-screenshot-{index} as filename argument value.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    # Uses ${TEST NAME}_FAILURE_SCREENSHOT_{index} as filename\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    robotframework-browser-screenshot-{index}    # Uses robotframework-browser-screenshot-{index} as filename\n${previous kw}=    <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    NONE    # Disables run on failure functionality.\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    ${previous kw}\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    fullPage=True\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    failure-{index}    fullPage=True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4316\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the keyword to execute, when a Browser keyword fails.", "tags": ["Config"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/runonfailure.py", "lineno": 31}, {"name": "Reload", "args": [], "returnType": null, "doc": "<p>Reloads current active page.</p>\n<p><a href=\"https://forum.robotframework.org/t//4317\">Comment &gt;&gt;</a></p>", "shortdoc": "Reloads current active page.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 513}, {"name": "Save Storage State", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Saves the current active context storage state to a file.</p>\n<p>Web apps use cookie-based or token-based authentication, where authenticated state is stored as <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies\">cookies</a> or in <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Storage\">local storage</a>. Keyword retrieves the storage state from authenticated contexts and save it to disk. Then <a href=\"#New%20Context\" class=\"name\">New Context</a> can be created with prepopulated state.</p>\n<p>Please note state file may contains secrets and should not be shared with people outside of your organisation.</p>\n<p>The file is created in ${OUTPUTDIR}/browser/state folder and file(s) are automatically deleted when new test execution starts. File path is returned by the keyword.</p>\n<p>Example:</p>\n<pre>\nTest Case\n    <a href=\"#New%20Context\" class=\"name\">New context</a>\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"https://login.page.html\">https://login.page.html</a>\n    #  Perform login\n    <a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    id=username    $username\n    <a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    id=password    $password\n    <a href=\"#Click\" class=\"name\">Click</a>    id=button\n    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=header    ==    Something\n    #  Save storage to disk\n    ${state_file} =    <a href=\"#Save%20Storage%20State\" class=\"name\">Save Storage State</a>\n    #  Create new context with saved state\n    <a href=\"#New%20Context\" class=\"name\">New context</a>    storageState=${state_file}\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"https://login.page.html\">https://login.page.html</a>\n    #  Login is not needed because authentication is read from state file\n    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=header    ==    Something\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4318\">Comment &gt;&gt;</a></p>", "shortdoc": "Saves the current active context storage state to a file.", "tags": ["BrowserControl", "Getter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1493}, {"name": "Scroll By", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "vertical", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "height", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = height"}, {"name": "horizontal", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = 0"}, {"name": "behavior", "type": {"name": "ScrollBehavior", "typedoc": "ScrollBehavior", "nested": [], "union": false}, "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "returnType": null, "doc": "<p>Scrolls an element or the page relative from current position by the given values.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. If the selector is <code>${None}</code> or <code>${Empty}</code> the page itself is scrolled. To ensure an element is in view use <a href=\"#Hover\" class=\"name\">Hover</a> instead. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>vertical</code></td>\n<td>defines how far and in which direction to scroll vertically. It can be a positive or negative number. Positive scrolls down, like <code>50</code>, negative scrolls up, like <code>-50</code>. It can be a percentage value of the absolute scrollable size, like <code>9.95%</code> or negative like <code>-10%</code>. It can be the string <code>height</code> to defining to scroll exactly one visible height down or up with <code>-height</code>. <i>Be aware that some pages do lazy loading and load more content once you scroll down.</i> The percentage of the current scrollable height is used and may change.</td>\n</tr>\n<tr>\n<td><code>horizontal</code></td>\n<td>defines where to scroll horizontally. Works same as vertical but defines positive values for right and negative values for left. <code>width</code> defines to scroll exactly one visible range to the right.</td>\n</tr>\n<tr>\n<td><code>behavior</code></td>\n<td>defines whether the scroll happens directly or it scrolls smoothly.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4319\">Comment &gt;&gt;</a></p>", "shortdoc": "Scrolls an element or the page relative from current position by the given values.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 589}, {"name": "Scroll To", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "vertical", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "top", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = top"}, {"name": "horizontal", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = left"}, {"name": "behavior", "type": {"name": "ScrollBehavior", "typedoc": "ScrollBehavior", "nested": [], "union": false}, "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "returnType": null, "doc": "<p>Scrolls an element or the page to an absolute position based on given coordinates.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. If the selector is <code>${None}</code> or <code>${Empty}</code> the page itself is scrolled. To ensure an element is in view use <a href=\"#Hover\" class=\"name\">Hover</a> instead. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>vertical</code></td>\n<td>defines where to scroll vertically. It can be a positive number, like <code>300</code>. It can be a percentage value of the absolute scrollable size, like <code>50%</code>. It can be a string defining that top or the bottom of the scroll area. &lt; <code>top</code></td>\n<td><code>bottom</code> &gt; <i>Be aware that some pages do lazy loading and load more content once you scroll down.</i> Bottom defines the current known bottom coordinate.</td>\n</tr>\n<tr>\n<td><code>horizontal</code></td>\n<td>defines where to scroll horizontally. Works same as vertical but defines &lt; <code>left</code></td>\n<td><code>right</code> &gt; as start and end.</td>\n</tr>\n<tr>\n<td><code>behavior</code></td>\n<td>defines whether the scroll happens directly or it scrolls smoothly.</td>\n<td></td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4320\">Comment &gt;&gt;</a></p>", "shortdoc": "Scrolls an element or the page to an absolute position based on given coordinates.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 552}, {"name": "Scroll To Element", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is already visible.</p>\n<p><a href=\"https://forum.robotframework.org/t//4321\">Comment &gt;&gt;</a></p>", "shortdoc": "This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 626}, {"name": "Select Options By", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "type": {"name": "SelectAttribute", "typedoc": "SelectAttribute", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: SelectAttribute"}, {"name": "values", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "doc": "<p>Selects options from select element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the <code>&lt;select&gt;</code> tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>attribute</code></td>\n<td>Attribute to select options by. Can be <code>value</code>, <code>label</code>, <code>text</code> or <code>index</code>. Where <code>label</code> and <code>text</code> are same.</td>\n</tr>\n<tr>\n<td><code>*values</code></td>\n<td>Values to select.</td>\n</tr>\n</table>\n<p>Returns list of options which keyword was able to select. The type of list item matches to <code>attribute</code> definition. Example if <code>attribute</code> equals to <span class=\"name\">label</span> returned list contains label values. Or in case of <span class=\"name\">index</span> it contains list of selected indexes.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>If no values to select are passed will deselect options in element.</p>\n<p>Example:</p>\n<pre>\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=preferred_channel]    label    Direct mail\nList Should Contain Value    ${selected}    Direct mail\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=interests]    value    males    females    others\nList Should Contain Value    ${selected}    males\nList Should Contain Value    ${selected}    females\nList Should Contain Value    ${selected}    others\nLength Should Be    ${selected}    3\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=possible_channels]    index    0    2\nList Should Contain Value    ${selected}    0\nList Should Contain Value    ${selected}    2\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=interests]    text     Males    Females\nList Should Contain Value    ${selected}    Males\nList Should Contain Value    ${selected}    Females\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4322\">Comment &gt;&gt;</a></p>", "shortdoc": "Selects options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 693}, {"name": "SessionStorage Clear", "args": [{"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove all saved data from the session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    mykey3    myvalue3\n <a href=\"#SessionStorage%20Clear\" class=\"name\">SessionStorage Clear</a>\n<a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>    mykey3    ==    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4323\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove all saved data from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 229}, {"name": "SessionStorage Get Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Get saved data from from session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Named key of the item in the storage.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>Assertion operator to use. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value to compare with.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Custom error message to use.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    key2    value2\n${item} =    <a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>    key1\nShould Be Equal    ${item}    value2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4324\">Comment &gt;&gt;</a></p>", "shortdoc": "Get saved data from from session storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 146}, {"name": "SessionStorage Remove Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove saved data with key from the session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the item which shall be deleted.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>       mykey2    myvalue2\n<a href=\"#SessionStorage%20Remove%20Item\" class=\"name\">SessionStorage Remove Item</a>    mykey2\n<a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>       mykey2    ==    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4325\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove saved data with key from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 206}, {"name": "SessionStorage Set Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Save data to session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the key under which it should be saved.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>The value which shall be saved as a string.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    key2    value2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4326\">Comment &gt;&gt;</a></p>", "shortdoc": "Save data to session storage.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 185}, {"name": "Set Assertion Formatters", "args": [{"name": "formatters", "type": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "FormatterKeywords", "typedoc": "FormatterKeywords", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "FormatingRules", "typedoc": "FormatingRules", "nested": [], "union": false}, {"name": "LambdaFunction", "typedoc": "LambdaFunction", "nested": [], "union": false}], "union": true}], "union": false}], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "formatters: Dict[FormatterKeywords, List[FormatingRules | LambdaFunction]]"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": false}, "doc": "<p>Set keywords formatters for assertions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>formatters</code></td>\n<td>Dictionary of keywords and formatters, where key is the keyword name where formatters are applied. Dictionary value is a list of formatter which are applied. Formatters for a defined keyword are always overwritten. An empty list will clear all formatters for the keyword. If <code>formatters</code> is empty dictionary, then all formatters are cleared from all keywords.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Defines the lifetime of the formatter, possible values are Global, Suite and Test.</td>\n</tr>\n</table>\n<p>See type documentation of <span class=\"name\">FormatterTypes</span> for more information.</p>\n<p>It is possible to define own formatters as lambda functions.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Set%20Assertion%20Formatters\" class=\"name\">Set Assertion Formatters</a>    {\"Get Text\": [\"strip\", \"normalize spaces\"]}  # This will convert all kind of spaces to single space and removes spaces from start and end of the string.\n<a href=\"#Set%20Assertion%20Formatters\" class=\"name\">Set Assertion Formatters</a>    {\"Get Title\": [\"apply to expected\",\"lambda x: x.replace(' ', '')\"]}  # This will remove all spaces from the string.\n${value} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    //div    ==    ${SPACE}Expected${SPACE * 2}Text\nShould Be Equal    ${value}    Expected Text\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4327\">Comment &gt;&gt;</a></p>", "shortdoc": "Set keywords formatters for assertions.", "tags": ["Config"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/formatter.py", "lineno": 98}, {"name": "Set Browser Timeout", "args": [{"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the timeout used by most input and getter keywords.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout of it is for current playwright context and for new contexts. Supports Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">time format</a> . Returns the previous value of the timeout.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <span class=\"name\">Scope Settings</span> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${old_timeout} =    <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    1m 30 seconds\nClick     //button\n<a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    ${old_timeout}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4328\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the timeout used by most input and getter keywords.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 316}, {"name": "Set Default Run Before Unload", "args": [{"name": "runBeforeUnload", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "runBeforeUnload: bool"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Set default runBeforeUnload value when <a href=\"#Close%20Page\" class=\"name\">Close Page</a> is called indirectly.</p>\n<p>Close Page is called indirectly when <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html#Automatic%20page%20and%20context%20closing\">automatic page closing</a> is done. The default value is false and this keyword can be used to change value. Returns the old runBeforeUnload value.</p>\n<p><a href=\"https://forum.robotframework.org/t/6203\">Comment &gt;&gt;</a></p>", "shortdoc": "Set default runBeforeUnload value when `Close Page` is called indirectly.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 308}, {"name": "Set Geolocation", "args": [{"name": "latitude", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude: float"}, {"name": "longitude", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude: float"}, {"name": "accuracy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "accuracy: float | None = None"}], "returnType": null, "doc": "<p>Updated the correct Context's geolocation.</p>\n<p>Latitude can be between -90 and 90 and longitude can be between -180 and 180. Accuracy of the location must be positive number and defaults to 0. When creating context, grant <code>geolocation</code> permission for pages to read its geolocation.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>latitude</code></td>\n<td>Latitude between -90 and 90.</td>\n</tr>\n<tr>\n<td><code>longitude</code></td>\n<td>Longitude between -180 and 180.</td>\n</tr>\n<tr>\n<td><code>accuracy</code></td>\n<td>Non-negative accuracy value. Defaults to 0.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${permissions} =    Create List    geolocation\n<a href=\"#New%20Context\" class=\"name\">New Context</a>    permissions=${permissions}\n<a href=\"#Set%20Geolocation\" class=\"name\">Set Geolocation</a>    60.173708, 24.982263    3    # Points to Korkeasaari in Helsinki.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4329\">Comment &gt;&gt;</a></p>", "shortdoc": "Updated the correct Context's geolocation.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 482}, {"name": "Set Offline", "args": [{"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "offline: bool = True"}], "returnType": null, "doc": "<p>Toggles current Context's offline emulation.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>offline</code></td>\n<td>Toggles the offline mode. Set to False to switch back to online mode. Defaults to True.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4330\">Comment &gt;&gt;</a></p>", "shortdoc": "Toggles current Context's offline emulation.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 469}, {"name": "Set Retry Assertions For", "args": [{"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the timeout used in retrying assertions when they fail.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Assertion retry timeout will determine how long Browser library will retry an assertion to be true.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>The other keyword <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser timeout</a> controls how long Playwright will perform waiting in the node side for Elements to fulfill the requirements of the specific keyword.</p>\n<p>Returns the previous value of the assertion retry timeout.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    10 seconds\n${old} =    <a href=\"#Set%20Retry%20Assertions%20For\" class=\"name\">Set Retry Assertions For</a>    30s\n<a href=\"#Get%20Title\" class=\"name\">Get Title</a>    ==    Login Page\n<a href=\"#Set%20Retry%20Assertions%20For\" class=\"name\">Set Retry Assertions For</a>    ${old}\n</pre>\n<p>Example waits 10 seconds on Playwright to get the page title and library will retry 30 seconds to make sure that title is correct.</p>\n<p><a href=\"https://forum.robotframework.org/t//4331\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the timeout used in retrying assertions when they fail.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 348}, {"name": "Set Selector Prefix", "args": [{"name": "prefix", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "prefix: str | None"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the prefix for all selectors in the given scope.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>prefix</code></td>\n<td>Prefix for all selectors. Prefix and selector will be separated by a single space. Use <code>${None}</code> or <code>${EMPTY}</code> to disable the prefix.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Returns the previous value of the prefix.</p>\n<p>Example:</p>\n<pre>\n${old} =    <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>    iframe#embedded_page &gt;&gt;&gt;\n<a href=\"#Click\" class=\"name\">Click</a>    button#login_btn       # Clicks on button inside iframe with the selector <code>iframe#embedded_page &gt;&gt;&gt; button#login_btn</code>\n<a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>    ${old}\n</pre>\n<p>Example will click on button with id <code>login_btn</code> inside iframe with id <code>embedded_page</code>. The resulting selector will be <code>iframe#embedded_page &gt;&gt;&gt; button#login_btn</code>.</p>\n<p>The effect of this prefix can be disable by prefixing any selector with <code>!prefix </code>, with a trailing space, for single keyword calls. i.e. <code>!prefix id=btn_outside_a_frame</code></p>\n<p><a href=\"#Get%20Element\" class=\"name\">Get Element</a>, <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a>, <a href=\"#Get%20Element%20By\" class=\"name\">Get Element By</a> and <a href=\"#Get%20Element%20By%20Role\" class=\"name\">Get Element By Role</a> do automatically prefix the returned selector with <code>!prefix </code> so that it is possible to use them directly without setting the prefix to <code>${None}</code> before usage.</p>\n<p><a href=\"https://forum.robotframework.org/t//4741\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the prefix for all selectors in the given scope.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 379}, {"name": "Set Strict Mode", "args": [{"name": "mode", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "mode: bool"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": null, "doc": "<p>Controls library strict mode.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>mode</code></td>\n<td>When set to <code>True</code>, keywords that are searching elements will use Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-query-selector\">strict mode</a>. Keyword changes library strict mode value and keyword also return the previous strict mode value.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${old_mode} =      Set Strict Mode    False\nGet Text           //input            # Does not fail if selector points to one or more elements\nSet Strict Mode    ${old_mode}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4332\">Comment &gt;&gt;</a></p>", "shortdoc": "Controls library strict mode.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/strict_mode.py", "lineno": 20}, {"name": "Set Viewport Size", "args": [{"name": "width", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}], "returnType": null, "doc": "<p>Sets current Pages viewport size to specified dimensions.</p>\n<p>In the case of multiple pages in a single browser, each page can have its own viewport size. However, <a href=\"#New%20Context\" class=\"name\">New Context</a> allows to set viewport size (and more) for all later opened pages in the context at once.</p>\n<p><a href=\"#Set%20Viewport%20Size\" class=\"name\">Set Viewport Size</a> will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport size before navigating to the page with <a href=\"#New%20Context\" class=\"name\">New Context</a> before opening the page itself.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>Sets the width size.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>Sets the height size.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4333\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets current Pages viewport size to specified dimensions.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 443}, {"name": "Show Keyword Banner", "args": [{"name": "show", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "show: bool = True"}, {"name": "style", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = "}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}], "union": false}, "doc": "<p>Controls if the keyword banner is shown on page or not.</p>\n<p>Keyword call banner is a css overlay that shows the currently executed keyword directly on page. This is useful for debugging and for showing the test execution on video recordings. By default, the banner is not shown on page except when running in presenter mode.</p>\n<p>The banner can be controlled by an import setting of Browser library. (see <a href=\"#Importing\" class=\"name\">Importing</a> section)</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>show</code></td>\n<td>If <span class=\"name\">True</span> banner is shown on page. If <span class=\"name\">False</span> banner is not shown on page. If <a href=\"#type-None\" class=\"name\">None</a> banner is shown on page only when running in presenter mode.</td>\n</tr>\n<tr>\n<td><code>style</code></td>\n<td>Additional css styles to be applied to the banner. These styles are css settings and may override the existing ones for the banner.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nShow Keyword Banner     True    top: 5px; bottom: auto; left: 5px; background-color: #00909077; font-size: 9px; color: black;   # Show banner on top left corner with custom styles\nShow Keyword Banner     False   # Hide banner\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4716\">Comment &gt;&gt;</a></p>", "shortdoc": "Controls if the keyword banner is shown on page or not.", "tags": ["Config", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 412}, {"name": "Switch Browser", "args": [{"name": "id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the currently active Browser to another open Browser.</p>\n<p>Returns a stable identifier for the previous browser. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>id</td>\n<td>The id of the browser to switch to. Example: <code>browser=96207191-8147-44e7-b9ac-5e04f2709c1d</code>. A browser id is returned by <a href=\"#New%20Browser\" class=\"name\">New Browser</a> when it is started or can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4334\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the currently active Browser to another open Browser.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1181}, {"name": "Switch Context", "args": [{"name": "id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the active BrowserContext to another open context.</p>\n<p>Returns a stable identifier for the previous context. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The id of the context to switch to. Example: <code>context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089</code>. A context id is returned by <a href=\"#New%20Context\" class=\"name\">New Context</a> when it is started or can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser in which to search for that context. <code>CURRENT</code> for the currently active browser, <code>ALL</code> to search in all open browsers or the id of the browser where to switch context.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${first_context} =     <a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#New%20Page\" class=\"name\">New Page</a>             ${URL1}\n${second_context} =    <a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#New%20Page\" class=\"name\">New Page</a>             ${URL2}\n<a href=\"#Switch%20Context\" class=\"name\">Switch Context</a>       ${first_context}    # Switches back to first context and page.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4335\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the active BrowserContext to another open context.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1199}, {"name": "Switch Page", "args": [{"name": "id", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "NewPageDetails", "typedoc": "NewPageDetails", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: NewPageDetails | str"}, {"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the active browser page to another open page by <code>id</code> or <code>NEW</code>.</p>\n<p>Returns a stable identifier <code>id</code> for the previous page. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The id or alias of the page to switch to. Example: <code>page=8baf2991-5eaf-444d-a318-8045f914e96a</code> or <code>NEW</code>. Can be a string or a dictionary returned by <a href=\"#New%20Page\" class=\"name\">New Page</a> Keyword. A page id can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>. <code>NEW</code> can be used to switch to a pop-up that just has been opened by the webpage, <code>CURRENT</code> can be used to switch to the active page of a different context or browser, identified by their id.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context in which to search for that page. <code>CURRENT</code> for the currently active context, <code>ALL</code> to search in all open contexts or the id of the context where to switch page.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser in which to search for that page. <code>CURRENT</code> for the currently active browser, <code>ALL</code> to search in all open browsers or the id of the browser where to switch page.</td>\n</tr>\n</table>\n<p><code>New</code> may timeout if no new pages exists before library timeout.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>           button#pops_up    # Open new page\n${previous} =    <a href=\"#Switch%20Page\" class=\"name\">Switch Page</a>      NEW\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4336\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the active browser page to another open page by ``id`` or ``NEW``.", "tags": ["BrowserControl", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 1255}, {"name": "Take Screenshot", "args": [{"name": "filename", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "robotframework-browser-screenshot-{index}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str | None = robotframework-browser-screenshot-{index}"}, {"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "crop", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "BoundingBox", "typedoc": "BoundingBox", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "crop: BoundingBox | None = None"}, {"name": "disableAnimations", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "disableAnimations: bool = False"}, {"name": "fileType", "type": {"name": "ScreenshotFileTypes", "typedoc": "ScreenshotFileTypes", "nested": [], "union": false}, "defaultValue": "png", "kind": "NAMED_ONLY", "required": false, "repr": "fileType: ScreenshotFileTypes = png"}, {"name": "fullPage", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "fullPage: bool = False"}, {"name": "log_screenshot", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "log_screenshot: bool = True"}, {"name": "mask", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "NAMED_ONLY", "required": false, "repr": "mask: List[str] | str = "}, {"name": "maskColor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "maskColor: str | None = None"}, {"name": "omitBackground", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "omitBackground: bool = False"}, {"name": "quality", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "quality: int | None = None"}, {"name": "scale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Scale", "typedoc": "Scale", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "scale: Scale | None = None"}, {"name": "return_as", "type": {"name": "ScreenshotReturnType", "typedoc": "ScreenshotReturnType", "nested": [], "union": false}, "defaultValue": "path_string", "kind": "NAMED_ONLY", "required": false, "repr": "return_as: ScreenshotReturnType = path_string"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bytes", "typedoc": "bytes", "nested": [], "union": false}, {"name": "Path", "typedoc": "Path", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Takes a screenshot of the current window or element and saves it to disk.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>filename</code></td>\n<td>Filename into which to save. The file will be saved into the robot framework  ${OUTPUTDIR}/browser/screenshot directory by default, but it can be overwritten by providing custom path or filename. String <code>{index}</code> in filename will be replaced with a rolling  number. Use this to not override filenames. If filename equals to EMBED (case insensitive) or ${NONE},  then screenshot is embedded as Base64 image to the log.html. The image is saved temporally  to the disk and warning is displayed if removing the temporary file fails. The ${OUTPUTDIR}/browser/ is removed at the first suite startup.</td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Take a screenshot of the element matched by selector. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors. If not provided take a screenshot of current viewport.</td>\n</tr>\n<tr>\n<td><code>crop</code></td>\n<td>Crops the taken screenshot to the given box. It takes same dictionary as returned from <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>. Cropping only works on page screenshot, so if no selector is given.</td>\n</tr>\n<tr>\n<td><code>disableAnimations</code></td>\n<td>When set to <code>True</code>, stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:  - finite animations are fast-forwarded to completion, so they'll fire transitionend event.  - infinite animations are canceled to initial state, and then played over after the screenshot.</td>\n</tr>\n<tr>\n<td><code>fileType</code></td>\n<td><code>png</code> or <code>jpeg</code> Specify screenshot type, defaults to <code>png</code> .</td>\n</tr>\n<tr>\n<td><code>fullPage</code></td>\n<td>When True, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>log_screenshot</code></td>\n<td>When set to <code>False</code> the screenshot is taken but not logged into log.html.</td>\n</tr>\n<tr>\n<td><code>mask</code></td>\n<td>Specify selectors that should be masked when the screenshot is taken. Masked elements will be overlayed with a pink box <code>#FF00FF</code> that completely covers its bounding box. Argument can take a single selector string or a list of selector strings if multiple different elements should be masked.</td>\n</tr>\n<tr>\n<td><code>maskColor</code></td>\n<td>Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink #FF00FF.</td>\n</tr>\n<tr>\n<td><code>omitBackground</code></td>\n<td>Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images.</td>\n</tr>\n<tr>\n<td><code>quality</code></td>\n<td>The quality of the image, between 0-100. Not applicable to png images.</td>\n</tr>\n<tr>\n<td><code>scale</code></td>\n<td><code>css</code> or <code>device</code>. <code>css</code> will reduce the image size and <code>device</code> keeps image in original size. Defaults to <code>device</code>.</td>\n</tr>\n<tr>\n<td><code>return_as</code></td>\n<td>Defines what this keyword returns. Possible values are documented in <a href=\"#type-ScreenshotReturnType\" class=\"name\">ScreenshotReturnType</a>. It can be either a path to the screenshot file as string or Path object, or the image data as bytes or base64 encoded string.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Maximum time how long taking screenshot can last, defaults to library timeout. Supports Robot Framework time format, like 10s or 1 min, pass 0 to disable timeout. The default value can be changed by using the <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a> keyword.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode if selector is defined. See <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>                                 # Takes screenshot from page with default filename\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   selector=id=username_field    # Captures element in image\n# Takes screenshot with jpeg extension, defines image quality and timeout how long taking screenhost should last\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   fullPage=True    fileType=jpeg    quality=50    timeout=10s\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   EMBED                         # Screenshot is embedded as Base64 image to the log.html.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4337\">Comment &gt;&gt;</a></p>", "shortdoc": "Takes a screenshot of the current window or element and saves it to disk.", "tags": ["PageContent"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 123}, {"name": "Tap", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_x: int | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_y: int | None = None"}, {"name": "trial", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "trial: bool = False"}], "returnType": null, "doc": "<p>Simulates tap on the element found by <code>selector</code>.</p>\n<p>Requires that the <code>hasTouch</code> option of the <a href=\"#New%20Context\" class=\"name\">New Context</a> be set to true. This method taps the element by performing the following steps:</p>\n<ul>\n<li>Wait for actionability checks on the element, unless force option is set.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use page.touchscreen to tap the center of the element, or the specified position.</li>\n<li>Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used. Modifiers can be specified in any order, and multiple modifiers can be specified. Valid modifier keys are <code>Control</code>, <code>Alt</code>, <code>Shift</code> and <code>Meta</code>.</td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Whether to bypass the actionability checks. Defaults to false.</td>\n</tr>\n<tr>\n<td><code>noWaitAfter</code></td>\n<td>Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to <code>False</code>.</td>\n</tr>\n<tr>\n<td><code>position_x</code> <code>position_y</code></td>\n<td>A point to click relative to the top-left corner of element bounding-box. Only positive values within the bounding-box are allowed. If not specified, clicks to some visible point of the element.</td>\n</tr>\n<tr>\n<td><code>trial</code></td>\n<td>When set, this method only performs the actionability checks and skips the action. Defaults to <code>False</code>.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nNew Context    hasTouch=${False}\nNew Page    ${URL}\nTap    css=input#login_button\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5939\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates tap on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 394}, {"name": "Type Secret", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "delay", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given secret from <code>variable_name</code> into the text field found by <code>selector</code>.</p>\n<p>This keyword does not log secret in Robot Framework logs, if keyword resolves the variable value internally. If <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>secret</code></td>\n<td>Environment variable name with % prefix or a local variable with $ prefix that has the secret text value. Variable names can be used with and without curly braces.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay between the single key strokes. It may be either a number or a Robot Framework time string. Time strings are fully explained in an appendix of Robot Framework User Guide. Defaults to <code>0 ms</code>. Example: <code>50 ms</code></td>\n</tr>\n<tr>\n<td><code>clear</code></td>\n<td>Set to false, if the field shall not be cleared before typing. Defaults to true.</td>\n</tr>\n</table>\n<p>This keyword does not log secret in Robot Framework logs, when keyword resolves the <code>secret</code> variable internally. When <code>secret</code> variable is prefixed with <span class=\"name\">$</span>, without the curly braces, library will resolve the corresponding Robot Framework variable.</p>\n<p>If <code>secret</code> variable is prefixed with <span class=\"name\">%</span>, library will resolve corresponding environment variable. Example <span class=\"name\">$Password</span>` will resolve to <code>${Password}</code> Robot Framework variable. Also <code>%ENV_PWD</code> will resolve to <code>%{ENV_PWD}</code> environment variable.</p>\n<p><b>Using normal Robot Framework variables like <code>${password}</code> will not work!</b></p>\n<p><b>Normal plain text will not work.</b> If you want to use plain text, use <a href=\"#Type%20Text\" class=\"name\">Type Text</a> keyword instead.</p>\n<p>This keyword will also work with a give cryptographic cipher text, that has been encrypted by Crypto library. See <a href=\"https://github.com/Snooz82/robotframework-crypto\">Crypto Library</a> for more details.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for details.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    $username      # Keyword resolves ${username} variable value from Robot Framework variables\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    %username      # Keyword resolves $USERNAME/%USERNAME% variable value from environment variables\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    ${username}    # Robot Framework resolves the variable value, but secrect can leak to Robot framework output files.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4338\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 133}, {"name": "Type Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "delay", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given <code>txt</code> into the text field found by <code>selector</code>.</p>\n<p>Sends a <code>keydown</code>, <code>keypress/input</code>, and <code>keyup</code> event for each character in the text.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>txt</code></td>\n<td>Text for the text field.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay between the single key strokes. It may be either a number or a Robot Framework time string. Time strings are fully explained in an appendix of Robot Framework User Guide. Defaults to <code>0 ms</code>. Example: <code>50 ms</code></td>\n</tr>\n<tr>\n<td><code>clear</code></td>\n<td>Set to false, if the field shall not be cleared before typing. Defaults to true.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for direct filling of the full text at once.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Type%20Text\" class=\"name\">Type Text</a>    input#username_field    user\n<a href=\"#Type%20Text\" class=\"name\">Type Text</a>    input#username_field    user    delay=10 ms    clear=No\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4339\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 47}, {"name": "Uncheck Checkbox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Unchecks the checkbox found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is not checked/selected.</p>\n<p><a href=\"https://forum.robotframework.org/t//4340\">Comment &gt;&gt;</a></p>", "shortdoc": "Unchecks the checkbox found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 670}, {"name": "Upload File By Selector", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "path", "type": {"name": "PathLike", "typedoc": "Path", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "returnType": null, "doc": "<p>Uploads file from <a href=\"#type-Path\" class=\"name\">path</a> to file input element matched by selector.</p>\n<p>Fails if upload is not done before library timeout. Therefor it may be necessary to increase the timeout with <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Identifies the file input element.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Path to the file to be uploaded.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Upload%20File%20By%20Selector\" class=\"name\">Upload File By Selector</a>    //input[@type='file']    big_file.zip\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4341\">Comment &gt;&gt;</a></p>", "shortdoc": "Uploads file from `path` to file input element matched by selector.", "tags": ["PageContent", "Setter"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 1259}, {"name": "Wait For", "args": [{"name": "promises", "type": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*promises: Future"}], "returnType": null, "doc": "<p>Waits for promises to finish and returns results from them.</p>\n<p>Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.</p>\n<p>See <a href=\"#Promise%20To\" class=\"name\">Promise To</a> for more information about promises.</p>\n<p>For general waiting of elements please see <a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>promises</code></td>\n<td>Promises to wait for.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${promise}=    <a href=\"#Promise%20To\" class=\"name\">Promise To</a>            <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>         \\#delayed_request\n${body}=       <a href=\"#Wait%20For\" class=\"name\">Wait For</a>              ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4342\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for promises to finish and returns results from them.", "tags": ["Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 227}, {"name": "Wait For Alert", "args": [{"name": "action", "type": {"name": "DialogAction", "typedoc": "DialogAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}, {"name": "text", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Returns a promise to wait for next dialog on page, handles it with <code>action</code> and optionally verifies the dialogs text.</p>\n<p>Dialog/alert can be any of alert, beforeunload, confirm or prompt.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>How to handle the alert. Can be <code>accept</code> or <code>dismiss</code>.</td>\n</tr>\n<tr>\n<td><code>prompt_input</code></td>\n<td>The value to enter into prompt. Only valid if <code>action</code> argument equals <code>accept</code>. Defaults to empty string.</td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Optional text to verify the dialogs text.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Optional timeout in Robot Framework time format.</td>\n</tr>\n</table>\n<p>The main difference between this keyword and <a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a> is that <a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a> keyword is automatically set as promise. But this keyword must be called as argument to <a href=\"#Promise%20To\" class=\"name\">Promise To</a> keyword. Also this keyword can optionally verify the dialogue text and return it. If <code>text</code> is argument <code>None</code> or is not set, dialogue text is not verified.</p>\n<p>Example with returning text:</p>\n<pre>\n${promise} =         <a href=\"#Promise%20To\" class=\"name\">Promise To</a>    <a href=\"#Wait%20For%20Alert\" class=\"name\">Wait For Alert</a>    action=accept\n<a href=\"#Click\" class=\"name\">Click</a>              id=alerts\n${text} =            <a href=\"#Wait%20For\" class=\"name\">Wait For</a>      ${promise}\nShould Be Equal      ${text}         Am an alert\n</pre>\n<p>Example with text verify:</p>\n<pre>\n${promise} =       Promise To    Wait For Alert    action=accept    text=Am an alert\nClick              id=alerts\n${text} =          Wait For      ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4343\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise to wait for next dialog on page, handles it with ``action`` and optionally verifies the dialogs text.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/interaction.py", "lineno": 856}, {"name": "Wait For All Promises", "args": [], "returnType": null, "doc": "<p>Waits for all promises to finish.</p>\n<p>If one promises fails, then this keyword will fail.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Promise%20To\" class=\"name\">Promise To</a>               Wait For Response     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>                    \\#delayed_request\n<a href=\"#Wait%20For%20All%20Promises\" class=\"name\">Wait For All Promises</a>\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4344\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for all promises to finish.", "tags": ["Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/promises.py", "lineno": 253}, {"name": "Wait For Condition", "args": [{"name": "condition", "type": {"name": "ConditionInputs", "typedoc": "ConditionInputs", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "condition: ConditionInputs"}, {"name": "args", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args: Any"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Waits for a condition, defined with Browser getter keywords to become True.</p>\n<p>This Keyword is basically just a wrapper around our assertion keywords, but with a timeout. It can be used to wait for anything that also can be asserted with our keywords.</p>\n<p>In comparison to Robot Frameworks <span class=\"name\">Wait Until Keywords Succeeds</span> this keyword is more readable and easier to use but is limited to Browser libraries assertion keywords.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>condition</code></td>\n<td>A condition, defined with Browser getter keywords, without the word <code>Get</code>.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>Arguments to pass to the condition keyword.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timout to wait for the condition to become True. Uses default timeout of the library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Overrides the default error message.</td>\n</tr>\n</table>\n<p>The easiest way to use this keyword is first starting with an assertion keyword with assertion like: <a href=\"#Get%20Text\" class=\"name\">Get Text</a></p>\n<p>Start:</p>\n<pre>\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=status_bar   contains    Done\n</pre>\n<p>Then you replace the word <span class=\"name\">Get</span> with <a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition    </a> and if necessary add the timeout argument.</p>\n<p>End:</p>\n<pre>\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Text    id=status_bar   contains    Done\n</pre>\n<p>Example usage:</p>\n<pre>\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Element States    id=cdk-overlay-0    ==    detached\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Element States     //h1    contains    visible    editable    enabled    timeout=2 s\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Title    should start with    Robot\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Url    should end with    robotframework.org\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5269\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for a condition, defined with Browser getter keywords to become True.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 231}, {"name": "Wait For Elements State", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "state", "type": {"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}, "defaultValue": "visible", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: ElementState = visible"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Waits for the element found by <code>selector</code> to satisfy state option.</p>\n<p>Note that Browser library has <a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a> mechanisms. Depending on the situation you might not need to use <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait for Elements State</a>.</p>\n<p>State options could be either appear/disappear from dom, or become visible/hidden. If at the moment of calling the keyword, the selector already satisfies the condition, the keyword will return immediately.</p>\n<p>If the selector doesn't satisfy the condition within the timeout the keyword will FAIL.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>See <a href=\"#type-ElementState\" class=\"name\">ElementState</a> for explanation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>uses default timeout from library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message. The <code>message</code> argument accepts <span class=\"name\">{selector}</span>, <span class=\"name\">{function}</span>, and <span class=\"name\">{timeout}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options. The <span class=\"name\">{function}</span> formatter is same <code>state</code> argument value.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a>    //h1    visible    timeout=2 s\n<a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a>    //hi    focused    1s\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4345\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for the element found by ``selector`` to satisfy state option.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 39}, {"name": "Wait For Function", "args": [{"name": "function", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: str"}, {"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}, {"name": "polling", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "raf", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "polling: str | timedelta = raf"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>function</code></td>\n<td>A valid javascript function or a javascript function body. For example <code>() =&gt; true</code> and <code>true</code> will behave similarly.</td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector to resolve and pass to the JavaScript function. This will be the first argument the function receives. If given a selector a function is necessary, with an argument to capture the elementhandle. For example <code>(element) =&gt; document.activeElement === element</code> See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>polling</code></td>\n<td>Default polling value of \"raf\" polls in a callback for <code>requestAnimationFrame</code>. Any other value for polling will be parsed as a robot framework time for interval between polls.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Uses default timeout of the library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message. The <code>message</code> argument accepts <span class=\"name\">{selector}</span>, <span class=\"name\">{function}</span>, and <span class=\"name\">{timeout}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example usage:</p>\n<pre>\n${promise}      <a href=\"#Promise%20To\" class=\"name\">Promise To</a>      <a href=\"#Wait%20For%20Function\" class=\"name\">Wait For Function</a>    element =&gt; element.style.width==\"100%\"    selector=\\#progress_bar    timeout=4s\n<a href=\"#Click\" class=\"name\">Click</a>         \\#progress_bar\n<a href=\"#Wait%20For\" class=\"name\">Wait For</a>      ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4346\">Comment &gt;&gt;</a></p>", "shortdoc": "Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 155}, {"name": "Wait For Load State", "args": [{"name": "state", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: PageLoadStates = load"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Waits that the page reaches the required load state.</p>\n<p>This resolves when the page reaches a required load state, load by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>State to wait for, defaults to <span class=\"name\">load</span>. Possible values are <span class=\"name\">load|domcontentloaded|networkidle</span></td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses browser timeout if not set.</td>\n</tr>\n</table>\n<p>If the state has been already reached while loading current document, the underlying Playwright will resolve immediately. Can be one of:</p>\n<pre>\n'load' - wait for the load event to be fired.\n'domcontentloaded' - wait for the DOMContentLoaded event to be fired.\n'networkidle' - DISCOURAGED wait until there are no network connections for at least 500 ms.\n</pre>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                         ${URL}\n<a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a>    domcontentloaded    timeout=3s\n</pre>", "shortdoc": "Waits that the page reaches the required load state.", "tags": ["PageContent", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/waiter.py", "lineno": 300}, {"name": "Wait For Navigation", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str | RegExp"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": null, "doc": "<p>Waits until page has navigated to given <code>url</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Expected navigation target address either the exact match or a JavaScript-like regex wrapped in <code>/</code> symbols.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Keyword works only when page is loaded and does not work if URL fragment changes. Example if <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html\">https://marketsquare.github.io/robotframework-browser/Browser.html</a> changes to <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html#Wait%20For%20Navigation\">https://marketsquare.github.io/robotframework-browser/Browser.html#Wait%20For%20Navigation</a> keyword will fail.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                  ${ROOT_URL}/redirector.html\n<a href=\"#Wait%20For%20Navigation\" class=\"name\">Wait for navigation</a>    ${ROOT_URL}/posted.html    wait_until=${wait_until}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4347\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits until page has navigated to given ``url``.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 266}, {"name": "Wait For Request", "args": [{"name": "matcher", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str | RegExp = "}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Waits for request matching matcher to be made.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>matcher</code></td>\n<td>Request URL matcher. Can be a string (Glob-Pattern), JavaScript RegExp (encapsulated in / with following flags) or JavaScript arrow-function that receives the <a href=\"https://playwright.dev/docs/api/class-request\">Request</a> object and returns a boolean. By default (with empty string) matches first available request. For additional information, see the Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-wait-for-request\">waitForRequest</a> documentation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n</table>\n<p>See <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a> for more details.</p>\n<p><b>CAUTION:</b> Before Browser library 17.0.0, the <code>matcher</code> argument was always either a regex or JS function. But the regex did not needed to be in slashes. The most simple way to migrate to the new syntax is to add slashes around the matcher. So <code>/api/get/json</code> becomes <code>//api/get/json/</code>.</p>\n<p><a href=\"https://forum.robotframework.org/t//4348\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for request matching matcher to be made.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 130}, {"name": "Wait For Response", "args": [{"name": "matcher", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str | RegExp = "}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": true}, "doc": "<p>Waits for response matching matcher and returns the response as robot dict.</p>\n<p>The response, which is returned by this keyword, is a robot dictionary with following attributes:</p>\n<ul>\n<li><code>status</code> &lt;int&gt; The status code of the response.</li>\n<li><code>statusText</code> &lt;str&gt; Status text corresponding to <code>status</code>, e.g OK or INTERNAL SERVER ERROR. This may not be available for all browser.</li>\n<li><code>body</code> &lt;dict | str&gt; The response body. If the body can be parsed as a JSON object, it will be returned as Python dictionary, otherwise it is returned as a string.</li>\n<li><code>headers</code> &lt;dict&gt; A dictionary containing all response headers.</li>\n<li><code>ok</code> &lt;bool&gt; Whether the request was successful, i.e. the <code>status</code> is range 200-299.</li>\n<li><code>request</code> &lt;dict&gt; containing <code>method</code> &lt;str&gt;, <code>headers</code> &lt;dict&gt; and <code>postData</code> &lt;dict&gt; | &lt;str&gt;</li>\n<li><code>url</code> &lt;str&gt; url of the request.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>matcher</code></td>\n<td>Request URL matcher. Can be a string (Glob-Pattern), JavaScript RegExp (encapsulated in / with following flags) or JavaScript arrow-function that receives the Response object and returns a boolean. By default (with empty string) matches first available request. For additional information, see the Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-wait-for-response\">page.waitForResponse</a> documentation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n</table>\n<p><b>CAUTION:</b> Before Browser library 17.0.0, the <code>matcher</code> argument was always either a regex or JS function. But the regex did not needed to be in slashes. The most simple way to migrate to the new syntax is to add slashes around the matcher. So <code>/api/get/json</code> becomes <code>//api/get/json/</code>.</p>\n<h3>Matcher Examples:</h3>\n<h4>Glob-Pattern:</h4>\n<p>Glob-Patterns are strings that can contain wildcards. The following wildcards are supported:</p>\n<p>Possible wildcards/patterns are:</p>\n<ul>\n<li><code>*</code> matches any number of characters, except <code>/</code></li>\n<li><code>**</code> matches any number of characters, including <code>/</code></li>\n<li><code>?</code> matches one character, except <code>/</code></li>\n<li><code>[abc]</code> matches one character in the brackets (in this example <code>a</code>, <code>b</code> or <code>c</code>)</li>\n<li><code>[a-z]</code> matches one character in the range (in this example <code>a</code> to <code>z</code>)</li>\n<li><code>{foo,bar,baz}</code> matches one of the strings in the braces (in this example <code>foo</code>, <code>bar</code> or <code>baz</code>)</li>\n</ul>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    **/api/get/text    # matches any request with url ending with /api/get/text. example: <a href=\"https://browser.fi/api/get/text\">https://browser.fi/api/get/text</a>\n</pre>\n<h4>RegExp:</h4>\n<p>Regular Expressions are JavaScript regular expressions encapsulated in <code>/</code> with optional following flags: Be aware that backslashes need to be escaped in Robot Framework, e.g. <code>\\\\w</code> instead of <code>\\w</code>. See <a href=\"https://regex101.com\">regex101</a> for more information on Regular Expressions.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    /http://\\\\w+:\\\\d+/api/get/text/i    # matches any request with url ending with /api/get/text and containing http:// followed by any word and port. example: <a href=\"http://localhost:8080/api/get/text\">http://localhost:8080/api/get/text</a>\n</pre>\n<h4>JavaScript Arrow-Function:</h4>\n<p>JavaScript Arrow-Functions are anonymous JavaScript functions that receive the <a href=\"https://playwright.dev/docs/api/class-response\">Response</a> object and return a boolean.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    response =&gt; response.url() === '<a href=\"http://localhost/api/post\">http://localhost/api/post</a>' &amp;&amp; response.status() === 200    # matches any response with url <a href=\"http://localhost/api/post\">http://localhost/api/post</a> and status code 200\n</pre>\n<h3>Robot Examples:</h3>\n<p>Synchronous Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>                \\#delayed_request    # Creates response which should be waited before next actions\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    matcher=/http://\\\\w+:\\\\d+/api/get/text/i\n<a href=\"#Click\" class=\"name\">Click</a>                \\#save\n</pre>\n<p>Asynchronous Example:</p>\n<pre>\n${promise} =    <a href=\"#Promise%20To\" class=\"name\">Promise To</a>    <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    timeout=60s\n<a href=\"#Click\" class=\"name\">Click</a>           \\#delayed_request    # Creates response which should be waited before pressing save.\n<a href=\"#Click\" class=\"name\">Click</a>           \\#next\n<a href=\"#Wait%20For\" class=\"name\">Wait For</a>        ${promise}            # Waits for the response\n<a href=\"#Click\" class=\"name\">Click</a>           \\#save\n</pre>\n<p>JavaScript Function Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>               \\#delayed_request    # Creates response which should be waited before pressing save.\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>   <a href=\"https://playwright.dev/docs/api/class-response/\">response</a> =&gt; response.url().endsWith('json') &amp;&amp; response.request().method() === 'GET'\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4349\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for response matching matcher and returns the response as robot dict.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 156}, {"name": "Wait Until Network Is Idle", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED!!</b> Use <a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a> instead. rfbrowser transform --wait-until-network-is-idle path/to/test command automatically transforms keyword to new format.</p>\n<p>If you have:</p>\n<pre>\n<a href=\"#Wait%20Until%20Network%20Is%20Idle\" class=\"name\">Wait Until Network Is Idle</a>    timeout=3s\n</pre>\n<p>then chnnage it to:</p>\n<pre>\n<a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a>    networkidle    timeout=3s\n</pre>\n<p>Waits until there has been at least one instance of 500 ms of no network traffic on the page after loading.</p>\n<p>Doesn't wait for network traffic that wasn't initiated within 500ms of page load.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses browser timeout if not set.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                         ${URL}\n<a href=\"#Wait%20Until%20Network%20Is%20Idle\" class=\"name\">Wait Until Network Is Idle</a>    timeout=3s\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4350\">Comment &gt;&gt;</a></p>", "shortdoc": "*DEPRECATED!!* Use `Wait For Load State` instead. rfbrowser transform --wait-until-network-is-idle path/to/test command automatically transforms keyword to new format.", "tags": ["HTTP", "Wait"], "source": "/home/runner/work/robotframework-browser/robotframework-browser/Browser/keywords/network.py", "lineno": 242, "deprecated": true}], "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Evaluate JavaScript", "Get Attribute", "Get BoundingBox", "Get Browser Catalog", "Get Client Size", "Get Console Log", "Get Download State", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Style", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Http", "LocalStorage Get Item", "Select Options By", "SessionStorage Get Item", "Wait For Condition", "Wait For Request", "Wait For Response"], "accepts": ["Any"]}, {"type": "Enum", "name": "AreaFields", "doc": "<p>Enumeration that defines which coordinates of an area should be selected.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "usages": ["Get Scroll Position"], "accepts": ["string"], "members": [{"name": "top", "value": "1"}, {"name": "left", "value": "2"}, {"name": "bottom", "value": "3"}, {"name": "right", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"type": "Enum", "name": "AssertionOperator", "doc": "<p>Currently supported assertion operators are:</p>\n<table border=\"1\">\n<tr>\n<th>Operator</th>\n<th>Alternative Operators</th>\n<th>Description</th>\n<th>Validate Equivalent</th>\n</tr>\n<tr>\n<td><code>==</code></td>\n<td><code>equal</code>, <code>equals</code>, <code>should be</code></td>\n<td>Checks if returned value is equal to expected value.</td>\n<td><code>value == expected</code></td>\n</tr>\n<tr>\n<td><code>!=</code></td>\n<td><code>inequal</code>, <code>should not be</code></td>\n<td>Checks if returned value is not equal to expected value.</td>\n<td><code>value != expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;</code></td>\n<td><code>greater than</code></td>\n<td>Checks if returned value is greater than expected value.</td>\n<td><code>value &gt; expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;=</code></td>\n<td></td>\n<td>Checks if returned value is greater than or equal to expected value.</td>\n<td><code>value &gt;= expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;</code></td>\n<td><code>less than</code></td>\n<td>Checks if returned value is less than expected value.</td>\n<td><code>value &lt; expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;=</code></td>\n<td></td>\n<td>Checks if returned value is less than or equal to expected value.</td>\n<td><code>value &lt;= expected</code></td>\n</tr>\n<tr>\n<td><code>*=</code></td>\n<td><code>contains</code></td>\n<td>Checks if returned value contains expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td></td>\n<td><code>not contains</code></td>\n<td>Checks if returned value does not contain expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td><code>^=</code></td>\n<td><code>should start with</code>, <code>starts</code></td>\n<td>Checks if returned value starts with expected value.</td>\n<td><code>re.search(f\"^{expected}\", value)</code></td>\n</tr>\n<tr>\n<td><code>$=</code></td>\n<td><code>should end with</code>, <code>ends</code></td>\n<td>Checks if returned value ends with expected value.</td>\n<td><code>re.search(f\"{expected}$\", value)</code></td>\n</tr>\n<tr>\n<td><code>matches</code></td>\n<td></td>\n<td>Checks if given RegEx matches minimum once in returned value.</td>\n<td><code>re.search(expected, value)</code></td>\n</tr>\n<tr>\n<td><code>validate</code></td>\n<td></td>\n<td>Checks if given Python expression evaluates to <code>True</code>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>evaluate</code></td>\n<td><code>then</code></td>\n<td>When using this operator, the keyword does return the evaluated Python expression.</td>\n<td></td>\n</tr>\n</table>\n<p>Currently supported formatters for assertions are:</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Substitutes multiple spaces to single space from the value</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from the beginning and end of the value</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts value to lower case before comparing</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies rules also for the expected value</td>\n</tr>\n</table>\n<p>Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If <code>apply to expected</code> formatter is defined, then formatters are then formatter are also applied to expected value.</p>", "usages": ["Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Download State", "Get Element Count", "Get Element States", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "LocalStorage Get Item", "SessionStorage Get Item"], "accepts": ["string"], "members": [{"name": "equal", "value": "=="}, {"name": "equals", "value": "=="}, {"name": "==", "value": "=="}, {"name": "should be", "value": "=="}, {"name": "inequal", "value": "!="}, {"name": "!=", "value": "!="}, {"name": "should not be", "value": "!="}, {"name": "less than", "value": "<"}, {"name": "<", "value": "<"}, {"name": "greater than", "value": ">"}, {"name": ">", "value": ">"}, {"name": "<=", "value": "<="}, {"name": ">=", "value": ">="}, {"name": "contains", "value": "*="}, {"name": "not contains", "value": "not contains"}, {"name": "*=", "value": "*="}, {"name": "starts", "value": "^="}, {"name": "^=", "value": "^="}, {"name": "should start with", "value": "^="}, {"name": "ends", "value": "$="}, {"name": "should end with", "value": "$="}, {"name": "$=", "value": "$="}, {"name": "matches", "value": "$"}, {"name": "validate", "value": "validate"}, {"name": "then", "value": "then"}, {"name": "evaluate", "value": "then"}]}, {"type": "Enum", "name": "AutoClosingLevel", "doc": "<p>Controls when contexts and pages are closed during the test execution.</p>\n<p>If automatic closing level is <span class=\"name\">TEST</span>, contexts and pages that are created during a single test are automatically closed when the test ends. Contexts and pages that are created during suite setup are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">SUITE</span>, all contexts and pages that are created during the test suite are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">MANUAL</span>, nothing is closed automatically while the test execution is ongoing. All browsers, context and pages are automatically closed when test execution ends.</p>\n<p>If automatic closing level is <span class=\"name\">KEEP</span>, nothing is closed automatically while the test execution is ongoing. Also, nothing is closed when test execution ends, including the node process. Therefore, it is users responsibility to close all browsers, context and pages and ensure that all process that are left running after the test execution end are closed. This level is only intended for test case development and must not be used when running tests in CI or similar environments.</p>\n<p>Automatic closing can be configured or switched off with the auto_closing_level library import parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "SUITE", "value": "1"}, {"name": "TEST", "value": "2"}, {"name": "MANUAL", "value": "3"}, {"name": "KEEP", "value": "4"}]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__", "Add Cookie", "Check Checkbox", "Click With Options", "Close Page", "Connect To Browser", "Download", "Evaluate JavaScript", "Fill Secret", "Fill Text", "Get Checkbox State", "Get Console Log", "Get Element By", "Get Element By Role", "Get Page Errors", "Hover", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Open Browser", "Promise To Wait For Download", "Set Default Run Before Unload", "Set Offline", "Set Strict Mode", "Show Keyword Banner", "Take Screenshot", "Tap", "Type Secret", "Type Text", "Uncheck Checkbox"], "accepts": ["string", "integer", "float", "None"]}, {"type": "TypedDict", "name": "BoundingBox", "doc": "<p>Bounding box of an element.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>x</code></td>\n<td>The amount of pixel between the left border of the page and the left border of the element.</td>\n</tr>\n<tr>\n<td><code>y</code></td>\n<td>The amount of pixel between the top border of the page and the top border of the element.</td>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>The width of the element, excluding margins.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>The height of the element, excluding margins.</td>\n</tr>\n</table>", "usages": ["Get BoundingBox", "Take Screenshot"], "accepts": ["string", "Mapping"], "items": [{"key": "x", "type": "float", "required": false}, {"key": "y", "type": "float", "required": false}, {"key": "width", "type": "float", "required": false}, {"key": "height", "type": "float", "required": false}]}, {"type": "Enum", "name": "BoundingBoxFields", "doc": "<p>Enumeration that defines which location information of an element should be selected.</p>\n<p><code>x</code> / <code>y</code> defines the position of the top left corner of an element.</p>\n<p><code>width</code> / <code>height</code> defines the size of an elements bounding box.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "usages": ["Get BoundingBox"], "accepts": ["string"], "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "x", "value": "3"}, {"name": "y", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"type": "TypedDict", "name": "BrowserInfo", "doc": "<p>Dictionary that contains information about a browser instance.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>The browser type. e.g. chromium, firefox or webkit.</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The unique id of the browser instance.</td>\n</tr>\n<tr>\n<td><code>contexts</code></td>\n<td>List of context information opened by the browser.</td>\n</tr>\n<tr>\n<td><code>activeContext</code></td>\n<td>The id of the active context.</td>\n</tr>\n<tr>\n<td><code>activeBrowser</code></td>\n<td>Boolean if the browser is the currently active browser.</td>\n</tr>\n</table>\n<p>Structure:</p>\n<pre>\n{\n  'type': <span class=\"name\">str</span>,\n  'id': <span class=\"name\">str</span>,\n  'contexts': [\n      {\n          'type': <span class=\"name\">str</span>,\n          'id': <span class=\"name\">str</span>,\n          'activePage': <span class=\"name\">str</span>,\n          'pages': [\n              {\n                  'type': <span class=\"name\">str</span>,\n                  'title': <span class=\"name\">str</span>,\n                  'url': <span class=\"name\">str</span>,\n                  'id': <span class=\"name\">str</span>,\n                  'timestamp': <a href=\"#type-float\" class=\"name\">float</a>\n              },\n              ...\n          ]\n      },\n      ...\n  ],\n  'activeContext': <span class=\"name\">str</span>,\n  'activeBrowser': <span class=\"name\">bool</span>\n}\n</pre>", "usages": ["Get Browser Catalog"], "accepts": ["string", "Mapping"], "items": [{"key": "type", "type": "str", "required": true}, {"key": "id", "type": "str", "required": true}, {"key": "contexts", "type": "typing.List[Browser.utils.data_types.ContextInfo]", "required": true}, {"key": "activeContext", "type": "str", "required": true}, {"key": "activeBrowser", "type": "bool", "required": true}]}, {"type": "Standard", "name": "bytes", "doc": "<p>Strings are converted to bytes so that each Unicode code point below 256 is directly mapped to a matching byte. Higher code points are not allowed. Robot Framework's <code>\\xHH</code> escape syntax is convenient with bytes having non-printable values.</p>\n<p>Examples: <code>good</code>, <code>hyv\u00e4</code> (same as <code>hyv\\xE4</code>), <code>\\x00</code> (the null byte)</p>", "usages": ["Take Screenshot"], "accepts": ["string", "bytearray"]}, {"type": "Enum", "name": "ColorScheme", "doc": "<p>Emulates 'prefers-colors-scheme' media feature.</p>\n<p>See <a href=\"https://playwright.dev/docs/api/class-page?_highlight=emulatemedia#pageemulatemediaparams\">emulateMedia(options)</a> for more details.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "dark", "value": "1"}, {"name": "light", "value": "2"}, {"name": "no-preference", "value": "3"}]}, {"type": "Enum", "name": "ConditionInputs", "doc": "<p>Following values are allowed and represent the assertion keywords to use:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Keyword</th>\n</tr>\n<tr>\n<td><code>Attribute</code></td>\n<td><a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a></td>\n</tr>\n<tr>\n<td><code>Attribute Names</code></td>\n<td><a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a></td>\n</tr>\n<tr>\n<td><code>BoundingBox</code></td>\n<td><a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a></td>\n</tr>\n<tr>\n<td><code>Browser Catalog</code></td>\n<td><a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a></td>\n</tr>\n<tr>\n<td><code>Checkbox State</code></td>\n<td><a href=\"#Get%20Checkbox%20State\" class=\"name\">Get Checkbox State</a></td>\n</tr>\n<tr>\n<td><code>Classes</code></td>\n<td><a href=\"#Get%20Classes\" class=\"name\">Get Classes</a></td>\n</tr>\n<tr>\n<td><code>Client Size</code></td>\n<td><a href=\"#Get%20Client%20Size\" class=\"name\">Get Client Size</a></td>\n</tr>\n<tr>\n<td><code>Download State</code></td>\n<td><a href=\"#Get%20Download%20State\" class=\"name\">Get Download State</a></td>\n</tr>\n<tr>\n<td><code>Element Count</code></td>\n<td><a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a></td>\n</tr>\n<tr>\n<td><code>Element States</code></td>\n<td><a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a></td>\n</tr>\n<tr>\n<td><code>Page Source</code></td>\n<td><a href=\"#Get%20Page%20Source\" class=\"name\">Get Page Source</a></td>\n</tr>\n<tr>\n<td><code>Property</code></td>\n<td><a href=\"#Get%20Property\" class=\"name\">Get Property</a></td>\n</tr>\n<tr>\n<td><code>Scroll Position</code></td>\n<td><a href=\"#Get%20Scroll%20Position\" class=\"name\">Get Scroll Position</a></td>\n</tr>\n<tr>\n<td><code>Scroll Size</code></td>\n<td><a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a></td>\n</tr>\n<tr>\n<td><code>Select Options</code></td>\n<td><a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a></td>\n</tr>\n<tr>\n<td><code>Selected Options</code></td>\n<td><a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a></td>\n</tr>\n<tr>\n<td><code>Style</code></td>\n<td><a href=\"#Get%20Style\" class=\"name\">Get Style</a></td>\n</tr>\n<tr>\n<td><code>Table Cell Index</code></td>\n<td><a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a></td>\n</tr>\n<tr>\n<td><code>Table Row Index</code></td>\n<td><a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a></td>\n</tr>\n<tr>\n<td><code>Text</code></td>\n<td><a href=\"#Get%20Text\" class=\"name\">Get Text</a></td>\n</tr>\n<tr>\n<td><code>Title</code></td>\n<td><a href=\"#Get%20Title\" class=\"name\">Get Title</a></td>\n</tr>\n<tr>\n<td><code>Url</code></td>\n<td><a href=\"#Get%20Url\" class=\"name\">Get Url</a></td>\n</tr>\n<tr>\n<td><code>Viewport Size</code></td>\n<td><a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a></td>\n</tr>\n</table>", "usages": ["Wait For Condition"], "accepts": ["string"], "members": [{"name": "attribute", "value": "get_attribute"}, {"name": "attribute_names", "value": "get_attribute_names"}, {"name": "bounding_box", "value": "get_bounding_box"}, {"name": "browser_catalog", "value": "get_browser_catalog"}, {"name": "checkbox_state", "value": "get_checkbox_state"}, {"name": "classes", "value": "get_classes"}, {"name": "client_size", "value": "get_client_size"}, {"name": "download_state", "value": "get_download_state"}, {"name": "element_count", "value": "get_element_count"}, {"name": "element_states", "value": "get_element_states"}, {"name": "page_source", "value": "get_page_source"}, {"name": "property", "value": "get_property"}, {"name": "scroll_position", "value": "get_scroll_position"}, {"name": "scroll_size", "value": "get_scroll_size"}, {"name": "select_options", "value": "get_select_options"}, {"name": "selected_options", "value": "get_selected_options"}, {"name": "style", "value": "get_style"}, {"name": "table_cell_index", "value": "get_table_cell_index"}, {"name": "table_row_index", "value": "get_table_row_index"}, {"name": "text", "value": "get_text"}, {"name": "title", "value": "get_title"}, {"name": "url", "value": "get_url"}, {"name": "viewport_size", "value": "get_viewport_size"}]}, {"type": "Enum", "name": "CookieSameSite", "doc": "<p>Enum that defines the Cookie SameSite type.</p>\n<p>It controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).</p>\n<p>The possible attribute values are:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>Strict</code></td>\n<td>Means that the browser sends the cookie only for same-site requests, that is, requests originating from the same site that set the cookie. If a request originates from a different domain or scheme (even with the same domain), no cookies with the SameSite=Strict attribute are sent.</td>\n</tr>\n<tr>\n<td><code>Lax</code></td>\n<td>Means that the cookie is not sent on cross-site requests, such as on requests to load images or frames, but is sent when a user is navigating to the origin site from an external site (for example, when following a link). This is the default behavior if the SameSite attribute is not specified.</td>\n</tr>\n<tr>\n<td><code>None</code></td>\n<td>means that the browser sends the cookie with both cross-site and same-site requests. The Secure attribute must also be set when setting this value.</td>\n</tr>\n</table>\n<p>See <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie\">MDN Set-Cookie</a> for more information.</p>", "usages": ["Add Cookie"], "accepts": ["string"], "members": [{"name": "Strict", "value": "Strict"}, {"name": "Lax", "value": "Lax"}, {"name": "None", "value": "None"}]}, {"type": "Enum", "name": "CookieType", "doc": "<p>Enum that defines the Cookie type.</p>", "usages": ["Get Cookie", "Get Cookies"], "accepts": ["string"], "members": [{"name": "dictionary", "value": "1"}, {"name": "dict", "value": "1"}, {"name": "string", "value": "2"}, {"name": "str", "value": "2"}]}, {"type": "Enum", "name": "DialogAction", "doc": "<p>Enum that defines how to handle a dialog.</p>", "usages": ["Handle Future Dialogs", "Wait For Alert"], "accepts": ["string"], "members": [{"name": "accept", "value": "1"}, {"name": "dismiss", "value": "2"}]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["__init__", "Get Console Log", "Get Cookie", "Get Cookies", "Get Device", "Get Devices", "Get Page Errors", "Get Style", "Http", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Set Assertion Formatters", "Show Keyword Banner", "Wait For Response"], "accepts": ["string", "Mapping"]}, {"type": "TypedDict", "name": "Dimensions", "doc": "<p>Dimensions of an object in pixels.</p>", "usages": ["Get Client Size", "Get Scroll Size"], "accepts": ["string", "Mapping"], "items": [{"key": "width", "type": "int", "required": true}, {"key": "height", "type": "int", "required": true}]}, {"type": "TypedDict", "name": "DownloadInfo", "doc": "<p>Downloaded file information.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>is the path where downloaded file is saved. empty string if the file is not yet fully downloaded.</td>\n</tr>\n<tr>\n<td><code>suggestedFilename</code></td>\n<td>is the suggested filename that was computed from the <code>Content-Disposition</code> response header.</td>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>is the state of the download. i.e. <code>in_progress</code>, <code>finished</code> or <code>canceled</code>.</td>\n</tr>\n<tr>\n<td><code>downloadID</code></td>\n<td>is the unique id of the download.</td>\n</tr>\n</table>", "usages": ["Cancel Download", "Download", "Get Download State"], "accepts": ["string", "Mapping"], "items": [{"key": "saveAs", "type": "str", "required": true}, {"key": "suggestedFilename", "type": "str", "required": true}, {"key": "state", "type": "str", "required": true}, {"key": "downloadID", "type": "typing.Union[str, NoneType]", "required": true}]}, {"type": "Enum", "name": "ElementRole", "doc": "<p>Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.</p>\n<p>Many html elements have an implicitly <a href=\"https://w3c.github.io/html-aam/#html-element-role-mappings\">defined role</a> that is recognized by the role selector. You can find all the <a href=\"https://www.w3.org/TR/wai-aria-1.2/#role_definitions\">supported roles</a> here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.</p>", "usages": ["Get Element By Role"], "accepts": ["string"], "members": [{"name": "ALERT", "value": "1"}, {"name": "ALERTDIALOG", "value": "2"}, {"name": "APPLICATION", "value": "3"}, {"name": "ARTICLE", "value": "4"}, {"name": "BANNER", "value": "5"}, {"name": "BLOCKQUOTE", "value": "6"}, {"name": "BUTTON", "value": "7"}, {"name": "CAPTION", "value": "8"}, {"name": "CELL", "value": "9"}, {"name": "CHECKBOX", "value": "10"}, {"name": "CODE", "value": "11"}, {"name": "COLUMNHEADER", "value": "12"}, {"name": "COMBOBOX", "value": "13"}, {"name": "COMPLEMENTARY", "value": "14"}, {"name": "CONTENTINFO", "value": "15"}, {"name": "DEFINITION", "value": "16"}, {"name": "DELETION", "value": "17"}, {"name": "DIALOG", "value": "18"}, {"name": "DIRECTORY", "value": "19"}, {"name": "DOCUMENT", "value": "20"}, {"name": "EMPHASIS", "value": "21"}, {"name": "FEED", "value": "22"}, {"name": "FIGURE", "value": "23"}, {"name": "FORM", "value": "24"}, {"name": "GENERIC", "value": "25"}, {"name": "GRID", "value": "26"}, {"name": "GRIDCELL", "value": "27"}, {"name": "GROUP", "value": "28"}, {"name": "HEADING", "value": "29"}, {"name": "IMG", "value": "30"}, {"name": "INSERTION", "value": "31"}, {"name": "LINK", "value": "32"}, {"name": "LIST", "value": "33"}, {"name": "LISTBOX", "value": "34"}, {"name": "LISTITEM", "value": "35"}, {"name": "LOG", "value": "36"}, {"name": "MAIN", "value": "37"}, {"name": "MARQUEE", "value": "38"}, {"name": "MATH", "value": "39"}, {"name": "METER", "value": "40"}, {"name": "MENU", "value": "41"}, {"name": "MENUBAR", "value": "42"}, {"name": "MENUITEM", "value": "43"}, {"name": "MENUITEMCHECKBOX", "value": "44"}, {"name": "MENUITEMRADIO", "value": "45"}, {"name": "NAVIGATION", "value": "46"}, {"name": "NONE", "value": "47"}, {"name": "NOTE", "value": "48"}, {"name": "OPTION", "value": "49"}, {"name": "PARAGRAPH", "value": "50"}, {"name": "PRESENTATION", "value": "51"}, {"name": "PROGRESSBAR", "value": "52"}, {"name": "RADIO", "value": "53"}, {"name": "RADIOGROUP", "value": "54"}, {"name": "REGION", "value": "55"}, {"name": "ROW", "value": "56"}, {"name": "ROWGROUP", "value": "57"}, {"name": "ROWHEADER", "value": "58"}, {"name": "SCROLLBAR", "value": "59"}, {"name": "SEARCH", "value": "60"}, {"name": "SEARCHBOX", "value": "61"}, {"name": "SEPARATOR", "value": "62"}, {"name": "SLIDER", "value": "63"}, {"name": "SPINBUTTON", "value": "64"}, {"name": "STATUS", "value": "65"}, {"name": "STRONG", "value": "66"}, {"name": "SUBSCRIPT", "value": "67"}, {"name": "SUPERSCRIPT", "value": "68"}, {"name": "SWITCH", "value": "69"}, {"name": "TAB", "value": "70"}, {"name": "TABLE", "value": "71"}, {"name": "TABLIST", "value": "72"}, {"name": "TABPANEL", "value": "73"}, {"name": "TERM", "value": "74"}, {"name": "TEXTBOX", "value": "75"}, {"name": "TIME", "value": "76"}, {"name": "TIMER", "value": "77"}, {"name": "TOOLBAR", "value": "78"}, {"name": "TOOLTIP", "value": "79"}, {"name": "TREE", "value": "80"}, {"name": "TREEGRID", "value": "81"}, {"name": "TREEITEM", "value": "82"}]}, {"type": "Enum", "name": "ElementState", "doc": "<p>Enum that defines the state an element can have.</p>\n<p>The following <code>states</code> are possible:</p>\n<table border=\"1\">\n<tr>\n<th>State</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>attached</code></td>\n<td>to be present in DOM.</td>\n</tr>\n<tr>\n<td><code>detached</code></td>\n<td>to not be present in DOM.</td>\n</tr>\n<tr>\n<td><code>visible</code></td>\n<td>to have non or empty bounding box and no visibility:hidden.</td>\n</tr>\n<tr>\n<td><code>hidden</code></td>\n<td>to be detached from DOM, or have an empty bounding box or visibility:hidden.</td>\n</tr>\n<tr>\n<td><code>enabled</code></td>\n<td>to not be <code>disabled</code>.</td>\n</tr>\n<tr>\n<td><code>disabled</code></td>\n<td>to be <code>disabled</code>. Can be used on &lt;button&gt;, &lt;fieldset&gt;, &lt;input&gt;, &lt;optgroup&gt;, &lt;option&gt;, &lt;select&gt; and &lt;textarea&gt;.</td>\n</tr>\n<tr>\n<td><code>editable</code></td>\n<td>to not be <code>readOnly</code>.</td>\n</tr>\n<tr>\n<td><code>readonly</code></td>\n<td>to be <code>readOnly</code>. Can be used on &lt;input&gt; and &lt;textarea&gt;.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>to be <code>selected</code>. Can be used on &lt;option&gt;.</td>\n</tr>\n<tr>\n<td><code>deselected</code></td>\n<td>to not be <code>selected</code>.</td>\n</tr>\n<tr>\n<td><code>focused</code></td>\n<td>to be the <code>activeElement</code>.</td>\n</tr>\n<tr>\n<td><code>defocused</code></td>\n<td>to not be the <code>activeElement</code>.</td>\n</tr>\n<tr>\n<td><code>checked</code></td>\n<td>to be <code>checked</code>. Can be used on &lt;input&gt;.</td>\n</tr>\n<tr>\n<td><code>unchecked</code></td>\n<td>to not be <code>checked</code>.</td>\n</tr>\n<tr>\n<td><code>stable</code></td>\n<td>to be both <code>visible</code> and <code>stable</code>.</td>\n</tr>\n</table>", "usages": ["Get Element States", "Wait For Elements State"], "accepts": ["string", "integer"], "members": [{"name": "attached", "value": "1"}, {"name": "detached", "value": "2"}, {"name": "visible", "value": "4"}, {"name": "hidden", "value": "8"}, {"name": "enabled", "value": "16"}, {"name": "disabled", "value": "32"}, {"name": "editable", "value": "64"}, {"name": "readonly", "value": "128"}, {"name": "selected", "value": "256"}, {"name": "deselected", "value": "512"}, {"name": "focused", "value": "1024"}, {"name": "defocused", "value": "2048"}, {"name": "checked", "value": "4096"}, {"name": "unchecked", "value": "8192"}, {"name": "stable", "value": "16384"}]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Click With Options", "Drag And Drop By Coordinates", "Drag And Drop Relative To", "Get BoundingBox", "Get Scroll Position", "Get Scroll Size", "Hover", "Launch Browser Server", "Mouse Button", "Mouse Move", "Mouse Move Relative To", "New Browser", "New Context", "New Persistent Context", "Set Geolocation"], "accepts": ["string", "Real"]}, {"type": "Enum", "name": "ForcedColors", "doc": "<p>Emulates <span class=\"name\">forced-colors</span> media feature, supported values are <span class=\"name\">active</span>, <a href=\"#type-None\" class=\"name\">none</a>.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "active", "value": "1"}, {"name": "none", "value": "2"}]}, {"type": "Enum", "name": "FormatingRules", "doc": "<p>Enum that defines the available formatters.</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Replaces all kind of spaces with a single space.</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from start and end of the string.</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies the formatter also to the expected value.</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts the string to lower case.</td>\n</tr>\n</table>", "usages": ["Set Assertion Formatters"], "accepts": ["string"], "members": [{"name": "normalize spaces", "value": "1"}, {"name": "strip", "value": "2"}, {"name": "apply to expected", "value": "3"}, {"name": "case insensitive", "value": "4"}]}, {"type": "Enum", "name": "FormatterKeywords", "doc": "<p>Enum that defines the available keywords for formatters.</p>\n<p>Keywords that are not listed here, do not support formatters.</p>", "usages": ["Set Assertion Formatters"], "accepts": ["string"], "members": [{"name": "Get Url", "value": "1"}, {"name": "Get Page Source", "value": "2"}, {"name": "Get Title", "value": "3"}, {"name": "Get Text", "value": "4"}, {"name": "Get Property", "value": "5"}, {"name": "Get Attribute", "value": "6"}, {"name": "Get Select Options", "value": "7"}, {"name": "Get Style", "value": "8"}, {"name": "Get Browser Catalog", "value": "9"}, {"name": "LocalStorage Get Item", "value": "10"}, {"name": "SessionStorage Get Item", "value": "11"}]}, {"type": "TypedDict", "name": "GeoLocation", "doc": "<p>Defines the geolocation.</p>\n<ul>\n<li><code>latitude</code> Latitude between -90 and 90.</li>\n<li><code>longitude</code> Longitude between -180 and 180.</li>\n<li><code>accuracy</code> <b>Optional</b> Non-negative accuracy value. Defaults to 0.</li>\n</ul>\n<p>Example usage: <code>{'latitude': 59.95, 'longitude': 30.31667}</code></p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "longitude", "type": "float", "required": true}, {"key": "latitude", "type": "float", "required": true}, {"key": "accuracy", "type": "float", "required": false}]}, {"type": "TypedDict", "name": "HighLightElement", "doc": "<p>Presenter mode configuration options.</p>\n<p><code>duration</code> Sets for how long the selector shall be highlighted. Defaults to <code>5s</code> =&gt; 5 seconds.</p>\n<p><code>width</code> Sets the width of the higlight border. Defaults to 2px.</p>\n<p><code>style</code> Sets the style of the border. Defaults to dotted.</p>\n<p><code>color</code> Sets the color of the border, default is blue. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></p>", "usages": ["__init__"], "accepts": ["string", "Mapping"], "items": [{"key": "duration", "type": "timedelta", "required": true}, {"key": "width", "type": "str", "required": true}, {"key": "style", "type": "str", "required": true}, {"key": "color", "type": "str", "required": true}]}, {"type": "TypedDict", "name": "HttpCredentials", "doc": "<p>Sets the credentials for http basic-auth.</p>\n<p><code>origin</code>: Restrain sending http credentials on specific origin (<a href=\"scheme://host:port\">scheme://host:port</a>). Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.</p>\n<p>Can be defined as robot dictionary or as string literal. Does not reveal secrets in Robot Framework logs. Instead, username and password values are resolved internally. Please note that if <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<p>Example as literal:</p>\n<pre>\n${pwd} =    Set Variable    1234\n${username} =    Set Variable    admin\n<a href=\"#New%20Context\" class=\"name\">New Context</a>\n...    httpCredentials={'username': '$username', 'password': '$pwd'}\n</pre>\n<p>Example as robot variable</p>\n<pre>\n<b>***</b> <b>Variables</b> <b>***</b>\n${username}=       admin\n${pwd}=            1234\n${credentials}=    username=$username    password=$pwd\n\n<b>***</b> <b>Keywords</b> <b>***</b>\nOpen Context\n   <a href=\"#New%20Context\" class=\"name\">New Context</a>    httpCredentials=${credentials}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "username", "type": "str", "required": true}, {"key": "password", "type": "str", "required": true}, {"key": "origin", "type": "str", "required": false}]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__", "Click With Options", "Crawl Site", "Drag And Drop", "Drag And Drop By Coordinates", "Drag And Drop Relative To", "Get BoundingBox", "Get Console Log", "Get Element By Role", "Get Element Count", "Get Page Errors", "Get Scroll Size", "Get Selected Options", "Get Table Cell Index", "Get Table Row Index", "Keyboard Input", "Launch Browser Server", "Mouse Button", "Mouse Move", "Mouse Move Relative To", "Mouse Wheel", "New Browser", "New Context", "New Persistent Context", "Set Viewport Size", "Take Screenshot", "Tap"], "accepts": ["string", "float"]}, {"type": "Enum", "name": "KeyAction", "doc": "<p>Enum that defines which <a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a> action to perform.</p>", "usages": ["Keyboard Key"], "accepts": ["string"], "members": [{"name": "down", "value": "1"}, {"name": "up", "value": "2"}, {"name": "press", "value": "3"}]}, {"type": "Enum", "name": "KeyboardInputAction", "doc": "<p>Enum that defines how <a href=\"#Keyboard%20Input\" class=\"name\">Keyboard Input</a> adds the text into the page.</p>\n<p><code>insertText</code> is mostly similar to pasting of text.</p>\n<p><code>type</code> is similar to typing by pressing keys on the keyboard.</p>", "usages": ["Keyboard Input"], "accepts": ["string"], "members": [{"name": "insertText", "value": "1"}, {"name": "type", "value": "2"}]}, {"type": "Enum", "name": "KeyboardModifier", "doc": "<p>Modifier keys to press while doing other actions.</p>\n<p>Modifiers that are pressed during the <a href=\"#Hover\" class=\"name\">Hover</a> or <a href=\"#Click\" class=\"name\">Click</a>.</p>", "usages": ["Click With Options", "Hover", "Tap"], "accepts": ["string"], "members": [{"name": "Alt", "value": "1"}, {"name": "Control", "value": "2"}, {"name": "Meta", "value": "3"}, {"name": "Shift", "value": "4"}]}, {"type": "Custom", "name": "LambdaFunction", "doc": "<p>Python lambda function.</p>\n<p>The string must start with <code>lambda</code> and the function must accept one argument.</p>\n<p>Example: <code>lambda value: value.lower().replace(' ', '')</code></p>", "usages": ["Set Assertion Formatters"], "accepts": ["string"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["__init__", "Get Attribute Names", "Get Browser Catalog", "Get Browser Ids", "Get Classes", "Get Context Ids", "Get Cookies", "Get Element States", "Get Elements", "Get Page Ids", "Get Select Options", "Get Selected Options", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Select Options By", "Set Assertion Formatters", "Take Screenshot"], "accepts": ["string", "Sequence"]}, {"type": "Enum", "name": "MouseButton", "doc": "<p>Enum that defines which mouse button to use.</p>", "usages": ["Click", "Click With Options", "Mouse Button"], "accepts": ["string"], "members": [{"name": "left", "value": "1"}, {"name": "middle", "value": "2"}, {"name": "right", "value": "3"}]}, {"type": "Enum", "name": "MouseButtonAction", "doc": "<p>Enum that defines which <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> action to perform.</p>", "usages": ["Mouse Button"], "accepts": ["string"], "members": [{"name": "click", "value": "1"}, {"name": "down", "value": "2"}, {"name": "up", "value": "3"}]}, {"type": "TypedDict", "name": "NewPageDetails", "doc": "<p>Return value of <a href=\"#New%20Page\" class=\"name\">New Page</a> keyword.</p>\n<p><code>page_id</code> is the UUID of the opened page. <code>video_path</code> path to the video or empty string if video is not created.</p>", "usages": ["New Page", "Switch Page"], "accepts": ["string", "Mapping"], "items": [{"key": "page_id", "type": "str", "required": true}, {"key": "video_path", "type": "str", "required": true}]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__", "Add Cookie", "Click With Options", "Crawl Site", "Download", "Evaluate JavaScript", "Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Download State", "Get Element By Role", "Get Element Count", "Get Element States", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Go To", "Grant Permissions", "Hover", "Http", "Launch Browser Server", "LocalStorage Clear", "LocalStorage Get Item", "LocalStorage Remove Item", "LocalStorage Set Item", "Mouse Button", "New Browser", "New Context", "New Page", "New Persistent Context", "Open Browser", "Promise To Wait For Download", "Record Selector", "Register Keyword To Run On Failure", "Scroll By", "Scroll To", "SessionStorage Clear", "SessionStorage Get Item", "SessionStorage Remove Item", "SessionStorage Set Item", "Set Geolocation", "Set Selector Prefix", "Show Keyword Banner", "Take Screenshot", "Tap", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Load State", "Wait For Navigation", "Wait For Request", "Wait For Response", "Wait Until Network Is Idle"], "accepts": ["string"]}, {"type": "Enum", "name": "PageLoadStates", "doc": "<p>Enum that defines available page load states.</p>", "usages": ["Go To", "New Page", "Wait For Load State", "Wait For Navigation"], "accepts": ["string"], "members": [{"name": "load", "value": "1"}, {"name": "domcontentloaded", "value": "2"}, {"name": "networkidle", "value": "3"}, {"name": "commit", "value": "4"}]}, {"type": "Standard", "name": "Path", "doc": "<p>Strings are converted <a href=\"https://docs.python.org/library/pathlib.html\">Path</a> objects. On Windows <code>/</code> is converted to <code>\\</code> automatically.</p>\n<p>Examples: <code>/tmp/absolute/path</code>, <code>relative/path/to/file.ext</code>, <code>name.txt</code></p>", "usages": ["Promise To Upload File", "Take Screenshot", "Upload File By Selector"], "accepts": ["string", "PurePath"]}, {"type": "Enum", "name": "Permission", "doc": "<p>Enum that defines the permission to grant to a context.</p>\n<p>See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions\">grantPermissions(permissions)</a> for more details.</p>", "usages": ["Grant Permissions", "New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "geolocation", "value": "geolocation"}, {"name": "midi", "value": "midi"}, {"name": "midi_sysex", "value": "midi-sysex"}, {"name": "midi-sysex", "value": "midi-sysex"}, {"name": "notifications", "value": "notifications"}, {"name": "camera", "value": "camera"}, {"name": "microphone", "value": "microphone"}, {"name": "background_sync", "value": "background-sync"}, {"name": "background-sync", "value": "background-sync"}, {"name": "ambient_light_sensor", "value": "ambient-light-sensor"}, {"name": "ambient-light-sensor", "value": "ambient-light-sensor"}, {"name": "accelerometer", "value": "accelerometer"}, {"name": "gyroscope", "value": "gyroscope"}, {"name": "magnetometer", "value": "magnetometer"}, {"name": "accessibility_events", "value": "accessibility-events"}, {"name": "accessibility-events", "value": "accessibility-events"}, {"name": "clipboard_read", "value": "clipboard-read"}, {"name": "clipboard-read", "value": "clipboard-read"}, {"name": "clipboard_write", "value": "clipboard-write"}, {"name": "clipboard-write", "value": "clipboard-write"}, {"name": "payment_handler", "value": "payment-handler"}, {"name": "payment-handler", "value": "payment-handler"}]}, {"type": "Enum", "name": "PlaywrightLogTypes", "doc": "<p>Enable low level debug information from the playwright to playwright-log.txt file.</p>\n<p>It is possible to disable the creation of playwright-log.txt totally. Mainly useful for the library developers and for debugging purposes. Will log everything as plain text, also including secrets. If playwright-log.txt file can not be deleted, time.time_ns() is added at the end of file name. Example playwright-log-12345.txt</p>\n<p><code>disabled</code>: playwright-log.txt is not created at all. All node side logging is lost. <code>library</code>: Default, only logging from Browser library node side is written to the playwright-log.txt file. <code>playwright</code>: Also includes Playwright log messages to the playwright-log.txt file. <code>false</code>: Same as <span class=\"name\">library</span> and for backwards compatability. <code>true</code>: Same as <span class=\"name\">playwright</span> and for backwards compatibility.</p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "disabled", "value": "1"}, {"name": "library", "value": "2"}, {"name": "playwright", "value": "3"}, {"name": "false", "value": "2"}, {"name": "true", "value": "3"}]}, {"type": "TypedDict", "name": "Proxy", "doc": "<p>Network proxy settings.</p>\n<p><code>server</code> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example <a href=\"http://myproxy.com:3128\">http://myproxy.com:3128</a> or <a href=\"socks5://myproxy.com:3128\">socks5://myproxy.com:3128</a>. Short form myproxy.com:3128 is considered an HTTP proxy.</p>\n<p><code>bypass</code> <b>Optional</b> coma-separated domains to bypass proxy, for example \".com, chromium.org, .domain.com\".</p>\n<p><code>username</code> <b>Optional</b> username to use if HTTP proxy requires authentication.</p>\n<p><code>password</code> <b>Optional</b> password to use if HTTP proxy requires authentication.</p>", "usages": ["Launch Browser Server", "New Browser", "New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "server", "type": "str", "required": true}, {"key": "bypass", "type": "str", "required": false}, {"key": "username", "type": "str", "required": false}, {"key": "password", "type": "str", "required": false}]}, {"type": "TypedDict", "name": "RecordHar", "doc": "<p>Enables HAR recording for all pages into to a file.</p>\n<p>If not specified, the HAR is not recorded. Make sure to await context to close for the <a href=\"http://www.softwareishard.com/blog/har-12-spec/\">HAR</a> to be saved.</p>\n<p><span class=\"name\">omitContent</span>: Optional setting to control whether to omit request content from the HAR. Default is False</p>\n<p><a href=\"#type-Path\" class=\"name\">path</a>: Path on the filesystem to write the HAR file to.</p>\n<p>Example:</p>\n<pre>\n${har} =    Create Dictionary     path=/path/to/har.file    omitContent=True\nNew Context    recordHar=${har}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "omitContent", "type": "bool", "required": false}, {"key": "path", "type": "str", "required": false}]}, {"type": "TypedDict", "name": "RecordVideo", "doc": "<p>Enables Video recording</p>\n<p>Examples:</p>\n<pre>\n New Context  recordVideo={'dir':'videos', 'size':{'width':400, 'height':200}}\n New Context  recordVideo={'dir': 'd:/automation/video'}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "dir", "type": "str", "required": false}, {"key": "size", "type": "ViewportDimensions", "required": false}]}, {"type": "Enum", "name": "ReduceMotion", "doc": "<p>Emulates <span class=\"name\">prefers-reduced-motion</span> media feature, supported values are <span class=\"name\">reduce</span>, <span class=\"name\">no-preference</span>.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "reduce", "value": "1"}, {"name": "no_preference", "value": "2"}]}, {"type": "Custom", "name": "RegExp", "doc": "<p>Create a (JavaScript) RegExp object from a string.</p>\n<p>The matcher must start with a slash and end with a slash and can be followed by flags.</p>\n<p>Example: <code>/hello world/gi</code> Which is equivalent to <code>new RegExp(\"hello world\", \"gi\")</code> in JavaScript.</p>\n<p>Following flags are supported:</p>\n<table border=\"1\">\n<tr>\n<th>Flag</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>g</td>\n<td>Global search.</td>\n</tr>\n<tr>\n<td>i</td>\n<td>Case-insensitive search.</td>\n</tr>\n<tr>\n<td>m</td>\n<td>Allows <code>^</code> and <code>$</code> to match newline characters.</td>\n</tr>\n<tr>\n<td>s</td>\n<td>Allows <code>.</code> to match newline characters.</td>\n</tr>\n<tr>\n<td>u</td>\n<td>\"unicode\"; treat a pattern as a sequence of unicode code points.</td>\n</tr>\n<tr>\n<td>y</td>\n<td>Perform a \"sticky\" search that matches starting at the current position in the target string.</td>\n</tr>\n</table>\n<p>See <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp\">RegExp Object</a> and <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions\">RegExp Guide</a> for more information.</p>", "usages": ["Get Element By", "Get Element By Role", "Wait For Navigation", "Wait For Request", "Wait For Response"], "accepts": ["string"]}, {"type": "Enum", "name": "RequestMethod", "doc": "<p>Enum that defines the request type.</p>", "usages": ["Http"], "accepts": ["string"], "members": [{"name": "HEAD", "value": "1"}, {"name": "GET", "value": "2"}, {"name": "POST", "value": "3"}, {"name": "PUT", "value": "4"}, {"name": "PATCH", "value": "5"}, {"name": "DELETE", "value": "6"}]}, {"type": "Enum", "name": "Scale", "doc": "<p>Enum that defines the scale of the screenshot.</p>\n<p>When set to \"css\", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using \"device\" option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger.</p>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "css", "value": "1"}, {"name": "device", "value": "2"}]}, {"type": "Enum", "name": "Scope", "doc": "<p>Some keywords which manipulates library settings have a scope argument. With that scope argument one can set the \"live time\" of that setting. Available Scopes are: <code>Global</code>, <code>Suite</code> and <code>Test</code> / <code>Task</code>. Is a scope finished, this scoped setting, like timeout, will no longer be used and the previous higher scope setting applies again.</p>\n<p>Live Times:</p>\n<ul>\n<li>A <code>Global</code> scope will live forever until it is overwritten by another Global scope. Or locally temporarily overridden by a more narrow scope.</li>\n<li>A <code>Suite</code> scope will locally override the Global scope and live until the end of the Suite within it is set, or if it is overwritten by a later setting with Global or same scope. Children suite does inherit the setting from the parent suite but also may have its own local Suite setting that then will be inherited to its children suites.</li>\n<li>A <code>Test</code> or <code>Task</code> scope will be inherited from its parent suite but when set, lives until the end of that particular test or task.</li>\n</ul>\n<p>A new set higher order scope will always remove the lower order scope which may be in charge. So the setting of a Suite scope from a test, will set that scope to the robot file suite where that test is and removes the Test scope that may have been in place.</p>", "usages": ["Register Keyword To Run On Failure", "Set Assertion Formatters", "Set Browser Timeout", "Set Retry Assertions For", "Set Selector Prefix", "Set Strict Mode", "Show Keyword Banner"], "accepts": ["string"], "members": [{"name": "Global", "value": "1"}, {"name": "Suite", "value": "2"}, {"name": "Test", "value": "3"}, {"name": "Task", "value": "3"}]}, {"type": "Enum", "name": "ScreenshotFileTypes", "doc": "<p>Enum that defines available file types for screenshots.</p>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "png", "value": "1"}, {"name": "jpeg", "value": "2"}]}, {"type": "Enum", "name": "ScreenshotReturnType", "doc": "<p>Enum that defines what <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> keyword returns.</p>\n<ul>\n<li><code>path</code> returns the path to the screenshot file as <code>pathlib.Path</code> object.</li>\n<li><code>path_string</code> returns the path to the screenshot file as string.</li>\n<li><code>bytes</code> returns the screenshot itself as bytes.</li>\n<li><code>base64</code> returns the screenshot itself as base64 encoded string.</li>\n</ul>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "path", "value": "1"}, {"name": "path_string", "value": "2"}, {"name": "bytes", "value": "3"}, {"name": "base64", "value": "4"}]}, {"type": "Enum", "name": "ScrollBehavior", "doc": "<p>Enum that controls the behavior of scrolling.</p>\n<p><code>smooth</code></p>", "usages": ["Scroll By", "Scroll To"], "accepts": ["string"], "members": [{"name": "auto", "value": "1"}, {"name": "smooth", "value": "2"}]}, {"type": "TypedDict", "name": "ScrollPosition", "doc": "<p>Scroll position of an element.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>top</code></td>\n<td>The amount of pixel between the top border of the page and the top border of visible area.</td>\n</tr>\n<tr>\n<td><code>left</code></td>\n<td>The amount of pixel between the left border of the page and the left border of visible area.</td>\n</tr>\n<tr>\n<td><code>bottom</code></td>\n<td>The amount of pixel between the top border of the page and the bottom border of visible area.</td>\n</tr>\n<tr>\n<td><code>right</code></td>\n<td>The amount of pixel between the left border of the page and the right border of visible area.</td>\n</tr>\n</table>", "usages": ["Get Scroll Position"], "accepts": ["string", "Mapping"], "items": [{"key": "top", "type": "float", "required": true}, {"key": "left", "type": "float", "required": true}, {"key": "bottom", "type": "float", "required": true}, {"key": "right", "type": "float", "required": true}]}, {"type": "Enum", "name": "SelectAttribute", "doc": "<p>Enum that defines the attribute of an &lt;option&gt; element in a &lt;select&gt;-list.</p>\n<p>This defines by what attribute an option is selected/chosen.</p>\n<pre>\n&lt;select class=\"my_drop_down\"&gt;\n  &lt;option value=\"0: Object\"&gt;None&lt;/option&gt;\n  &lt;option value=\"1: Object\"&gt;Some&lt;/option&gt;\n  &lt;option value=\"2: Object\"&gt;Other&lt;/option&gt;\n&lt;/select&gt;\n</pre>\n<p><code>value</code> of the first option would be <code>0: Object</code>.</p>\n<p><code>label</code> / <code>text</code> both defines the innerText which would be <code>None</code> for first element.</p>\n<p><code>index</code> 0 indexed number of an option. Would be <code>0</code> for the first element.</p>", "usages": ["Get Selected Options", "Select Options By"], "accepts": ["string"], "members": [{"name": "value", "value": "1"}, {"name": "label", "value": "2"}, {"name": "text", "value": "2"}, {"name": "index", "value": "3"}]}, {"type": "Enum", "name": "SelectionStrategy", "doc": "<p>SelectionStrategy to be used. Refers to Playwrights <code>page.getBy***</code> functions. See <a href=\"https://playwright.dev/docs/locators\">Playwright Locators</a></p>\n<h3>AltText</h3>\n<p>All images should have an alt attribute that describes the image. You can locate an image based on the text alternative using page.getByAltText().</p>\n<p>For example, consider the following DOM structure.</p>\n<pre>\n&lt;img alt=\"playwright logo\" src=\"/img/playwright-logo.svg\" width=\"100\" /&gt;\n</pre>\n<h3>Label</h3>\n<p>Allows locating input elements by the text of the associated <code>&lt;label&gt;</code> or <code>aria-labelledby</code> element, or by the <code>aria-label</code> attribute.</p>\n<p>For example, this method will find inputs by label \"Username\" and \"Password\" in the following DOM:</p>\n<pre>\n&lt;input aria-label=\"Username\"&gt;\n&lt;label for=\"password-input\"&gt;Password:&lt;/label&gt;\n&lt;input id=\"password-input\"&gt;\n</pre>\n<h3>Placeholder</h3>\n<p>Allows locating input elements by the placeholder text.</p>\n<p>Example:</p>\n<pre>\n&lt;input type=\"email\" placeholder=\"name@example.com\" /&gt;\n</pre>\n<h3>TestId</h3>\n<p>Locate element by the test id.</p>\n<p>Currently only the exact attribute <code>data-testid</code> is supported.</p>\n<p>Example:</p>\n<pre>\n&lt;button data-testid=\"directions\"&gt;Itin\u00e9raire&lt;/button&gt;\n</pre>\n<h3>Text</h3>\n<p>Allows locating elements that contain given text.</p>\n<p>Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace. Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text \"Log in\" matches &lt;input type=button value=\"Log in\"&gt;.</p>\n<h3>Title</h3>\n<p>Allows locating elements by their title attribute.</p>\n<p>Example:</p>\n<pre>\n&lt;img alt=\"playwright logo\" src=\"/img/playwright-logo.svg\" title=\"Playwright\" width=\"100\" /&gt;\n</pre>", "usages": ["Get Element By"], "accepts": ["string"], "members": [{"name": "AltText", "value": "AltText"}, {"name": "Label", "value": "Label"}, {"name": "Placeholder", "value": "Placeholder"}, {"name": "TestID", "value": "TestId"}, {"name": "Text", "value": "Text"}, {"name": "Title", "value": "Title"}]}, {"type": "Enum", "name": "SelectionType", "doc": "<p>Enum that defines if the current id or all ids shall be returned.</p>\n<p><code>ACTIVE</code> / <code>CURRENT</code> defines to return only the id of the currently active instance of a Browser/Context/Page.</p>\n<p><code>ALL</code> / <code>ANY</code> defines to return ids of all instances.</p>", "usages": ["Close Browser", "Close Context", "Close Page", "Get Browser Ids", "Get Context Ids", "Get Page Ids", "Switch Context", "Switch Page"], "accepts": ["string"], "members": [{"name": "CURRENT", "value": "CURRENT"}, {"name": "ACTIVE", "value": "CURRENT"}, {"name": "ALL", "value": "ALL"}, {"name": "ANY", "value": "ALL"}]}, {"type": "TypedDict", "name": "SelectOptions", "doc": "<p>Dictionary with the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<table border=\"1\">\n<tr>\n<th>Keys</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>index</code></td>\n<td>0 based index of the option.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Value attribute of the option.</td>\n</tr>\n<tr>\n<td><code>label</code></td>\n<td>Label/Text of the option.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>Boolean if the option is selected.</td>\n</tr>\n</table>", "usages": ["Get Select Options"], "accepts": ["string", "Mapping"], "items": [{"key": "index", "type": "int", "required": true}, {"key": "value", "type": "str", "required": true}, {"key": "label", "type": "str", "required": true}, {"key": "selected", "type": "bool", "required": true}]}, {"type": "Enum", "name": "ServiceWorkersPermissions", "doc": "<p>Whether to allow sites to register Service workers.</p>\n<p><code>allow</code>: Service Workers can be registered.</p>\n<p><code>block</code>: Playwright will block all registration of Service Workers.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "allow", "value": "1"}, {"name": "block", "value": "2"}]}, {"type": "Enum", "name": "SizeFields", "doc": "<p>Enum that defines how the returned size is filtered.</p>\n<p><code>ALL</code> defines that the size is returned as a dictionary. <code>{'width': &lt;float&gt;, 'height': &lt;float&gt;}.</code></p>\n<p><code>width</code> / <code>height</code> will return a single float value of the chosen dimension.</p>", "usages": ["Get Client Size", "Get Scroll Size", "Get Viewport Size"], "accepts": ["string"], "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "ALL", "value": "3"}]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Add Cookie", "Add Style Tag", "Cancel Download", "Check Checkbox", "Clear Text", "Click", "Click With Options", "Close Browser", "Close Browser Server", "Close Context", "Close Page", "Connect To Browser", "Crawl Site", "Deselect Options", "Download", "Drag And Drop", "Drag And Drop Relative To", "Evaluate JavaScript", "Fill Secret", "Fill Text", "Focus", "Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Browser Ids", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Cookie", "Get Cookies", "Get Device", "Get Download State", "Get Element", "Get Element By", "Get Element By Role", "Get Element Count", "Get Element States", "Get Elements", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Element", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Go To", "Grant Permissions", "Handle Future Dialogs", "Highlight Elements", "Hover", "Http", "Keyboard Input", "Keyboard Key", "Launch Browser Server", "LocalStorage Clear", "LocalStorage Get Item", "LocalStorage Remove Item", "LocalStorage Set Item", "Mouse Move Relative To", "New Browser", "New Context", "New Page", "New Persistent Context", "Open Browser", "Press Keys", "Promise To", "Promise To Wait For Download", "Record Selector", "Register Keyword To Run On Failure", "Save Storage State", "Scroll By", "Scroll To", "Scroll To Element", "Select Options By", "SessionStorage Clear", "SessionStorage Get Item", "SessionStorage Remove Item", "SessionStorage Set Item", "Set Assertion Formatters", "Set Browser Timeout", "Set Retry Assertions For", "Set Selector Prefix", "Show Keyword Banner", "Switch Browser", "Switch Context", "Switch Page", "Take Screenshot", "Tap", "Type Secret", "Type Text", "Uncheck Checkbox", "Upload File By Selector", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Navigation", "Wait For Request", "Wait For Response"], "accepts": ["Any"]}, {"type": "Enum", "name": "SupportedBrowsers", "doc": "<p>Defines which browser shall be started.</p>\n<table border=\"1\">\n<tr>\n<th>Browser</th>\n<th>Browser with this engine</th>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td>Google Chrome, Microsoft Edge (since 2020), Opera</td>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td>Mozilla Firefox</td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td>Apple Safari, Mail, AppStore on MacOS and iOS</td>\n</tr>\n</table>\n<p>Since <a href=\"https://github.com/microsoft/playwright\">Playwright</a> comes with a pack of builtin binaries for all browsers, no additional drivers e.g. geckodriver are needed.</p>\n<p>All these browsers that cover more than 85% of the world wide used browsers, can be tested on Windows, Linux and MacOS. Theres is not need for dedicated machines anymore.</p>", "usages": ["__init__", "Connect To Browser", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Open Browser"], "accepts": ["string"], "members": [{"name": "chromium", "value": "1"}, {"name": "firefox", "value": "2"}, {"name": "webkit", "value": "3"}]}, {"type": "Standard", "name": "timedelta", "doc": "<p>Strings are expected to represent a time interval in one of the time formats Robot Framework supports:</p>\n<ul>\n<li>a number representing seconds like <code>42</code> or <code>10.5</code></li>\n<li>a time string like <code>1 hour 2 seconds</code> or <code>1h 2s</code></li>\n<li>a \"timer\" string like <code>01:02</code> (1 minute 2 seconds) or <code>01:00:03</code> (1 hour 3 seconds)</li>\n</ul>\n<p>Integers and floats are considered to be seconds.</p>\n<p>See the <a href=\"https://robotframework.org/robotframework/\">Robot Framework User Guide</a> for more details about the supported time formats.</p>", "usages": ["__init__", "Click With Options", "Download", "Get Console Log", "Get Page Errors", "Go To", "Highlight Elements", "Keyboard Input", "Launch Browser Server", "Mouse Button", "New Browser", "New Persistent Context", "Promise To Wait For Download", "Set Browser Timeout", "Set Retry Assertions For", "Take Screenshot", "Type Secret", "Type Text", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Load State", "Wait For Navigation", "Wait For Request", "Wait For Response", "Wait Until Network Is Idle"], "accepts": ["string", "integer", "float"]}, {"type": "TypedDict", "name": "ViewportDimensions", "doc": "<p>Viewport dimensions.</p>\n<p>Viewport is the browsers inner window size that is used to display the page.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>page width in pixels.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>page height in pixels.</td>\n</tr>\n</table>", "usages": ["Get Viewport Size", "New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "width", "type": "int", "required": true}, {"key": "height", "type": "int", "required": true}]}]}
 </script>
 <title></title>
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-106835747-3"></script><script>
diff --git a/index.html b/index.html
index 7fe1566d8..572b54e80 100644
--- a/index.html
+++ b/index.html
@@ -16,7 +16,7 @@
             </p>
             <p>
                 <h3> Old releases</h3>
-                ['<a href="versions/Browser-0.15.1.html">Browser-0.15.1.html</a>', '<a href="versions/Browser-0.16.0.html">Browser-0.16.0.html</a>', '<a href="versions/Browser-1.0.0.html">Browser-1.0.0.html</a>', '<a href="versions/Browser-1.1.1.html">Browser-1.1.1.html</a>', '<a href="versions/Browser-1.2.3.html">Browser-1.2.3.html</a>', '<a href="versions/Browser-1.2.4.html">Browser-1.2.4.html</a>', '<a href="versions/Browser-1.3.0-dev.html">Browser-1.3.0-dev.html</a>', '<a href="versions/Browser-1.3.0.html">Browser-1.3.0.html</a>', '<a href="versions/Browser-1.4.0.html">Browser-1.4.0.html</a>', '<a href="versions/Browser-1.5.0.html">Browser-1.5.0.html</a>', '<a href="versions/Browser-1.6.0.html">Browser-1.6.0.html</a>', '<a href="versions/Browser-1.7.0.html">Browser-1.7.0.html</a>', '<a href="versions/Browser-10.0.0.html">Browser-10.0.0.html</a>', '<a href="versions/Browser-10.0.1.html">Browser-10.0.1.html</a>', '<a href="versions/Browser-10.0.2.html">Browser-10.0.2.html</a>', '<a href="versions/Browser-10.1.0.html">Browser-10.1.0.html</a>', '<a href="versions/Browser-11.1.1.html">Browser-11.1.1.html</a>', '<a href="versions/Browser-11.2.0.html">Browser-11.2.0.html</a>', '<a href="versions/Browser-11.3.0.html">Browser-11.3.0.html</a>', '<a href="versions/Browser-11.4.0.html">Browser-11.4.0.html</a>', '<a href="versions/Browser-12.0.0.html">Browser-12.0.0.html</a>', '<a href="versions/Browser-12.0.1.html">Browser-12.0.1.html</a>', '<a href="versions/Browser-12.1.0.html">Browser-12.1.0.html</a>', '<a href="versions/Browser-12.2.0.html">Browser-12.2.0.html</a>', '<a href="versions/Browser-12.3.0.html">Browser-12.3.0.html</a>', '<a href="versions/Browser-12.4.0.html">Browser-12.4.0.html</a>', '<a href="versions/Browser-13.0.0.html">Browser-13.0.0.html</a>', '<a href="versions/Browser-13.1.0.html">Browser-13.1.0.html</a>', '<a href="versions/Browser-13.2.0.html">Browser-13.2.0.html</a>', '<a href="versions/Browser-13.3.0.html">Browser-13.3.0.html</a>', '<a href="versions/Browser-13.4.0.html">Browser-13.4.0.html</a>', '<a href="versions/Browser-13.6.0.html">Browser-13.6.0.html</a>', '<a href="versions/Browser-14.0.0.html">Browser-14.0.0.html</a>', '<a href="versions/Browser-14.0.1.html">Browser-14.0.1.html</a>', '<a href="versions/Browser-14.1.0.html">Browser-14.1.0.html</a>', '<a href="versions/Browser-14.2.0.html">Browser-14.2.0.html</a>', '<a href="versions/Browser-14.2.1.html">Browser-14.2.1.html</a>', '<a href="versions/Browser-14.3.0.html">Browser-14.3.0.html</a>', '<a href="versions/Browser-14.4.0.html">Browser-14.4.0.html</a>', '<a href="versions/Browser-15.0.0.html">Browser-15.0.0.html</a>', '<a href="versions/Browser-15.0.1.html">Browser-15.0.1.html</a>', '<a href="versions/Browser-15.1.0.html">Browser-15.1.0.html</a>', '<a href="versions/Browser-15.2.0.html">Browser-15.2.0.html</a>', '<a href="versions/Browser-16.0.0.html">Browser-16.0.0.html</a>', '<a href="versions/Browser-16.0.1.html">Browser-16.0.1.html</a>', '<a href="versions/Browser-16.0.2.html">Browser-16.0.2.html</a>', '<a href="versions/Browser-16.0.3.html">Browser-16.0.3.html</a>', '<a href="versions/Browser-16.0.4.html">Browser-16.0.4.html</a>', '<a href="versions/Browser-16.0.5.html">Browser-16.0.5.html</a>', '<a href="versions/Browser-16.1.0.html">Browser-16.1.0.html</a>', '<a href="versions/Browser-16.2.0.html">Browser-16.2.0.html</a>', '<a href="versions/Browser-16.3.0.html">Browser-16.3.0.html</a>', '<a href="versions/Browser-17.0.0.html">Browser-17.0.0.html</a>', '<a href="versions/Browser-17.1.0.html">Browser-17.1.0.html</a>', '<a href="versions/Browser-17.1.1.html">Browser-17.1.1.html</a>', '<a href="versions/Browser-17.2.0.html">Browser-17.2.0.html</a>', '<a href="versions/Browser-17.3.0.html">Browser-17.3.0.html</a>', '<a href="versions/Browser-17.4.0.html">Browser-17.4.0.html</a>', '<a href="versions/Browser-17.5.0.html">Browser-17.5.0.html</a>', '<a href="versions/Browser-17.5.1.html">Browser-17.5.1.html</a>', '<a href="versions/Browser-17.5.2.html">Browser-17.5.2.html</a>', '<a href="versions/Browser-18.0.0.html">Browser-18.0.0.html</a>', '<a href="versions/Browser-18.1.0.html">Browser-18.1.0.html</a>', '<a href="versions/Browser-18.2.0.html">Browser-18.2.0.html</a>', '<a href="versions/Browser-18.3.0.html">Browser-18.3.0.html</a>', '<a href="versions/Browser-2.0.0.html">Browser-2.0.0.html</a>', '<a href="versions/Browser-2.1.0.html">Browser-2.1.0.html</a>', '<a href="versions/Browser-2.3.0.html">Browser-2.3.0.html</a>', '<a href="versions/Browser-2.3.1.html">Browser-2.3.1.html</a>', '<a href="versions/Browser-2.3.2.html">Browser-2.3.2.html</a>', '<a href="versions/Browser-2.3.3.html">Browser-2.3.3.html</a>', '<a href="versions/Browser-2.3.4.html">Browser-2.3.4.html</a>', '<a href="versions/Browser-2.4.0.html">Browser-2.4.0.html</a>', '<a href="versions/Browser-2.4.1.html">Browser-2.4.1.html</a>', '<a href="versions/Browser-2.4.2.html">Browser-2.4.2.html</a>', '<a href="versions/Browser-2.5.0.html">Browser-2.5.0.html</a>', '<a href="versions/Browser-3.0.0.html">Browser-3.0.0.html</a>', '<a href="versions/Browser-3.0.1.html">Browser-3.0.1.html</a>', '<a href="versions/Browser-3.1.0.html">Browser-3.1.0.html</a>', '<a href="versions/Browser-3.1.1.html">Browser-3.1.1.html</a>', '<a href="versions/Browser-3.2.0.html">Browser-3.2.0.html</a>', '<a href="versions/Browser-3.3.0.html">Browser-3.3.0.html</a>', '<a href="versions/Browser-3.3.1.html">Browser-3.3.1.html</a>', '<a href="versions/Browser-3.3.2.html">Browser-3.3.2.html</a>', '<a href="versions/Browser-4.0.0.html">Browser-4.0.0.html</a>', '<a href="versions/Browser-4.0.1.html">Browser-4.0.1.html</a>', '<a href="versions/Browser-4.1.0.html">Browser-4.1.0.html</a>', '<a href="versions/Browser-4.2.0.html">Browser-4.2.0.html</a>', '<a href="versions/Browser-4.3.0.html">Browser-4.3.0.html</a>', '<a href="versions/Browser-4.4.0.html">Browser-4.4.0.html</a>', '<a href="versions/Browser-4.5.0.html">Browser-4.5.0.html</a>', '<a href="versions/Browser-4.5.1.html">Browser-4.5.1.html</a>', '<a href="versions/Browser-4.5.2.html">Browser-4.5.2.html</a>', '<a href="versions/Browser-5.0.0.html">Browser-5.0.0.html</a>', '<a href="versions/Browser-5.0.1.html">Browser-5.0.1.html</a>', '<a href="versions/Browser-5.1.0.html">Browser-5.1.0.html</a>', '<a href="versions/Browser-5.1.1.html">Browser-5.1.1.html</a>', '<a href="versions/Browser-5.1.2.html">Browser-5.1.2.html</a>', '<a href="versions/Browser-5.2.0.html">Browser-5.2.0.html</a>', '<a href="versions/Browser-6.0.0.html">Browser-6.0.0.html</a>', '<a href="versions/Browser-7.0.0.html">Browser-7.0.0.html</a>', '<a href="versions/Browser-7.1.0.html">Browser-7.1.0.html</a>', '<a href="versions/Browser-7.1.1.html">Browser-7.1.1.html</a>', '<a href="versions/Browser-7.2.0.html">Browser-7.2.0.html</a>', '<a href="versions/Browser-8.0.0.html">Browser-8.0.0.html</a>', '<a href="versions/Browser-8.0.1.html">Browser-8.0.1.html</a>', '<a href="versions/Browser-8.0.2.html">Browser-8.0.2.html</a>', '<a href="versions/Browser-9.0.0.html">Browser-9.0.0.html</a>', '<a href="versions/Browser-9.0.1.html">Browser-9.0.1.html</a>', '<a href="versions/Browser-9.0.2.html">Browser-9.0.2.html</a>']
+                ['<a href="versions/Browser-0.15.1.html">Browser-0.15.1.html</a>', '<a href="versions/Browser-0.16.0.html">Browser-0.16.0.html</a>', '<a href="versions/Browser-1.0.0.html">Browser-1.0.0.html</a>', '<a href="versions/Browser-1.1.1.html">Browser-1.1.1.html</a>', '<a href="versions/Browser-1.2.3.html">Browser-1.2.3.html</a>', '<a href="versions/Browser-1.2.4.html">Browser-1.2.4.html</a>', '<a href="versions/Browser-1.3.0-dev.html">Browser-1.3.0-dev.html</a>', '<a href="versions/Browser-1.3.0.html">Browser-1.3.0.html</a>', '<a href="versions/Browser-1.4.0.html">Browser-1.4.0.html</a>', '<a href="versions/Browser-1.5.0.html">Browser-1.5.0.html</a>', '<a href="versions/Browser-1.6.0.html">Browser-1.6.0.html</a>', '<a href="versions/Browser-1.7.0.html">Browser-1.7.0.html</a>', '<a href="versions/Browser-10.0.0.html">Browser-10.0.0.html</a>', '<a href="versions/Browser-10.0.1.html">Browser-10.0.1.html</a>', '<a href="versions/Browser-10.0.2.html">Browser-10.0.2.html</a>', '<a href="versions/Browser-10.1.0.html">Browser-10.1.0.html</a>', '<a href="versions/Browser-11.1.1.html">Browser-11.1.1.html</a>', '<a href="versions/Browser-11.2.0.html">Browser-11.2.0.html</a>', '<a href="versions/Browser-11.3.0.html">Browser-11.3.0.html</a>', '<a href="versions/Browser-11.4.0.html">Browser-11.4.0.html</a>', '<a href="versions/Browser-12.0.0.html">Browser-12.0.0.html</a>', '<a href="versions/Browser-12.0.1.html">Browser-12.0.1.html</a>', '<a href="versions/Browser-12.1.0.html">Browser-12.1.0.html</a>', '<a href="versions/Browser-12.2.0.html">Browser-12.2.0.html</a>', '<a href="versions/Browser-12.3.0.html">Browser-12.3.0.html</a>', '<a href="versions/Browser-12.4.0.html">Browser-12.4.0.html</a>', '<a href="versions/Browser-13.0.0.html">Browser-13.0.0.html</a>', '<a href="versions/Browser-13.1.0.html">Browser-13.1.0.html</a>', '<a href="versions/Browser-13.2.0.html">Browser-13.2.0.html</a>', '<a href="versions/Browser-13.3.0.html">Browser-13.3.0.html</a>', '<a href="versions/Browser-13.4.0.html">Browser-13.4.0.html</a>', '<a href="versions/Browser-13.6.0.html">Browser-13.6.0.html</a>', '<a href="versions/Browser-14.0.0.html">Browser-14.0.0.html</a>', '<a href="versions/Browser-14.0.1.html">Browser-14.0.1.html</a>', '<a href="versions/Browser-14.1.0.html">Browser-14.1.0.html</a>', '<a href="versions/Browser-14.2.0.html">Browser-14.2.0.html</a>', '<a href="versions/Browser-14.2.1.html">Browser-14.2.1.html</a>', '<a href="versions/Browser-14.3.0.html">Browser-14.3.0.html</a>', '<a href="versions/Browser-14.4.0.html">Browser-14.4.0.html</a>', '<a href="versions/Browser-15.0.0.html">Browser-15.0.0.html</a>', '<a href="versions/Browser-15.0.1.html">Browser-15.0.1.html</a>', '<a href="versions/Browser-15.1.0.html">Browser-15.1.0.html</a>', '<a href="versions/Browser-15.2.0.html">Browser-15.2.0.html</a>', '<a href="versions/Browser-16.0.0.html">Browser-16.0.0.html</a>', '<a href="versions/Browser-16.0.1.html">Browser-16.0.1.html</a>', '<a href="versions/Browser-16.0.2.html">Browser-16.0.2.html</a>', '<a href="versions/Browser-16.0.3.html">Browser-16.0.3.html</a>', '<a href="versions/Browser-16.0.4.html">Browser-16.0.4.html</a>', '<a href="versions/Browser-16.0.5.html">Browser-16.0.5.html</a>', '<a href="versions/Browser-16.1.0.html">Browser-16.1.0.html</a>', '<a href="versions/Browser-16.2.0.html">Browser-16.2.0.html</a>', '<a href="versions/Browser-16.3.0.html">Browser-16.3.0.html</a>', '<a href="versions/Browser-17.0.0.html">Browser-17.0.0.html</a>', '<a href="versions/Browser-17.1.0.html">Browser-17.1.0.html</a>', '<a href="versions/Browser-17.1.1.html">Browser-17.1.1.html</a>', '<a href="versions/Browser-17.2.0.html">Browser-17.2.0.html</a>', '<a href="versions/Browser-17.3.0.html">Browser-17.3.0.html</a>', '<a href="versions/Browser-17.4.0.html">Browser-17.4.0.html</a>', '<a href="versions/Browser-17.5.0.html">Browser-17.5.0.html</a>', '<a href="versions/Browser-17.5.1.html">Browser-17.5.1.html</a>', '<a href="versions/Browser-17.5.2.html">Browser-17.5.2.html</a>', '<a href="versions/Browser-18.0.0.html">Browser-18.0.0.html</a>', '<a href="versions/Browser-18.1.0.html">Browser-18.1.0.html</a>', '<a href="versions/Browser-18.2.0.html">Browser-18.2.0.html</a>', '<a href="versions/Browser-18.3.0.html">Browser-18.3.0.html</a>', '<a href="versions/Browser-18.4.0.html">Browser-18.4.0.html</a>', '<a href="versions/Browser-2.0.0.html">Browser-2.0.0.html</a>', '<a href="versions/Browser-2.1.0.html">Browser-2.1.0.html</a>', '<a href="versions/Browser-2.3.0.html">Browser-2.3.0.html</a>', '<a href="versions/Browser-2.3.1.html">Browser-2.3.1.html</a>', '<a href="versions/Browser-2.3.2.html">Browser-2.3.2.html</a>', '<a href="versions/Browser-2.3.3.html">Browser-2.3.3.html</a>', '<a href="versions/Browser-2.3.4.html">Browser-2.3.4.html</a>', '<a href="versions/Browser-2.4.0.html">Browser-2.4.0.html</a>', '<a href="versions/Browser-2.4.1.html">Browser-2.4.1.html</a>', '<a href="versions/Browser-2.4.2.html">Browser-2.4.2.html</a>', '<a href="versions/Browser-2.5.0.html">Browser-2.5.0.html</a>', '<a href="versions/Browser-3.0.0.html">Browser-3.0.0.html</a>', '<a href="versions/Browser-3.0.1.html">Browser-3.0.1.html</a>', '<a href="versions/Browser-3.1.0.html">Browser-3.1.0.html</a>', '<a href="versions/Browser-3.1.1.html">Browser-3.1.1.html</a>', '<a href="versions/Browser-3.2.0.html">Browser-3.2.0.html</a>', '<a href="versions/Browser-3.3.0.html">Browser-3.3.0.html</a>', '<a href="versions/Browser-3.3.1.html">Browser-3.3.1.html</a>', '<a href="versions/Browser-3.3.2.html">Browser-3.3.2.html</a>', '<a href="versions/Browser-4.0.0.html">Browser-4.0.0.html</a>', '<a href="versions/Browser-4.0.1.html">Browser-4.0.1.html</a>', '<a href="versions/Browser-4.1.0.html">Browser-4.1.0.html</a>', '<a href="versions/Browser-4.2.0.html">Browser-4.2.0.html</a>', '<a href="versions/Browser-4.3.0.html">Browser-4.3.0.html</a>', '<a href="versions/Browser-4.4.0.html">Browser-4.4.0.html</a>', '<a href="versions/Browser-4.5.0.html">Browser-4.5.0.html</a>', '<a href="versions/Browser-4.5.1.html">Browser-4.5.1.html</a>', '<a href="versions/Browser-4.5.2.html">Browser-4.5.2.html</a>', '<a href="versions/Browser-5.0.0.html">Browser-5.0.0.html</a>', '<a href="versions/Browser-5.0.1.html">Browser-5.0.1.html</a>', '<a href="versions/Browser-5.1.0.html">Browser-5.1.0.html</a>', '<a href="versions/Browser-5.1.1.html">Browser-5.1.1.html</a>', '<a href="versions/Browser-5.1.2.html">Browser-5.1.2.html</a>', '<a href="versions/Browser-5.2.0.html">Browser-5.2.0.html</a>', '<a href="versions/Browser-6.0.0.html">Browser-6.0.0.html</a>', '<a href="versions/Browser-7.0.0.html">Browser-7.0.0.html</a>', '<a href="versions/Browser-7.1.0.html">Browser-7.1.0.html</a>', '<a href="versions/Browser-7.1.1.html">Browser-7.1.1.html</a>', '<a href="versions/Browser-7.2.0.html">Browser-7.2.0.html</a>', '<a href="versions/Browser-8.0.0.html">Browser-8.0.0.html</a>', '<a href="versions/Browser-8.0.1.html">Browser-8.0.1.html</a>', '<a href="versions/Browser-8.0.2.html">Browser-8.0.2.html</a>', '<a href="versions/Browser-9.0.0.html">Browser-9.0.0.html</a>', '<a href="versions/Browser-9.0.1.html">Browser-9.0.1.html</a>', '<a href="versions/Browser-9.0.2.html">Browser-9.0.2.html</a>']
             </p>
         </body>
     </html>
diff --git a/releasenotes/Browser-18.5.0.rst b/releasenotes/Browser-18.5.0.rst
new file mode 100644
index 000000000..60ee319a6
--- /dev/null
+++ b/releasenotes/Browser-18.5.0.rst
@@ -0,0 +1,66 @@
+======================
+Browser library 18.5.0
+======================
+
+
+.. default-role:: code
+
+
+Browser_ is a web testing library for `Robot Framework`_ that utilizes
+the Playwright_ tool internally. Browser library 18.5.0 is a new release with
+which has Playwright 1.44.0 and bug fix to rfbrowser --version command. Also
+there is small refactoring to creating Docker container. All issues targeted
+for Browser library v18.5.0 can be found from the `issue tracker`_.
+For first time installation with pip_, just run
+::
+   pip install robotframework-browser
+   rfbrowser init
+to install the latest available release. If you upgrading
+from previous release with pip_, run
+::
+   pip install --upgrade robotframework-browser
+   rfbrowser clean-node
+   rfbrowser init
+Alternatively you can download the source distribution from PyPI_ and
+install it manually. Browser library 18.5.0 was released on Thursday May 16, 2024.
+Browser supports Python 3.8+, Node 18/20 LTS and Robot Framework 5.0+.
+Library was tested with Playwright 1.44.0
+
+.. _Robot Framework: http://robotframework.org
+.. _Browser: https://github.com/MarketSquare/robotframework-browser
+.. _Playwright: https://github.com/microsoft/playwright
+.. _pip: http://pip-installer.org
+.. _PyPI: https://pypi.python.org/pypi/robotframework-browser
+.. _issue tracker: https://github.com/MarketSquare/robotframework-browser/milestones/v18.5.0
+
+
+.. contents::
+   :depth: 2
+   :local:
+
+Most important enhancements
+===========================
+
+rfbrowser --version fails with exception from  (`#3600`_)
+---------------------------------------------------------
+New priting out version does not fail.
+
+
+Full list of fixes and enhancements
+===================================
+
+.. list-table::
+    :header-rows: 1
+
+    * - ID
+      - Type
+      - Priority
+      - Summary
+    * - `#3600`_
+      - bug
+      - critical
+      - rfbrowser --version fails with exception from
+
+Altogether 1 issue. View on the `issue tracker <https://github.com/MarketSquare/robotframework-browser/issues?q=milestone%3Av18.5.0>`__.
+
+.. _#3600: https://github.com/MarketSquare/robotframework-browser/issues/3600
diff --git a/versions/Browser-18.4.0.html b/versions/Browser-18.4.0.html
new file mode 100644
index 000000000..dabcaec0b
--- /dev/null
+++ b/versions/Browser-18.4.0.html
@@ -0,0 +1,1873 @@
+<!DOCTYPE html>
+
+<html id="library-documentation-top" lang="en">
+<head>
+<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
+<meta content="width=device-width, initial-scale=1.0, maximum-scale=1, user-scalable=0" name="viewport"/>
+<meta content="no-cache" http-equiv="Pragma"/>
+<meta content="-1" http-equiv="Expires"/>
+<meta content="IE=edge" http-equiv="X-UA-Compatible"/>
+<meta content="Robot Framework 7.0 (Python 3.11.6 on darwin)" name="Generator"/>
+<link href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKcAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAqAAAAAAAAAAAAAAAAAAAALIAAAD/AAAA4AAAANwAAADcAAAA3AAAANwAAADcAAAA3AAAANwAAADcAAAA4AAAAP8AAACxAAAAAAAAAKYAAAD/AAAAuwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC/AAAA/wAAAKkAAAD6AAAAzAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN8AAAD/AAAA+gAAAMMAAAAAAAAAAgAAAGsAAABrAAAAawAAAGsAAABrAAAAawAAAGsAAABrAAAADAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAIsAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAANEAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAAAAAAAAMgAAADIAAAAyAAAAMgAAADIAAAAyAAAAMgAAADIAAAAFAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAADwAAAB8AAAAAAAAAGAAAABcAAAAAAAAAH8AAABKAAAAAAAAAAAAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAADCAAAA/wAAACkAAADqAAAA4QAAAAAAAAD7AAAA/wAAALAAAAAGAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAIwAAAP4AAAD/AAAA/wAAAGAAAAAAAAAAAAAAAMkAAAD/AAAAigAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAAAAAAAIAAAAcAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAEgAAAAAAAAAAAAAA2gAAAP8AAAD7AAAAywAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN4AAAD/AAAAqwAAAP8AAACvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALIAAAD/AAAAsgAAAAAAAAC5AAAA/wAAAMoAAADAAAAAwAAAAMAAAADAAAAAwAAAAMAAAADAAAAAwAAAAMkAAAD/AAAAvAAAAAAAAAAAAAAAAAAAAKwAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAArQAAAAAAAAAAwAMAAIABAAAf+AAAP/wAAD/8AAAgBAAAP/wAAD/8AAA//AAAJIwAADHEAAA//AAAP/wAAB/4AACAAQAAwAMAAA==" rel="icon" type="image/x-icon"/>
+<style media="all">
+:root {
+    --background-color: white;
+    --text-color: black;
+    --border-color: #e0e0e2;
+    --light-background-color: #f3f3f3;
+    --robot-highlight: #00c0b5;
+    --highlighted-color: var(--text-color);
+    --highlighted-background-color: yellow;
+    --less-important-text-color: gray;
+    --link-color: #0000ee;
+}
+[data-theme="dark"] {
+    --background-color: #1c2227;
+    --text-color: #e2e1d7;
+    --border-color: #4e4e4e;
+    --light-background-color: #002b36;
+    --robot-highlight: yellow;
+    --highlighted-color: var(--background-color);
+    --highlighted-background-color: yellow;
+    --less-important-text-color: #5b6a6f;
+    --link-color: #52adff;
+    color-scheme: dark;
+}
+body {
+    background: var(--background-color);
+    color: var(--text-color);
+    margin: 0;
+    font-family: system-ui, -apple-system, sans-serif;
+}
+input, button, select {
+    background: var(--background-color);
+    color: var(--text-color);
+}
+a {
+    color: var(--link-color);
+}
+.base-container {
+    display: flex;
+}
+.libdoc-overview {
+    height: 100vh;
+    display: flex;
+    flex-direction: column;
+    background: white;
+    background: var(--background-color);
+    position: -webkit-sticky; /* Safari */
+    position: sticky;
+    top: 0;
+}
+.libdoc-overview h4 {
+    margin-bottom: 0.5rem;
+    margin-top: 0.5rem;
+}
+.keyword-search-box {
+    display: flex;
+    justify-content: space-between;
+    height: 30px;
+    border: 1px solid var(--border-color);
+    border-radius: 3px;
+    margin-top: 0.5rem;
+}
+#tags-shortcuts-container {
+    margin-top: 0.5rem;
+    height: 30px;
+    border: 1px solid var(--border-color);
+    border-radius: 3px;
+}
+.search-input {
+    flex: 1;
+    border: none;
+    text-indent: 4px;
+}
+.clear-search {
+    border: none;
+}
+#shortcuts-container {
+    display: flex;
+    flex-direction: column;
+    height: 100%;
+}
+.libdoc-details {
+    margin-top: 60px;
+    padding-left: 2%;
+    padding-right: 2%;
+    overflow: auto;
+    max-width: 1000px;
+}
+.libdoc-title {
+    position: fixed;
+    left: 0;
+    top: 0;
+    width: 300px;
+    height: 36px;
+    padding: 0.5rem;
+    margin: 0.5rem;
+    display: flex;
+    align-items: center;
+    text-decoration: none;
+    color: var(--text-color);
+}
+.hamburger-menu {
+    display: none;
+    position: fixed;
+    z-index: 100;
+}
+input.hamburger-menu
+{
+  display: none;
+  width: 67px;
+  height: 46px;
+  position: fixed;
+  top: 0;
+  right: 0;
+  cursor: pointer;
+  opacity: 0;
+  z-index: 2;
+  -webkit-touch-callout: none;
+}
+span.hamburger-menu
+{
+  width: 31px;
+  height: 2px;
+  margin-bottom: 5px;
+  position: fixed;
+  right: 20px;
+  background: black;
+  background: var(--text-color);
+  border-radius: 2px;
+  z-index: 1;
+  transform-origin: 4px 0;
+  transition: transform 0.3s cubic-bezier(0.77,0.2,0.05,1.0),
+              opacity 0.35s ease;
+}
+span.hamburger-menu-1
+{
+    top: 14px;
+    transform-origin: 0 0;
+}
+span.hamburger-menu-2
+{
+    top: 24px;
+}
+span.hamburger-menu-3
+{
+    top: 34px;
+    transform-origin: 0 100%;
+}
+input.hamburger-menu:checked ~ span.hamburger-menu-1
+{
+  opacity: 1;
+  transform: rotate(45deg) translate(2px, -3px);
+  background: var(--text-color);
+}
+input.hamburger-menu:checked ~ span.hamburger-menu-2
+{
+  opacity: 0;
+  transform: rotate(0deg) scale(0.2, 0.2);
+}
+input.hamburger-menu:checked ~ span.hamburger-menu-3
+{
+  transform: rotate(-45deg) translate(2px, 3px);
+  background: var(--text-color);
+}
+.libdoc-title > svg {
+    padding-top: 2px;
+    height: 42px;
+    width: 42px;
+}
+#robot-svg-path {
+    fill: var(--text-color);
+    stroke: none;
+    fill-opacity:1;
+    fill-rule:nonzero;
+}
+.keywords-overview {
+    display: flex;
+    flex-direction: column;
+    height: 0;
+    max-height: calc(100vh - 60px - 0.5rem);
+    flex: 1;
+    border: 1px solid var(--border-color);
+    border-radius: 3px;
+    padding-right: 0.5rem;
+    padding-left: 0.5rem;
+    margin: 60px 0 0.5rem 0.5rem;
+}
+.keywords-overview-header-row {
+    display: flex;
+    justify-content: space-between;
+}
+.shortcuts {
+    font-size: 0.9em;
+    overflow: auto;
+    list-style: none;
+    padding-left: 0;
+    margin: 0;
+    flex: 1;
+    max-width: 320px;
+}
+.shortcuts.keyword-wall{
+    flex: unset;
+}
+.shortcuts a {
+    display: block;
+    text-decoration: none;
+    white-space: nowrap;
+    color: var(--text-color);
+    padding: 0.5rem;
+}
+.shortcuts a:hover {
+    background: var(--light-background-color);
+}
+.shortcuts a::first-letter {
+    font-weight: bold;
+    letter-spacing: 0.1em;
+}
+.shortcuts.keyword-wall a {
+    padding: 0;
+    padding-right: 0.5rem;
+    padding-bottom: 0.5rem;
+}
+.shortcuts.keyword-wall a::after {
+    content: '·';
+    padding-left: 0.5rem;
+}
+.enum-type-members, .dt-usages-list {
+    list-style: none;
+    padding-left: 1em;
+}
+.dt-usages-list > li {
+    margin-bottom: 0.2em;
+}
+.dt-usages a {
+    text-decoration: none;
+    color: var(--text-color);
+    display: inline-block;
+    font-size: 0.9em;
+}
+.dt-usages a::first-letter {
+    font-weight: bold;
+    letter-spacing: 0.1em;
+}
+.arguments-list-container {
+    overflow-y: auto;
+    margin-bottom: 1.33rem;
+}
+.arguments-list {
+    display: -ms-inline-grid;
+    display: inline-grid;
+    -ms-grid-columns: 1fr 1fr 1fr;
+    grid-template-columns: auto auto auto;
+    row-gap: 3px;
+}
+.typed-dict-annotation > span,
+.enum-type-members span,
+.arguments-list .arg-name {
+    -ms-grid-column: 1;
+    grid-column: 1;
+    border-radius: 3px;
+    white-space: nowrap;
+    padding-left: 0.5rem;
+    padding-right: 0.5rem;
+    justify-self: start;
+}
+.arguments-list .arg-default-container {
+    -ms-grid-column: 2;
+    grid-column: 2;
+    display: flex;
+}
+.optional-key {
+    font-style: italic;
+}
+.arguments-list .arg-default-eq {
+    margin-left: 2rem;
+    margin-right: 0.5rem;
+    background: var(--background-color);
+}
+.arguments-list .arg-default-value {
+    padding-left: 0.5rem;
+    padding-right: 0.5rem;
+    border-radius: 3px;
+}
+.arguments-list .base-arg-data {
+    display: flex;
+    min-width: 150px;
+}
+.arguments-list .arg-type,
+.return-type .arg-type {
+    margin-left: 2rem;
+    -ms-grid-column: 3;
+    grid-column: 3;
+    background: var(--background-color);
+    white-space: nowrap;
+    -webkit-text-size-adjust: none;
+}
+.tags .kw-tags {
+    margin-left: 2rem;
+    display: flex;
+}
+.arguments-list .arg-kind {
+  color: transparent;
+  text-shadow: 0 0 0 var(--less-important-text-color);
+  padding: 0;
+  font-size: 0.8em;
+}
+@media only screen and (min-width: 900px) {
+    .libdoc-details {
+        z-index: 1;
+        background: var(--background-color);
+    }
+    #toggle-keyword-shortcuts {
+        border: 1px solid var(--border-color);
+        border-radius: 3px;
+        margin-top: 3px;
+        margin-bottom: 3px;
+    }
+    #toggle-keyword-shortcuts:hover {
+        background: var(--light-background-color);
+    }
+    .shortcuts.keyword-wall {
+        display: flex;
+        flex-wrap: wrap;
+        width: 320px;
+        max-width: none;
+    }
+}
+@media only screen and (min-width: 1200px) {
+    .shortcuts.keyword-wall {
+        width: 640px;
+    }
+}
+@media only screen and (max-width: 899px) {
+    .libdoc-overview {
+        display: none;
+    }
+    #toggle-keyword-shortcuts {
+        display: none;
+    }
+    .libdoc-title {
+        width: 100%;
+        padding: 0.5rem;
+        margin: 0;
+        border-bottom: 1px solid var(--border-color);
+        background: white;
+        background: var(--background-color);
+    }
+    .libdoc-title > svg {
+        margin-right: 60px;
+    }
+    .libdoc-details {
+        padding-left: 0.5rem;
+    }
+    input.hamburger-menu {
+        display: block;
+    }
+    .hamburger-menu {
+        display: block;
+    }
+    .hamburger-menu:checked ~ .libdoc-overview {
+        display: block;
+        position: fixed;
+        height: 100vh;
+        width: 100%;
+    }
+    .keywords-overview {
+        border: none;
+        margin: 60px 0 0;
+    }
+    .shortcuts {
+        max-width: 100vw;
+        overscroll-behavior: none;
+    }
+}
+.metadata {
+    margin-top: 0.5rem;
+ }
+.metadata th {
+    text-align: left;
+    padding-right: 1em;
+}
+a.name, span.name {
+    font-style: italic;
+}
+.libdoc-details a img {
+    border: 1px solid #c30 !important;
+}
+a:hover, a:active {
+    text-decoration: underline;
+    color: var(--text-color);
+}
+a:hover {
+    text-decoration: underline !important;
+}
+.normal-first-letter::first-letter {
+    font-weight: normal !important;
+    letter-spacing: 0 !important;
+}
+.shortcut-list-toggle, .tag-list-toggle {
+    margin-bottom: 1em;
+    font-size: 0.9em;
+}
+input.switch {
+    display: none;
+}
+.slider {
+    background-color: var(--border-color);
+    display: inline-block;
+    position: relative;
+    top: 5px;
+    height: 18px;
+    width: 36px;
+}
+.slider:before {
+    background-color: var(--background-color);
+    content: "";
+    position: absolute;
+    top: 3px;
+    left: 3px;
+    height: 12px;
+    width: 12px;
+}
+input.switch:checked + .slider::before {
+    background-color: var(--background-color);
+    left: 21px;
+}
+.keywords {
+    display: flex;
+    flex-direction: column;
+}
+.kw-overview {
+    display: flex;
+    flex-direction: column;
+    justify-content: start;
+}
+@media only screen and (min-width: 899px) {
+    .kw-overview {
+        max-width: 850px;
+        margin-right: 1.5rem;
+    }
+}
+.kw-docs {
+    display: flex;
+    flex-direction: column;
+    overflow-y: auto;
+}
+.dt-name:link,
+.kw-name:link {
+    text-decoration: none;
+    color: var(--text-color);
+}
+.dt-name:visited,
+.kw-name:visited {
+    text-decoration: none;
+    color: var(--text-color);
+}
+.kw {
+    display: flex;
+    align-items: baseline;
+    min-width: 250px
+}
+h4 {
+    margin-right: 0.5rem;
+}
+.keyword-container {
+    border: 1px solid var(--border-color);
+    border-radius: 3px;
+    padding: 0.5rem 1.0rem 0.5rem 1.0rem;
+    margin-bottom: 0.5rem;
+    display: flex;
+    flex-direction: column;
+    scroll-margin-top: 60px;
+}
+.keyword-container:target {
+    box-shadow: 0 0 4px var(--robot-highlight);
+}
+.data-type-content,
+.keyword-content {
+    display: flex;
+    flex-direction: column;
+}
+.data-type-container {
+    border-top: 1px solid var(--border-color);
+    padding: 0.5rem 1.0rem 0.5rem 1.0rem;
+    margin-bottom: 0.5rem;
+    display: flex;
+    flex-direction: column;
+    scroll-margin-top: 60px;
+}
+.kw-row {
+    display: flex;
+    flex-direction: column;
+    text-decoration: none;
+    justify-content: start;
+    border: 1px solid var(--border-color);
+    border-radius: 3px;
+    padding: 0.5rem 1.0rem 0.5rem 1.0rem;
+    margin-bottom: 0.5rem;
+}
+.kw a {
+    color: inherit;
+    text-decoration: none;
+    font-weight: bold;
+}
+.args {
+    min-width: 200px;
+}
+.enum-type-members span,
+.args span,
+.return-type span,
+.args a
+ {
+    font-family: monospace;
+    background: var(--light-background-color);
+    padding: 0 0.1em;
+    font-size: 1.1em;
+}
+.arg-type,
+span.type,
+a.type {
+    font-size: 1em;
+    background: none;
+    padding: 0 0
+}
+.typed-dict-item .td-type::after {
+    content: ',';
+}
+.typed-dict-item .td-type:nth-last-child(2)::after {
+    content: '';
+}
+.td-item::before {
+    content: '  ';
+    white-space: pre;
+}
+.typed-dict-item {
+    display: block;
+    padding: 0.4rem;
+    font-family: monospace;
+    background: var(--light-background-color);
+    font-size: 1.1em;
+}
+.args span .highlight {
+    background: var(--highlighted-background-color);
+    color: var(--highlighted-color);
+}
+.tags, .return-type {
+    display: flex;
+    align-items: baseline;
+}
+.tags a {
+    color: inherit;
+    text-decoration: none;
+    padding: 0 0.1em;
+}
+.footer {
+    font-size: 0.9em;
+}
+.doc div > *:last-child {
+    margin-bottom: 0;
+}
+.highlight {
+    background: var(--highlighted-background-color);
+    color: var(--highlighted-color);
+}
+.data-type {
+    font-style: italic;
+}
+.no-match {
+    color: var(--less-important-text-color) !important;
+}
+.no-match .dt-name,
+.no-match .kw-name {
+    color: var(--less-important-text-color);
+}
+.modal-icon {
+    cursor: pointer;
+    font-size: 12px;
+    font-weight: 600;
+    margin: 0 0.25rem;
+    width: 1rem;
+    height: 1rem;
+    padding: 0;
+    border: none;
+    background: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" height="100%" width="100%"><path stroke="black" fill="none" stroke-width="2px" stroke-linecap="round" d="M1 8 L1 1 L8 1 M16 1 L23 1 L23 8 M23 16 L23 23 L16 23 M8 23 L1 23 L1 16"></path><path fill="black" stroke="none" stroke-width="1px" transform="scale(1.3) translate(-3 -2.5)" d="M19 7.97zm-8 9.2-4-2.3v-4.63l4 2.33v4.6zm1-6.33L8.04 8.53 12 6.25l3.96 2.28L12 10.84zm5 4.03-4 2.3v-4.6l4-2.33v4.63z"></path></svg>');
+}
+@media (prefers-color-scheme: dark) {
+    .modal-icon {
+        background: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" height="100%" width="100%"><path stroke="%23e2e1d7" fill="none" stroke-width="2px" stroke-linecap="round" d="M1 8 L1 1 L8 1 M16 1 L23 1 L23 8 M23 16 L23 23 L16 23 M8 23 L1 23 L1 16"></path><path fill="%23e2e1d7" stroke="none" stroke-width="1px" transform="scale(1.3) translate(-3 -2.5)" d="M19 7.97zm-8 9.2-4-2.3v-4.63l4 2.33v4.6zm1-6.33L8.04 8.53 12 6.25l3.96 2.28L12 10.84zm5 4.03-4 2.3v-4.6l4-2.33v4.63z"></path></svg>');
+    }
+}
+.modal-background, .modal {
+    opacity: 0;
+    pointer-events: none;
+    transition: opacity 0.2s;
+}
+.modal-background {
+    position: fixed;
+    top: 0;
+    right: 0;
+    bottom: 0;
+    left: 0;
+    background-color: rgba(0, 0, 0, 0.7);
+    z-index: 1;
+}
+.modal {
+    display: flex;
+    flex-wrap: nowrap;
+    flex-direction: column;
+    width: 720px;
+    max-width: calc(100vw - 2rem);
+    margin: 0 auto;
+    height: calc(100vh - 6rem);
+    overflow: auto;
+    background-color: var(--background-color);
+    border: 1px solid var(--border-color);
+    border-radius: 3px;
+    z-index: 2;
+    transition-delay: 0.1s;
+}
+.modal-content {
+    margin-bottom: 3rem;
+}
+.modal > .modal-content > .data-type-container {
+    border-top: none;
+}
+.modal-close-button-wrapper {
+    display: flex;
+    justify-content: flex-end;
+}
+.modal-close-button-container {
+    width: 720px;
+    max-width: calc(100vw - 2rem);
+    margin: 0 auto;
+    overflow: auto;
+}
+.modal-close-button {
+    margin: 0.5rem 0;
+    padding: 0.25rem 0.5rem;
+    border-radius:3px;
+    border: 1px solid var(--border-color);
+    cursor: pointer;
+}
+.modal-background.visible, .modal.visible {
+    opacity: 1;
+    pointer-events: all;
+}
+#data-types-container {
+    display: none;
+}
+</style>
+<style media="all">
+/* Pygments 'default' style sheet. Generated with Pygments 2.1.3 using:
+    pygmentize -S default -f html -a .code > src/robot/htmldata/libdoc/pygments.css
+    and added for dark mode
+    @media (prefers-color-scheme: dark)
+    pygmentize -S solarized-dark -f html -a .code > src/robot/htmldata/libdoc/pygments.css
+*/
+.code .hll { background-color: #ffffcc }
+.code  { background: #f8f8f8; }
+.code .c { color: #408080; font-style: italic } /* Comment */
+.code .err { border: 1px solid #FF0000 } /* Error */
+.code .k { color: #008000; font-weight: bold } /* Keyword */
+.code .o { color: #666666 } /* Operator */
+.code .ch { color: #408080; font-style: italic } /* Comment.Hashbang */
+.code .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+.code .cp { color: #BC7A00 } /* Comment.Preproc */
+.code .cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */
+.code .c1 { color: #408080; font-style: italic } /* Comment.Single */
+.code .cs { color: #408080; font-style: italic } /* Comment.Special */
+.code .gd { color: #A00000 } /* Generic.Deleted */
+.code .ge { font-style: italic } /* Generic.Emph */
+.code .gr { color: #FF0000 } /* Generic.Error */
+.code .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.code .gi { color: #00A000 } /* Generic.Inserted */
+.code .go { color: #888888 } /* Generic.Output */
+.code .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+.code .gs { font-weight: bold } /* Generic.Strong */
+.code .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.code .gt { color: #0044DD } /* Generic.Traceback */
+.code .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
+.code .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
+.code .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
+.code .kp { color: #008000 } /* Keyword.Pseudo */
+.code .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
+.code .kt { color: #B00040 } /* Keyword.Type */
+.code .m { color: #666666 } /* Literal.Number */
+.code .s { color: #BA2121 } /* Literal.String */
+.code .na { color: #7D9029 } /* Name.Attribute */
+.code .nb { color: #008000 } /* Name.Builtin */
+.code .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.code .no { color: #880000 } /* Name.Constant */
+.code .nd { color: #AA22FF } /* Name.Decorator */
+.code .ni { color: #999999; font-weight: bold } /* Name.Entity */
+.code .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+.code .nf { color: #0000FF } /* Name.Function */
+.code .nl { color: #A0A000 } /* Name.Label */
+.code .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.code .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.code .nv { color: #19177C } /* Name.Variable */
+.code .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.code .w { color: #bbbbbb } /* Text.Whitespace */
+.code .mb { color: #666666 } /* Literal.Number.Bin */
+.code .mf { color: #666666 } /* Literal.Number.Float */
+.code .mh { color: #666666 } /* Literal.Number.Hex */
+.code .mi { color: #666666 } /* Literal.Number.Integer */
+.code .mo { color: #666666 } /* Literal.Number.Oct */
+.code .sa { color: #BA2121 } /* Literal.String.Affix */
+.code .sb { color: #BA2121 } /* Literal.String.Backtick */
+.code .sc { color: #BA2121 } /* Literal.String.Char */
+.code .dl { color: #BA2121 } /* Literal.String.Delimiter */
+.code .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
+.code .s2 { color: #BA2121 } /* Literal.String.Double */
+.code .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+.code .sh { color: #BA2121 } /* Literal.String.Heredoc */
+.code .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+.code .sx { color: #008000 } /* Literal.String.Other */
+.code .sr { color: #BB6688 } /* Literal.String.Regex */
+.code .s1 { color: #BA2121 } /* Literal.String.Single */
+.code .ss { color: #19177C } /* Literal.String.Symbol */
+.code .bp { color: #008000 } /* Name.Builtin.Pseudo */
+.code .fm { color: #0000FF } /* Name.Function.Magic */
+.code .vc { color: #19177C } /* Name.Variable.Class */
+.code .vg { color: #19177C } /* Name.Variable.Global */
+.code .vi { color: #19177C } /* Name.Variable.Instance */
+.code .vm { color: #19177C } /* Name.Variable.Magic */
+.code .il { color: #666666 } /* Literal.Number.Integer.Long */
+@media (prefers-color-scheme: dark) {
+    .code .hll { background-color: #073642 }
+    .code  { background: #002b36; color: #839496 }
+    .code .c { color: #586e75; font-style: italic } /* Comment */
+    .code .err { color: #839496; background-color: #dc322f } /* Error */
+    .code .esc { color: #839496 } /* Escape */
+    .code .g { color: #839496 } /* Generic */
+    .code .k { color: #859900 } /* Keyword */
+    .code .l { color: #839496 } /* Literal */
+    .code .n { color: #839496 } /* Name */
+    .code .o { color: #586e75 } /* Operator */
+    .code .x { color: #839496 } /* Other */
+    .code .p { color: #839496 } /* Punctuation */
+    .code .ch { color: #586e75; font-style: italic } /* Comment.Hashbang */
+    .code .cm { color: #586e75; font-style: italic } /* Comment.Multiline */
+    .code .cp { color: #d33682 } /* Comment.Preproc */
+    .code .cpf { color: #586e75 } /* Comment.PreprocFile */
+    .code .c1 { color: #586e75; font-style: italic } /* Comment.Single */
+    .code .cs { color: #586e75; font-style: italic } /* Comment.Special */
+    .code .gd { color: #dc322f } /* Generic.Deleted */
+    .code .ge { color: #839496; font-style: italic } /* Generic.Emph */
+    .code .gr { color: #dc322f } /* Generic.Error */
+    .code .gh { color: #839496; font-weight: bold } /* Generic.Heading */
+    .code .gi { color: #859900 } /* Generic.Inserted */
+    .code .go { color: #839496 } /* Generic.Output */
+    .code .gp { color: #839496 } /* Generic.Prompt */
+    .code .gs { color: #839496; font-weight: bold } /* Generic.Strong */
+    .code .gu { color: #839496; text-decoration: underline } /* Generic.Subheading */
+    .code .gt { color: #268bd2 } /* Generic.Traceback */
+    .code .kc { color: #2aa198 } /* Keyword.Constant */
+    .code .kd { color: #2aa198 } /* Keyword.Declaration */
+    .code .kn { color: #cb4b16 } /* Keyword.Namespace */
+    .code .kp { color: #859900 } /* Keyword.Pseudo */
+    .code .kr { color: #859900 } /* Keyword.Reserved */
+    .code .kt { color: #b58900 } /* Keyword.Type */
+    .code .ld { color: #839496 } /* Literal.Date */
+    .code .m { color: #2aa198 } /* Literal.Number */
+    .code .s { color: #2aa198 } /* Literal.String */
+    .code .na { color: #839496 } /* Name.Attribute */
+    .code .nb { color: #268bd2 } /* Name.Builtin */
+    .code .nc { color: #268bd2 } /* Name.Class */
+    .code .no { color: #268bd2 } /* Name.Constant */
+    .code .nd { color: #268bd2 } /* Name.Decorator */
+    .code .ni { color: #268bd2 } /* Name.Entity */
+    .code .ne { color: #268bd2 } /* Name.Exception */
+    .code .nf { color: #268bd2 } /* Name.Function */
+    .code .nl { color: #268bd2 } /* Name.Label */
+    .code .nn { color: #268bd2 } /* Name.Namespace */
+    .code .nx { color: #839496 } /* Name.Other */
+    .code .py { color: #839496 } /* Name.Property */
+    .code .nt { color: #268bd2 } /* Name.Tag */
+    .code .nv { color: #268bd2 } /* Name.Variable */
+    .code .ow { color: #859900 } /* Operator.Word */
+    .code .w { color: #839496 } /* Text.Whitespace */
+    .code .mb { color: #2aa198 } /* Literal.Number.Bin */
+    .code .mf { color: #2aa198 } /* Literal.Number.Float */
+    .code .mh { color: #2aa198 } /* Literal.Number.Hex */
+    .code .mi { color: #2aa198 } /* Literal.Number.Integer */
+    .code .mo { color: #2aa198 } /* Literal.Number.Oct */
+    .code .sa { color: #2aa198 } /* Literal.String.Affix */
+    .code .sb { color: #2aa198 } /* Literal.String.Backtick */
+    .code .sc { color: #2aa198 } /* Literal.String.Char */
+    .code .dl { color: #2aa198 } /* Literal.String.Delimiter */
+    .code .sd { color: #586e75 } /* Literal.String.Doc */
+    .code .s2 { color: #2aa198 } /* Literal.String.Double */
+    .code .se { color: #2aa198 } /* Literal.String.Escape */
+    .code .sh { color: #2aa198 } /* Literal.String.Heredoc */
+    .code .si { color: #2aa198 } /* Literal.String.Interpol */
+    .code .sx { color: #2aa198 } /* Literal.String.Other */
+    .code .sr { color: #cb4b16 } /* Literal.String.Regex */
+    .code .s1 { color: #2aa198 } /* Literal.String.Single */
+    .code .ss { color: #2aa198 } /* Literal.String.Symbol */
+    .code .bp { color: #268bd2 } /* Name.Builtin.Pseudo */
+    .code .fm { color: #268bd2 } /* Name.Function.Magic */
+    .code .vc { color: #268bd2 } /* Name.Variable.Class */
+    .code .vg { color: #268bd2 } /* Name.Variable.Global */
+    .code .vi { color: #268bd2 } /* Name.Variable.Instance */
+    .code .vm { color: #268bd2 } /* Name.Variable.Magic */
+    .code .il { color: #2aa198 } /* Literal.Number.Integer.Long */
+}
+</style>
+<style media="print">
+body {
+    margin: 0;
+    padding: 0;
+    font-size: 8pt;
+}
+a {
+    text-decoration: none;
+}
+#search, #open-search {
+    display: none;
+}
+</style>
+<style media="all">
+#javascript-disabled {
+    width: 600px;
+    margin: 100px auto 0 auto;
+    padding: 20px;
+    color: black;
+    border: 1px solid #ccc;
+    background: #eee;
+}
+#javascript-disabled h1 {
+    width: 100%;
+    float: none;
+}
+#javascript-disabled ul {
+    font-size: 1.2em;
+}
+#javascript-disabled li {
+    margin: 0.5em 0;
+}
+#javascript-disabled b {
+    font-style: italic;
+}
+</style>
+<style media="all">
+#introduction-container > h2,
+.doc > h1,
+.doc > h2,
+.section > h1,
+.section > h2 {
+    margin-top: 4rem;
+    margin-bottom: 1rem;
+}
+.doc > h3, .section > h3 {
+    margin-top: 3rem;
+    margin-bottom: 1rem;
+}
+.doc > h4, .section > h4 {
+    margin-top: 2rem;
+    margin-bottom: 1rem;
+}
+.doc > p, .section > p {
+    margin-top: 1rem;
+    margin-bottom: 0.5rem;
+}
+.doc > *:first-child {
+    margin-top: 0.1em;
+}
+.doc table {
+    border: none;
+    background: transparent;
+    border-collapse: collapse;
+    empty-cells: show;
+    font-size: 0.9em;
+    overflow-y: auto;
+    display: block;
+}
+.doc table th, .doc table td {
+    border: 1px solid var(--border-color);
+    background: transparent;
+    padding: 0.1em 0.3em;
+    height: 1.2em;
+}
+.doc table th {
+    text-align: center;
+    letter-spacing: 0.1em;
+}
+.doc pre {
+    font-size: 1.1em;
+    letter-spacing: 0.05em;
+    background: var(--light-background-color);
+    overflow-y: auto;
+    padding: 0.3rem;
+    border-radius: 3px;
+}
+.doc code,
+.docutils.literal {
+    font-size: 1.1em;
+    letter-spacing: 0.05em;
+    background: var(--light-background-color);
+    padding: 1px;
+    border-radius: 3px;
+}
+.doc li {
+    list-style-position: inside;
+    list-style-type: square;
+}
+.doc img {
+    border: 1px solid #ccc;
+}
+.doc hr {
+    background: #ccc;
+    height: 1px;
+    border: 0;
+}
+</style>
+<script type="text/javascript">
+storage = function () {
+    var prefix = 'robot-framework-';
+    var storage;
+    function init(user) {
+        if (user)
+            prefix += user + '-';
+        storage = getStorage();
+    }
+    function getStorage() {
+        // Use localStorage if it's accessible, normal object otherwise.
+        // Inspired by https://stackoverflow.com/questions/11214404
+        try {
+            localStorage.setItem(prefix, prefix);
+            localStorage.removeItem(prefix);
+            return localStorage;
+        } catch (exception) {
+            return {};
+        }
+    }
+    function get(key, defaultValue) {
+        var value = storage[fullKey(key)];
+        if (typeof value === 'undefined')
+            return defaultValue;
+        return value;
+    }
+    function set(key, value) {
+        storage[fullKey(key)] = value;
+    }
+    function fullKey(key) {
+        return prefix + key;
+    }
+    return {init: init, get: get, set: set, fullKey: fullKey};
+}();
+</script>
+<script type="text/javascript">
+window.util = function () {
+    function map(elems, func) {
+        var ret = [];
+        for (var i = 0, len = elems.length; i < len; i++) {
+            ret[i] = func(elems[i]);
+        }
+        return ret;
+    }
+    function filter(elems, predicate) {
+        var ret = [];
+        for (var i = 0, len = elems.length; i < len; i++) {
+            if (predicate(elems[i]))
+                ret.push(elems[i]);
+        }
+        return ret;
+    }
+    function all(elems) {
+        for (var i = 0, len = elems.length; i < len; i++) {
+            if (!elems[i])
+                return false;
+        }
+        return true;
+    }
+    function any(elems) {
+        for (var i = 0, len = elems.length; i < len; i++) {
+            if (elems[i])
+                return elems[i];
+        }
+        return false;
+    }
+    function contains(elems, e) {
+        for (var i = 0, len = elems.length; i < len; i++) {
+            if (elems[i] == e)
+                return true;
+        }
+        return false;
+    }
+    function last(items) {
+        return items[items.length-1];
+    }
+    function unescape(string) {
+        return string.replace(/&lt;/g, '<').replace(/&gt;/g, '>').replace(/&amp;/g, '&');
+    }
+    function escape(string) {
+        return string.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+    }
+    function normalize(string) {
+        return string.toLowerCase().replace(/ /g, '').replace(/_/g, '');
+    }
+    function regexpEscape(string) {
+        return string.replace(/[-[\]{}()+?*.,\\^$|#]/g, "\\$&");
+    }
+    function Matcher(pattern) {
+        pattern = regexpEscape(normalize(pattern));
+        var rePattern = '^' + pattern.replace(/\\\?/g, '.').replace(/\\\*/g, '[\\s\\S]*') + '$';
+        var regexp = new RegExp(rePattern);
+        function matches(string) {
+            return regexp.test(normalize(string));
+        }
+        return {
+            matches: matches,
+            matchesAny: function (strings) {
+                for (var i = 0, len = strings.length; i < len; i++)
+                    if (matches(strings[i]))
+                        return true;
+                return false;
+            }
+        };
+    }
+    function formatParentName(item) {
+        var parentName = item.fullName.slice(0, item.fullName.length - item.name.length);
+        return parentName.replace(/\./g, ' . ');
+    }
+    function timeFromDate(date) {
+        if (!date)
+            return 'N/A';
+        return formatTime(date.getHours(), date.getMinutes(),
+                          date.getSeconds(), date.getMilliseconds());
+    }
+    function dateFromDate(date) {
+        if (!date)
+            return 'N/A';
+        return padTo(date.getFullYear(), 4) +
+               padTo(date.getMonth() + 1, 2) +
+               padTo(date.getDate(), 2);
+    }
+    function dateTimeFromDate(date) {
+        if (!date)
+            return 'N/A';
+        return dateFromDate(date) + ' ' + timeFromDate(date);
+    }
+    function formatTime(hours, minutes, seconds, milliseconds) {
+        return padTo(hours, 2) + ':' +
+               padTo(minutes, 2) + ':' +
+               padTo(seconds, 2) + '.' +
+               padTo(milliseconds, 3);
+    }
+    function formatElapsed(elapsed) {
+        var millis = elapsed;
+        var hours = Math.floor(millis / (60 * 60 * 1000));
+        millis -= hours * 60 * 60 * 1000;
+        var minutes = Math.floor(millis / (60 * 1000));
+        millis -= minutes * 60 * 1000;
+        var seconds = Math.floor(millis / 1000);
+        millis -= seconds * 1000;
+        return formatTime(hours, minutes, seconds, millis);
+    }
+    function padTo(number, len) {
+        var numString = number + "";
+        while (numString.length < len) numString = "0" + numString;
+        return numString;
+    }
+    function timestamp(millis) {
+        // used also by tools that do not set window.output.baseMillis
+        var base = window.output ? window.output.baseMillis : 0;
+        return new Date(base + millis);
+    }
+    function createGeneratedString(timestamp) {
+        var date = new Date(timestamp);
+        var dt = dateTimeFromDate(date).slice(0, 17);  // drop millis
+        var offset = date.getTimezoneOffset();
+        var sign = offset > 0 ? '-' : '+';
+        var hh = Math.floor(Math.abs(offset) / 60);
+        var mm = Math.abs(offset) % 60;
+        return dt + ' UTC' + sign + padTo(hh, 2) + ':' + padTo(mm, 2);
+    }
+    function createGeneratedAgoString(timestamp) {
+        function timeString(time, shortUnit) {
+            var unit = {y: 'year', d: 'day', h: 'hour', m: 'minute',
+                        s: 'second'}[shortUnit];
+            var end = time == 1 ? ' ' : 's ';
+            return time + ' ' + unit + end;
+        }
+        function compensateLeapYears(days, years) {
+            // Not a perfect algorithm but ought to be enough
+            return days - Math.floor(years / 4);
+        }
+        var generated = Math.round(timestamp / 1000);
+        var current = Math.round(new Date().getTime() / 1000);
+        var elapsed = current - generated;
+        var prefix = '';
+        if (elapsed < 0) {
+            prefix = '- ';
+            elapsed = Math.abs(elapsed);
+        }
+        var secs  = elapsed % 60;
+        var mins  = Math.floor(elapsed / 60) % 60;
+        var hours = Math.floor(elapsed / (60*60)) % 24;
+        var days  = Math.floor(elapsed / (60*60*24)) % 365;
+        var years = Math.floor(elapsed / (60*60*24*365));
+        if (years) {
+            days = compensateLeapYears(days, years);
+            return prefix + timeString(years, 'y') + timeString(days, 'd');
+        } else if (days) {
+            return prefix + timeString(days, 'd') + timeString(hours, 'h');
+        } else if (hours) {
+            return prefix + timeString(hours, 'h') + timeString(mins, 'm');
+        } else if (mins) {
+            return prefix + timeString(mins, 'm') + timeString(secs, 's');
+        } else {
+            return prefix + timeString(secs, 's');
+        }
+    }
+    function parseQueryString(query) {
+        var result = {};
+        if (!query)
+            return result;
+        var params = query.split('&');
+        var parts;
+        function decode(item) {
+            return decodeURIComponent(item.replace('+', ' '));
+        }
+        for (var i = 0, len = params.length; i < len; i++) {
+            parts = params[i].split('=');
+            result[decode(parts.shift())] = decode(parts.join('='));
+        }
+        return result;
+    }
+    return {
+        map: map,
+        filter: filter,
+        all: all,
+        any: any,
+        contains: contains,
+        last: last,
+        escape: escape,
+        unescape: unescape,
+        normalize: normalize,
+        regexpEscape: regexpEscape,
+        Matcher: Matcher,
+        formatParentName: formatParentName,
+        timeFromDate: timeFromDate,
+        dateFromDate: dateFromDate,
+        dateTimeFromDate: dateTimeFromDate,
+        formatElapsed: formatElapsed,
+        timestamp: timestamp,
+        createGeneratedString: createGeneratedString,
+        createGeneratedAgoString: createGeneratedAgoString,
+        parseQueryString: parseQueryString
+    };
+}();
+</script>
+<script type="text/javascript">
+/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */
+!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0<t&&t-1 in e)}S.fn=S.prototype={jquery:f,constructor:S,length:0,toArray:function(){return s.call(this)},get:function(e){return null==e?s.call(this):e<0?this[e+this.length]:this[e]},pushStack:function(e){var t=S.merge(this.constructor(),e);return t.prevObject=this,t},each:function(e){return S.each(this,e)},map:function(n){return this.pushStack(S.map(this,function(e,t){return n.call(e,t,e)}))},slice:function(){return this.pushStack(s.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},even:function(){return this.pushStack(S.grep(this,function(e,t){return(t+1)%2}))},odd:function(){return this.pushStack(S.grep(this,function(e,t){return t%2}))},eq:function(e){var t=this.length,n=+e+(e<0?t:0);return this.pushStack(0<=n&&n<t?[this[n]]:[])},end:function(){return this.prevObject||this.constructor()},push:u,sort:t.sort,splice:t.splice},S.extend=S.fn.extend=function(){var e,t,n,r,i,o,a=arguments[0]||{},s=1,u=arguments.length,l=!1;for("boolean"==typeof a&&(l=a,a=arguments[s]||{},s++),"object"==typeof a||m(a)||(a={}),s===u&&(a=this,s--);s<u;s++)if(null!=(e=arguments[s]))for(t in e)r=e[t],"__proto__"!==t&&a!==r&&(l&&r&&(S.isPlainObject(r)||(i=Array.isArray(r)))?(n=a[t],o=i&&!Array.isArray(n)?[]:i||S.isPlainObject(n)?n:{},i=!1,a[t]=S.extend(l,o,r)):void 0!==r&&(a[t]=r));return a},S.extend({expando:"jQuery"+(f+Math.random()).replace(/\D/g,""),isReady:!0,error:function(e){throw new Error(e)},noop:function(){},isPlainObject:function(e){var t,n;return!(!e||"[object Object]"!==o.call(e))&&(!(t=r(e))||"function"==typeof(n=v.call(t,"constructor")&&t.constructor)&&a.call(n)===l)},isEmptyObject:function(e){var t;for(t in e)return!1;return!0},globalEval:function(e,t,n){b(e,{nonce:t&&t.nonce},n)},each:function(e,t){var n,r=0;if(p(e)){for(n=e.length;r<n;r++)if(!1===t.call(e[r],r,e[r]))break}else for(r in e)if(!1===t.call(e[r],r,e[r]))break;return e},makeArray:function(e,t){var n=t||[];return null!=e&&(p(Object(e))?S.merge(n,"string"==typeof e?[e]:e):u.call(n,e)),n},inArray:function(e,t,n){return null==t?-1:i.call(t,e,n)},merge:function(e,t){for(var n=+t.length,r=0,i=e.length;r<n;r++)e[i++]=t[r];return e.length=i,e},grep:function(e,t,n){for(var r=[],i=0,o=e.length,a=!n;i<o;i++)!t(e[i],i)!==a&&r.push(e[i]);return r},map:function(e,t,n){var r,i,o=0,a=[];if(p(e))for(r=e.length;o<r;o++)null!=(i=t(e[o],o,n))&&a.push(i);else for(o in e)null!=(i=t(e[o],o,n))&&a.push(i);return g(a)},guid:1,support:y}),"function"==typeof Symbol&&(S.fn[Symbol.iterator]=t[Symbol.iterator]),S.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(e,t){n["[object "+t+"]"]=t.toLowerCase()});var d=function(n){var e,d,b,o,i,h,f,g,w,u,l,T,C,a,E,v,s,c,y,S="sizzle"+1*new Date,p=n.document,k=0,r=0,m=ue(),x=ue(),A=ue(),N=ue(),D=function(e,t){return e===t&&(l=!0),0},j={}.hasOwnProperty,t=[],q=t.pop,L=t.push,H=t.push,O=t.slice,P=function(e,t){for(var n=0,r=e.length;n<r;n++)if(e[n]===t)return n;return-1},R="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",I="(?:\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+",W="\\["+M+"*("+I+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+I+"))|)"+M+"*\\]",F=":("+I+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+W+")*)|.*)\\)|)",B=new RegExp(M+"+","g"),$=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),_=new RegExp("^"+M+"*,"+M+"*"),z=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="<a id='"+S+"'></a><select id='"+S+"-\r\\' msallowcapture=''><option selected=''></option></select>",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0<se(t,C,null,[e]).length},se.contains=function(e,t){return(e.ownerDocument||e)!=C&&T(e),y(e,t)},se.attr=function(e,t){(e.ownerDocument||e)!=C&&T(e);var n=b.attrHandle[t.toLowerCase()],r=n&&j.call(b.attrHandle,t.toLowerCase())?n(e,t,!E):void 0;return void 0!==r?r:d.attributes||!E?e.getAttribute(t):(r=e.getAttributeNode(t))&&r.specified?r.value:null},se.escape=function(e){return(e+"").replace(re,ie)},se.error=function(e){throw new Error("Syntax error, unrecognized expression: "+e)},se.uniqueSort=function(e){var t,n=[],r=0,i=0;if(l=!d.detectDuplicates,u=!d.sortStable&&e.slice(0),e.sort(D),l){while(t=e[i++])t===e[i]&&(r=n.push(i));while(r--)e.splice(n[r],1)}return u=null,e},o=se.getText=function(e){var t,n="",r=0,i=e.nodeType;if(i){if(1===i||9===i||11===i){if("string"==typeof e.textContent)return e.textContent;for(e=e.firstChild;e;e=e.nextSibling)n+=o(e)}else if(3===i||4===i)return e.nodeValue}else while(t=e[r++])n+=o(t);return n},(b=se.selectors={cacheLength:50,createPseudo:le,match:G,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1<t.indexOf(i):"$="===r?i&&t.slice(-i.length)===i:"~="===r?-1<(" "+t.replace(B," ")+" ").indexOf(i):"|="===r&&(t===i||t.slice(0,i.length+1)===i+"-"))}},CHILD:function(h,e,t,g,v){var y="nth"!==h.slice(0,3),m="last"!==h.slice(-4),x="of-type"===e;return 1===g&&0===v?function(e){return!!e.parentNode}:function(e,t,n){var r,i,o,a,s,u,l=y!==m?"nextSibling":"previousSibling",c=e.parentNode,f=x&&e.nodeName.toLowerCase(),p=!n&&!x,d=!1;if(c){if(y){while(l){a=e;while(a=a[l])if(x?a.nodeName.toLowerCase()===f:1===a.nodeType)return!1;u=l="only"===h&&!u&&"nextSibling"}return!0}if(u=[m?c.firstChild:c.lastChild],m&&p){d=(s=(r=(i=(o=(a=c)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1])&&r[2],a=s&&c.childNodes[s];while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if(1===a.nodeType&&++d&&a===e){i[h]=[k,s,d];break}}else if(p&&(d=s=(r=(i=(o=(a=e)[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]||[])[0]===k&&r[1]),!1===d)while(a=++s&&a&&a[l]||(d=s=0)||u.pop())if((x?a.nodeName.toLowerCase()===f:1===a.nodeType)&&++d&&(p&&((i=(o=a[S]||(a[S]={}))[a.uniqueID]||(o[a.uniqueID]={}))[h]=[k,d]),a===e))break;return(d-=v)===g||d%g==0&&0<=d/g}}},PSEUDO:function(e,o){var t,a=b.pseudos[e]||b.setFilters[e.toLowerCase()]||se.error("unsupported pseudo: "+e);return a[S]?a(o):1<a.length?(t=[e,e,"",o],b.setFilters.hasOwnProperty(e.toLowerCase())?le(function(e,t){var n,r=a(e,o),i=r.length;while(i--)e[n=P(e,r[i])]=!(t[n]=r[i])}):function(e){return a(e,0,t)}):a}},pseudos:{not:le(function(e){var r=[],i=[],s=f(e.replace($,"$1"));return s[S]?le(function(e,t,n,r){var i,o=s(e,null,r,[]),a=e.length;while(a--)(i=o[a])&&(e[a]=!(t[a]=i))}):function(e,t,n){return r[0]=e,s(r,null,n,i),r[0]=null,!i.pop()}}),has:le(function(t){return function(e){return 0<se(t,e).length}}),contains:le(function(t){return t=t.replace(te,ne),function(e){return-1<(e.textContent||o(e)).indexOf(t)}}),lang:le(function(n){return V.test(n||"")||se.error("unsupported lang: "+n),n=n.replace(te,ne).toLowerCase(),function(e){var t;do{if(t=E?e.lang:e.getAttribute("xml:lang")||e.getAttribute("lang"))return(t=t.toLowerCase())===n||0===t.indexOf(n+"-")}while((e=e.parentNode)&&1===e.nodeType);return!1}}),target:function(e){var t=n.location&&n.location.hash;return t&&t.slice(1)===e.id},root:function(e){return e===a},focus:function(e){return e===C.activeElement&&(!C.hasFocus||C.hasFocus())&&!!(e.type||e.href||~e.tabIndex)},enabled:ge(!1),disabled:ge(!0),checked:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&!!e.checked||"option"===t&&!!e.selected},selected:function(e){return e.parentNode&&e.parentNode.selectedIndex,!0===e.selected},empty:function(e){for(e=e.firstChild;e;e=e.nextSibling)if(e.nodeType<6)return!1;return!0},parent:function(e){return!b.pseudos.empty(e)},header:function(e){return J.test(e.nodeName)},input:function(e){return Q.test(e.nodeName)},button:function(e){var t=e.nodeName.toLowerCase();return"input"===t&&"button"===e.type||"button"===t},text:function(e){var t;return"input"===e.nodeName.toLowerCase()&&"text"===e.type&&(null==(t=e.getAttribute("type"))||"text"===t.toLowerCase())},first:ve(function(){return[0]}),last:ve(function(e,t){return[t-1]}),eq:ve(function(e,t,n){return[n<0?n+t:n]}),even:ve(function(e,t){for(var n=0;n<t;n+=2)e.push(n);return e}),odd:ve(function(e,t){for(var n=1;n<t;n+=2)e.push(n);return e}),lt:ve(function(e,t,n){for(var r=n<0?n+t:t<n?t:n;0<=--r;)e.push(r);return e}),gt:ve(function(e,t,n){for(var r=n<0?n+t:n;++r<t;)e.push(r);return e})}}).pseudos.nth=b.pseudos.eq,{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})b.pseudos[e]=de(e);for(e in{submit:!0,reset:!0})b.pseudos[e]=he(e);function me(){}function xe(e){for(var t=0,n=e.length,r="";t<n;t++)r+=e[t].value;return r}function be(s,e,t){var u=e.dir,l=e.next,c=l||u,f=t&&"parentNode"===c,p=r++;return e.first?function(e,t,n){while(e=e[u])if(1===e.nodeType||f)return s(e,t,n);return!1}:function(e,t,n){var r,i,o,a=[k,p];if(n){while(e=e[u])if((1===e.nodeType||f)&&s(e,t,n))return!0}else while(e=e[u])if(1===e.nodeType||f)if(i=(o=e[S]||(e[S]={}))[e.uniqueID]||(o[e.uniqueID]={}),l&&l===e.nodeName.toLowerCase())e=e[u]||e;else{if((r=i[c])&&r[0]===k&&r[1]===p)return a[2]=r[2];if((i[c]=a)[2]=s(e,t,n))return!0}return!1}}function we(i){return 1<i.length?function(e,t,n){var r=i.length;while(r--)if(!i[r](e,t,n))return!1;return!0}:i[0]}function Te(e,t,n,r,i){for(var o,a=[],s=0,u=e.length,l=null!=t;s<u;s++)(o=e[s])&&(n&&!n(o,r,i)||(a.push(o),l&&t.push(s)));return a}function Ce(d,h,g,v,y,e){return v&&!v[S]&&(v=Ce(v)),y&&!y[S]&&(y=Ce(y,e)),le(function(e,t,n,r){var i,o,a,s=[],u=[],l=t.length,c=e||function(e,t,n){for(var r=0,i=t.length;r<i;r++)se(e,t[r],n);return n}(h||"*",n.nodeType?[n]:n,[]),f=!d||!e&&h?c:Te(c,s,d,n,r),p=g?y||(e?d:l||v)?[]:t:f;if(g&&g(f,p,n,r),v){i=Te(p,u),v(i,[],n,r),o=i.length;while(o--)(a=i[o])&&(p[u[o]]=!(f[u[o]]=a))}if(e){if(y||d){if(y){i=[],o=p.length;while(o--)(a=p[o])&&i.push(f[o]=a);y(null,p=[],i,r)}o=p.length;while(o--)(a=p[o])&&-1<(i=y?P(e,a):s[o])&&(e[i]=!(t[i]=a))}}else p=Te(p===t?p.splice(l,p.length):p),y?y(null,t,p,r):H.apply(t,p)})}function Ee(e){for(var i,t,n,r=e.length,o=b.relative[e[0].type],a=o||b.relative[" "],s=o?1:0,u=be(function(e){return e===i},a,!0),l=be(function(e){return-1<P(i,e)},a,!0),c=[function(e,t,n){var r=!o&&(n||t!==w)||((i=t).nodeType?u(e,t,n):l(e,t,n));return i=null,r}];s<r;s++)if(t=b.relative[e[s].type])c=[be(we(c),t)];else{if((t=b.filter[e[s].type].apply(null,e[s].matches))[S]){for(n=++s;n<r;n++)if(b.relative[e[n].type])break;return Ce(1<s&&we(c),1<s&&xe(e.slice(0,s-1).concat({value:" "===e[s-2].type?"*":""})).replace($,"$1"),t,s<n&&Ee(e.slice(s,n)),n<r&&Ee(e=e.slice(n)),n<r&&xe(e))}c.push(t)}return we(c)}return me.prototype=b.filters=b.pseudos,b.setFilters=new me,h=se.tokenize=function(e,t){var n,r,i,o,a,s,u,l=x[e+" "];if(l)return t?0:l.slice(0);a=e,s=[],u=b.preFilter;while(a){for(o in n&&!(r=_.exec(a))||(r&&(a=a.slice(r[0].length)||a),s.push(i=[])),n=!1,(r=z.exec(a))&&(n=r.shift(),i.push({value:n,type:r[0].replace($," ")}),a=a.slice(n.length)),b.filter)!(r=G[o].exec(a))||u[o]&&!(r=u[o](r))||(n=r.shift(),i.push({value:n,type:o,matches:r}),a=a.slice(n.length));if(!n)break}return t?a.length:a?se.error(e):x(e,s).slice(0)},f=se.compile=function(e,t){var n,v,y,m,x,r,i=[],o=[],a=A[e+" "];if(!a){t||(t=h(e)),n=t.length;while(n--)(a=Ee(t[n]))[S]?i.push(a):o.push(a);(a=A(e,(v=o,m=0<(y=i).length,x=0<v.length,r=function(e,t,n,r,i){var o,a,s,u=0,l="0",c=e&&[],f=[],p=w,d=e||x&&b.find.TAG("*",i),h=k+=null==p?1:Math.random()||.1,g=d.length;for(i&&(w=t==C||t||i);l!==g&&null!=(o=d[l]);l++){if(x&&o){a=0,t||o.ownerDocument==C||(T(o),n=!E);while(s=v[a++])if(s(o,t||C,n)){r.push(o);break}i&&(k=h)}m&&((o=!s&&o)&&u--,e&&c.push(o))}if(u+=l,m&&l!==u){a=0;while(s=y[a++])s(c,f,t,n);if(e){if(0<u)while(l--)c[l]||f[l]||(f[l]=q.call(r));f=Te(f)}H.apply(r,f),i&&!e&&0<f.length&&1<u+y.length&&se.uniqueSort(r)}return i&&(k=h,w=p),c},m?le(r):r))).selector=e}return a},g=se.select=function(e,t,n,r){var i,o,a,s,u,l="function"==typeof e&&e,c=!r&&h(e=l.selector||e);if(n=n||[],1===c.length){if(2<(o=c[0]=c[0].slice(0)).length&&"ID"===(a=o[0]).type&&9===t.nodeType&&E&&b.relative[o[1].type]){if(!(t=(b.find.ID(a.matches[0].replace(te,ne),t)||[])[0]))return n;l&&(t=t.parentNode),e=e.slice(o.shift().value.length)}i=G.needsContext.test(e)?0:o.length;while(i--){if(a=o[i],b.relative[s=a.type])break;if((u=b.find[s])&&(r=u(a.matches[0].replace(te,ne),ee.test(o[0].type)&&ye(t.parentNode)||t))){if(o.splice(i,1),!(e=r.length&&xe(o)))return H.apply(n,r),n;break}}}return(l||f(e,c))(r,t,!E,n,!t||ee.test(e)&&ye(t.parentNode)||t),n},d.sortStable=S.split("").sort(D).join("")===S,d.detectDuplicates=!!l,T(),d.sortDetached=ce(function(e){return 1&e.compareDocumentPosition(C.createElement("fieldset"))}),ce(function(e){return e.innerHTML="<a href='#'></a>","#"===e.firstChild.getAttribute("href")})||fe("type|href|height|width",function(e,t,n){if(!n)return e.getAttribute(t,"type"===t.toLowerCase()?1:2)}),d.attributes&&ce(function(e){return e.innerHTML="<input/>",e.firstChild.setAttribute("value",""),""===e.firstChild.getAttribute("value")})||fe("value",function(e,t,n){if(!n&&"input"===e.nodeName.toLowerCase())return e.defaultValue}),ce(function(e){return null==e.getAttribute("disabled")})||fe(R,function(e,t,n){var r;if(!n)return!0===e[t]?t.toLowerCase():(r=e.getAttributeNode(t))&&r.specified?r.value:null}),se}(C);S.find=d,S.expr=d.selectors,S.expr[":"]=S.expr.pseudos,S.uniqueSort=S.unique=d.uniqueSort,S.text=d.getText,S.isXMLDoc=d.isXML,S.contains=d.contains,S.escapeSelector=d.escape;var h=function(e,t,n){var r=[],i=void 0!==n;while((e=e[t])&&9!==e.nodeType)if(1===e.nodeType){if(i&&S(e).is(n))break;r.push(e)}return r},T=function(e,t){for(var n=[];e;e=e.nextSibling)1===e.nodeType&&e!==t&&n.push(e);return n},k=S.expr.match.needsContext;function A(e,t){return e.nodeName&&e.nodeName.toLowerCase()===t.toLowerCase()}var N=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1<i.call(n,e)!==r}):S.filter(n,e,r)}S.filter=function(e,t,n){var r=t[0];return n&&(e=":not("+e+")"),1===t.length&&1===r.nodeType?S.find.matchesSelector(r,e)?[r]:[]:S.find.matches(e,S.grep(t,function(e){return 1===e.nodeType}))},S.fn.extend({find:function(e){var t,n,r=this.length,i=this;if("string"!=typeof e)return this.pushStack(S(e).filter(function(){for(t=0;t<r;t++)if(S.contains(i[t],this))return!0}));for(n=this.pushStack([]),t=0;t<r;t++)S.find(e,i[t],n);return 1<r?S.uniqueSort(n):n},filter:function(e){return this.pushStack(D(this,e||[],!1))},not:function(e){return this.pushStack(D(this,e||[],!0))},is:function(e){return!!D(this,"string"==typeof e&&k.test(e)?S(e):e||[],!1).length}});var j,q=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e<n;e++)if(S.contains(this,t[e]))return!0})},closest:function(e,t){var n,r=0,i=this.length,o=[],a="string"!=typeof e&&S(e);if(!k.test(e))for(;r<i;r++)for(n=this[r];n&&n!==t;n=n.parentNode)if(n.nodeType<11&&(a?-1<a.index(n):1===n.nodeType&&S.find.matchesSelector(n,e))){o.push(n);break}return this.pushStack(1<o.length?S.uniqueSort(o):o)},index:function(e){return e?"string"==typeof e?i.call(S(e),this[0]):i.call(this,e.jquery?e[0]:e):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(e,t){return this.pushStack(S.uniqueSort(S.merge(this.get(),S(e,t))))},addBack:function(e){return this.add(null==e?this.prevObject:this.prevObject.filter(e))}}),S.each({parent:function(e){var t=e.parentNode;return t&&11!==t.nodeType?t:null},parents:function(e){return h(e,"parentNode")},parentsUntil:function(e,t,n){return h(e,"parentNode",n)},next:function(e){return O(e,"nextSibling")},prev:function(e){return O(e,"previousSibling")},nextAll:function(e){return h(e,"nextSibling")},prevAll:function(e){return h(e,"previousSibling")},nextUntil:function(e,t,n){return h(e,"nextSibling",n)},prevUntil:function(e,t,n){return h(e,"previousSibling",n)},siblings:function(e){return T((e.parentNode||{}).firstChild,e)},children:function(e){return T(e.firstChild)},contents:function(e){return null!=e.contentDocument&&r(e.contentDocument)?e.contentDocument:(A(e,"template")&&(e=e.content||e),S.merge([],e.childNodes))}},function(r,i){S.fn[r]=function(e,t){var n=S.map(this,i,e);return"Until"!==r.slice(-5)&&(t=e),t&&"string"==typeof t&&(n=S.filter(t,n)),1<this.length&&(H[r]||S.uniqueSort(n),L.test(r)&&n.reverse()),this.pushStack(n)}});var P=/[^\x20\t\r\n\f]+/g;function R(e){return e}function M(e){throw e}function I(e,t,n,r){var i;try{e&&m(i=e.promise)?i.call(e).done(t).fail(n):e&&m(i=e.then)?i.call(e,t,n):t.apply(void 0,[e].slice(r))}catch(e){n.apply(void 0,[e])}}S.Callbacks=function(r){var e,n;r="string"==typeof r?(e=r,n={},S.each(e.match(P)||[],function(e,t){n[t]=!0}),n):S.extend({},r);var i,t,o,a,s=[],u=[],l=-1,c=function(){for(a=a||r.once,o=i=!0;u.length;l=-1){t=u.shift();while(++l<s.length)!1===s[l].apply(t[0],t[1])&&r.stopOnFalse&&(l=s.length,t=!1)}r.memory||(t=!1),i=!1,a&&(s=t?[]:"")},f={add:function(){return s&&(t&&!i&&(l=s.length-1,u.push(t)),function n(e){S.each(e,function(e,t){m(t)?r.unique&&f.has(t)||s.push(t):t&&t.length&&"string"!==w(t)&&n(t)})}(arguments),t&&!i&&c()),this},remove:function(){return S.each(arguments,function(e,t){var n;while(-1<(n=S.inArray(t,s,n)))s.splice(n,1),n<=l&&l--}),this},has:function(e){return e?-1<S.inArray(e,s):0<s.length},empty:function(){return s&&(s=[]),this},disable:function(){return a=u=[],s=t="",this},disabled:function(){return!s},lock:function(){return a=u=[],t||i||(s=t=""),this},locked:function(){return!!a},fireWith:function(e,t){return a||(t=[e,(t=t||[]).slice?t.slice():t],u.push(t),i||c()),this},fire:function(){return f.fireWith(this,arguments),this},fired:function(){return!!o}};return f},S.extend({Deferred:function(e){var o=[["notify","progress",S.Callbacks("memory"),S.Callbacks("memory"),2],["resolve","done",S.Callbacks("once memory"),S.Callbacks("once memory"),0,"resolved"],["reject","fail",S.Callbacks("once memory"),S.Callbacks("once memory"),1,"rejected"]],i="pending",a={state:function(){return i},always:function(){return s.done(arguments).fail(arguments),this},"catch":function(e){return a.then(null,e)},pipe:function(){var i=arguments;return S.Deferred(function(r){S.each(o,function(e,t){var n=m(i[t[4]])&&i[t[4]];s[t[1]](function(){var e=n&&n.apply(this,arguments);e&&m(e.promise)?e.promise().progress(r.notify).done(r.resolve).fail(r.reject):r[t[0]+"With"](this,n?[e]:arguments)})}),i=null}).promise()},then:function(t,n,r){var u=0;function l(i,o,a,s){return function(){var n=this,r=arguments,e=function(){var e,t;if(!(i<u)){if((e=a.apply(n,r))===o.promise())throw new TypeError("Thenable self-resolution");t=e&&("object"==typeof e||"function"==typeof e)&&e.then,m(t)?s?t.call(e,l(u,o,R,s),l(u,o,M,s)):(u++,t.call(e,l(u,o,R,s),l(u,o,M,s),l(u,o,R,o.notifyWith))):(a!==R&&(n=void 0,r=[e]),(s||o.resolveWith)(n,r))}},t=s?e:function(){try{e()}catch(e){S.Deferred.exceptionHook&&S.Deferred.exceptionHook(e,t.stackTrace),u<=i+1&&(a!==M&&(n=void 0,r=[e]),o.rejectWith(n,r))}};i?t():(S.Deferred.getStackHook&&(t.stackTrace=S.Deferred.getStackHook()),C.setTimeout(t))}}return S.Deferred(function(e){o[0][3].add(l(0,e,m(r)?r:R,e.notifyWith)),o[1][3].add(l(0,e,m(t)?t:R)),o[2][3].add(l(0,e,m(n)?n:M))}).promise()},promise:function(e){return null!=e?S.extend(e,a):a}},s={};return S.each(o,function(e,t){var n=t[2],r=t[5];a[t[1]]=n.add,r&&n.add(function(){i=r},o[3-e][2].disable,o[3-e][3].disable,o[0][2].lock,o[0][3].lock),n.add(t[3].fire),s[t[0]]=function(){return s[t[0]+"With"](this===s?void 0:this,arguments),this},s[t[0]+"With"]=n.fireWith}),a.promise(s),e&&e.call(s,s),s},when:function(e){var n=arguments.length,t=n,r=Array(t),i=s.call(arguments),o=S.Deferred(),a=function(t){return function(e){r[t]=this,i[t]=1<arguments.length?s.call(arguments):e,--n||o.resolveWith(r,i)}};if(n<=1&&(I(e,o.done(a(t)).resolve,o.reject,!n),"pending"===o.state()||m(i[t]&&i[t].then)))return o.then();while(t--)I(i[t],a(t),o.reject);return o.promise()}});var W=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;S.Deferred.exceptionHook=function(e,t){C.console&&C.console.warn&&e&&W.test(e.name)&&C.console.warn("jQuery.Deferred exception: "+e.message,e.stack,t)},S.readyException=function(e){C.setTimeout(function(){throw e})};var F=S.Deferred();function B(){E.removeEventListener("DOMContentLoaded",B),C.removeEventListener("load",B),S.ready()}S.fn.ready=function(e){return F.then(e)["catch"](function(e){S.readyException(e)}),this},S.extend({isReady:!1,readyWait:1,ready:function(e){(!0===e?--S.readyWait:S.isReady)||(S.isReady=!0)!==e&&0<--S.readyWait||F.resolveWith(E,[S])}}),S.ready.then=F.then,"complete"===E.readyState||"loading"!==E.readyState&&!E.documentElement.doScroll?C.setTimeout(S.ready):(E.addEventListener("DOMContentLoaded",B),C.addEventListener("load",B));var $=function(e,t,n,r,i,o,a){var s=0,u=e.length,l=null==n;if("object"===w(n))for(s in i=!0,n)$(e,t,s,n[s],!0,o,a);else if(void 0!==r&&(i=!0,m(r)||(a=!0),l&&(a?(t.call(e,r),t=null):(l=t,t=function(e,t,n){return l.call(S(e),n)})),t))for(;s<u;s++)t(e[s],n,a?r:r.call(e[s],s,t(e[s],n)));return i?e:l?t.call(e):u?t(e[0],n):o},_=/^-ms-/,z=/-([a-z])/g;function U(e,t){return t.toUpperCase()}function X(e){return e.replace(_,"ms-").replace(z,U)}var V=function(e){return 1===e.nodeType||9===e.nodeType||!+e.nodeType};function G(){this.expando=S.expando+G.uid++}G.uid=1,G.prototype={cache:function(e){var t=e[this.expando];return t||(t={},V(e)&&(e.nodeType?e[this.expando]=t:Object.defineProperty(e,this.expando,{value:t,configurable:!0}))),t},set:function(e,t,n){var r,i=this.cache(e);if("string"==typeof t)i[X(t)]=n;else for(r in t)i[X(r)]=t[r];return i},get:function(e,t){return void 0===t?this.cache(e):e[this.expando]&&e[this.expando][X(t)]},access:function(e,t,n){return void 0===t||t&&"string"==typeof t&&void 0===n?this.get(e,t):(this.set(e,t,n),void 0!==n?n:t)},remove:function(e,t){var n,r=e[this.expando];if(void 0!==r){if(void 0!==t){n=(t=Array.isArray(t)?t.map(X):(t=X(t))in r?[t]:t.match(P)||[]).length;while(n--)delete r[t[n]]}(void 0===t||S.isEmptyObject(r))&&(e.nodeType?e[this.expando]=void 0:delete e[this.expando])}},hasData:function(e){var t=e[this.expando];return void 0!==t&&!S.isEmptyObject(t)}};var Y=new G,Q=new G,J=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,K=/[A-Z]/g;function Z(e,t,n){var r,i;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(K,"-$&").toLowerCase(),"string"==typeof(n=e.getAttribute(r))){try{n="true"===(i=n)||"false"!==i&&("null"===i?null:i===+i+""?+i:J.test(i)?JSON.parse(i):i)}catch(e){}Q.set(e,t,n)}else n=void 0;return n}S.extend({hasData:function(e){return Q.hasData(e)||Y.hasData(e)},data:function(e,t,n){return Q.access(e,t,n)},removeData:function(e,t){Q.remove(e,t)},_data:function(e,t,n){return Y.access(e,t,n)},_removeData:function(e,t){Y.remove(e,t)}}),S.fn.extend({data:function(n,e){var t,r,i,o=this[0],a=o&&o.attributes;if(void 0===n){if(this.length&&(i=Q.get(o),1===o.nodeType&&!Y.get(o,"hasDataAttrs"))){t=a.length;while(t--)a[t]&&0===(r=a[t].name).indexOf("data-")&&(r=X(r.slice(5)),Z(o,r,i[r]));Y.set(o,"hasDataAttrs",!0)}return i}return"object"==typeof n?this.each(function(){Q.set(this,n)}):$(this,function(e){var t;if(o&&void 0===e)return void 0!==(t=Q.get(o,n))?t:void 0!==(t=Z(o,n))?t:void 0;this.each(function(){Q.set(this,n,e)})},null,e,1<arguments.length,null,!0)},removeData:function(e){return this.each(function(){Q.remove(this,e)})}}),S.extend({queue:function(e,t,n){var r;if(e)return t=(t||"fx")+"queue",r=Y.get(e,t),n&&(!r||Array.isArray(n)?r=Y.access(e,t,S.makeArray(n)):r.push(n)),r||[]},dequeue:function(e,t){t=t||"fx";var n=S.queue(e,t),r=n.length,i=n.shift(),o=S._queueHooks(e,t);"inprogress"===i&&(i=n.shift(),r--),i&&("fx"===t&&n.unshift("inprogress"),delete o.stop,i.call(e,function(){S.dequeue(e,t)},o)),!r&&o&&o.empty.fire()},_queueHooks:function(e,t){var n=t+"queueHooks";return Y.get(e,n)||Y.access(e,n,{empty:S.Callbacks("once memory").add(function(){Y.remove(e,[t+"queue",n])})})}}),S.fn.extend({queue:function(t,n){var e=2;return"string"!=typeof t&&(n=t,t="fx",e--),arguments.length<e?S.queue(this[0],t):void 0===n?this:this.each(function(){var e=S.queue(this,t,n);S._queueHooks(this,t),"fx"===t&&"inprogress"!==e[0]&&S.dequeue(this,t)})},dequeue:function(e){return this.each(function(){S.dequeue(this,e)})},clearQueue:function(e){return this.queue(e||"fx",[])},promise:function(e,t){var n,r=1,i=S.Deferred(),o=this,a=this.length,s=function(){--r||i.resolveWith(o,[o])};"string"!=typeof e&&(t=e,e=void 0),e=e||"fx";while(a--)(n=Y.get(o[a],e+"queueHooks"))&&n.empty&&(r++,n.empty.add(s));return s(),i.promise(t)}});var ee=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,te=new RegExp("^(?:([+-])=|)("+ee+")([a-z%]*)$","i"),ne=["Top","Right","Bottom","Left"],re=E.documentElement,ie=function(e){return S.contains(e.ownerDocument,e)},oe={composed:!0};re.getRootNode&&(ie=function(e){return S.contains(e.ownerDocument,e)||e.getRootNode(oe)===e.ownerDocument});var ae=function(e,t){return"none"===(e=t||e).style.display||""===e.style.display&&ie(e)&&"none"===S.css(e,"display")};function se(e,t,n,r){var i,o,a=20,s=r?function(){return r.cur()}:function(){return S.css(e,t,"")},u=s(),l=n&&n[3]||(S.cssNumber[t]?"":"px"),c=e.nodeType&&(S.cssNumber[t]||"px"!==l&&+u)&&te.exec(S.css(e,t));if(c&&c[3]!==l){u/=2,l=l||c[3],c=+u||1;while(a--)S.style(e,t,c+l),(1-o)*(1-(o=s()/u||.5))<=0&&(a=0),c/=o;c*=2,S.style(e,t,c+l),n=n||[]}return n&&(c=+c||+u||0,i=n[1]?c+(n[1]+1)*n[2]:+n[2],r&&(r.unit=l,r.start=c,r.end=i)),i}var ue={};function le(e,t){for(var n,r,i,o,a,s,u,l=[],c=0,f=e.length;c<f;c++)(r=e[c]).style&&(n=r.style.display,t?("none"===n&&(l[c]=Y.get(r,"display")||null,l[c]||(r.style.display="")),""===r.style.display&&ae(r)&&(l[c]=(u=a=o=void 0,a=(i=r).ownerDocument,s=i.nodeName,(u=ue[s])||(o=a.body.appendChild(a.createElement(s)),u=S.css(o,"display"),o.parentNode.removeChild(o),"none"===u&&(u="block"),ue[s]=u)))):"none"!==n&&(l[c]="none",Y.set(r,"display",n)));for(c=0;c<f;c++)null!=l[c]&&(e[c].style.display=l[c]);return e}S.fn.extend({show:function(){return le(this,!0)},hide:function(){return le(this)},toggle:function(e){return"boolean"==typeof e?e?this.show():this.hide():this.each(function(){ae(this)?S(this).show():S(this).hide()})}});var ce,fe,pe=/^(?:checkbox|radio)$/i,de=/<([a-z][^\/\0>\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="<textarea>x</textarea>",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="<option></option>",y.option=!!ce.lastChild;var ge={thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n<r;n++)Y.set(e[n],"globalEval",!t||Y.get(t[n],"globalEval"))}ge.tbody=ge.tfoot=ge.colgroup=ge.caption=ge.thead,ge.th=ge.td,y.option||(ge.optgroup=ge.option=[1,"<select multiple='multiple'>","</select>"]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d<h;d++)if((o=e[d])||0===o)if("object"===w(o))S.merge(p,o.nodeType?[o]:o);else if(me.test(o)){a=a||f.appendChild(t.createElement("div")),s=(de.exec(o)||["",""])[1].toLowerCase(),u=ge[s]||ge._default,a.innerHTML=u[1]+S.htmlPrefilter(o)+u[2],c=u[0];while(c--)a=a.lastChild;S.merge(p,a.childNodes),(a=f.firstChild).textContent=""}else p.push(t.createTextNode(o));f.textContent="",d=0;while(o=p[d++])if(r&&-1<S.inArray(o,r))i&&i.push(o);else if(l=ie(o),a=ve(f.appendChild(o),"script"),l&&ye(a),n){c=0;while(o=a[c++])he.test(o.type||"")&&n.push(o)}return f}var be=/^key/,we=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Te=/^([^.]*)(?:\.(.+)|)/;function Ce(){return!0}function Ee(){return!1}function Se(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function ke(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)ke(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Ee;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return S().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=S.guid++)),e.each(function(){S.event.add(this,t,i,r,n)})}function Ae(e,i,o){o?(Y.set(e,i,!1),S.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Y.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(S.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Y.set(this,i,r),t=o(this,i),this[i](),r!==(n=Y.get(this,i))||t?Y.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Y.set(this,i,{value:S.event.trigger(S.extend(r[0],S.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Y.get(e,i)&&S.event.add(e,i,Ce)}S.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.get(t);if(V(t)){n.handler&&(n=(o=n).handler,i=o.selector),i&&S.find.matchesSelector(re,i),n.guid||(n.guid=S.guid++),(u=v.events)||(u=v.events=Object.create(null)),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof S&&S.event.triggered!==e.type?S.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(P)||[""]).length;while(l--)d=g=(s=Te.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=S.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=S.event.special[d]||{},c=S.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&S.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),S.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Y.hasData(e)&&Y.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(P)||[""]).length;while(l--)if(d=g=(s=Te.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=S.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||S.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)S.event.remove(e,d+t[l],n,r,!0);S.isEmptyObject(u)&&Y.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=new Array(arguments.length),u=S.event.fix(e),l=(Y.get(this,"events")||Object.create(null))[u.type]||[],c=S.event.special[u.type]||{};for(s[0]=u,t=1;t<arguments.length;t++)s[t]=arguments[t];if(u.delegateTarget=this,!c.preDispatch||!1!==c.preDispatch.call(this,u)){a=S.event.handlers.call(this,u,l),t=0;while((i=a[t++])&&!u.isPropagationStopped()){u.currentTarget=i.elem,n=0;while((o=i.handlers[n++])&&!u.isImmediatePropagationStopped())u.rnamespace&&!1!==o.namespace&&!u.rnamespace.test(o.namespace)||(u.handleObj=o,u.data=o.data,void 0!==(r=((S.event.special[o.origType]||{}).handle||o.handler).apply(i.elem,s))&&!1===(u.result=r)&&(u.preventDefault(),u.stopPropagation()))}return c.postDispatch&&c.postDispatch.call(this,u),u.result}},handlers:function(e,t){var n,r,i,o,a,s=[],u=t.delegateCount,l=e.target;if(u&&l.nodeType&&!("click"===e.type&&1<=e.button))for(;l!==this;l=l.parentNode||this)if(1===l.nodeType&&("click"!==e.type||!0!==l.disabled)){for(o=[],a={},n=0;n<u;n++)void 0===a[i=(r=t[n]).selector+" "]&&(a[i]=r.needsContext?-1<S(i,this).index(l):S.find(i,this,null,[l]).length),a[i]&&o.push(r);o.length&&s.push({elem:l,handlers:o})}return l=this,u<t.length&&s.push({elem:l,handlers:t.slice(u)}),s},addProp:function(t,e){Object.defineProperty(S.Event.prototype,t,{enumerable:!0,configurable:!0,get:m(e)?function(){if(this.originalEvent)return e(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[t]},set:function(e){Object.defineProperty(this,t,{enumerable:!0,configurable:!0,writable:!0,value:e})}})},fix:function(e){return e[S.expando]?e:new S.Event(e)},special:{load:{noBubble:!0},click:{setup:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click",Ce),!1},trigger:function(e){var t=this||e;return pe.test(t.type)&&t.click&&A(t,"input")&&Ae(t,"click"),!0},_default:function(e){var t=e.target;return pe.test(t.type)&&t.click&&A(t,"input")&&Y.get(t,"click")||A(t,"a")}},beforeunload:{postDispatch:function(e){void 0!==e.result&&e.originalEvent&&(e.originalEvent.returnValue=e.result)}}}},S.removeEvent=function(e,t,n){e.removeEventListener&&e.removeEventListener(t,n)},S.Event=function(e,t){if(!(this instanceof S.Event))return new S.Event(e,t);e&&e.type?(this.originalEvent=e,this.type=e.type,this.isDefaultPrevented=e.defaultPrevented||void 0===e.defaultPrevented&&!1===e.returnValue?Ce:Ee,this.target=e.target&&3===e.target.nodeType?e.target.parentNode:e.target,this.currentTarget=e.currentTarget,this.relatedTarget=e.relatedTarget):this.type=e,t&&S.extend(this,t),this.timeStamp=e&&e.timeStamp||Date.now(),this[S.expando]=!0},S.Event.prototype={constructor:S.Event,isDefaultPrevented:Ee,isPropagationStopped:Ee,isImmediatePropagationStopped:Ee,isSimulated:!1,preventDefault:function(){var e=this.originalEvent;this.isDefaultPrevented=Ce,e&&!this.isSimulated&&e.preventDefault()},stopPropagation:function(){var e=this.originalEvent;this.isPropagationStopped=Ce,e&&!this.isSimulated&&e.stopPropagation()},stopImmediatePropagation:function(){var e=this.originalEvent;this.isImmediatePropagationStopped=Ce,e&&!this.isSimulated&&e.stopImmediatePropagation(),this.stopPropagation()}},S.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,code:!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(e){var t=e.button;return null==e.which&&be.test(e.type)?null!=e.charCode?e.charCode:e.keyCode:!e.which&&void 0!==t&&we.test(e.type)?1&t?1:2&t?3:4&t?2:0:e.which}},S.event.addProp),S.each({focus:"focusin",blur:"focusout"},function(e,t){S.event.special[e]={setup:function(){return Ae(this,e,Se),!1},trigger:function(){return Ae(this,e),!0},delegateType:t}}),S.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(e,i){S.event.special[e]={delegateType:i,bindType:i,handle:function(e){var t,n=e.relatedTarget,r=e.handleObj;return n&&(n===this||S.contains(this,n))||(e.type=r.origType,t=r.handler.apply(this,arguments),e.type=i),t}}}),S.fn.extend({on:function(e,t,n,r){return ke(this,e,t,n,r)},one:function(e,t,n,r){return ke(this,e,t,n,r,1)},off:function(e,t,n){var r,i;if(e&&e.preventDefault&&e.handleObj)return r=e.handleObj,S(e.delegateTarget).off(r.namespace?r.origType+"."+r.namespace:r.origType,r.selector,r.handler),this;if("object"==typeof e){for(i in e)this.off(i,t,e[i]);return this}return!1!==t&&"function"!=typeof t||(n=t,t=void 0),!1===n&&(n=Ee),this.each(function(){S.event.remove(this,e,n,t)})}});var Ne=/<script|<style|<link/i,De=/checked\s*(?:[^=]|=\s*.checked.)/i,je=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n<r;n++)S.event.add(t,i,s[i][n]);Q.hasData(e)&&(o=Q.access(e),a=S.extend({},o),Q.set(t,a))}}function Pe(n,r,i,o){r=g(r);var e,t,a,s,u,l,c=0,f=n.length,p=f-1,d=r[0],h=m(d);if(h||1<f&&"string"==typeof d&&!y.checkClone&&De.test(d))return n.each(function(e){var t=n.eq(e);h&&(r[0]=d.call(this,e,t.html())),Pe(t,r,i,o)});if(f&&(t=(e=xe(r,n[0].ownerDocument,!1,n,o)).firstChild,1===e.childNodes.length&&(e=t),t||o)){for(s=(a=S.map(ve(e,"script"),Le)).length;c<f;c++)u=e,c!==p&&(u=S.clone(u,!0,!0),s&&S.merge(a,ve(u,"script"))),i.call(n[c],u,c);if(s)for(l=a[a.length-1].ownerDocument,S.map(a,He),c=0;c<s;c++)u=a[c],he.test(u.type||"")&&!Y.access(u,"globalEval")&&S.contains(l,u)&&(u.src&&"module"!==(u.type||"").toLowerCase()?S._evalUrl&&!u.noModule&&S._evalUrl(u.src,{nonce:u.nonce||u.getAttribute("nonce")},l):b(u.textContent.replace(je,""),u,l))}return n}function Re(e,t,n){for(var r,i=t?S.filter(t,e):e,o=0;null!=(r=i[o]);o++)n||1!==r.nodeType||S.cleanData(ve(r)),r.parentNode&&(n&&ie(r)&&ye(ve(r,"script")),r.parentNode.removeChild(r));return e}S.extend({htmlPrefilter:function(e){return e},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=ie(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||S.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r<i;r++)s=o[r],u=a[r],void 0,"input"===(l=u.nodeName.toLowerCase())&&pe.test(s.type)?u.checked=s.checked:"input"!==l&&"textarea"!==l||(u.defaultValue=s.defaultValue);if(t)if(n)for(o=o||ve(e),a=a||ve(c),r=0,i=o.length;r<i;r++)Oe(o[r],a[r]);else Oe(e,c);return 0<(a=ve(c,"script")).length&&ye(a,!f&&ve(e,"script")),c},cleanData:function(e){for(var t,n,r,i=S.event.special,o=0;void 0!==(n=e[o]);o++)if(V(n)){if(t=n[Y.expando]){if(t.events)for(r in t.events)i[r]?S.event.remove(n,r):S.removeEvent(n,r,t.handle);n[Y.expando]=void 0}n[Q.expando]&&(n[Q.expando]=void 0)}}}),S.fn.extend({detach:function(e){return Re(this,e,!0)},remove:function(e){return Re(this,e)},text:function(e){return $(this,function(e){return void 0===e?S.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=e)})},null,e,arguments.length)},append:function(){return Pe(this,arguments,function(e){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||qe(this,e).appendChild(e)})},prepend:function(){return Pe(this,arguments,function(e){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var t=qe(this,e);t.insertBefore(e,t.firstChild)}})},before:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this)})},after:function(){return Pe(this,arguments,function(e){this.parentNode&&this.parentNode.insertBefore(e,this.nextSibling)})},empty:function(){for(var e,t=0;null!=(e=this[t]);t++)1===e.nodeType&&(S.cleanData(ve(e,!1)),e.textContent="");return this},clone:function(e,t){return e=null!=e&&e,t=null==t?e:t,this.map(function(){return S.clone(this,e,t)})},html:function(e){return $(this,function(e){var t=this[0]||{},n=0,r=this.length;if(void 0===e&&1===t.nodeType)return t.innerHTML;if("string"==typeof e&&!Ne.test(e)&&!ge[(de.exec(e)||["",""])[1].toLowerCase()]){e=S.htmlPrefilter(e);try{for(;n<r;n++)1===(t=this[n]||{}).nodeType&&(S.cleanData(ve(t,!1)),t.innerHTML=e);t=0}catch(e){}}t&&this.empty().append(e)},null,e,arguments.length)},replaceWith:function(){var n=[];return Pe(this,arguments,function(e){var t=this.parentNode;S.inArray(this,n)<0&&(S.cleanData(ve(this)),t&&t.replaceChild(e,this))},n)}}),S.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(e,a){S.fn[e]=function(e){for(var t,n=[],r=S(e),i=r.length-1,o=0;o<=i;o++)t=o===i?this:this.clone(!0),S(r[o])[a](t),u.apply(n,t.get());return this.pushStack(n)}});var Me=new RegExp("^("+ee+")(?!px)[a-z%]+$","i"),Ie=function(e){var t=e.ownerDocument.defaultView;return t&&t.opener||(t=C),t.getComputedStyle(e)},We=function(e,t,n){var r,i,o={};for(i in t)o[i]=e.style[i],e.style[i]=t[i];for(i in r=n.call(e),t)e.style[i]=o[i];return r},Fe=new RegExp(ne.join("|"),"i");function Be(e,t,n){var r,i,o,a,s=e.style;return(n=n||Ie(e))&&(""!==(a=n.getPropertyValue(t)||n[t])||ie(e)||(a=S.style(e,t)),!y.pixelBoxStyles()&&Me.test(a)&&Fe.test(t)&&(r=s.width,i=s.minWidth,o=s.maxWidth,s.minWidth=s.maxWidth=s.width=a,a=n.width,s.width=r,s.minWidth=i,s.maxWidth=o)),void 0!==a?a+"":a}function $e(e,t){return{get:function(){if(!e())return(this.get=t).apply(this,arguments);delete this.get}}}!function(){function e(){if(l){u.style.cssText="position:absolute;left:-11111px;width:60px;margin-top:1px;padding:0;border:0",l.style.cssText="position:relative;display:block;box-sizing:border-box;overflow:scroll;margin:auto;border:1px;padding:1px;width:60%;top:1%",re.appendChild(u).appendChild(l);var e=C.getComputedStyle(l);n="1%"!==e.top,s=12===t(e.marginLeft),l.style.right="60%",o=36===t(e.right),r=36===t(e.width),l.style.position="absolute",i=12===t(l.offsetWidth/3),re.removeChild(u),l=null}}function t(e){return Math.round(parseFloat(e))}var n,r,i,o,a,s,u=E.createElement("div"),l=E.createElement("div");l.style&&(l.style.backgroundClip="content-box",l.cloneNode(!0).style.backgroundClip="",y.clearCloneStyle="content-box"===l.style.backgroundClip,S.extend(y,{boxSizingReliable:function(){return e(),r},pixelBoxStyles:function(){return e(),o},pixelPosition:function(){return e(),n},reliableMarginLeft:function(){return e(),s},scrollboxSize:function(){return e(),i},reliableTrDimensions:function(){var e,t,n,r;return null==a&&(e=E.createElement("table"),t=E.createElement("tr"),n=E.createElement("div"),e.style.cssText="position:absolute;left:-11111px",t.style.height="1px",n.style.height="9px",re.appendChild(e).appendChild(t).appendChild(n),r=C.getComputedStyle(t),a=3<parseInt(r.height),re.removeChild(e)),a}}))}();var _e=["Webkit","Moz","ms"],ze=E.createElement("div").style,Ue={};function Xe(e){var t=S.cssProps[e]||Ue[e];return t||(e in ze?e:Ue[e]=function(e){var t=e[0].toUpperCase()+e.slice(1),n=_e.length;while(n--)if((e=_e[n]+t)in ze)return e}(e)||e)}var Ve=/^(none|table(?!-c[ea]).+)/,Ge=/^--/,Ye={position:"absolute",visibility:"hidden",display:"block"},Qe={letterSpacing:"0",fontWeight:"400"};function Je(e,t,n){var r=te.exec(t);return r?Math.max(0,r[2]-(n||0))+(r[3]||"px"):t}function Ke(e,t,n,r,i,o){var a="width"===t?1:0,s=0,u=0;if(n===(r?"border":"content"))return 0;for(;a<4;a+=2)"margin"===n&&(u+=S.css(e,n+ne[a],!0,i)),r?("content"===n&&(u-=S.css(e,"padding"+ne[a],!0,i)),"margin"!==n&&(u-=S.css(e,"border"+ne[a]+"Width",!0,i))):(u+=S.css(e,"padding"+ne[a],!0,i),"padding"!==n?u+=S.css(e,"border"+ne[a]+"Width",!0,i):s+=S.css(e,"border"+ne[a]+"Width",!0,i));return!r&&0<=o&&(u+=Math.max(0,Math.ceil(e["offset"+t[0].toUpperCase()+t.slice(1)]-o-u-s-.5))||0),u}function Ze(e,t,n){var r=Ie(e),i=(!y.boxSizingReliable()||n)&&"border-box"===S.css(e,"boxSizing",!1,r),o=i,a=Be(e,t,r),s="offset"+t[0].toUpperCase()+t.slice(1);if(Me.test(a)){if(!n)return a;a="auto"}return(!y.boxSizingReliable()&&i||!y.reliableTrDimensions()&&A(e,"tr")||"auto"===a||!parseFloat(a)&&"inline"===S.css(e,"display",!1,r))&&e.getClientRects().length&&(i="border-box"===S.css(e,"boxSizing",!1,r),(o=s in e)&&(a=e[s])),(a=parseFloat(a)||0)+Ke(e,t,n||(i?"border":"content"),o,r,a)+"px"}function et(e,t,n,r,i){return new et.prototype.init(e,t,n,r,i)}S.extend({cssHooks:{opacity:{get:function(e,t){if(t){var n=Be(e,"opacity");return""===n?"1":n}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,gridArea:!0,gridColumn:!0,gridColumnEnd:!0,gridColumnStart:!0,gridRow:!0,gridRowEnd:!0,gridRowStart:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{},style:function(e,t,n,r){if(e&&3!==e.nodeType&&8!==e.nodeType&&e.style){var i,o,a,s=X(t),u=Ge.test(t),l=e.style;if(u||(t=Xe(s)),a=S.cssHooks[t]||S.cssHooks[s],void 0===n)return a&&"get"in a&&void 0!==(i=a.get(e,!1,r))?i:l[t];"string"===(o=typeof n)&&(i=te.exec(n))&&i[1]&&(n=se(e,t,i),o="number"),null!=n&&n==n&&("number"!==o||u||(n+=i&&i[3]||(S.cssNumber[s]?"":"px")),y.clearCloneStyle||""!==n||0!==t.indexOf("background")||(l[t]="inherit"),a&&"set"in a&&void 0===(n=a.set(e,n,r))||(u?l.setProperty(t,n):l[t]=n))}},css:function(e,t,n,r){var i,o,a,s=X(t);return Ge.test(t)||(t=Xe(s)),(a=S.cssHooks[t]||S.cssHooks[s])&&"get"in a&&(i=a.get(e,!0,n)),void 0===i&&(i=Be(e,t,r)),"normal"===i&&t in Qe&&(i=Qe[t]),""===n||n?(o=parseFloat(i),!0===n||isFinite(o)?o||0:i):i}}),S.each(["height","width"],function(e,u){S.cssHooks[u]={get:function(e,t,n){if(t)return!Ve.test(S.css(e,"display"))||e.getClientRects().length&&e.getBoundingClientRect().width?Ze(e,u,n):We(e,Ye,function(){return Ze(e,u,n)})},set:function(e,t,n){var r,i=Ie(e),o=!y.scrollboxSize()&&"absolute"===i.position,a=(o||n)&&"border-box"===S.css(e,"boxSizing",!1,i),s=n?Ke(e,u,n,a,i):0;return a&&o&&(s-=Math.ceil(e["offset"+u[0].toUpperCase()+u.slice(1)]-parseFloat(i[u])-Ke(e,u,"border",!1,i)-.5)),s&&(r=te.exec(t))&&"px"!==(r[3]||"px")&&(e.style[u]=t,t=S.css(e,u)),Je(0,t,s)}}}),S.cssHooks.marginLeft=$e(y.reliableMarginLeft,function(e,t){if(t)return(parseFloat(Be(e,"marginLeft"))||e.getBoundingClientRect().left-We(e,{marginLeft:0},function(){return e.getBoundingClientRect().left}))+"px"}),S.each({margin:"",padding:"",border:"Width"},function(i,o){S.cssHooks[i+o]={expand:function(e){for(var t=0,n={},r="string"==typeof e?e.split(" "):[e];t<4;t++)n[i+ne[t]+o]=r[t]||r[t-2]||r[0];return n}},"margin"!==i&&(S.cssHooks[i+o].set=Je)}),S.fn.extend({css:function(e,t){return $(this,function(e,t,n){var r,i,o={},a=0;if(Array.isArray(t)){for(r=Ie(e),i=t.length;a<i;a++)o[t[a]]=S.css(e,t[a],!1,r);return o}return void 0!==n?S.style(e,t,n):S.css(e,t)},e,t,1<arguments.length)}}),((S.Tween=et).prototype={constructor:et,init:function(e,t,n,r,i,o){this.elem=e,this.prop=n,this.easing=i||S.easing._default,this.options=t,this.start=this.now=this.cur(),this.end=r,this.unit=o||(S.cssNumber[n]?"":"px")},cur:function(){var e=et.propHooks[this.prop];return e&&e.get?e.get(this):et.propHooks._default.get(this)},run:function(e){var t,n=et.propHooks[this.prop];return this.options.duration?this.pos=t=S.easing[this.easing](e,this.options.duration*e,0,1,this.options.duration):this.pos=t=e,this.now=(this.end-this.start)*t+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),n&&n.set?n.set(this):et.propHooks._default.set(this),this}}).init.prototype=et.prototype,(et.propHooks={_default:{get:function(e){var t;return 1!==e.elem.nodeType||null!=e.elem[e.prop]&&null==e.elem.style[e.prop]?e.elem[e.prop]:(t=S.css(e.elem,e.prop,""))&&"auto"!==t?t:0},set:function(e){S.fx.step[e.prop]?S.fx.step[e.prop](e):1!==e.elem.nodeType||!S.cssHooks[e.prop]&&null==e.elem.style[Xe(e.prop)]?e.elem[e.prop]=e.now:S.style(e.elem,e.prop,e.now+e.unit)}}}).scrollTop=et.propHooks.scrollLeft={set:function(e){e.elem.nodeType&&e.elem.parentNode&&(e.elem[e.prop]=e.now)}},S.easing={linear:function(e){return e},swing:function(e){return.5-Math.cos(e*Math.PI)/2},_default:"swing"},S.fx=et.prototype.init,S.fx.step={};var tt,nt,rt,it,ot=/^(?:toggle|show|hide)$/,at=/queueHooks$/;function st(){nt&&(!1===E.hidden&&C.requestAnimationFrame?C.requestAnimationFrame(st):C.setTimeout(st,S.fx.interval),S.fx.tick())}function ut(){return C.setTimeout(function(){tt=void 0}),tt=Date.now()}function lt(e,t){var n,r=0,i={height:e};for(t=t?1:0;r<4;r+=2-t)i["margin"+(n=ne[r])]=i["padding"+n]=e;return t&&(i.opacity=i.width=e),i}function ct(e,t,n){for(var r,i=(ft.tweeners[t]||[]).concat(ft.tweeners["*"]),o=0,a=i.length;o<a;o++)if(r=i[o].call(n,t,e))return r}function ft(o,e,t){var n,a,r=0,i=ft.prefilters.length,s=S.Deferred().always(function(){delete u.elem}),u=function(){if(a)return!1;for(var e=tt||ut(),t=Math.max(0,l.startTime+l.duration-e),n=1-(t/l.duration||0),r=0,i=l.tweens.length;r<i;r++)l.tweens[r].run(n);return s.notifyWith(o,[l,n,t]),n<1&&i?t:(i||s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l]),!1)},l=s.promise({elem:o,props:S.extend({},e),opts:S.extend(!0,{specialEasing:{},easing:S.easing._default},t),originalProperties:e,originalOptions:t,startTime:tt||ut(),duration:t.duration,tweens:[],createTween:function(e,t){var n=S.Tween(o,l.opts,e,t,l.opts.specialEasing[e]||l.opts.easing);return l.tweens.push(n),n},stop:function(e){var t=0,n=e?l.tweens.length:0;if(a)return this;for(a=!0;t<n;t++)l.tweens[t].run(1);return e?(s.notifyWith(o,[l,1,0]),s.resolveWith(o,[l,e])):s.rejectWith(o,[l,e]),this}}),c=l.props;for(!function(e,t){var n,r,i,o,a;for(n in e)if(i=t[r=X(n)],o=e[n],Array.isArray(o)&&(i=o[1],o=e[n]=o[0]),n!==r&&(e[r]=o,delete e[n]),(a=S.cssHooks[r])&&"expand"in a)for(n in o=a.expand(o),delete e[r],o)n in e||(e[n]=o[n],t[n]=i);else t[r]=i}(c,l.opts.specialEasing);r<i;r++)if(n=ft.prefilters[r].call(l,o,c,l.opts))return m(n.stop)&&(S._queueHooks(l.elem,l.opts.queue).stop=n.stop.bind(n)),n;return S.map(c,ct,l),m(l.opts.start)&&l.opts.start.call(o,l),l.progress(l.opts.progress).done(l.opts.done,l.opts.complete).fail(l.opts.fail).always(l.opts.always),S.fx.timer(S.extend(u,{elem:o,anim:l,queue:l.opts.queue})),l}S.Animation=S.extend(ft,{tweeners:{"*":[function(e,t){var n=this.createTween(e,t);return se(n.elem,e,te.exec(t),n),n}]},tweener:function(e,t){m(e)?(t=e,e=["*"]):e=e.match(P);for(var n,r=0,i=e.length;r<i;r++)n=e[r],ft.tweeners[n]=ft.tweeners[n]||[],ft.tweeners[n].unshift(t)},prefilters:[function(e,t,n){var r,i,o,a,s,u,l,c,f="width"in t||"height"in t,p=this,d={},h=e.style,g=e.nodeType&&ae(e),v=Y.get(e,"fxshow");for(r in n.queue||(null==(a=S._queueHooks(e,"fx")).unqueued&&(a.unqueued=0,s=a.empty.fire,a.empty.fire=function(){a.unqueued||s()}),a.unqueued++,p.always(function(){p.always(function(){a.unqueued--,S.queue(e,"fx").length||a.empty.fire()})})),t)if(i=t[r],ot.test(i)){if(delete t[r],o=o||"toggle"===i,i===(g?"hide":"show")){if("show"!==i||!v||void 0===v[r])continue;g=!0}d[r]=v&&v[r]||S.style(e,r)}if((u=!S.isEmptyObject(t))||!S.isEmptyObject(d))for(r in f&&1===e.nodeType&&(n.overflow=[h.overflow,h.overflowX,h.overflowY],null==(l=v&&v.display)&&(l=Y.get(e,"display")),"none"===(c=S.css(e,"display"))&&(l?c=l:(le([e],!0),l=e.style.display||l,c=S.css(e,"display"),le([e]))),("inline"===c||"inline-block"===c&&null!=l)&&"none"===S.css(e,"float")&&(u||(p.done(function(){h.display=l}),null==l&&(c=h.display,l="none"===c?"":c)),h.display="inline-block")),n.overflow&&(h.overflow="hidden",p.always(function(){h.overflow=n.overflow[0],h.overflowX=n.overflow[1],h.overflowY=n.overflow[2]})),u=!1,d)u||(v?"hidden"in v&&(g=v.hidden):v=Y.access(e,"fxshow",{display:l}),o&&(v.hidden=!g),g&&le([e],!0),p.done(function(){for(r in g||le([e]),Y.remove(e,"fxshow"),d)S.style(e,r,d[r])})),u=ct(g?v[r]:0,r,p),r in v||(v[r]=u.start,g&&(u.end=u.start,u.start=0))}],prefilter:function(e,t){t?ft.prefilters.unshift(e):ft.prefilters.push(e)}}),S.speed=function(e,t,n){var r=e&&"object"==typeof e?S.extend({},e):{complete:n||!n&&t||m(e)&&e,duration:e,easing:n&&t||t&&!m(t)&&t};return S.fx.off?r.duration=0:"number"!=typeof r.duration&&(r.duration in S.fx.speeds?r.duration=S.fx.speeds[r.duration]:r.duration=S.fx.speeds._default),null!=r.queue&&!0!==r.queue||(r.queue="fx"),r.old=r.complete,r.complete=function(){m(r.old)&&r.old.call(this),r.queue&&S.dequeue(this,r.queue)},r},S.fn.extend({fadeTo:function(e,t,n,r){return this.filter(ae).css("opacity",0).show().end().animate({opacity:t},e,n,r)},animate:function(t,e,n,r){var i=S.isEmptyObject(t),o=S.speed(e,n,r),a=function(){var e=ft(this,S.extend({},t),o);(i||Y.get(this,"finish"))&&e.stop(!0)};return a.finish=a,i||!1===o.queue?this.each(a):this.queue(o.queue,a)},stop:function(i,e,o){var a=function(e){var t=e.stop;delete e.stop,t(o)};return"string"!=typeof i&&(o=e,e=i,i=void 0),e&&this.queue(i||"fx",[]),this.each(function(){var e=!0,t=null!=i&&i+"queueHooks",n=S.timers,r=Y.get(this);if(t)r[t]&&r[t].stop&&a(r[t]);else for(t in r)r[t]&&r[t].stop&&at.test(t)&&a(r[t]);for(t=n.length;t--;)n[t].elem!==this||null!=i&&n[t].queue!==i||(n[t].anim.stop(o),e=!1,n.splice(t,1));!e&&o||S.dequeue(this,i)})},finish:function(a){return!1!==a&&(a=a||"fx"),this.each(function(){var e,t=Y.get(this),n=t[a+"queue"],r=t[a+"queueHooks"],i=S.timers,o=n?n.length:0;for(t.finish=!0,S.queue(this,a,[]),r&&r.stop&&r.stop.call(this,!0),e=i.length;e--;)i[e].elem===this&&i[e].queue===a&&(i[e].anim.stop(!0),i.splice(e,1));for(e=0;e<o;e++)n[e]&&n[e].finish&&n[e].finish.call(this);delete t.finish})}}),S.each(["toggle","show","hide"],function(e,r){var i=S.fn[r];S.fn[r]=function(e,t,n){return null==e||"boolean"==typeof e?i.apply(this,arguments):this.animate(lt(r,!0),e,t,n)}}),S.each({slideDown:lt("show"),slideUp:lt("hide"),slideToggle:lt("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(e,r){S.fn[e]=function(e,t,n){return this.animate(r,e,t,n)}}),S.timers=[],S.fx.tick=function(){var e,t=0,n=S.timers;for(tt=Date.now();t<n.length;t++)(e=n[t])()||n[t]!==e||n.splice(t--,1);n.length||S.fx.stop(),tt=void 0},S.fx.timer=function(e){S.timers.push(e),S.fx.start()},S.fx.interval=13,S.fx.start=function(){nt||(nt=!0,st())},S.fx.stop=function(){nt=null},S.fx.speeds={slow:600,fast:200,_default:400},S.fn.delay=function(r,e){return r=S.fx&&S.fx.speeds[r]||r,e=e||"fx",this.queue(e,function(e,t){var n=C.setTimeout(e,r);t.stop=function(){C.clearTimeout(n)}})},rt=E.createElement("input"),it=E.createElement("select").appendChild(E.createElement("option")),rt.type="checkbox",y.checkOn=""!==rt.value,y.optSelected=it.selected,(rt=E.createElement("input")).value="t",rt.type="radio",y.radioValue="t"===rt.value;var pt,dt=S.expr.attrHandle;S.fn.extend({attr:function(e,t){return $(this,S.attr,e,t,1<arguments.length)},removeAttr:function(e){return this.each(function(){S.removeAttr(this,e)})}}),S.extend({attr:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return"undefined"==typeof e.getAttribute?S.prop(e,t,n):(1===o&&S.isXMLDoc(e)||(i=S.attrHooks[t.toLowerCase()]||(S.expr.match.bool.test(t)?pt:void 0)),void 0!==n?null===n?void S.removeAttr(e,t):i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:(e.setAttribute(t,n+""),n):i&&"get"in i&&null!==(r=i.get(e,t))?r:null==(r=S.find.attr(e,t))?void 0:r)},attrHooks:{type:{set:function(e,t){if(!y.radioValue&&"radio"===t&&A(e,"input")){var n=e.value;return e.setAttribute("type",t),n&&(e.value=n),t}}}},removeAttr:function(e,t){var n,r=0,i=t&&t.match(P);if(i&&1===e.nodeType)while(n=i[r++])e.removeAttribute(n)}}),pt={set:function(e,t,n){return!1===t?S.removeAttr(e,n):e.setAttribute(n,n),n}},S.each(S.expr.match.bool.source.match(/\w+/g),function(e,t){var a=dt[t]||S.find.attr;dt[t]=function(e,t,n){var r,i,o=t.toLowerCase();return n||(i=dt[o],dt[o]=r,r=null!=a(e,t,n)?o:null,dt[o]=i),r}});var ht=/^(?:input|select|textarea|button)$/i,gt=/^(?:a|area)$/i;function vt(e){return(e.match(P)||[]).join(" ")}function yt(e){return e.getAttribute&&e.getAttribute("class")||""}function mt(e){return Array.isArray(e)?e:"string"==typeof e&&e.match(P)||[]}S.fn.extend({prop:function(e,t){return $(this,S.prop,e,t,1<arguments.length)},removeProp:function(e){return this.each(function(){delete this[S.propFix[e]||e]})}}),S.extend({prop:function(e,t,n){var r,i,o=e.nodeType;if(3!==o&&8!==o&&2!==o)return 1===o&&S.isXMLDoc(e)||(t=S.propFix[t]||t,i=S.propHooks[t]),void 0!==n?i&&"set"in i&&void 0!==(r=i.set(e,n,t))?r:e[t]=n:i&&"get"in i&&null!==(r=i.get(e,t))?r:e[t]},propHooks:{tabIndex:{get:function(e){var t=S.find.attr(e,"tabindex");return t?parseInt(t,10):ht.test(e.nodeName)||gt.test(e.nodeName)&&e.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),y.optSelected||(S.propHooks.selected={get:function(e){var t=e.parentNode;return t&&t.parentNode&&t.parentNode.selectedIndex,null},set:function(e){var t=e.parentNode;t&&(t.selectedIndex,t.parentNode&&t.parentNode.selectedIndex)}}),S.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){S.propFix[this.toLowerCase()]=this}),S.fn.extend({addClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).addClass(t.call(this,e,yt(this)))});if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])r.indexOf(" "+o+" ")<0&&(r+=o+" ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},removeClass:function(t){var e,n,r,i,o,a,s,u=0;if(m(t))return this.each(function(e){S(this).removeClass(t.call(this,e,yt(this)))});if(!arguments.length)return this.attr("class","");if((e=mt(t)).length)while(n=this[u++])if(i=yt(n),r=1===n.nodeType&&" "+vt(i)+" "){a=0;while(o=e[a++])while(-1<r.indexOf(" "+o+" "))r=r.replace(" "+o+" "," ");i!==(s=vt(r))&&n.setAttribute("class",s)}return this},toggleClass:function(i,t){var o=typeof i,a="string"===o||Array.isArray(i);return"boolean"==typeof t&&a?t?this.addClass(i):this.removeClass(i):m(i)?this.each(function(e){S(this).toggleClass(i.call(this,e,yt(this),t),t)}):this.each(function(){var e,t,n,r;if(a){t=0,n=S(this),r=mt(i);while(e=r[t++])n.hasClass(e)?n.removeClass(e):n.addClass(e)}else void 0!==i&&"boolean"!==o||((e=yt(this))&&Y.set(this,"__className__",e),this.setAttribute&&this.setAttribute("class",e||!1===i?"":Y.get(this,"__className__")||""))})},hasClass:function(e){var t,n,r=0;t=" "+e+" ";while(n=this[r++])if(1===n.nodeType&&-1<(" "+vt(yt(n))+" ").indexOf(t))return!0;return!1}});var xt=/\r/g;S.fn.extend({val:function(n){var r,e,i,t=this[0];return arguments.length?(i=m(n),this.each(function(e){var t;1===this.nodeType&&(null==(t=i?n.call(this,e,S(this).val()):n)?t="":"number"==typeof t?t+="":Array.isArray(t)&&(t=S.map(t,function(e){return null==e?"":e+""})),(r=S.valHooks[this.type]||S.valHooks[this.nodeName.toLowerCase()])&&"set"in r&&void 0!==r.set(this,t,"value")||(this.value=t))})):t?(r=S.valHooks[t.type]||S.valHooks[t.nodeName.toLowerCase()])&&"get"in r&&void 0!==(e=r.get(t,"value"))?e:"string"==typeof(e=t.value)?e.replace(xt,""):null==e?"":e:void 0}}),S.extend({valHooks:{option:{get:function(e){var t=S.find.attr(e,"value");return null!=t?t:vt(S.text(e))}},select:{get:function(e){var t,n,r,i=e.options,o=e.selectedIndex,a="select-one"===e.type,s=a?null:[],u=a?o+1:i.length;for(r=o<0?u:a?o:0;r<u;r++)if(((n=i[r]).selected||r===o)&&!n.disabled&&(!n.parentNode.disabled||!A(n.parentNode,"optgroup"))){if(t=S(n).val(),a)return t;s.push(t)}return s},set:function(e,t){var n,r,i=e.options,o=S.makeArray(t),a=i.length;while(a--)((r=i[a]).selected=-1<S.inArray(S.valHooks.option.get(r),o))&&(n=!0);return n||(e.selectedIndex=-1),o}}}}),S.each(["radio","checkbox"],function(){S.valHooks[this]={set:function(e,t){if(Array.isArray(t))return e.checked=-1<S.inArray(S(e).val(),t)}},y.checkOn||(S.valHooks[this].get=function(e){return null===e.getAttribute("value")?"on":e.value})}),y.focusin="onfocusin"in C;var bt=/^(?:focusinfocus|focusoutblur)$/,wt=function(e){e.stopPropagation()};S.extend(S.event,{trigger:function(e,t,n,r){var i,o,a,s,u,l,c,f,p=[n||E],d=v.call(e,"type")?e.type:e,h=v.call(e,"namespace")?e.namespace.split("."):[];if(o=f=a=n=n||E,3!==n.nodeType&&8!==n.nodeType&&!bt.test(d+S.event.triggered)&&(-1<d.indexOf(".")&&(d=(h=d.split(".")).shift(),h.sort()),u=d.indexOf(":")<0&&"on"+d,(e=e[S.expando]?e:new S.Event(d,"object"==typeof e&&e)).isTrigger=r?2:3,e.namespace=h.join("."),e.rnamespace=e.namespace?new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,e.result=void 0,e.target||(e.target=n),t=null==t?[e]:S.makeArray(t,[e]),c=S.event.special[d]||{},r||!c.trigger||!1!==c.trigger.apply(n,t))){if(!r&&!c.noBubble&&!x(n)){for(s=c.delegateType||d,bt.test(s+d)||(o=o.parentNode);o;o=o.parentNode)p.push(o),a=o;a===(n.ownerDocument||E)&&p.push(a.defaultView||a.parentWindow||C)}i=0;while((o=p[i++])&&!e.isPropagationStopped())f=o,e.type=1<i?s:c.bindType||d,(l=(Y.get(o,"events")||Object.create(null))[e.type]&&Y.get(o,"handle"))&&l.apply(o,t),(l=u&&o[u])&&l.apply&&V(o)&&(e.result=l.apply(o,t),!1===e.result&&e.preventDefault());return e.type=d,r||e.isDefaultPrevented()||c._default&&!1!==c._default.apply(p.pop(),t)||!V(n)||u&&m(n[d])&&!x(n)&&((a=n[u])&&(n[u]=null),S.event.triggered=d,e.isPropagationStopped()&&f.addEventListener(d,wt),n[d](),e.isPropagationStopped()&&f.removeEventListener(d,wt),S.event.triggered=void 0,a&&(n[u]=a)),e.result}},simulate:function(e,t,n){var r=S.extend(new S.Event,n,{type:e,isSimulated:!0});S.event.trigger(r,null,t)}}),S.fn.extend({trigger:function(e,t){return this.each(function(){S.event.trigger(e,t,this)})},triggerHandler:function(e,t){var n=this[0];if(n)return S.event.trigger(e,t,n,!0)}}),y.focusin||S.each({focus:"focusin",blur:"focusout"},function(n,r){var i=function(e){S.event.simulate(r,e.target,S.event.fix(e))};S.event.special[r]={setup:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r);t||e.addEventListener(n,i,!0),Y.access(e,r,(t||0)+1)},teardown:function(){var e=this.ownerDocument||this.document||this,t=Y.access(e,r)-1;t?Y.access(e,r,t):(e.removeEventListener(n,i,!0),Y.remove(e,r))}}});var Tt=C.location,Ct={guid:Date.now()},Et=/\?/;S.parseXML=function(e){var t;if(!e||"string"!=typeof e)return null;try{t=(new C.DOMParser).parseFromString(e,"text/xml")}catch(e){t=void 0}return t&&!t.getElementsByTagName("parsererror").length||S.error("Invalid XML: "+e),t};var St=/\[\]$/,kt=/\r?\n/g,At=/^(?:submit|button|image|reset|file)$/i,Nt=/^(?:input|select|textarea|keygen)/i;function Dt(n,e,r,i){var t;if(Array.isArray(e))S.each(e,function(e,t){r||St.test(n)?i(n,t):Dt(n+"["+("object"==typeof t&&null!=t?e:"")+"]",t,r,i)});else if(r||"object"!==w(e))i(n,e);else for(t in e)Dt(n+"["+t+"]",e[t],r,i)}S.param=function(e,t){var n,r=[],i=function(e,t){var n=m(t)?t():t;r[r.length]=encodeURIComponent(e)+"="+encodeURIComponent(null==n?"":n)};if(null==e)return"";if(Array.isArray(e)||e.jquery&&!S.isPlainObject(e))S.each(e,function(){i(this.name,this.value)});else for(n in e)Dt(n,e[n],t,i);return r.join("&")},S.fn.extend({serialize:function(){return S.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var e=S.prop(this,"elements");return e?S.makeArray(e):this}).filter(function(){var e=this.type;return this.name&&!S(this).is(":disabled")&&Nt.test(this.nodeName)&&!At.test(e)&&(this.checked||!pe.test(e))}).map(function(e,t){var n=S(this).val();return null==n?null:Array.isArray(n)?S.map(n,function(e){return{name:t.name,value:e.replace(kt,"\r\n")}}):{name:t.name,value:n.replace(kt,"\r\n")}}).get()}});var jt=/%20/g,qt=/#.*$/,Lt=/([?&])_=[^&]*/,Ht=/^(.*?):[ \t]*([^\r\n]*)$/gm,Ot=/^(?:GET|HEAD)$/,Pt=/^\/\//,Rt={},Mt={},It="*/".concat("*"),Wt=E.createElement("a");function Ft(o){return function(e,t){"string"!=typeof e&&(t=e,e="*");var n,r=0,i=e.toLowerCase().match(P)||[];if(m(t))while(n=i[r++])"+"===n[0]?(n=n.slice(1)||"*",(o[n]=o[n]||[]).unshift(t)):(o[n]=o[n]||[]).push(t)}}function Bt(t,i,o,a){var s={},u=t===Mt;function l(e){var r;return s[e]=!0,S.each(t[e]||[],function(e,t){var n=t(i,o,a);return"string"!=typeof n||u||s[n]?u?!(r=n):void 0:(i.dataTypes.unshift(n),l(n),!1)}),r}return l(i.dataTypes[0])||!s["*"]&&l("*")}function $t(e,t){var n,r,i=S.ajaxSettings.flatOptions||{};for(n in t)void 0!==t[n]&&((i[n]?e:r||(r={}))[n]=t[n]);return r&&S.extend(!0,e,r),e}Wt.href=Tt.href,S.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:Tt.href,type:"GET",isLocal:/^(?:about|app|app-storage|.+-extension|file|res|widget):$/.test(Tt.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":It,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":S.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(e,t){return t?$t($t(e,S.ajaxSettings),t):$t(S.ajaxSettings,e)},ajaxPrefilter:Ft(Rt),ajaxTransport:Ft(Mt),ajax:function(e,t){"object"==typeof e&&(t=e,e=void 0),t=t||{};var c,f,p,n,d,r,h,g,i,o,v=S.ajaxSetup({},t),y=v.context||v,m=v.context&&(y.nodeType||y.jquery)?S(y):S.event,x=S.Deferred(),b=S.Callbacks("once memory"),w=v.statusCode||{},a={},s={},u="canceled",T={readyState:0,getResponseHeader:function(e){var t;if(h){if(!n){n={};while(t=Ht.exec(p))n[t[1].toLowerCase()+" "]=(n[t[1].toLowerCase()+" "]||[]).concat(t[2])}t=n[e.toLowerCase()+" "]}return null==t?null:t.join(", ")},getAllResponseHeaders:function(){return h?p:null},setRequestHeader:function(e,t){return null==h&&(e=s[e.toLowerCase()]=s[e.toLowerCase()]||e,a[e]=t),this},overrideMimeType:function(e){return null==h&&(v.mimeType=e),this},statusCode:function(e){var t;if(e)if(h)T.always(e[T.status]);else for(t in e)w[t]=[w[t],e[t]];return this},abort:function(e){var t=e||u;return c&&c.abort(t),l(0,t),this}};if(x.promise(T),v.url=((e||v.url||Tt.href)+"").replace(Pt,Tt.protocol+"//"),v.type=t.method||t.type||v.method||v.type,v.dataTypes=(v.dataType||"*").toLowerCase().match(P)||[""],null==v.crossDomain){r=E.createElement("a");try{r.href=v.url,r.href=r.href,v.crossDomain=Wt.protocol+"//"+Wt.host!=r.protocol+"//"+r.host}catch(e){v.crossDomain=!0}}if(v.data&&v.processData&&"string"!=typeof v.data&&(v.data=S.param(v.data,v.traditional)),Bt(Rt,v,t,T),h)return T;for(i in(g=S.event&&v.global)&&0==S.active++&&S.event.trigger("ajaxStart"),v.type=v.type.toUpperCase(),v.hasContent=!Ot.test(v.type),f=v.url.replace(qt,""),v.hasContent?v.data&&v.processData&&0===(v.contentType||"").indexOf("application/x-www-form-urlencoded")&&(v.data=v.data.replace(jt,"+")):(o=v.url.slice(f.length),v.data&&(v.processData||"string"==typeof v.data)&&(f+=(Et.test(f)?"&":"?")+v.data,delete v.data),!1===v.cache&&(f=f.replace(Lt,"$1"),o=(Et.test(f)?"&":"?")+"_="+Ct.guid+++o),v.url=f+o),v.ifModified&&(S.lastModified[f]&&T.setRequestHeader("If-Modified-Since",S.lastModified[f]),S.etag[f]&&T.setRequestHeader("If-None-Match",S.etag[f])),(v.data&&v.hasContent&&!1!==v.contentType||t.contentType)&&T.setRequestHeader("Content-Type",v.contentType),T.setRequestHeader("Accept",v.dataTypes[0]&&v.accepts[v.dataTypes[0]]?v.accepts[v.dataTypes[0]]+("*"!==v.dataTypes[0]?", "+It+"; q=0.01":""):v.accepts["*"]),v.headers)T.setRequestHeader(i,v.headers[i]);if(v.beforeSend&&(!1===v.beforeSend.call(y,T,v)||h))return T.abort();if(u="abort",b.add(v.complete),T.done(v.success),T.fail(v.error),c=Bt(Mt,v,t,T)){if(T.readyState=1,g&&m.trigger("ajaxSend",[T,v]),h)return T;v.async&&0<v.timeout&&(d=C.setTimeout(function(){T.abort("timeout")},v.timeout));try{h=!1,c.send(a,l)}catch(e){if(h)throw e;l(-1,e)}}else l(-1,"No Transport");function l(e,t,n,r){var i,o,a,s,u,l=t;h||(h=!0,d&&C.clearTimeout(d),c=void 0,p=r||"",T.readyState=0<e?4:0,i=200<=e&&e<300||304===e,n&&(s=function(e,t,n){var r,i,o,a,s=e.contents,u=e.dataTypes;while("*"===u[0])u.shift(),void 0===r&&(r=e.mimeType||t.getResponseHeader("Content-Type"));if(r)for(i in s)if(s[i]&&s[i].test(r)){u.unshift(i);break}if(u[0]in n)o=u[0];else{for(i in n){if(!u[0]||e.converters[i+" "+u[0]]){o=i;break}a||(a=i)}o=o||a}if(o)return o!==u[0]&&u.unshift(o),n[o]}(v,T,n)),!i&&-1<S.inArray("script",v.dataTypes)&&(v.converters["text script"]=function(){}),s=function(e,t,n,r){var i,o,a,s,u,l={},c=e.dataTypes.slice();if(c[1])for(a in e.converters)l[a.toLowerCase()]=e.converters[a];o=c.shift();while(o)if(e.responseFields[o]&&(n[e.responseFields[o]]=t),!u&&r&&e.dataFilter&&(t=e.dataFilter(t,e.dataType)),u=o,o=c.shift())if("*"===o)o=u;else if("*"!==u&&u!==o){if(!(a=l[u+" "+o]||l["* "+o]))for(i in l)if((s=i.split(" "))[1]===o&&(a=l[u+" "+s[0]]||l["* "+s[0]])){!0===a?a=l[i]:!0!==l[i]&&(o=s[0],c.unshift(s[1]));break}if(!0!==a)if(a&&e["throws"])t=a(t);else try{t=a(t)}catch(e){return{state:"parsererror",error:a?e:"No conversion from "+u+" to "+o}}}return{state:"success",data:t}}(v,s,T,i),i?(v.ifModified&&((u=T.getResponseHeader("Last-Modified"))&&(S.lastModified[f]=u),(u=T.getResponseHeader("etag"))&&(S.etag[f]=u)),204===e||"HEAD"===v.type?l="nocontent":304===e?l="notmodified":(l=s.state,o=s.data,i=!(a=s.error))):(a=l,!e&&l||(l="error",e<0&&(e=0))),T.status=e,T.statusText=(t||l)+"",i?x.resolveWith(y,[o,l,T]):x.rejectWith(y,[T,l,a]),T.statusCode(w),w=void 0,g&&m.trigger(i?"ajaxSuccess":"ajaxError",[T,v,i?o:a]),b.fireWith(y,[T,l]),g&&(m.trigger("ajaxComplete",[T,v]),--S.active||S.event.trigger("ajaxStop")))}return T},getJSON:function(e,t,n){return S.get(e,t,n,"json")},getScript:function(e,t){return S.get(e,void 0,t,"script")}}),S.each(["get","post"],function(e,i){S[i]=function(e,t,n,r){return m(t)&&(r=r||n,n=t,t=void 0),S.ajax(S.extend({url:e,type:i,dataType:r,data:t,success:n},S.isPlainObject(e)&&e))}}),S.ajaxPrefilter(function(e){var t;for(t in e.headers)"content-type"===t.toLowerCase()&&(e.contentType=e.headers[t]||"")}),S._evalUrl=function(e,t,n){return S.ajax({url:e,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,converters:{"text script":function(){}},dataFilter:function(e){S.globalEval(e,t,n)}})},S.fn.extend({wrapAll:function(e){var t;return this[0]&&(m(e)&&(e=e.call(this[0])),t=S(e,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstElementChild)e=e.firstElementChild;return e}).append(this)),this},wrapInner:function(n){return m(n)?this.each(function(e){S(this).wrapInner(n.call(this,e))}):this.each(function(){var e=S(this),t=e.contents();t.length?t.wrapAll(n):e.append(n)})},wrap:function(t){var n=m(t);return this.each(function(e){S(this).wrapAll(n?t.call(this,e):t)})},unwrap:function(e){return this.parent(e).not("body").each(function(){S(this).replaceWith(this.childNodes)}),this}}),S.expr.pseudos.hidden=function(e){return!S.expr.pseudos.visible(e)},S.expr.pseudos.visible=function(e){return!!(e.offsetWidth||e.offsetHeight||e.getClientRects().length)},S.ajaxSettings.xhr=function(){try{return new C.XMLHttpRequest}catch(e){}};var _t={0:200,1223:204},zt=S.ajaxSettings.xhr();y.cors=!!zt&&"withCredentials"in zt,y.ajax=zt=!!zt,S.ajaxTransport(function(i){var o,a;if(y.cors||zt&&!i.crossDomain)return{send:function(e,t){var n,r=i.xhr();if(r.open(i.type,i.url,i.async,i.username,i.password),i.xhrFields)for(n in i.xhrFields)r[n]=i.xhrFields[n];for(n in i.mimeType&&r.overrideMimeType&&r.overrideMimeType(i.mimeType),i.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest"),e)r.setRequestHeader(n,e[n]);o=function(e){return function(){o&&(o=a=r.onload=r.onerror=r.onabort=r.ontimeout=r.onreadystatechange=null,"abort"===e?r.abort():"error"===e?"number"!=typeof r.status?t(0,"error"):t(r.status,r.statusText):t(_t[r.status]||r.status,r.statusText,"text"!==(r.responseType||"text")||"string"!=typeof r.responseText?{binary:r.response}:{text:r.responseText},r.getAllResponseHeaders()))}},r.onload=o(),a=r.onerror=r.ontimeout=o("error"),void 0!==r.onabort?r.onabort=a:r.onreadystatechange=function(){4===r.readyState&&C.setTimeout(function(){o&&a()})},o=o("abort");try{r.send(i.hasContent&&i.data||null)}catch(e){if(o)throw e}},abort:function(){o&&o()}}}),S.ajaxPrefilter(function(e){e.crossDomain&&(e.contents.script=!1)}),S.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(e){return S.globalEval(e),e}}}),S.ajaxPrefilter("script",function(e){void 0===e.cache&&(e.cache=!1),e.crossDomain&&(e.type="GET")}),S.ajaxTransport("script",function(n){var r,i;if(n.crossDomain||n.scriptAttrs)return{send:function(e,t){r=S("<script>").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="<form></form><form></form>",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1<s&&(r=vt(e.slice(s)),e=e.slice(0,s)),m(t)?(n=t,t=void 0):t&&"object"==typeof t&&(i="POST"),0<a.length&&S.ajax({url:e,type:i||"GET",dataType:"html",data:t}).done(function(e){o=arguments,a.html(r?S("<div>").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0<arguments.length?this.on(n,null,e,t):this.trigger(n)}});var Gt=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;S.proxy=function(e,t){var n,r,i;if("string"==typeof t&&(n=e[t],t=e,e=n),m(e))return r=s.call(arguments,2),(i=function(){return e.apply(t||this,r.concat(s.call(arguments)))}).guid=e.guid=e.guid||S.guid++,i},S.holdReady=function(e){e?S.readyWait++:S.ready(!0)},S.isArray=Array.isArray,S.parseJSON=JSON.parse,S.nodeName=A,S.isFunction=m,S.isWindow=x,S.camelCase=X,S.type=w,S.now=Date.now,S.isNumeric=function(e){var t=S.type(e);return("number"===t||"string"===t)&&!isNaN(e-parseFloat(e))},S.trim=function(e){return null==e?"":(e+"").replace(Gt,"")},"function"==typeof define&&define.amd&&define("jquery",[],function(){return S});var Yt=C.jQuery,Qt=C.$;return S.noConflict=function(e){return C.$===S&&(C.$=Qt),e&&C.jQuery===S&&(C.jQuery=Yt),S},"undefined"==typeof e&&(C.jQuery=C.$=S),S});
+</script>
+<script type="text/javascript">
+/*
+ * jQuery Templates Plugin 1.0.0pre
+ * http://github.com/jquery/jquery-tmpl
+ * Requires jQuery 1.4.2
+ *
+ * Copyright Software Freedom Conservancy, Inc.
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ */
+(function(a){var r=a.fn.domManip,d="_tmplitem",q=/^[^<]*(<[\w\W]+>)[^>]*$|\{\{\! /,b={},f={},e,p={key:0,data:{}},i=0,c=0,l=[];function g(g,d,h,e){var c={data:e||(e===0||e===false)?e:d?d.data:{},_wrap:d?d._wrap:null,tmpl:null,parent:d||null,nodes:[],calls:u,nest:w,wrap:x,html:v,update:t};g&&a.extend(c,g,{nodes:[],parent:d});if(h){c.tmpl=h;c._ctnt=c._ctnt||c.tmpl(a,c);c.key=++i;(l.length?f:b)[i]=c}return c}a.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(f,d){a.fn[f]=function(n){var g=[],i=a(n),k,h,m,l,j=this.length===1&&this[0].parentNode;e=b||{};if(j&&j.nodeType===11&&j.childNodes.length===1&&i.length===1){i[d](this[0]);g=this}else{for(h=0,m=i.length;h<m;h++){c=h;k=(h>0?this.clone(true):this).get();a(i[h])[d](k);g=g.concat(k)}c=0;g=this.pushStack(g,f,i.selector)}l=e;e=null;a.tmpl.complete(l);return g}});a.fn.extend({tmpl:function(d,c,b){return a.tmpl(this[0],d,c,b)},tmplItem:function(){return a.tmplItem(this[0])},template:function(b){return a.template(b,this[0])},domManip:function(d,m,k){if(d[0]&&a.isArray(d[0])){var g=a.makeArray(arguments),h=d[0],j=h.length,i=0,f;while(i<j&&!(f=a.data(h[i++],"tmplItem")));if(f&&c)g[2]=function(b){a.tmpl.afterManip(this,b,k)};r.apply(this,g)}else r.apply(this,arguments);c=0;!e&&a.tmpl.complete(b);return this}});a.extend({tmpl:function(d,h,e,c){var i,k=!c;if(k){c=p;d=a.template[d]||a.template(null,d);f={}}else if(!d){d=c.tmpl;b[c.key]=c;c.nodes=[];c.wrapped&&n(c,c.wrapped);return a(j(c,null,c.tmpl(a,c)))}if(!d)return[];if(typeof h==="function")h=h.call(c||{});e&&e.wrapped&&n(e,e.wrapped);i=a.isArray(h)?a.map(h,function(a){return a?g(e,c,d,a):null}):[g(e,c,d,h)];return k?a(j(c,null,i)):i},tmplItem:function(b){var c;if(b instanceof a)b=b[0];while(b&&b.nodeType===1&&!(c=a.data(b,"tmplItem"))&&(b=b.parentNode));return c||p},template:function(c,b){if(b){if(typeof b==="string")b=o(b);else if(b instanceof a)b=b[0]||{};if(b.nodeType)b=a.data(b,"tmpl")||a.data(b,"tmpl",o(b.innerHTML));return typeof c==="string"?(a.template[c]=b):b}return c?typeof c!=="string"?a.template(null,c):a.template[c]||a.template(null,q.test(c)?c:a(c)):null},encode:function(a){return(""+a).split("&").join("&amp;").split("<").join("&lt;").split(">").join("&gt;").split('"').join("&#34;").split("'").join("&#39;")}});a.extend(a.tmpl,{tag:{tmpl:{_default:{$2:"null"},open:"if($notnull_1){__=__.concat($item.nest($1,$2));}"},wrap:{_default:{$2:"null"},open:"$item.calls(__,$1,$2);__=[];",close:"call=$item.calls();__=call._.concat($item.wrap(call,__));"},each:{_default:{$2:"$index, $value"},open:"if($notnull_1){$.each($1a,function($2){with(this){",close:"}});}"},"if":{open:"if(($notnull_1) && $1a){",close:"}"},"else":{_default:{$1:"true"},open:"}else if(($notnull_1) && $1a){"},html:{open:"if($notnull_1){__.push($1a);}"},"=":{_default:{$1:"$data"},open:"if($notnull_1){__.push($.encode($1a));}"},"!":{open:""}},complete:function(){b={}},afterManip:function(f,b,d){var e=b.nodeType===11?a.makeArray(b.childNodes):b.nodeType===1?[b]:[];d.call(f,b);m(e);c++}});function j(e,g,f){var b,c=f?a.map(f,function(a){return typeof a==="string"?e.key?a.replace(/(<\w+)(?=[\s>])(?![^>]*_tmplitem)([^>]*)/g,"$1 "+d+'="'+e.key+'" $2'):a:j(a,e,a._ctnt)}):e;if(g)return c;c=c.join("");c.replace(/^\s*([^<\s][^<]*)?(<[\w\W]+>)([^>]*[^>\s])?\s*$/,function(f,c,e,d){b=a(e).get();m(b);if(c)b=k(c).concat(b);if(d)b=b.concat(k(d))});return b?b:k(c)}function k(c){var b=document.createElement("div");b.innerHTML=c;return a.makeArray(b.childNodes)}function o(b){return new Function("jQuery","$item","var $=jQuery,call,__=[],$data=$item.data;with($data){__.push('"+a.trim(b).replace(/([\\'])/g,"\\$1").replace(/[\r\t\n]/g," ").replace(/\$\{([^\}]*)\}/g,"{{= $1}}").replace(/\{\{(\/?)(\w+|.)(?:\(((?:[^\}]|\}(?!\}))*?)?\))?(?:\s+(.*?)?)?(\(((?:[^\}]|\}(?!\}))*?)\))?\s*\}\}/g,function(m,l,k,g,b,c,d){var j=a.tmpl.tag[k],i,e,f;if(!j)throw"Unknown template tag: "+k;i=j._default||[];if(c&&!/\w$/.test(b)){b+=c;c=""}if(b){b=h(b);d=d?","+h(d)+")":c?")":"";e=c?b.indexOf(".")>-1?b+h(c):"("+b+").call($item"+d:b;f=c?e:"(typeof("+b+")==='function'?("+b+").call($item):("+b+"))"}else f=e=i.$1||"null";g=h(g);return"');"+j[l?"close":"open"].split("$notnull_1").join(b?"typeof("+b+")!=='undefined' && ("+b+")!=null":"true").split("$1a").join(f).split("$1").join(e).split("$2").join(g||i.$2||"")+"__.push('"})+"');}return __;")}function n(c,b){c._wrap=j(c,true,a.isArray(b)?b:[q.test(b)?b:a(b).html()]).join("")}function h(a){return a?a.replace(/\\'/g,"'").replace(/\\\\/g,"\\"):null}function s(b){var a=document.createElement("div");a.appendChild(b.cloneNode(true));return a.innerHTML}function m(o){var n="_"+c,k,j,l={},e,p,h;for(e=0,p=o.length;e<p;e++){if((k=o[e]).nodeType!==1)continue;j=k.getElementsByTagName("*");for(h=j.length-1;h>=0;h--)m(j[h]);m(k)}function m(j){var p,h=j,k,e,m;if(m=j.getAttribute(d)){while(h.parentNode&&(h=h.parentNode).nodeType===1&&!(p=h.getAttribute(d)));if(p!==m){h=h.parentNode?h.nodeType===11?0:h.getAttribute(d)||0:0;if(!(e=b[m])){e=f[m];e=g(e,b[h]||f[h]);e.key=++i;b[i]=e}c&&o(m)}j.removeAttribute(d)}else if(c&&(e=a.data(j,"tmplItem"))){o(e.key);b[e.key]=e;h=a.data(j.parentNode,"tmplItem");h=h?h.key:0}if(e){k=e;while(k&&k.key!=h){k.nodes.push(j);k=k.parent}delete e._ctnt;delete e._wrap;a.data(j,"tmplItem",e)}function o(a){a=a+n;e=l[a]=l[a]||g(e,b[e.parent.key+n]||e.parent)}}}function u(a,d,c,b){if(!a)return l.pop();l.push({_:a,tmpl:d,item:this,data:c,options:b})}function w(d,c,b){return a.tmpl(a.template(d),c,b,this)}function x(b,d){var c=b.options||{};c.wrapped=d;return a.tmpl(a.template(b.tmpl),b.data,c,b.item)}function v(d,c){var b=this._wrap;return a.map(a(a.isArray(b)?b.join(""):b).filter(d||"*"),function(a){return c?a.innerText||a.textContent:a.outerHTML||s(a)})}function t(){var b=this.nodes;a.tmpl(null,null,null,this).insertBefore(b[0]);a(b).remove()}})(jQuery);
+</script>
+<script type="text/javascript">
+/*
+ * jQuery Highlight plugin
+ *
+ * Based on highlight v3 by Johann Burkard
+ * http://johannburkard.de/blog/programming/javascript/highlight-javascript-text-higlighting-jquery-plugin.html
+ *
+ * Copyright (c) 2009 Bartek Szopka
+ *
+ * Licensed under MIT license.
+ */
+jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
+</script>
+<script type="text/javascript">
+libdoc = {"specversion": 3, "name": "Browser", "doc": "<p>Browser library is a browser automation library for Robot Framework.</p>\n<p>This is the keyword documentation for Browser library. For information about installation, support, and more please visit the <a href=\"https://github.com/MarketSquare/robotframework-playwright\">project pages</a>. For more information about Robot Framework itself, see <a href=\"https://robotframework.org\">robotframework.org</a>.</p>\n<p>Browser library uses <a href=\"https://github.com/microsoft/playwright\">Playwright Node module</a> to automate <a href=\"https://www.chromium.org/Home\">Chromium</a>, <a href=\"https://www.mozilla.org/en-US/firefox/new/\">Firefox</a> and <a href=\"https://webkit.org/\">WebKit</a> with a single library.</p>\n<h3 id=\"Table of contents\">Table of contents</h3>\n<ul>\n<li><a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a></li>\n<li><a href=\"#Automatic%20page%20and%20context%20closing\" class=\"name\">Automatic page and context closing</a></li>\n<li><a href=\"#Finding%20elements\" class=\"name\">Finding elements</a></li>\n<li><a href=\"#Assertions\" class=\"name\">Assertions</a></li>\n<li><a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a></li>\n<li><a href=\"#Experimental%3A%20Re-using%20same%20node%20process\" class=\"name\">Experimental: Re-using same node process</a></li>\n<li><a href=\"#Experimental%3A%20Provide%20parameters%20to%20node%20process\" class=\"name\">Experimental: Provide parameters to node process</a></li>\n<li><a href=\"#Scope%20Setting\" class=\"name\">Scope Setting</a></li>\n<li><a href=\"#Extending%20Browser%20library%20with%20a%20JavaScript%20module\" class=\"name\">Extending Browser library with a JavaScript module</a></li>\n<li><a href=\"#Plugins\" class=\"name\">Plugins</a></li>\n<li><a href=\"#Language\" class=\"name\">Language</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Browser, Context and Page\">Browser, Context and Page</h2>\n<p>Browser library works with three different layers that build on each other: <b>Browser</b>, <b>Context</b> and <b>Page</b>.</p>\n<h3 id=\"Browsers\">Browsers</h3>\n<p>A <b>browser</b> can be started with one of the three different engines Chromium, Firefox or Webkit.</p>\n<h4 id=\"Supported Browsers\">Supported Browsers</h4>\n<table border=\"1\">\n<tr>\n<td>Browser</td>\n<td>Browser with this engine</td>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td>Google Chrome, Microsoft Edge (since 2020), Opera</td>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td>Mozilla Firefox</td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td>Apple Safari, Mail, AppStore on MacOS and iOS</td>\n</tr>\n</table>\n<p>Since <a href=\"https://github.com/microsoft/playwright\">Playwright</a> comes with a pack of builtin binaries for all browsers, no additional drivers e.g. geckodriver are needed.</p>\n<p>All these browsers that cover more than 85% of the world wide used browsers, can be tested on Windows, Linux and MacOS. There is no need for dedicated machines anymore.</p>\n<p>A browser process is started <code>headless</code> (without a GUI) by default. Run <a href=\"#New%20Browser\" class=\"name\">New Browser</a> with specified arguments if a browser with a GUI is requested or if a proxy has to be configured. A browser process can contain several contexts.</p>\n<h3 id=\"Contexts\">Contexts</h3>\n<p>A <b>context</b> corresponds to a set of independent incognito pages in a browser that share cookies, sessions or profile settings. Pages in two separate contexts do not share cookies, sessions or profile settings. Compared to Selenium, these do <b>not</b> require their own browser process. To get a clean environment a test can just open a new context. Due to this new independent browser sessions can be opened with Robot Framework Browser about 10 times faster than with Selenium by just opening a <a href=\"#New%20Context\" class=\"name\">New Context</a> within the opened browser.</p>\n<p>To make pages in the same suite share state, use the same context by opening the context with <a href=\"#New%20Context\" class=\"name\">New Context</a> on suite setup.</p>\n<p>The context layer is useful e.g. for testing different user sessions on the same webpage without opening a whole new browser context. Contexts can also have detailed configurations, such as geo-location, language settings, the viewport size or color scheme. Contexts do also support http credentials to be set, so that basic authentication can also be tested. To be able to download files within the test, the <code>acceptDownloads</code> argument must be set to <code>True</code> in <a href=\"#New%20Context\" class=\"name\">New Context</a> keyword. A context can contain different pages.</p>\n<h3 id=\"Pages\">Pages</h3>\n<p>A <b>page</b> does contain the content of the loaded web site and has a browsing history. Pages and browser tabs are the same.</p>\n<p>Typical usage could be:</p>\n<pre>\n<b>*</b> Test Cases <b>*</b>\nStarting a browser with a page\n    New Browser    chromium    headless=false\n    New Context    viewport={'width': 1920, 'height': 1080}\n    New Page       <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html\">https://marketsquare.github.io/robotframework-browser/Browser.html</a>\n    Get Title      ==    Browser\n</pre>\n<p>The <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword opens a new browser, a new context and a new page. This keyword is useful for quick experiments or debugging sessions.</p>\n<p>When a <a href=\"#New%20Page\" class=\"name\">New Page</a> is called without an open browser, <a href=\"#New%20Browser\" class=\"name\">New Browser</a> and <a href=\"#New%20Context\" class=\"name\">New Context</a> are executed with default values first.</p>\n<p>Each Browser, Context and Page has a unique ID with which they can be addressed. A full catalog of what is open can be received by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a> as a dictionary.</p>\n<h2 id=\"Automatic page and context closing\">Automatic page and context closing</h2>\n<p>Controls when contexts and pages are closed during the test execution.</p>\n<p>If automatic closing level is <span class=\"name\">TEST</span>, contexts and pages that are created during a single test are automatically closed when the test ends. Contexts and pages that are created during suite setup are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">SUITE</span>, all contexts and pages that are created during the test suite are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">MANUAL</span>, nothing is closed automatically while the test execution is ongoing. All browsers, context and pages are automatically closed when test execution ends.</p>\n<p>If automatic closing level is <span class=\"name\">KEEP</span>, nothing is closed automatically while the test execution is ongoing. Also, nothing is closed when test execution ends, including the node process. Therefore, it is users responsibility to close all browsers, context and pages and ensure that all process that are left running after the test execution end are closed. This level is only intended for test case development and must not be used when running tests in CI or similar environments.</p>\n<p>Automatic closing can be configured or switched off with the auto_closing_level library import parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>\n<h2 id=\"Finding elements\">Finding elements</h2>\n<p>All keywords in the library that need to interact with an element on a web page take an argument typically named <code>selector</code> that specifies how to find the element. Keywords can find elements with strict mode. If strict mode is true and locator finds multiple elements from the page, keyword will fail. If keyword finds one element, keyword does not fail because of strict mode. If strict mode is false, keyword does not fail if selector points many elements. Strict mode is enabled by default, but can be changed in library <a href=\"#Importing\" class=\"name\">importing</a> or <a href=\"#Set%20Strict%20Mode\" class=\"name\">Set Strict Mode</a> keyword. Keyword documentation states if keyword uses strict mode. If keyword does not state that strict mode is used, then strict mode is not applied for the keyword. For more details, see Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-query-selector\">strict documentation</a>.</p>\n<p>Selector strategies that are supported by default are listed in the table below.</p>\n<table border=\"1\">\n<tr>\n<th>Strategy</th>\n<th>Match based on</th>\n<th>Example</th>\n</tr>\n<tr>\n<td><code>css</code></td>\n<td>CSS selector.</td>\n<td><code>css=.class &gt; \\#login_btn</code></td>\n</tr>\n<tr>\n<td><code>xpath</code></td>\n<td>XPath expression.</td>\n<td><code>xpath=//input[@id=\"login_btn\"]</code></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Browser text engine.</td>\n<td><code>text=Login</code></td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>Element ID Attribute.</td>\n<td><code>id=login_btn</code></td>\n</tr>\n</table>\n<p>CSS Selectors can also be recorded with <a href=\"#Record%20Selector\" class=\"name\">Record selector</a> keyword.</p>\n<h3 id=\"Explicit Selector Strategy\">Explicit Selector Strategy</h3>\n<p>The explicit selector strategy is specified with a prefix using syntax <code>strategy=value</code>. Spaces around the separator are ignored, so <code>css=foo</code>, <code>css= foo</code> and <code>css = foo</code> are all equivalent.</p>\n<h3 id=\"Implicit Selector Strategy\">Implicit Selector Strategy</h3>\n<p><b>The default selector strategy is <a href=\"#CSS\" class=\"name\">css</a>.</b></p>\n<p>If selector does not contain one of the know explicit selector strategies, it is assumed to contain css selector.</p>\n<p>Selectors that are starting with <code>//</code> or <code>..</code> are considered as xpath selectors.</p>\n<p>Selectors that are in quotes are considered as text selectors.</p>\n<p>Examples:</p>\n<pre>\n# CSS selectors are default.\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class         # This is equivalent\n<a href=\"#Click\" class=\"name\">Click</a>  css=span &gt; button.some_class     # to this.\n\n# // or .. leads to xpath selector strategy\n<a href=\"#Click\" class=\"name\">Click</a>  //span/button[@class=\"some_class\"]\n<a href=\"#Click\" class=\"name\">Click</a>  xpath=//span/button[@class=\"some_class\"]\n\n# \"text\" in quotes leads to exact text selector strategy\n<a href=\"#Click\" class=\"name\">Click</a>  \"Login\"\n<a href=\"#Click\" class=\"name\">Click</a>  text=\"Login\"\n</pre>\n<h3 id=\"CSS\">CSS</h3>\n<p>As written before, the default selector strategy is <a href=\"#CSS\" class=\"name\">css</a>. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\">css selector</a> for more information.</p>\n<p>Any malformed selector not starting with <code>//</code> or <code>..</code> nor starting and ending with a quote is assumed to be a css selector.</p>\n<p>Note that <code>#</code> is a comment character in <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#ignored-data\">Robot Framework syntax</a> and needs to be escaped like <code>\\#</code> to work as a <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors\">css ID selector</a>.</p>\n<p>Examples:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>  \\#username_field  ==  George\n</pre>\n<h3 id=\"XPath\">XPath</h3>\n<p>XPath engine is equivalent to <a href=\"https://developer.mozilla.org/en/docs/Web/API/Document/evaluate\">Document.evaluate</a>. Example: <code>xpath=//html/body//span[text()=\"Hello World\"]</code>.</p>\n<p>Malformed selector starting with <code>//</code> or <code>..</code> is assumed to be an xpath selector. For example, <code>//html/body</code> is converted to <code>xpath=//html/body</code>. More examples are displayed in <a href=\"#Examples\" class=\"name\">Examples</a>.</p>\n<p>Note that xpath does not pierce <a href=\"https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM\">shadow_roots</a>.</p>\n<h3 id=\"Text\">Text</h3>\n<p>Text engine finds an element that contains a text node with the passed text. For example, <code>Click    text=Login</code> clicks on a login button, and <code>Wait For Elements State   text=\"lazy loaded text\"</code> waits for the \"lazy loaded text\" to appear in the page.</p>\n<p>Text engine finds fields based on their labels in text inserting keywords.</p>\n<p>Malformed selector starting and ending with a quote (either <code>\"</code> or <code>'</code>) is assumed to be a text selector. For example, <code>Click    \"Login\"</code> is converted to <code>Click    text=\"Login\"</code>. Be aware that these leads to exact matches only! More examples are displayed in <a href=\"#Examples\" class=\"name\">Examples</a>.</p>\n<h4 id=\"Insensitive match\">Insensitive match</h4>\n<p>By default, the match is case-insensitive, ignores leading/trailing whitespace and searches for a substring. This means <code>text= Login</code> matches <code>&lt;button&gt;Button loGIN (click me)&lt;/button&gt;</code>.</p>\n<h4 id=\"Exact match\">Exact match</h4>\n<p>Text body can be escaped with single or double quotes for precise matching, insisting on exact match, including specified whitespace and case. This means <code>text=\"Login \"</code> will only match <code>&lt;button&gt;Login &lt;/button&gt;</code> with exactly one space after \"Login\". Quoted text follows the usual escaping rules, e.g. use <code>\\\"</code> to escape double quote in a double-quoted string: <code>text=\"foo\\\"bar\"</code>.</p>\n<h4 id=\"RegEx\">RegEx</h4>\n<p>Text body can also be a JavaScript-like regex wrapped in / symbols. This means <code>text=/^hello .*!$/i</code> or <code>text=/^Hello .*!$/</code> will match <code>&lt;span&gt;Hello Peter Parker!&lt;/span&gt;</code> with any name after <code>Hello</code>, ending with <code>!</code>. The first one flagged with <code>i</code> for case-insensitive. See <a href=\"https://regex101.com/\">https://regex101.com</a> for more information about RegEx.</p>\n<h4 id=\"Button and Submit Values\">Button and Submit Values</h4>\n<p>Input elements of the type button and submit are rendered with their value as text, and text engine finds them. For example, <code>text=Login</code> matches <code>&lt;input type=button value=\"Login\"&gt;</code>.</p>\n<h3 id=\"Cascaded selector syntax\">Cascaded selector syntax</h3>\n<p>Browser library supports the same selector strategies as the underlying Playwright node module: xpath, css, id and text. The strategy can either be explicitly specified with a prefix or the strategy can be implicit.</p>\n<p>A major advantage of Browser is that multiple selector engines can be used within one selector. It is possible to mix XPath, CSS and Text selectors while selecting a single element.</p>\n<p>Selectors are strings that consists of one or more clauses separated by <code>&gt;&gt;</code> token, e.g. <code>clause1 &gt;&gt; clause2 &gt;&gt; clause3</code>. When multiple clauses are present, next one is queried relative to the previous one's result. Browser library supports concatenation of different selectors separated by <code>&gt;&gt;</code>.</p>\n<p>For example:</p>\n<pre>\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    \"Hello\" &gt;&gt; ../.. &gt;&gt; .select_button\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    text=Hello &gt;&gt; xpath=../.. &gt;&gt; css=.select_button\n</pre>\n<p>Each clause contains a selector engine name and selector body, e.g. <code>engine=body</code>. Here <code>engine</code> is one of the supported engines (e.g. css or a custom one). Selector <code>body</code> follows the format of the particular engine, e.g. for css engine it should be a <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors\">css selector</a>. Body format is assumed to ignore leading and trailing white spaces, so that extra whitespace can be added for readability. If the selector engine needs to include <code>&gt;&gt;</code> in the body, it should be escaped inside a string to not be confused with clause separator, e.g. <code>text=\"some &gt;&gt; text\"</code>.</p>\n<p>Selector engine name can be prefixed with <code>*</code> to capture an element that matches the particular clause instead of the last one. For example, <code>css=article &gt;&gt; text=Hello</code> captures the element with the text <code>Hello</code>, and <code>*css=article &gt;&gt; text=Hello</code> (note the *) captures the article element that contains some element with the text Hello.</p>\n<p>For convenience, selectors in the wrong format are heuristically converted to the right format. See <a href=\"#Implicit%20Selector%20Strategy\" class=\"name\">Implicit Selector Strategy</a></p>\n<h3 id=\"Examples\">Examples</h3>\n<pre>\n# queries 'div' css selector\nGet Element    css=div\n\n# queries '//html/body/div' xpath selector\nGet Element    //html/body/div\n\n# queries '\"foo\"' text selector\nGet Element    text=foo\n\n# queries 'span' css selector inside the result of '//html/body/div' xpath selector\nGet Element    xpath=//html/body/div &gt;&gt; css=span\n\n# converted to 'css=div'\nGet Element    div\n\n# converted to 'xpath=//html/body/div'\nGet Element    //html/body/div\n\n# converted to 'text=\"foo\"'\nGet Element    \"foo\"\n\n# queries the div element of every 2nd span element inside an element with the id foo\nGet Element    \\#foo &gt;&gt; css=span:nth-child(2n+1) &gt;&gt; div\nGet Element    id=foo &gt;&gt; css=span:nth-child(2n+1) &gt;&gt; div\n</pre>\n<p>Be aware that using <code>#</code> as a starting character in Robot Framework would be interpreted as comment. Due to that fact a <code>#id</code> must be escaped as <code>\\#id</code>.</p>\n<h3 id=\"iFrames\">iFrames</h3>\n<p>By default, selector chains do not cross frame boundaries. It means that a simple CSS selector is not able to select an element located inside an iframe or a frameset. For this use case, there is a special selector <code>&gt;&gt;&gt;</code> which can be used to combine a selector for the frame and a selector for an element inside a frame.</p>\n<p>Given this simple pseudo html snippet:</p>\n<pre>\n&lt;iframe id=\"iframe\" src=\"src.html\"&gt;\n  #document\n    &lt;!DOCTYPE html&gt;\n    &lt;html&gt;\n      &lt;head&gt;&lt;/head&gt;\n      &lt;body&gt;\n        &lt;button id=\"btn\"&gt;Click Me&lt;/button&gt;\n      &lt;/body&gt;\n    &lt;/html&gt;\n&lt;/iframe&gt;\n</pre>\n<p>Here's a keyword call that clicks the button inside the frame.</p>\n<pre>\nClick   id=iframe &gt;&gt;&gt; id=btn\n</pre>\n<p>The selectors on the left and right side of <code>&gt;&gt;&gt;</code> can be any valid selectors. The selector clause directly before the frame opener <code>&gt;&gt;&gt;</code> must select the frame element itself. Frame selection is the only place where Browser Library modifies the selector, as explained in above. In all cases, the library does not alter the selector in any way, instead it is passed as is to the Playwright side.</p>\n<p>If multiple keyword shall be performed inside a frame, it is possible to define a selector prefix with <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>. If this prefix is set to a frame/iframe it has similar behavior as SeleniumLibrary keyword <span class=\"name\">Select Frame</span>.</p>\n<h3 id=\"WebComponents and Shadow DOM\">WebComponents and Shadow DOM</h3>\n<p>Playwright and so also Browser are able to do automatic piercing of Shadow DOMs and therefore are the best automation technology when working with WebComponents.</p>\n<p>Also other technologies claim that they can handle <a href=\"https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM\">Shadow DOM and Web Components</a>. However, none of them do pierce shadow roots automatically, which may be inconvenient when working with Shadow DOM and Web Components.</p>\n<p>For that reason, the css engine pierces shadow roots. More specifically, every <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/Descendant_combinator\">Descendant combinator</a> pierces an arbitrary number of open shadow roots, including the implicit descendant combinator at the start of the selector.</p>\n<p>That means, it is not necessary to select each shadow host, open its shadow root and select the next shadow host until you reach the element that should be controlled.</p>\n<h4 id=\"CSS:light\">CSS:light</h4>\n<p><code>css:light</code> engine is equivalent to <a href=\"https://developer.mozilla.org/en/docs/Web/API/Document/querySelector\">Document.querySelector</a> and behaves according to the CSS spec. However, it does not pierce shadow roots.</p>\n<p><code>css</code> engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.</p>\n<p>Examples:</p>\n<pre>\n&lt;article&gt;\n  &lt;div&gt;In the light dom&lt;/div&gt;\n  &lt;div slot='myslot'&gt;In the light dom, but goes into the shadow slot&lt;/div&gt;\n  &lt;open mode shadow root&gt;\n      &lt;div class='in-the-shadow'&gt;\n          &lt;span class='content'&gt;\n              In the shadow dom\n              &lt;open mode shadow root&gt;\n                  &lt;li id='target'&gt;Deep in the shadow&lt;/li&gt;\n              &lt;/open mode shadow root&gt;\n          &lt;/span&gt;\n      &lt;/div&gt;\n      &lt;slot name='myslot'&gt;&lt;/slot&gt;\n  &lt;/open mode shadow root&gt;\n&lt;/article&gt;\n</pre>\n<p>Note that <code>&lt;open mode shadow root&gt;</code> is not an html element, but rather a shadow root created with <code>element.attachShadow({mode: 'open'})</code>.</p>\n<ul>\n<li>Both <code>\"css=article div\"</code> and <code>\"css:light=article div\"</code> match the first <code>&lt;div&gt;In the light dom&lt;/div&gt;</code>.</li>\n<li>Both <code>\"css=article &gt; div\"</code> and <code>\"css:light=article &gt; div\"</code> match two <code>div</code> elements that are direct children of the <code>article</code>.</li>\n<li><code>\"css=article .in-the-shadow\"</code> matches the <code>&lt;div class='in-the-shadow'&gt;</code>, piercing the shadow root, while <code>\"css:light=article .in-the-shadow\"</code> does not match anything.</li>\n<li><code>\"css:light=article div &gt; span\"</code> does not match anything, because both light-dom <code>div</code> elements do not contain a <code>span</code>.</li>\n<li><code>\"css=article div &gt; span\"</code> matches the <code>&lt;span class='content'&gt;</code>, piercing the shadow root.</li>\n<li><code>\"css=article &gt; .in-the-shadow\"</code> does not match anything, because <code>&lt;div class='in-the-shadow'&gt;</code> is not a direct child of <code>article</code></li>\n<li><code>\"css:light=article &gt; .in-the-shadow\"</code> does not match anything.</li>\n<li><code>\"css=article li#target\"</code> matches the <code>&lt;li id='target'&gt;Deep in the shadow&lt;/li&gt;</code>, piercing two shadow roots.</li>\n</ul>\n<h4 id=\"text:light\">text:light</h4>\n<p><code>text</code> engine open pierces shadow roots similarly to <code>css</code>, while <code>text:light</code> does not. Text engine first searches for elements in the light dom in the iteration order, and then recursively inside open shadow roots in the iteration order. It does not search inside closed shadow roots or iframes.</p>\n<h4 id=\"id, data-testid, data-test-id, data-test and their :light counterparts\">id, data-testid, data-test-id, data-test and their :light counterparts</h4>\n<p>Attribute engines are selecting based on the corresponding attribute value. For example: <code>data-test-id=foo</code> is equivalent to <code>css=[data-test-id=\"foo\"]</code>, and <code>id:light=foo</code> is equivalent to <code>css:light=[id=\"foo\"]</code>.</p>\n<h3 id=\"Element reference syntax\">Element reference syntax</h3>\n<p>It is possible to get a reference to a Locator by using <a href=\"#Get%20Element\" class=\"name\">Get Element</a> and <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a> keywords. Keywords do not save reference to an element in the HTML document, instead it saves reference to a Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a>. In nutshell Locator captures the logic of how to retrieve that element from the page. Each time an action is performed, the locator re-searches the elements in the page. This reference can be used as a <b>first</b> part of a selector by using a special selector syntax <span class=\"name\">element=</span>. like this:</p>\n<pre>\n${ref}=    Get Element    .some_class\n           Click          ${ref} &gt;&gt; .some_child     # Locator searches an element from the page.\n           Click          ${ref} &gt;&gt; .other_child    # Locator searches again an element from the page.\n</pre>\n<p>The <span class=\"name\">.some_child</span> and <span class=\"name\">.other_child</span> selectors in the example are relative to the element referenced by ${ref}. Please note that frame piercing is not possible with element reference.</p>\n<h2 id=\"Assertions\">Assertions</h2>\n<p>Keywords that accept arguments <code>assertion_operator</code> &lt;<a href=\"#type-AssertionOperator\" class=\"name\">AssertionOperator</a>&gt; and <code>assertion_expected</code> can optionally assert that a specified condition holds. Keywords will return the value even when the assertion is performed by the keyword.</p>\n<p>Assert will retry and fail only after a specified timeout. See <a href=\"#Importing\" class=\"name\">Importing</a> and <code>retry_assertions_for</code> (default is 1 second) for configuring this timeout.</p>\n<p>Currently supported assertion operators are:</p>\n<table border=\"1\">\n<tr>\n<th>Operator</th>\n<th>Alternative Operators</th>\n<th>Description</th>\n<th>Validate Equivalent</th>\n</tr>\n<tr>\n<td><code>==</code></td>\n<td><code>equal</code>, <code>equals</code>, <code>should be</code></td>\n<td>Checks if returned value is equal to expected value.</td>\n<td><code>value == expected</code></td>\n</tr>\n<tr>\n<td><code>!=</code></td>\n<td><code>inequal</code>, <code>should not be</code></td>\n<td>Checks if returned value is not equal to expected value.</td>\n<td><code>value != expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;</code></td>\n<td><code>greater than</code></td>\n<td>Checks if returned value is greater than expected value.</td>\n<td><code>value &gt; expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;=</code></td>\n<td></td>\n<td>Checks if returned value is greater than or equal to expected value.</td>\n<td><code>value &gt;= expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;</code></td>\n<td><code>less than</code></td>\n<td>Checks if returned value is less than expected value.</td>\n<td><code>value &lt; expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;=</code></td>\n<td></td>\n<td>Checks if returned value is less than or equal to expected value.</td>\n<td><code>value &lt;= expected</code></td>\n</tr>\n<tr>\n<td><code>*=</code></td>\n<td><code>contains</code></td>\n<td>Checks if returned value contains expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td></td>\n<td><code>not contains</code></td>\n<td>Checks if returned value does not contain expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td><code>^=</code></td>\n<td><code>should start with</code>, <code>starts</code></td>\n<td>Checks if returned value starts with expected value.</td>\n<td><code>re.search(f\"^{expected}\", value)</code></td>\n</tr>\n<tr>\n<td><code>$=</code></td>\n<td><code>should end with</code>, <code>ends</code></td>\n<td>Checks if returned value ends with expected value.</td>\n<td><code>re.search(f\"{expected}$\", value)</code></td>\n</tr>\n<tr>\n<td><code>matches</code></td>\n<td></td>\n<td>Checks if given RegEx matches minimum once in returned value.</td>\n<td><code>re.search(expected, value)</code></td>\n</tr>\n<tr>\n<td><code>validate</code></td>\n<td></td>\n<td>Checks if given Python expression evaluates to <code>True</code>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>evaluate</code></td>\n<td><code>then</code></td>\n<td>When using this operator, the keyword does return the evaluated Python expression.</td>\n<td></td>\n</tr>\n</table>\n<p>Currently supported formatters for assertions are:</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Substitutes multiple spaces to single space from the value</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from the beginning and end of the value</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts value to lower case before comparing</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies rules also for the expected value</td>\n</tr>\n</table>\n<p>Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If <code>apply to expected</code> formatter is defined, then formatters are then formatter are also applied to expected value.</p>\n<p>By default, keywords will provide an error message if an assertion fails. Default error messages can be overwritten with a <code>message</code> argument. The <code>message</code> argument accepts <span class=\"name\">{value}</span>, <span class=\"name\">{value_type}</span>, <span class=\"name\">{expected}</span> and <span class=\"name\">{expected_type}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options. The <span class=\"name\">{value}</span> is the value returned by the keyword and the <span class=\"name\">{expected}</span> is the expected value defined by the user, usually the value in the <code>assertion_expected</code> argument. The <span class=\"name\">{value_type}</span> and <span class=\"name\">{expected_type}</span> are the type definitions from <span class=\"name\">{value}</span> and <span class=\"name\">{expected}</span> arguments. In similar fashion as Python <a href=\"https://docs.python.org/3/library/functions.html#type\">type</a> returns type definition. Assertions will retry until <code>timeout</code> has expired if they do not pass.</p>\n<p>The assertion <code>assertion_expected</code> value is not converted by the library and is used as is. Therefore when assertion is made, the <code>assertion_expected</code> argument value and value returned the keyword must have the same type. If types are not the same, assertion will fail. Example <a href=\"#Get%20Text\" class=\"name\">Get Text</a> always returns a string and has to be compared with a string, even the returned value might look like a number.</p>\n<p>Other Keywords have other specific types they return. <a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a> always returns an integer. <a href=\"#Get%20BoundingBox\" class=\"name\">Get Bounding Box</a> and <a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a> can be filtered. They return a dictionary without a filter and a number when filtered. These Keywords do automatic conversion for the expected value if a number is returned.</p>\n<p>* &lt; less or greater &gt; With Strings* Comparisons of strings with <code>greater than</code> or <code>less than</code> compares each character, starting from 0 regarding where it stands in the code page. Example: <code>A &lt; Z</code>, <code>Z &lt; a</code>, <code>ac &lt; dc<span class=\"name\"> It does never compare the length of elements. Neither lists nor strings. The comparison stops at the first character that is different. Examples: </span>`'abcde' &lt; 'abd'</code>, <code>'100.000' &lt; '2'</code> In Python 3 and therefore also in Browser it is not possible to compare numbers with strings with a greater or less operator. On keywords that return numbers, the given expected value is automatically converted to a number before comparison.</p>\n<p>The getters <span class=\"name\">Get Page State</span> and <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a> return a dictionary. Values of the dictionary can directly asserted. Pay attention of possible types because they are evaluated in Python. For example:</p>\n<pre>\nGet Page State    validate    2020 &gt;= value['year']                     # Comparison of numbers\nGet Page State    validate    \"IMPORTANT MESSAGE!\" == value['message']  # Comparison of strings\n</pre>\n<h3 id=\"The 'then' or 'evaluate' closure\">The 'then' or 'evaluate' closure</h3>\n<p>Keywords that accept arguments <code>assertion_operator</code> and <code>assertion_expected</code> can optionally also use <code>then</code> or <code>evaluate</code> closure to modify the returned value with BuiltIn Evaluate. Actual value can be accessed with <code>value</code>.</p>\n<p>For example <code>Get Title  then  'TITLE: '+value</code>. See <a href=\"https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Evaluating%20expressions\">Builtin Evaluating expressions</a> for more info on the syntax.</p>\n<h3 id=\"Examples\">Examples</h3>\n<pre>\n# <b>Keyword</b>    <b>Selector</b>                    <b>Key</b>        <b>Assertion Operator</b>    <b>Assertion Expected</b>\nGet Title                                           equal                 Page Title\nGet Title                                           ^=                    Page\nGet Style    //*[@id=\"div-element\"]      width      &gt;                     100\nGet Title                                           matches               \\\\w+\\\\s\\\\w+\nGet Title                                           validate              value == \"Login Page\"\nGet Title                                           evaluate              value if value == \"some value\" else \"something else\"\n</pre>\n<h2 id=\"Implicit waiting\">Implicit waiting</h2>\n<p>Browser library and Playwright have many mechanisms to help in waiting for elements. Playwright will auto-wait before performing actions on elements. Please see <a href=\"https://playwright.dev/docs/actionability/\">Auto-waiting on Playwright documentation</a> for more information.</p>\n<p>On top of Playwright auto-waiting Browser assertions will wait and retry for specified time before failing any <a href=\"#Assertions\" class=\"name\">Assertions</a>. Time is specified in Browser library initialization with <code>retry_assertions_for</code>.</p>\n<p>Browser library also includes explicit waiting keywords such as <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait for Elements State</a> if more control for waiting is needed.</p>\n<h2 id=\"Experimental: Re-using same node process\">Experimental: Re-using same node process</h2>\n<p>Browser library integrated nodejs and python. The NodeJS side can be also executed as a standalone process. Browser libraries running on the same machine can talk to that instead of starting new node processes. This can speed execution when running tests parallel. To start node side run on the directory when the Browser package is <code>PLAYWRIGHT_BROWSERS_PATH=0 node Browser/wrapper/index.js PORT</code>.</p>\n<p><code>PORT</code> is the port you want to use for the node process. To execute tests then with pabot for example do <code>ROBOT_FRAMEWORK_BROWSER_NODE_PORT=PORT pabot ..</code>.</p>\n<h2 id=\"Experimental: Provide parameters to node process\">Experimental: Provide parameters to node process</h2>\n<p>Browser library is integrated with NodeJSand and Python. Browser library starts a node process, to communicate Playwright API in NodeJS side. It is possible to provide parameters for the started node process by defining ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS environment variable, before starting the test execution. Example: <code>ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS=--inspect;robot path/to/tests</code>. There can be multiple arguments defined in the environment variable and arguments must be separated with comma.</p>\n<h2 id=\"Scope Setting\">Scope Setting</h2>\n<p>Some keywords which manipulates library settings have a scope argument. With that scope argument one can set the \"live time\" of that setting. Available Scopes are: <span class=\"name\">Global</span>, <span class=\"name\">Suite</span> and <span class=\"name\">Test</span>/<span class=\"name\">Task</span> See <a href=\"#type-Scope\" class=\"name\">Scope</a>. Is a scope finished, this scoped setting, like timeout, will no longer be used.</p>\n<p>Live Times:</p>\n<ul>\n<li>A <span class=\"name\">Global</span> scope will live forever until it is overwritten by another <span class=\"name\">Global</span> scope. Or locally temporarily overridden by a more narrow scope.</li>\n<li>A <span class=\"name\">Suite</span> scope will locally override the <span class=\"name\">Global</span> scope and live until the end of the Suite within it is set, or if it is overwritten by a later setting with <span class=\"name\">Global</span> or same scope. Children suite does inherit the setting from the parent suite but also may have its own local <span class=\"name\">Suite</span> setting that then will be inherited to its children suites.</li>\n<li>A <span class=\"name\">Test</span> or <span class=\"name\">Task</span> scope will be inherited from its parent suite but when set, lives until the end of that particular test or task.</li>\n</ul>\n<p>A new set higher order scope will always remove the lower order scope which may be in charge. So the setting of a <span class=\"name\">Suite</span> scope from a test, will set that scope to the robot file suite where that test is and removes the <span class=\"name\">Test</span> scope that may have been in place.</p>\n<h2 id=\"Extending Browser library with a JavaScript module\">Extending Browser library with a JavaScript module</h2>\n<p>Browser library can be extended with JavaScript. The module must be in CommonJS format that Node.js uses. You can translate your ES6 module to Node.js CommonJS style with Babel. Many other languages can be also translated to modules that can be used from Node.js. For example TypeScript, PureScript and ClojureScript just to mention few.</p>\n<pre>\nasync function myGoToKeyword(url, args, page, logger, playwright) {\n  logger(args.toString())\n  playwright.coolNewFeature()\n  return await page.goto(url);\n}\n</pre>\n<p>Functions can contain any number of arguments and arguments may have default values.</p>\n<p>There are some reserved arguments that are not accessible from Robot Framework side. They are injected to the function if they are in the arguments:</p>\n<p><code>page</code>: <a href=\"https://playwright.dev/docs/api/class-page\">the playwright Page object</a>.</p>\n<p><code>args</code>: the rest of values from Robot Framework keyword call <code>*args</code>.</p>\n<p><code>logger</code>: callback function that takes strings as arguments and writes them to robot log. Can be called multiple times.</p>\n<p><code>playwright</code>: playwright module (* from 'playwright'). Useful for integrating with Playwright features that Browser library doesn't support with it's own keywords. <a href=\"https://playwright.dev/docs/api/class-playwright\">API docs</a></p>\n<p>also argument name <code>self</code> can not be used.</p>\n<h3 id=\"Example module.js\">Example module.js</h3>\n<pre>\nasync function myGoToKeyword(pageUrl, page) {\n  await page.goto(pageUrl);\n  return await page.title();\n}\nexports.__esModule = true;\nexports.myGoToKeyword = myGoToKeyword;\n</pre>\n<h3 id=\"Example Robot Framework side\">Example Robot Framework side</h3>\n<pre>\n<b>*</b> Settings <b>*</b>\nLibrary   Browser  jsextension=${CURDIR}/module.js\n\n<b>*</b> Test Cases <b>*</b>\nHello\n  New Page\n  ${title}=  myGoToKeyword  <a href=\"https://playwright.dev\">https://playwright.dev</a>\n  Should be equal  ${title}  Playwright\n</pre>\n<p>Also selector syntax can be extended with a custom selector using a js module</p>\n<h3 id=\"Example module keyword for custom selector registering\">Example module keyword for custom selector registering</h3>\n<pre>\nasync function registerMySelector(playwright) {\nplaywright.selectors.register(\"myselector\", () =&gt; ({\n   // Returns the first element matching given selector in the root's subtree.\n   query(root, selector) {\n      return root.querySelector(<span class=\"name\">a[data-title=\"${selector}\"]</span>);\n    },\n\n    // Returns all elements matching given selector in the root's subtree.\n    queryAll(root, selector) {\n      return Array.from(root.querySelectorAll(<span class=\"name\">a[data-title=\"${selector}\"]</span>));\n    }\n}));\nreturn 1;\n}\nexports.__esModule = true;\nexports.registerMySelector = registerMySelector;\n</pre>\n<h2 id=\"Plugins\">Plugins</h2>\n<p>Browser library offers plugins as a way to modify and add library keywords and modify some of the internal functionality without creating a new library or hacking the source code. See plugin API <a href=\"https://github.com/MarketSquare/robotframework-browser/blob/main/docs/plugins/README.md\">documentation</a> for further details.</p>\n<h2 id=\"Language\">Language</h2>\n<p>Browser library offers possibility to translte keyword names and documentation to new language. If language is defined, Browser library will search from <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#module-search-path\">module search path</a> Python packages starting with <span class=\"name\">robotframework_browser_translation</span> by using <a href=\"https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/\">Python pluging API</a>. Library is using naming convention to find Python plugins.</p>\n<p>The package must implement single API call, <code>get_language</code> without any arguments. Method must return a dictionary containing two keys: <code>language</code> and <code>path</code>. The language key value defines which language the package contains. Also value should match (case insentive) the library <code>language</code> import parameter. The path parameter value should be full path to the translation file.</p>\n<h3 id=\"Translation file\">Translation file</h3>\n<p>The file name or extension is not important, but data must be in <a href=\"https://www.json.org/json-en.html\">json</a> format. The keys of json are the methods names, not the keyword names, which implements keywords. Value of key is json object which contains two keys: <code>name</code> and <code>doc</code>. The <code>name</code> key contains the keyword translated name and <span class=\"name\">doc</span> contains translated documentation. Providing doc and name are optional, example translation json file can only provide translations to keyword names or only to documentatin. But it is always recomended to provide translation to both name and doc. Special key <code>__intro__</code> is for class level documentation and <code>__init__</code> is for init level documentation. These special values <code>name</code> can not be translated, instead <code>name</code> should be kept the same.</p>\n<h3 id=\"Generating template translation file\">Generating template translation file</h3>\n<p>Template translation file, with English language can be created by running: <span class=\"name\">rfbrowser translation /path/to/translation.json</span> command. Command does not provide translations to other languages, it only provides easy way to create full list keywords and their documentation in correct format. It is also possible to add keywords from library plugins and js extensions by providing <span class=\"name\">--plugings</span> and <span class=\"name\">--jsextension</span> arguments to command. Example: <span class=\"name\">rfbrowser translation --plugings myplugin.SomePlugin --jsextension /path/ot/jsplugin.js /path/to/translation.json</span></p>\n<p>Example project for translation can be found from <a href=\"https://github.com/MarketSquare/robotframework-browser-translation-fi\">robotframework-browser-translation-fi</a> repository.</p>", "version": "18.4.0", "generated": "2024-05-16T15:29:53+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/__init__.py", "lineno": 113, "tags": ["Assertion", "BrowserControl", "Config", "Crawling", "Getter", "HTTP", "PageContent", "Setter", "Wait"], "inits": [{"name": "__init__", "args": [{"name": "_", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*_"}, {"name": "auto_closing_level", "type": {"name": "AutoClosingLevel", "typedoc": "AutoClosingLevel", "nested": [], "union": false}, "defaultValue": "TEST", "kind": "NAMED_ONLY", "required": false, "repr": "auto_closing_level: AutoClosingLevel = TEST"}, {"name": "enable_playwright_debug", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "PlaywrightLogTypes", "typedoc": "PlaywrightLogTypes", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "defaultValue": "library", "kind": "NAMED_ONLY", "required": false, "repr": "enable_playwright_debug: PlaywrightLogTypes | bool = library"}, {"name": "enable_presenter_mode", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HighLightElement", "typedoc": "HighLightElement", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "enable_presenter_mode: HighLightElement | bool = False"}, {"name": "external_browser_executable", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "external_browser_executable: Dict[SupportedBrowsers, str] | None = None"}, {"name": "jsextension", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "jsextension: List[str] | str | None = None"}, {"name": "playwright_process_port", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "playwright_process_port: int | None = None"}, {"name": "plugins", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "plugins: List[str] | str | None = None"}, {"name": "retry_assertions_for", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:01", "kind": "NAMED_ONLY", "required": false, "repr": "retry_assertions_for: timedelta = 0:00:01"}, {"name": "run_on_failure", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "Take Screenshot \\ fail-screenshot-{index}", "kind": "NAMED_ONLY", "required": false, "repr": "run_on_failure: str = Take Screenshot \\ fail-screenshot-{index}"}, {"name": "selector_prefix", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "selector_prefix: str | None = None"}, {"name": "show_keyword_call_banner", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "show_keyword_call_banner: bool | None = None"}, {"name": "strict", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "strict: bool = True"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:10", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:10"}, {"name": "language", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "language: str | None = None"}], "returnType": null, "doc": "<p>Browser library can be taken into use with optional arguments:</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>auto_closing_level</code></td>\n<td>Configure context and page automatic closing. Default is <code>TEST</code>, for more details, see <a href=\"#type-AutoClosingLevel\" class=\"name\">AutoClosingLevel</a></td>\n</tr>\n<tr>\n<td><code>enable_playwright_debug</code></td>\n<td>Enable low level debug information from the playwright to playwright-log.txt file. For more details, see <a href=\"#type-PlaywrightLogTypes\" class=\"name\">PlaywrightLogTypes</a>.</td>\n</tr>\n<tr>\n<td><code>enable_presenter_mode</code></td>\n<td>Automatic highlights the interacted components, slowMo and a small pause at the end. Can be enabled by giving True or can be customized by giving a dictionary: <span class=\"name\">{\"duration\": \"2 seconds\", \"width\": \"2px\", \"style\": \"dotted\", \"color\": \"blue\"}</span> Where <span class=\"name\">duration</span> is time format in Robot Framework format, defaults to 2 seconds. <span class=\"name\">width</span> is width of the marker in pixels, defaults the <span class=\"name\">2px</span>. <span class=\"name\">style</span> is the style of border, defaults to <span class=\"name\">dotted</span>. <span class=\"name\">color</span> is the color of the marker, defaults to <span class=\"name\">blue</span>. By default, the call banner keyword is also enabled unless explicitly disabled.</td>\n</tr>\n<tr>\n<td><code>external_browser_executable</code></td>\n<td>Dict mapping name of browser to path of executable of a browser. Will make opening new browsers of the given type use the set executablePath. Currently only configuring of <span class=\"name\">chromium</span> to a separate executable (chrome, chromium and Edge executables all work with recent versions) works.</td>\n</tr>\n<tr>\n<td><code>jsextension</code></td>\n<td>Path to Javascript modules exposed as extra keywords. The modules must be in CommonJS. It can either be a single path, a comma-separated lists of path or a real list of strings</td>\n</tr>\n<tr>\n<td><code>playwright_process_port</code></td>\n<td>Experimental reusing of playwright process. <code>playwright_process_port</code> is preferred over environment variable <code>ROBOT_FRAMEWORK_BROWSER_NODE_PORT</code>. See <a href=\"#Experimental%3A%20Re-using%20same%20node%20process\" class=\"name\">Experimental: Re-using same node process</a> for more details.</td>\n</tr>\n<tr>\n<td><code>plugins</code></td>\n<td>Allows extending the Browser library with external Python classes. Can either be a single class/module, a comma-separated list or a real list of strings</td>\n</tr>\n<tr>\n<td><code>retry_assertions_for</code></td>\n<td>Timeout for retrying assertions on keywords before failing the keywords. This timeout starts counting from the first failure. Global <code>timeout</code> will still be in effect. This allows stopping execution faster to assertion failure when element is found fast.</td>\n</tr>\n<tr>\n<td><code>run_on_failure</code></td>\n<td>Sets the keyword to execute in case of a failing Browser keyword. It can be the name of any keyword. If the keyword has arguments those must be separated with two spaces for example <code>My keyword \\ arg1 \\ arg2</code>. If no extra action should be done after a failure, set it to <code>None</code> or any other robot falsy value. Run on failure is not applied when library methods are executed directly from Python.</td>\n</tr>\n<tr>\n<td><code>selector_prefix</code></td>\n<td>Prefix for all selectors. This is useful when you need to use add an iframe selector before each selector.</td>\n</tr>\n<tr>\n<td><code>show_keyword_call_banner</code></td>\n<td>If set to <code>True</code>, will show a banner with the keyword name and arguments before the keyword is executed at the bottom of the page. If set to <code>False</code>, will not show the banner. If set to None, which is the default, will show the banner only if the presenter mode is enabled. <a href=\"#Get%20Page%20Source\" class=\"name\">Get Page Source</a> and <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> will not show the banner, because that could negatively affect your test cases/tasks. This feature may be super helpful when you are debugging your tests and using tracing from <a href=\"#New%20Context\" class=\"name\">New Context</a> or <span class=\"name\">Video recording</span> features.</td>\n</tr>\n<tr>\n<td><code>strict</code></td>\n<td>If keyword selector points multiple elements and keywords should interact with one element, keyword will fail if <code>strict</code> mode is true. Strict mode can be changed individually in keywords or by <span class=\"name\">`</span>et Strict Mode`` keyword.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout for keywords that operate on elements. The keywords will wait for this time for the element to appear into the page. Defaults to \"10s\" =&gt; 10 seconds.</td>\n</tr>\n<tr>\n<td><code>language</code></td>\n<td>Defines language which is used to translate keyword names and documentation.</td>\n</tr>\n</table>", "shortdoc": "Browser library can be taken into use with optional arguments:", "tags": [], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/__init__.py", "lineno": 801}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "domain", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str | None = None"}, {"name": "path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str | None = None"}, {"name": "expires", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expires: str | None = None"}, {"name": "httpOnly", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "httpOnly: bool | None = None"}, {"name": "secure", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool | None = None"}, {"name": "sameSite", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "CookieSameSite", "typedoc": "CookieSameSite", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sameSite: CookieSameSite | None = None"}], "returnType": null, "doc": "<p>Adds a cookie to currently active browser context.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Name of the cookie.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Given value for the cookie.</td>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Given url for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>domain</code></td>\n<td>Given domain for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Given path for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</td>\n</tr>\n<tr>\n<td><code>expires</code></td>\n<td>Given expiry for the cookie. Can be of date format or unix time. Supports the same formats as the <a href=\"http://robotframework.org/robotframework/latest/libraries/DateTime.html\">DateTime</a> library or an epoch timestamp. - example: 2027-09-28 16:21:35</td>\n</tr>\n<tr>\n<td><code>httpOnly</code></td>\n<td>Sets the httpOnly token.</td>\n</tr>\n<tr>\n<td><code>secure</code></td>\n<td>Sets the secure token.</td>\n</tr>\n<tr>\n<td><code>samesite</code></td>\n<td>Sets the samesite mode.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>                                     # Using url argument.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   domain=example.com                path=/foo/bar                     # Using domain and url arguments.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>   expires=2027-09-28 16:21:35       # Expires as timestamp.\n<a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a>   foo   bar   <a href=\"http://address.com/path/to/site\">http://address.com/path/to/site</a>   expires=1822137695                # Expires as epoch seconds.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4233\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a cookie to currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 91}, {"name": "Add Style Tag", "args": [{"name": "content", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "content: str"}], "returnType": null, "doc": "<p>Adds a &lt;style type=\"text/css\"&gt; tag with the content.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>content</code></td>\n<td>Raw CSS content to be injected into frame.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Add%20Style%20Tag\" class=\"name\">Add Style Tag</a>    \\#username_field:focus {background-color: aqua;}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4234\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a <style type=\"text/css\"> tag with the content.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 131}, {"name": "Cancel Download", "args": [{"name": "download", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "download: DownloadInfo | str"}], "returnType": null, "doc": "<p>Cancels an active download.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>download</td>\n<td>A <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> object or id of the download to be canceled.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//6478\">Comment &gt;&gt;</a></p>", "shortdoc": "Cancels an active download.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1554}, {"name": "Check Checkbox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Checks the checkbox or selects radio button found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is already checked/selected.</p>\n<p><a href=\"https://forum.robotframework.org/t//4235\">Comment &gt;&gt;</a></p>", "shortdoc": "Checks the checkbox or selects radio button found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 647}, {"name": "Clear Permissions", "args": [], "returnType": null, "doc": "<p>Clears all permissions from the current context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4236\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears all permissions from the current context.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 545}, {"name": "Clear Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Clears the text field found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4237\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 115}, {"name": "Click", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}], "returnType": null, "doc": "<p>Simulates mouse click on the element found by <code>selector</code>.</p>\n<p>This keyword clicks an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element matches selector. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> to click in the center of the element, or the specified position.</li>\n<li>Wait for initiated navigation to either succeed or fail.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>Defaults to <code>left</code> if invalid.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location    left\n<a href=\"#Click\" class=\"name\">Click</a>    id=button_location    right\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4238\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 290}, {"name": "Click With Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}, {"name": "clickCount", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "NAMED_ONLY", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "delay: timedelta | None = None"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_x: float | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_y: float | None = None"}, {"name": "trial", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "trial: bool = False"}], "returnType": null, "doc": "<p>Simulates mouse click on the element found by <code>selector</code>.</p>\n<p>This keyword clicks an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element matches selector. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> to click in the center of the element, or the specified position.</li>\n<li>Wait for initiated navigation to either succeed or fail, unless <code>noWaitAfter</code> option is set.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>Defaults to <code>left</code> if invalid.</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used. Modifiers can be specified in any order, and multiple modifiers can be specified. Valid modifier keys are <code>Control</code>, <code>Alt</code>, <code>Shift</code> and <code>Meta</code>. Due to the fact that the argument <span class=\"name\">*modifiers</span> is a positional only argument, all preceding keyword arguments have to be specified as positional arguments before <span class=\"name\">*modifiers</span>.</td>\n</tr>\n<tr>\n<td><code>clickCount</code></td>\n<td>Defaults to 1.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Time to wait between mouse-down and mouse-up. Defaults to 0.</td>\n</tr>\n<tr>\n<td><code>position_x</code> <code>position_y</code></td>\n<td>A point to click relative to the top-left corner of element bounding-box. Only positive values within the bounding-box are allowed. If not specified, clicks to some visible point of the element.</td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's Actionability checks (<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a>).</td>\n</tr>\n<tr>\n<td><code>noWaitAfter</code></td>\n<td>Actions that initiate navigation, are waiting for these navigation to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to <code>False</code>.</td>\n</tr>\n<tr>\n<td><code>trial</code></td>\n<td>When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.</td>\n</tr>\n</table>\n<p>Arguments <code>clickCount</code>, <code>delay</code>, <code>position_x</code>, <code>position_y</code>, <code>force</code>, <code>noWaitAfter</code> and <code>trial</code> are named-only arguments and must be specified using their names..</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=button_location\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=button_location    trial=True\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    \\#clickWithOptions    delay=100ms    clickCount=2\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=clickWithModifiers    left     Alt    Meta    Shift    clickCount=1    force=True\n<a href=\"#Click%20With%20Options\" class=\"name\">Click With Options</a>    id=clickWithOptions    right    clickCount=2    force=True    noWaitAfter=True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5936\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 318}, {"name": "Close Browser", "args": [{"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": null, "doc": "<p>Closes the current browser.</p>\n<p>Active browser is set to the browser that was active before this one. Closes all context and pages belonging to this browser. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser to close. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    ALL        # Closes all browsers\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    CURRENT    # Close current browser\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>               # Close current browser\n<a href=\"#Close%20Browser\" class=\"name\">Close Browser</a>    ${id}      # Close browser matching id\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4239\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes the current browser.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 118}, {"name": "Close Browser Server", "args": [{"name": "wsEndpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}], "returnType": null, "doc": "<p>Close a playwright Browser Server identified by its websocket endpoint (wsEndpoint).</p>\n<p>The wsEndpoint string is returned by <a href=\"#Launch%20Browser%20Server\" class=\"name\">Launch Browser Server</a> and is also used by <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n</table>\n<pre>\n<code>wsEndpoint</code> | Address of the browser server. Example: <span class=\"name\">`ws://127.0.0.1:63784/ca69bf0e9471391e8183d9ac1e90e1ba</span>`|\n</pre>", "shortdoc": "Close a playwright Browser Server identified by its websocket endpoint (wsEndpoint).", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 484}, {"name": "Close Context", "args": [{"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": null, "doc": "<p>Closes a Context.</p>\n<p>Active context is set to the context that was active before this one. Closes pages belonging to this context. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>Context to close. <code>CURRENT</code> selects the active context. <code>ALL</code> closes all contexts. When a context id is provided, that context is closed.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser where to close context. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>                          #  Closes current context and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    CURRENT    CURRENT    #  Closes current context and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    ALL        CURRENT    #  Closes all context from current browser and current browser\n<a href=\"#Close%20Context\" class=\"name\">Close Context</a>    ALL        ALL        #  Closes all context from current browser and all browser\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4240\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes a Context.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 162}, {"name": "Close Page", "args": [{"name": "page", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType | str = CURRENT"}, {"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}, {"name": "runBeforeUnload", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "runBeforeUnload: bool = False"}], "returnType": null, "doc": "<p>Closes the <code>page</code> in <code>context</code> in <code>browser</code>.</p>\n<p>Defaults to current for all three. Active page is set to the page that was active before this one. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<p><code>runBeforeUnload</code> defines where to run the <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Window/beforeunload_event\">before unload</a> page handlers. Defaults to false.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>Page to close. <code>CURRENT</code> selects the active page. <code>ALL</code> closes all pages. When a page id is provided, that page is closed.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>Context where to close page. <code>CURRENT</code> selects the active context. <code>ALL</code> closes all contexts. When a context id is provided, that context is closed.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser where to close page. <code>CURRENT</code> selects the active browser. <code>ALL</code> closes all browsers. When a browser id is provided, that browser is closed.</td>\n</tr>\n</table>\n<p>Returns a list of dictionaries containing id, errors and console messages from the page.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>                                       # Closes current page, within the current context and browser\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>    CURRENT     CURRENT     CURRENT    # Closes current page, within the current context and browser\n<a href=\"#Close%20Page\" class=\"name\">Close Page</a>    ALL         ALL         ALL        # Closes all pages, within all contexts and browsers\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4241\">Comment &gt;&gt;</a></p>", "shortdoc": "Closes the ``page`` in ``context`` in ``browser``.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 240}, {"name": "Connect To Browser", "args": [{"name": "wsEndpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "use_cdp", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "use_cdp: bool = False"}], "returnType": null, "doc": "<p>Connect to a Playwright browser server via playwright websocket or Chrome DevTools Protocol.</p>\n<p>See <a href=\"#Launch%20Browser%20Server\" class=\"name\">Launch Browser Server</a> for more information about how to launch a playwright browser server.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Returns a stable identifier for the connected browser.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>wsEndpoint</code></td>\n<td>Address to connect to. Either <code>ws://</code> or <code>http://</code> if cdp is used.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Opens the specified browser. Defaults to <code>chromium</code>.</td>\n</tr>\n<tr>\n<td><code>use_cdp</code></td>\n<td>Connect to browser via Chrome DevTools Protocol. Defaults to False. Works only with Chromium based browsers.</td>\n</tr>\n</table>\n<p>To Connect to a Browser viw Chrome DevTools Protocol, the browser must be started with this protocol enabled. This typically done by starting a Chrome browser with the argument <code>--remote-debugging-port=9222</code> or similar. When the browser is running with activated CDP, it is possible to connect to it either with websockets (<code>ws://</code>) or via HTTP (<code>http://</code>). The HTTP connection can be used when <code>use_cdp</code> is set to True. A typical address for a CDP connection is <code>http://127.0.0.1:9222</code>.</p>\n<p><a href=\"https://forum.robotframework.org/t//4242\">Comment &gt;&gt;</a></p>", "shortdoc": "Connect to a Playwright browser server via playwright websocket or Chrome DevTools Protocol.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 323}, {"name": "Crawl Site", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "page_crawl_keyword", "type": null, "defaultValue": "take_screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_crawl_keyword=take_screenshot"}, {"name": "max_number_of_page_to_crawl", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "max_number_of_page_to_crawl: int = 1000"}, {"name": "max_depth_to_crawl", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "50", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "max_depth_to_crawl: int = 50"}], "returnType": null, "doc": "<p>Web crawler is a tool to go through all the pages on a specific URL domain. This happens by finding all links going to the same site and opening those.</p>\n<p>returns list of crawled urls.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>is the page to start crawling from.</td>\n</tr>\n<tr>\n<td><code>page_crawl_keyword</code></td>\n<td>is the keyword that will be executed on every page.  By default it will take a screenshot on every page.</td>\n</tr>\n<tr>\n<td><code>max_number_of_page_to_crawl</code></td>\n<td>is the upper limit of pages to crawl. Crawling will stop if the number of crawled pages goes over this.</td>\n</tr>\n<tr>\n<td><code>max_depth_to_crawl</code></td>\n<td>is the upper limit of consecutive links followed from the start page. Crawling will stop if there are no more links under this depth.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4243\">Comment &gt;&gt;</a></p>", "shortdoc": "Web crawler is a tool to go through all the pages on a specific URL domain. This happens by finding all links going to the same site and opening those.", "tags": ["Crawling"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/crawling.py", "lineno": 14}, {"name": "Delete All Cookies", "args": [], "returnType": null, "doc": "<p>Deletes all cookies from the currently active browser context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4244\">Comment &gt;&gt;</a></p>", "shortdoc": "Deletes all cookies from the currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 150}, {"name": "Deselect Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Deselects all options from select element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the select tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>If you just want to select one or more specific options and currently more options are selected, use <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a> keyword with the options to be selected in the end.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4245\">Comment &gt;&gt;</a></p>", "shortdoc": "Deselects all options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 763}, {"name": "Download", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "saveAs", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}, {"name": "wait_for_finished", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_for_finished: bool = True"}, {"name": "download_timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "download_timeout: timedelta | None = None"}], "returnType": {"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, "doc": "<p>Download given url content.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>URL to the file that shall be downloaded.</td>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>Path where the file shall be saved persistently. If empty, generated unique path (GUID) is used and file is deleted when the context is closed.</td>\n</tr>\n<tr>\n<td><code>wait_for_finished</code></td>\n<td>If set to <code>False</code> keyword returns immediately after the download is started. Defaults to <code>True</code>.</td>\n</tr>\n<tr>\n<td><code>download_timeout</code></td>\n<td>Timeout for the download itself if <code>wait_for_finished</code> is set to <code>True</code>. By default no timeout is set.</td>\n</tr>\n</table>\n<p>Keyword returns dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a>.</p>\n<p>Example:</p>\n<pre>\n{\n  \"saveAs\": \"/tmp/robotframework-browser/downloads/2f1b3b7c-1b1b-4b1b-9b1b-1b1b1b1b1b1b\",\n  \"suggestedFilename\": \"downloaded_file.txt\"\n  \"state\": \"finished\",\n  \"downloadID\": None,\n}\n</pre>\n<p>If the download should be started by an interaction with an element on the page, <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> keyword may be a better choice.</p>\n<p>The keyword <a href=\"#New%20Browser\" class=\"name\">New Browser</a> has a <code>downloadsPath</code> setting which can be used to set the default download directory. If <span class=\"name\">saveAs</span> is set to a relative path, the file will be saved relative to the browser's <code>downloadsPath</code> setting or if that is not set, relative to the Playwright's working directory. If <code>saveAs</code> is set to an absolute path, the file will be saved to that absolute path independent of <code>downloadsPath</code>.</p>\n<p>To enable downloads context's <code>acceptDownloads</code> needs to be true. This keyword requires that there is currently an open page. The keyword uses the current pages local state (cookies, sessionstorage, localstorage) for the download to avoid authentication problems.</p>\n<p>Example:</p>\n<pre>\n${file_object}=    <a href=\"#Download\" class=\"name\">Download</a>    ${url}\n${actual_size}=    Get File Size    ${file_object.saveAs}\n</pre>\n<p>Example 2:</p>\n<pre>\n${href}=          <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    text=\"Download File\"    href\n<a href=\"#Download\" class=\"name\">Download</a>    ${href}    saveAs=${OUTPUT DIR}/downloads/downloaded_file.txt\nFile Should Exist    ${OUTPUT DIR}/downloads/downloaded_file.txt\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4246\">Comment &gt;&gt;</a></p>", "shortdoc": "Download given url content.", "tags": ["Page Content"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 147}, {"name": "Drag And Drop", "args": [{"name": "selector_from", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "selector_to", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_to: str"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from the element selected by <code>selector_from</code> to the element selected by <code>selector_to</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector_from</code></td>\n<td>Identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>selector_to</code></td>\n<td>Identifies the element, which center is the end-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>First it moves the mouse to the start-point, then presses the left mouse button, then moves to the end-point in specified number of steps, then releases the mouse button.</p>\n<p>Start- and end-point are defined by the center of the elements boundingbox.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Drag%20And%20Drop\" class=\"name\">Drag And Drop</a>    \"Circle\"    \"Goal\"\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4247\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to the element selected by ``selector_to``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 982}, {"name": "Drag And Drop By Coordinates", "args": [{"name": "from_x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_x: float"}, {"name": "from_y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_y: float"}, {"name": "to_x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_x: float"}, {"name": "to_y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_y: float"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from a coordinate to another coordinate.</p>\n<p>First it moves the mouse to the start-point, then presses the left mouse button, then moves to the end-point in specified number of steps, then releases the mouse button.</p>\n<p>Start- and end-point are defined by <code>x</code> and <code>y</code> coordinates relative to the top left corner of the pages viewport.</p>\n<table border=\"1\">\n<tr>\n<td><code>from_x</code> &amp; <code>from_y</code></td>\n<td>Identify the start-point on page.</td>\n</tr>\n<tr>\n<td><code>to_x</code> &amp; <code>to_y</code></td>\n<td>Identify the end-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Drag%20And%20Drop%20By%20Coordinates\" class=\"name\">Drag And Drop By Coordinates</a>\n...    from_x=30    from_y=30\n...    to_x=10    to_y=10    steps=20\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4248\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from a coordinate to another coordinate.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1021}, {"name": "Drag And Drop Relative To", "args": [{"name": "selector_from", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Executes a Drag&amp;Drop operation from the element selected by <code>selector_from</code> to coordinates relative to the center of that element.</p>\n<p>This keyword can be handy to simulate swipe actions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector_from</code></td>\n<td>identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>identifies the end-point which is relative to the start-point.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>defines how many intermediate mouse move events are sent. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>First it moves the mouse to the start-point (center of boundingbox), then presses the left mouse button, then moves to the relative position with the given intermediate steps, then releases the mouse button.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Drag%20And%20Drop%20Relative%20To\" class=\"name\">Drag And Drop Relative to</a>    \"Circle\"    -20    0     # Slides the element 20 pixel to the left\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4249\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to coordinates relative to the center of that element.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1055}, {"name": "Eat All Cookies", "args": [], "returnType": null, "doc": "<p>Eat all cookies for all easter.</p>\n<p><a href=\"https://forum.robotframework.org/t//4250\">Comment &gt;&gt;</a></p>", "shortdoc": "Eat all cookies for all easter.", "tags": [], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 160}, {"name": "Evaluate JavaScript", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "function", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*function: str"}, {"name": "arg", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "arg: Any = None"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "all_elements: bool = False"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Executes given javascript on the selected element(s) or on page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector to resolve and pass to the JavaScript function. This will be the first argument the function receives if not <code>${None}</code>. <code>selector</code> is optional and can be omitted. If given a selector, a function is necessary, with an argument to capture the elementHandle. For example <code>(element) =&gt; document.activeElement === element</code> See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*function</code></td>\n<td>A valid javascript function or a javascript function body. These arguments can be used to write readable multiline JavaScript.</td>\n</tr>\n<tr>\n<td><code>arg</code></td>\n<td>an additional argument that can be handed over to the JavaScript function. This argument must be JSON serializable. ElementHandles are not supported.</td>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>defines if only the single elementHandle found by <code>selector</code> is handed over to the function or if set to <code>True</code> all found elements are handed over as array.</td>\n</tr>\n</table>\n<p>Example with <code>all_elements=True</code>:</p>\n<pre>\n ${texts}=    Evaluate JavaScript    button\n ...    (elements, arg) =&gt; {\n ...        let text = []\n ...            for (e of elements) {\n ...                console.log(e.innerText)\n ...                text.push(e.innerText)\n ...            }\n ...        text.push(arg)\n ...        return text\n ...    }\n ...    all_elements=True\n ...    arg=Just another Text\n</pre>\n<p>Keyword uses strict mode if <code>all_elements</code> is <code>False</code>. See <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://github.com/MarketSquare/robotframework-browser/tree/main/atest/test/06_Examples/js_evaluation.robot\">Usage examples.</a></p>\n<p><a href=\"https://forum.robotframework.org/t//4251\">Comment &gt;&gt;</a></p>", "shortdoc": "Executes given javascript on the selected element(s) or on page.", "tags": ["Getter", "PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 28}, {"name": "Fill Secret", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Fills the given secret from <code>variable_name</code> into the text field found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>secret</code></td>\n<td>The secret string that should be filled into the text field.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>This keyword does not log secret in Robot Framework logs, when keyword resolves the <code>secret</code> variable internally. When <code>secret</code> variable is prefixed with <span class=\"name\">$</span>, without the curly braces, library will resolve the corresponding Robot Framework variable.</p>\n<p>If <code>secret</code> variable is prefixed with <span class=\"name\">%</span>, library will resolve corresponding environment variable. Example <span class=\"name\">$Password</span>` will resolve to <code>${Password}</code> Robot Framework variable. Also <code>%ENV_PWD</code> will resolve to <code>%{ENV_PWD}</code> environment variable.</p>\n<p><b>Using normal Robot Framework variables like <code>${password}</code> will not work!</b></p>\n<p><b>Normal plain text will not work.</b> If you want to use plain text, use <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> keyword instead.</p>\n<p>This keyword will also work with a give cryptographic cipher text, that has been encrypted by Crypto library. See <a href=\"https://github.com/Snooz82/robotframework-crypto\">Crypto Library</a> for more details.</p>\n<p>If <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for other details.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    input#username_field    $username    # Keyword resolves variable value from Robot Framework variables\n<a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    input#username_field    %username    # Keyword resolves variable value from environment variables\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4253\">Comment &gt;&gt;</a></p>", "shortdoc": "Fills the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 198}, {"name": "Fill Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Clears and fills the given <code>txt</code> into the text field found by <code>selector</code>.</p>\n<p>This method waits for an element matching the <code>selector</code> to appear, waits for actionability checks, focuses the element, fills it and triggers an input event after filling.</p>\n<p>If the element matching selector is not an &lt;input&gt;, &lt;textarea&gt; or [contenteditable] element, this method throws an error. Note that you can pass an empty string as <code>txt</code> to clear the input field.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>txt</code></td>\n<td>Text for the text field.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for emulating typing text character by character.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Fill%20Text\" class=\"name\">Fill Text</a>    css=input#username_field    username\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4254\">Comment &gt;&gt;</a></p>", "shortdoc": "Clears and fills the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 85}, {"name": "Focus", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>Moves focus on to the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>If there's no element matching selector, the method waits until a matching element appears in the DOM. Timeouts after 10 seconds.</p>\n<p><a href=\"https://forum.robotframework.org/t//4255\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves focus on to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 531}, {"name": "Get Attribute", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns the HTML <code>attribute</code> of the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>attribute</code></td>\n<td>Requested attribute name.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the attribute value matches the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>When a attribute is selected that is not present and no assertion operator is set, the keyword fails. If an assertion operator is set and the attribute is not present, the returned value is <code>None</code>. This can be used to assert check the presents or the absents of an attribute.</p>\n<p>Example Element:</p>\n<pre>\n&lt;button class=\"login button active\" id=\"enabled_button\" something&gt;Login&lt;/button&gt;\n</pre>\n<p>Example Code:</p>\n<pre>\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled                   # FAIL =&gt; \"Attribute 'disabled' not found!\"\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled     ==    ${None}     # PASS =&gt; returns: None\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    something    evaluate    value is not None    # PASS =&gt;  returns: True\n<a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a>   id=enabled_button    disabled     evaluate    value is None        # PASS =&gt;  returns: True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4256\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the HTML ``attribute`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 271}, {"name": "Get Attribute Names", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all HTML attribute names of an element as a list.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that attribute names do match to the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a>    [name=\"readonly_input\"]    ==    type    name    value    readonly    # Has exactly these attribute names.\n<a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a>    [name=\"readonly_input\"]    contains    disabled    # Contains at least this attribute name.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4257\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all HTML attribute names of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 334}, {"name": "Get BoundingBox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "type": {"name": "BoundingBoxFields", "typedoc": "BoundingBoxFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: BoundingBoxFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "BoundingBox", "typedoc": "BoundingBox", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements size and location as an object <code>{x: float, y: float, width: float, height: float}</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the BoundingBox as Dictionary, otherwise it will just return the single value selected by the key. Note: If a single value is retrieved, an assertion does <b>not</b> need a <code>validate</code> combined with a cast of <code>value</code>.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example use:</p>\n<pre>\n${bounding_box}=    <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>    id=element                 # unfiltered\nLog                 ${bounding_box}                                 # {'x': 559.09375, 'y': 75.5, 'width': 188.796875, 'height': 18}\n${x}=               <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>    id=element    x            # filtered\nLog                 X: ${x}                                         # X: 559.09375\n# Assertions:\n<a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>     id=element         width         &gt;    180\n<a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>     id=element         ALL           validate    value['x'] &gt; value['y']*2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4258\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements size and location as an object ``{x: float, y: float, width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 1127}, {"name": "Get Browser Catalog", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "BrowserInfo", "typedoc": "BrowserInfo", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all browsers, open contexts in them and open pages in these contexts.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about these concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n</table>\n<p>The data is parsed into a python list containing data representing the open Objects.</p>\n<p>On the root level the data contains a list of open browsers.</p>\n<p>Data can be manipulated also with <code>assertion_operator</code> for example to find a specific id based on index or page title with <code>then</code> operator.</p>\n<p>Return value can also be asserted against expected value.</p>\n<p>Sample:</p>\n<pre>\n[\n  {\n    \"type\": \"chromium\",\n    \"id\": \"browser=96207191-8147-44e7-b9ac-5e04f2709c1d\",\n    \"contexts\": [\n      {\n        \"type\": \"context\",\n        \"id\": \"context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089\",\n        \"activePage\": \"page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12\",\n        \"pages\": [\n          {\n            \"type\": \"page\",\n            \"title\": \"Robocorp\",\n            \"url\": \"<a href=\"https://robocorp.com/\">https://robocorp.com/</a>\",\n            \"id\": \"page=7ac15782-22d2-48b4-8591-ff17663fa737\",\n            \"timestamp\": 1598607713.858\n          },\n          {\n            \"type\": \"page\",\n            \"title\": \"Home - Reaktor\",\n            \"url\": \"<a href=\"https://www.reaktor.com/\">https://www.reaktor.com/</a>\",\n            \"id\": \"page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12\",\n            \"timestamp\": 1598607714.702\n          }\n        ]\n      }\n    ],\n    \"activeContext\": \"context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089\",\n    \"activeBrowser\": false\n  },\n  {\n    \"type\": \"firefox\",\n    \"id\": \"browser=ad99abac-17a9-472b-ac7f-d6352630834e\",\n    \"contexts\": [\n      {\n        \"type\": \"context\",\n        \"id\": \"context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0\",\n        \"activePage\": \"page=8baf2991-5eaf-444d-a318-8045f914e96a\",\n        \"pages\": [\n          {\n            \"type\": \"page\",\n            \"title\": \"Software-Qualit\u00e4tssicherung und Softwaretest\",\n            \"url\": \"<a href=\"https://www.imbus.de/\">https://www.imbus.de/</a>\",\n            \"id\": \"page=8baf2991-5eaf-444d-a318-8045f914e96a\",\n            \"timestamp\": 1598607716.828\n          }\n        ]\n      }\n    ],\n    \"activeContext\": \"context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0\",\n    \"activeBrowser\": true\n  }\n]\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4259\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all browsers, open contexts in them and open pages in these contexts.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 933}, {"name": "Get Browser Ids", "args": [{"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a list of ids from open browsers. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p><code>browser</code> Defaults to <code>ALL</code></p>\n<ul>\n<li><code>ALL</code> / <code>ANY</code> Returns all ids as a list.</li>\n<li><code>ACTIVE</code> / <code>CURRENT</code> Returns the id of the currently active browser as list.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the ids from. <code>ALL</code> for all open browsers, <code>ACTIVE</code> for the currently active browser or the id of the browser to get the ids from.</td>\n</tr>\n</table>\n<p>The ACTIVE browser is a synonym for the CURRENT Browser.</p>\n<p><a href=\"https://forum.robotframework.org/t//4260\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of ids from open browsers. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1344}, {"name": "Get Checkbox State", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "Unchecked", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: bool | str = Unchecked"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Returns the state of the checkbox found by <code>selector</code>.</p>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector which shall be examined. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td><code>==</code> and <code>!=</code> and equivalent are allowed on boolean values. Other operators are not accepted.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Boolean value of expected state. Strings are interpreted as booleans. All strings are <code>${True}</code> except of the following <span class=\"name\">FALSE, NO, OFF, 0, UNCHECKED, NONE, ${EMPTY}</span>` (case-insensitive). Defaults to unchecked.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<ul>\n<li><code>checked</code> =&gt; <code>True</code></li>\n<li><code>unchecked</code> =&gt; <code>False</code></li>\n</ul>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Checkbox%20State\" class=\"name\">Get Checkbox State</a>    [name=can_send_email]    ==    checked\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4261\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the state of the checkbox found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 555}, {"name": "Get Classes", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all classes of an element as a list.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected values for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Classes\" class=\"name\">Get Classes</a>    id=draggable    ==    react-draggable    box    # Element contains exactly this class name.\n<a href=\"#Get%20Classes\" class=\"name\">Get Classes</a>    id=draggable    validate    \"react-draggable-dragged\" not in value    # Element does not contain react-draggable-dragged class.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4262\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns all classes of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 387}, {"name": "Get Client Size", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Dimensions", "typedoc": "Dimensions", "nested": [], "union": false}, "doc": "<p>Gets elements or pages client size (<code>clientHeight</code>, <code>clientWidth</code>) as object {width: float, height: float}.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the client size of the page itself is used (<code>document.scrollingElement</code>). See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll size as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> or <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> for examples.</p>\n<p><a href=\"https://forum.robotframework.org/t//4263\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages client size (``clientHeight``, ``clientWidth``) as object {width: float, height: float}.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 1296}, {"name": "Get Console Log", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "full", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "full: bool = False"}, {"name": "last", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "last: int | timedelta | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns the console log of the active page.</p>\n<p>If assertions are used and fail, this keyword will fail immediately without retrying.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>full</td>\n<td>If true, returns the full console log. If false, returns only new entries that were added since last time.</td>\n</tr>\n<tr>\n<td>last</td>\n<td>If set, returns only the last n entries. Can be <span class=\"name\">int</span> for number of entries or <a href=\"#type-timedelta\" class=\"name\">timedelta</a> for time period.</td>\n</tr>\n</table>\n<p>The returned data is a <a href=\"#type-list\" class=\"name\">list</a> of log messages.</p>\n<p>A log message is a <span class=\"name\">dict</span> with the following structure:</p>\n<pre>\n{\n  \"type\": str,\n  \"text\": str,\n  \"location\": {\n    \"url\": str,\n    \"lineNumber\": int,\n    \"columnNumber\": int\n  },\n  \"time\": str\n}\n</pre>\n<p>Example:</p>\n<pre>\n[{\n  'type': 'log',\n  'text': 'Stuff loaded...',\n  'location': {\n    'url': '<a href=\"https://example.com/js/chunk-769742de.6a462276.js\">https://example.com/js/chunk-769742de.6a462276.js</a>',\n    'lineNumber': 60,\n    'columnNumber': 63771\n  },\n  'time': '2023-02-05T17:42:52.064Z'\n}]\n</pre>\n<p>Keys:</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>One of the following values: <code>log</code>, <code>debug</code>, <code>info</code>, <code>error</code>, <code>warning</code>, <code>dir</code>, <code>dirxml</code>, <code>table</code>, <code>trace</code>, <code>clear</code>, <code>startGroup</code>, <code>startGroupCollapsed</code>, <code>endGroup</code>, <code>assert</code>, <code>profile</code>, <code>profileEnd</code>, <code>count</code>, <code>timeEnd</code></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>The text of the console message.</td>\n</tr>\n<tr>\n<td><code>location.url</code></td>\n<td>The URL of the resource that generated this message.</td>\n</tr>\n<tr>\n<td><code>location.lineNumber</code></td>\n<td>The line number in the resource that generated this message (0-based).</td>\n</tr>\n<tr>\n<td><code>location.columnNumber</code></td>\n<td>The column number in the resource that generated this message (0-based).</td>\n</tr>\n<tr>\n<td><code>time</code></td>\n<td>The timestamp of the log message as ISO 8601 string.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//5267\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the console log of the active page.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1029}, {"name": "Get Context Ids", "args": [{"name": "context", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [], "union": false}, "doc": "<p>Returns a list of context ids based on the browser selection. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<p><code>ALL</code> and <code>ANY</code> are synonyms. <code>ACTIVE</code> and <code>CURRENT</code> are also synonyms.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context to get the ids from. <code>ALL</code> will return all ids from selected browser(s), <code>ACTIVE</code> for the one active context of each selected browser.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the context ids from. <code>ALL</code> Context ids from all open browsers shall be fetched. <code>ACTIVE</code> Only context ids from the active browser shall be fetched.</td>\n</tr>\n</table>\n<p>The ACTIVE context of the ACTIVE Browser is the <code>Current</code> Context.</p>\n<p><a href=\"https://forum.robotframework.org/t//4264\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of context ids based on the browser selection. See `Browser, Context and Page` for more information about Context and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1369}, {"name": "Get Cookie", "args": [{"name": "cookie", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "cookie: str"}, {"name": "return_type", "type": {"name": "CookieType", "typedoc": "CookieType", "nested": [], "union": false}, "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns information of cookie with <code>name</code> as a Robot Framework dot dictionary or a string.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>cookie</code></td>\n<td>Name of the cookie to be retrieved.</td>\n</tr>\n<tr>\n<td><code>return_type</code></td>\n<td>Type of the return value. Can be either <code>dictionary</code> or <code>string</code>. Defaults to <code>dictionary</code>.</td>\n</tr>\n</table>\n<p>If <code>return_type</code> is <code>dictionary</code> or <code>dict</code> then keyword returns a of Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#accessing-list-and-dictionary-items\">dot dictionary</a> The dictionary contains all possible key value pairs of the cookie. If <code>return_type</code> is <code>string</code> or <code>str</code>, then keyword returns the cookie as a string in format: <code>name1=value1</code>. The return value contains only <code>name</code> and <code>value</code> keys of the cookie.</p>\n<p>If no cookie is found with <code>name</code> keyword fails. The cookie dictionary contains details about the cookie. Keys available in the dictionary are documented in the table below.</p>\n<table border=\"1\">\n<tr>\n<td><b>Value</b></td>\n<td><b>Explanation</b></td>\n</tr>\n<tr>\n<td>name</td>\n<td>The name of a cookie, mandatory.</td>\n</tr>\n<tr>\n<td>value</td>\n<td>Value of the cookie, mandatory.</td>\n</tr>\n<tr>\n<td>url</td>\n<td>Define the scope of the cookie, what URLs the cookies should be sent to.</td>\n</tr>\n<tr>\n<td>domain</td>\n<td>Specifies which hosts are allowed to receive the cookie.</td>\n</tr>\n<tr>\n<td>path</td>\n<td>Indicates a URL path that must exist in the requested URL, for example <span class=\"name\">/</span>.</td>\n</tr>\n<tr>\n<td>expires</td>\n<td>Lifetime of a cookie. Returned as datatime object or None if not valid time received.</td>\n</tr>\n<tr>\n<td>httpOnly</td>\n<td>When true, the cookie is not accessible via JavaScript.</td>\n</tr>\n<tr>\n<td>secure</td>\n<td>When true, the cookie is only used with HTTPS connections.</td>\n</tr>\n<tr>\n<td>sameSite</td>\n<td>Attribute lets servers require that a cookie shouldn't be sent with cross-origin requests.</td>\n</tr>\n</table>\n<p>See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browsercontextaddcookiescookies\">playwright documentation</a> for details about each attribute.</p>\n<p>Example:</p>\n<pre>\n${cookie}=        <a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a>              Foobar\nShould Be Equal   ${cookie.value}           Tidii\nShould Be Equal   ${cookie.expires.year}     ${2020}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4265\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns information of cookie with ``name`` as a Robot Framework dot dictionary or a string.", "tags": ["BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 179}, {"name": "Get Cookies", "args": [{"name": "return_type", "type": {"name": "CookieType", "typedoc": "CookieType", "nested": [], "union": false}, "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns cookies from the current active browser context.</p>\n<p>If <code>return_type</code> is <code>dictionary</code> or <code>dict</code> then keyword returns list of Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#accessing-list-and-dictionary-items\">dot dictionaries</a> The dictionary contains all possible key value pairs of the cookie. See <a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a> keyword documentation about the dictionary keys and values.</p>\n<p>If <code>return_type</code> is <code>string</code> or <code>str</code>, then keyword returns the cookie as a string in format: <code>name1=value1; name2=value2; name3=value3</code>. The return value contains only <code>name</code> and <code>value</code> keys of the cookie.</p>\n<p><a href=\"https://forum.robotframework.org/t//4266\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns cookies from the current active browser context.", "tags": ["Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 29}, {"name": "Get Device", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Get a single device descriptor with name exactly matching name.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Given name of the requested device. See Playwright's <a href=\"https://github.com/microsoft/playwright/blob/master/packages/playwright-core/src/server/deviceDescriptorsSource.json\">deviceDescriptorsSource.json</a> for a formatted list.</td>\n</tr>\n</table>\n<p>Allows a concise syntax to set website testing values to exact matches of specific mobile devices.</p>\n<p>Use by passing to a context. After creating a context with devicedescriptor, before using ensure your active page is on that context. Usage:</p>\n<pre>\n${device}=          <a href=\"#Get%20Device\" class=\"name\">Get Device</a>       iPhone X\n<a href=\"#New%20Context\" class=\"name\">New Context</a>         &amp;{device}\n<a href=\"#New%20Page\" class=\"name\">New Page</a>\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>   # returns { \"width\": 375, \"height\": 812 }\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4267\">Comment &gt;&gt;</a></p>", "shortdoc": "Get a single device descriptor with name exactly matching name.", "tags": ["BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/device_descriptors.py", "lineno": 40}, {"name": "Get Devices", "args": [], "returnType": {"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns a dict of all playwright device descriptors.</p>\n<p>See Playwright's <a href=\"https://github.com/microsoft/playwright/blob/master/packages/playwright-core/src/server/deviceDescriptorsSource.json\">deviceDescriptorsSource.json</a> for a formatted list.</p>\n<p><a href=\"https://forum.robotframework.org/t//4268\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a dict of all playwright device descriptors.", "tags": ["BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/device_descriptors.py", "lineno": 25}, {"name": "Get Download State", "args": [{"name": "download", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "download: DownloadInfo | str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "DownloadInfo", "typedoc": "DownloadInfo", "nested": [], "union": false}, "doc": "<p>Gets the state of a download.</p>\n<p>Returns a dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> with the following keys:</p>\n<pre>\n{\n  saveAs: str\n  suggestedFilename: str\n  state: str\n  downloadID: Optional[str]\n}\n</pre>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>download</code></td>\n<td><a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> dictionary returned from <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> or download id as string.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected state of the download. Be aware that the returned value is a dictionary</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//6479\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets the state of a download.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 1432}, {"name": "Get Element", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns a reference to a Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a>.</p>\n<p>The reference can be used in subsequent selectors.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved . See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n${element} =    <a href=\"#Get%20Element\" class=\"name\">Get Element</a>    \\#username_field\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${element} &gt;&gt; optionOne    value    # Locator is resolved from the page.\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${element} &gt;&gt; optionTwo    value    # Locator is resolved again from the page.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4269\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to a Playwright [https://playwright.dev/docs/api/class-locator|Locator].", "tags": ["Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 837}, {"name": "Get Element By", "args": [{"name": "selection_strategy", "type": {"name": "SelectionStrategy", "typedoc": "SelectionStrategy", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selection_strategy: SelectionStrategy"}, {"name": "text", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str | RegExp"}, {"name": "exact", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "exact: bool = False"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "all_elements: bool = False"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Allows locating elements by their features.</p>\n<p>Selection strategies can be several Playwright strategies like AltText or Label. See <a href=\"https://playwright.dev/docs/locators\">Playwright Locators</a> for more information.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>locator_type</code></td>\n<td>SelectionStrategy to be used. Refers to Playwrights <code>page.getBy***</code> functions. See <a href=\"https://playwright.dev/docs/locators\">https://playwright.dev/docs/locators</a></td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Text to locate the element for.</td>\n</tr>\n<tr>\n<td><code>exact</code></td>\n<td>Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace. This has no effect if RegExp is used or if TestID is used as strategy.</td>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>If True, returns all matched elements as a list.</td>\n</tr>\n</table>\n<p>This keywords implements the following Playwright functions:</p>\n<ul>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-alt-text\">page.getByAltText</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-label\">page.getByLabel</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-placeholder\">page.getByPlaceholder</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-test-id\">page.getByTestId</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-text\">page.getByText</a></li>\n<li><a href=\"https://playwright.dev/docs/api/class-page#page-get-by-title\">page.getByTitle</a></li>\n</ul>\n<p><code>page.getByRole</code> is supported by <a href=\"#Get%20Element%20By%20Role\" class=\"name\">Get Element By Role</a> keyword.</p>\n<p>If an element shall be fetched from an iframe, a selector prefix must be set using <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a> keyword including <code>&gt;&gt;&gt;</code> as ending.</p>\n<p><a href=\"https://forum.robotframework.org/t//5937\">Comment &gt;&gt;</a></p>", "shortdoc": "Allows locating elements by their features.", "tags": ["Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 994}, {"name": "Get Element By Role", "args": [{"name": "role", "type": {"name": "ElementRole", "typedoc": "ElementRole", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "role: ElementRole"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "all_elements", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "all_elements: bool = False"}, {"name": "checked", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "checked: bool | None = None"}, {"name": "disabled", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "disabled: bool | None = None"}, {"name": "exact", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "exact: bool | None = None"}, {"name": "expanded", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "expanded: bool | None = None"}, {"name": "include_hidden", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "include_hidden: bool | None = None"}, {"name": "level", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "level: int | None = None"}, {"name": "name", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "name: str | RegExp | None = None"}, {"name": "pressed", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "pressed: bool | None = None"}, {"name": "selected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "selected: bool | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns a reference to Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a> for the matched element by <code>role</code> or a list of references if <code>all_elements</code> is set to <code>True</code>.</p>\n<p>Allows locating elements by their <a href=\"https://www.w3.org/TR/wai-aria-1.2/#roles\">ARIA role</a>, <a href=\"https://www.w3.org/TR/wai-aria-1.2/#aria-attributes\">ARIA attributes</a> and <a href=\"https://w3c.github.io/accname/#dfn-accessible-name\">accessible name</a>.</p>\n<p>Consider the following DOM structure.</p>\n<pre>\n&lt;h3&gt;Sign up&lt;/h3&gt;\n&lt;label&gt;\n  &lt;input type=\"checkbox\" /&gt; Subscribe\n&lt;/label&gt;\n&lt;br/&gt;\n&lt;button&gt;Submit&lt;/button&gt;\n</pre>\n<p>You can locate each element by it's implicit role:</p>\n<pre>\n${heading}    Get Element By Role    heading    name=Sign up\n${checkbox}   Get Element By Role    checkbox    name=Subscribe\n${button}     Get Element By Role    button    name=/submit/i\n</pre>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>all_elements</code></td>\n<td>If True, returns all matched elements as a list.</td>\n</tr>\n<tr>\n<td><code>role</code></td>\n<td>Role from which shall be retrieved.</td>\n</tr>\n<tr>\n<td><code>checked</code></td>\n<td>An attribute that is usually set by aria-checked or native &lt;input type=checkbox&gt; controls.</td>\n</tr>\n<tr>\n<td><code>disabled</code></td>\n<td>An attribute that is usually set by aria-disabled or disabled.</td>\n</tr>\n<tr>\n<td><code>exact</code></td>\n<td>Whether name is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when name is a regular expression. Note that exact match still trims whitespace.</td>\n</tr>\n<tr>\n<td><code>expanded</code></td>\n<td>An attribute that is usually set by aria-expanded.</td>\n</tr>\n<tr>\n<td><code>include_hidden</code></td>\n<td>Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.</td>\n</tr>\n<tr>\n<td><code>level</code></td>\n<td>A number attribute that is usually present for roles heading, list item, row, treeitem, with default values for &lt;h1&gt;-&lt;h6&gt; elements.</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.</td>\n</tr>\n<tr>\n<td><code>pressed</code></td>\n<td>An attribute that is usually set by aria-pressed.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>An attribute that is usually set by aria-selected.</td>\n</tr>\n</table>\n<p>If an element shall be fetched from an iframe, a selector prefix must be set using <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a> keyword including <code>&gt;&gt;&gt;</code> as ending.</p>\n<p><a href=\"https://forum.robotframework.org/t//5938\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to Playwright [https://playwright.dev/docs/api/class-locator|Locator] for the matched element by ``role`` or a list of references if ``all_elements`` is set to ``True``.", "tags": ["Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 898}, {"name": "Get Element Count", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the count of elements found with <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector which shall be counted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a>    label    &gt;    1\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4270\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the count of elements found with ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 605}, {"name": "Get Element States", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected: ElementState | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}, {"name": "return_names", "type": null, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "return_names=True"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}], "union": true}, "doc": "<p>Get the active states from the element found by <code>selector</code>.</p>\n<p>This Keyword returns a list of states that are valid for the selected element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected states</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n<tr>\n<td><code>return_names</code></td>\n<td>If set to <code>False</code> the keyword does return an IntFlag object (<a href=\"#type-ElementState\" class=\"name\">ElementState</a>) instead of a list. <a href=\"#type-ElementState\" class=\"name\">ElementState</a> may contain multiple states at the same time. Defaults to <code>True</code>.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default, assertion is not done.</p>\n<p>This keyword internally works with Python IntFlag. Flags can be processed using bitwise operators like &amp; (bitwise AND) and | (bitwise OR). When using the assertion operators <code>then</code>, <code>evaluate</code> or <code>validate</code> the <code>value</code> contain the states as <a href=\"#type-ElementState\" class=\"name\">ElementState</a>.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    validate    value &amp; visible   # Fails in case of an invisible element\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    then    value &amp; (visible | hidden)  # Returns either <code>['visible']</code> or <code>['hidden']</code>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    h1    then    bool(value &amp; visible)  # Returns <code>${True}</code> if element is visible\n</pre>\n<p>The most typical use case would be to verify if an element contains a specific state or multiple states.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=checked_elem      *=    checked\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=checked_elem      not contains    checked\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=invisible_elem    contains    hidden    attached\n<a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a>    id=disabled_elem     contains    visible    disabled    readonly\n</pre>\n<p>Elements do return the positive and negative values if applicable. As example, a checkbox does return either <code>checked</code> or <code>unchecked</code> while a text input element has none of those two states. Select elements have also either <code>selected</code> or <code>unselected</code>.</p>\n<p>The state of <code>animating</code> will be set if an element is not considered <code>stable</code> within 300 ms.</p>\n<p>If an element is not attached to the dom, so it can not be found within 250ms it is marked as <code>detached</code> as the only state.</p>\n<p><code>stable</code> state is not returned, because it would cause too high delay in that keyword.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4272\">Comment &gt;&gt;</a></p>", "shortdoc": "Get the active states from the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 1346}, {"name": "Get Elements", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a reference to Playwright <a href=\"https://playwright.dev/docs/api/class-locator\">Locator</a> for all matched elements by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${elements} =    <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a>\n${elem} =    Get From List    ${elements}    0\n${option_value} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    ${elem} &gt;&gt; option    value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4273\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a reference to Playwright [https://playwright.dev/docs/api/class-locator|Locator] for all matched elements by ``selector``.", "tags": ["Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 864}, {"name": "Get Page Errors", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "full", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "full: bool = False"}, {"name": "last", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "last: int | timedelta | None = None"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, "doc": "<p>Returns the page errors of the active page.</p>\n<p>If assertions are used and fail, this keyword will fail immediately without retrying.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>assertion_operator</td>\n<td>Optional assertion operator. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>assertion_expected</td>\n<td>Optional expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>message</td>\n<td>Optional custom message to use on failure. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td>full</td>\n<td>If true, returns the full console log. If false, returns only new entries that were added since last time.</td>\n</tr>\n<tr>\n<td>last</td>\n<td>If set, returns only the last n entries. Can be <span class=\"name\">int</span> for number of entries or <a href=\"#type-timedelta\" class=\"name\">timedelta</a> for time period.</td>\n</tr>\n</table>\n<p>The returned data is a <a href=\"#type-list\" class=\"name\">list</a> of error messages.</p>\n<p>An error message is a <span class=\"name\">dict</span> with the following structure:</p>\n<pre>\n{\n  \"name\": str,\n  \"message\": str,\n  \"stack\": str,\n  \"time\": str\n}\n</pre>\n<p>Example:</p>\n<pre>\n[{\n  'name': 'ReferenceError',\n  'message': 'YT is not defined',\n  'stack': 'ReferenceError: YT is not defined\\n    at HTMLIFrameElement.onload (<a href=\"https://example.com/:20:2245\">https://example.com/:20:2245</a>)',\n  'time': '2023-02-05T20:08:48.912Z'\n}]\n</pre>\n<p>Keys:</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>The name/type of the error.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>The human readable error message.</td>\n</tr>\n<tr>\n<td><code>stack</code></td>\n<td>The stack trace of the error, if given.</td>\n</tr>\n<tr>\n<td><code>time</code></td>\n<td>The timestamp of the error as ISO 8601 string.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//5268\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the page errors of the active page.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1101}, {"name": "Get Page Ids", "args": [{"name": "page", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType = ALL"}, {"name": "context", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "type": {"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "returnType": {"name": "List", "typedoc": "list", "nested": [], "union": false}, "doc": "<p>Returns a list of page ids based on the context and browser selection. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<p><code>ALL</code> and <code>ANY</code> are synonyms. <code>ACTIVE</code> and <code>CURRENT</code> are also synonyms.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>The page to get the ids from. <code>ALL</code> Returns all page ids as a list. <code>ACTIVE</code> Returns the id of the active page as a list.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context to get the page ids from. <code>ALL</code> Page ids from all contexts shall be fetched. <code>ACTIVE</code> Only page ids from the active context shall be fetched.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser to get the page ids from. <code>ALL</code> Page ids from all open browsers shall be fetched. <code>ACTIVE</code> Only page ids from the active browser shall be fetched.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nTest Case\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://www.imbus.de\">http://www.imbus.de</a>\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://www.reaktor.com\">http://www.reaktor.com</a>\n    ${current_page}=   <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>    ACTIVE    ACTIVE    ACTIVE\n    Log                Current page ID is: ${current_page}[0]\n    ${all_pages}=      <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>    CURRENT   CURRENT   ALL\n    Log Many           These are all Page IDs    @{all_pages}\n</pre>\n<p>The ACTIVE page of the ACTIVE context of the ACTIVE Browser is the <code>Current</code> Page.</p>\n<p><a href=\"https://forum.robotframework.org/t//4274\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a list of page ids based on the context and browser selection. See `Browser, Context and Page` for more information about Page and related concepts.", "tags": ["BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1410}, {"name": "Get Page Source", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Gets pages HTML source as a string.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally does a string assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4275\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets pages HTML source as a string.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 89}, {"name": "Get Property", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "property", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "property: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Returns the <code>property</code> of the element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>property</code></td>\n<td>Requested property name.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the property value matches the expected value. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>If <code>assertion_operator</code> is set and property is not found, <code>value</code> is <code>None</code> and Keyword does not fail. See <a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a> for examples.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Property\" class=\"name\">Get Property</a>    h1    innerText    ==    Login Page\n${property} =    <a href=\"#Get%20Property\" class=\"name\">Get Property</a>    h1    innerText\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4276\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the ``property`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 212}, {"name": "Get Scroll Position", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "AreaFields", "typedoc": "AreaFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: AreaFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "ScrollPosition", "typedoc": "ScrollPosition", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements or pages current scroll position as object <code>{top: float, left: float, bottom: float, right: float}</code>.</p>\n<p>It describes the rectangle which is visible of the scrollable content of that element. all values are measured from position {top: 0, left: 0}.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the client size of the page itself is used (<code>document.scrollingElement</code>). See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll position as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the value matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> or <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> for examples.</p>\n<p><a href=\"https://forum.robotframework.org/t//4277\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages current scroll position as object ``{top: float, left: float, bottom: float, right: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 1240}, {"name": "Get Scroll Size", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dimensions", "typedoc": "Dimensions", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets elements or pages scrollable size as object <code>{width: float, height: float}</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Optional selector from which shall be retrieved. If no selector is given the scroll size of the page itself is used. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the scroll size as dictionary, otherwise it will just return the single value selected by the key.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>See <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a> for more similar examples.</p>\n<p>Example use:</p>\n<pre>\n${height}=         <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a>    height                          # filtered page by height\nLog                Width: ${height}                                   # Height: 58425\n${scroll_size}=    <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a>    id=keyword-shortcuts-container  # unfiltered element\nLog                ${scroll_size}                                     # {'width': 253, 'height': 3036}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4278\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets elements or pages scrollable size as object ``{width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 1184}, {"name": "Get Select Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "SelectOptions", "typedoc": "SelectOptions", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns attributes of options of a <code>select</code> element as a list of dictionaries.</p>\n<p>Returned dictionaries have the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that these match the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a>     //select[2]    validate  [v[\"label\"] for v in value] == [\"Email\", \"Mobile\"]\n<a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a>   select#names     validate  any(v[\"label\"] == \"Mikko\" for v in value)\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4279\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns attributes of options of a ``select`` element as a list of dictionaries.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 434}, {"name": "Get Selected Options", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "option_attribute", "type": {"name": "SelectAttribute", "typedoc": "SelectAttribute", "nested": [], "union": false}, "defaultValue": "label", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "option_attribute: SelectAttribute = label"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": true}], "union": false}, "doc": "<p>Returns the specified attribute of selected options of the <code>select</code> element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the info is to be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>option_attribute</code></td>\n<td>Which attribute shall be returned/verified. Defaults to label.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>*assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that these match the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<ul>\n<li><code>==</code> , <code>!=</code> and <code>contains</code> / <code>*=</code> can work with multiple values</li>\n<li><code>validate</code> and <code>evaluate</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>      label                    //select[2]    Email      Mobile\n${selected_list}         <a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   //select[2]                                         # getter\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   //select[2]              label          <span class=\"name\">==</span>       Mobile             Mail   #assertion content\n<a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>      label                    select#names   2          4\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             index          <span class=\"name\">==</span>       2                  4      #assertion index\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             label          *=         Mikko                     #assertion contain\n<a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a>   select#names             label          validate   len(value) == 3           #assertion length\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4280\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the specified attribute of selected options of the ``select`` element.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 493}, {"name": "Get Style", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: str | None = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "pseudo_element", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pseudo_element: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "doc": "<p>Gets the computed style properties of the element selected by <code>selector</code>.</p>\n<p>Optionally matches with any sequence assertion operator.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector from which the style shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Key of the requested CSS property. Retrieves \"ALL\" styles as dictionary by default. All css settings can be used as keys even if they are not all returned in the dictionary.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n<tr>\n<td><code>pseudo_element</code></td>\n<td>Pseudo element to match. Defaults to None. Pseudo elements are special css</td>\n</tr>\n</table>\n<p><a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/Pseudo-elements\">Pseudo element</a> is a css fuctionality to add styles. Example <span class=\"name\">::before</span> or <span class=\"name\">::after</span>.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the style matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4281\">Comment &gt;&gt;</a></p>", "shortdoc": "Gets the computed style properties of the element selected by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 1056}, {"name": "Get Table Cell Element", "args": [{"name": "table", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "table: str"}, {"name": "column", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: str"}, {"name": "row", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the Web Element that has the same column index and same row index as the selected elements.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>table</code></td>\n<td>selector must select the <code>&lt;table&gt;</code> element that contains both selected elements</td>\n</tr>\n<tr>\n<td><code>column</code></td>\n<td>selector can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants.</td>\n</tr>\n<tr>\n<td><code>row</code></td>\n<td>selector can select any <code>&lt;tr&gt;</code> element or one of their descendant like <code>&lt;td&gt;</code> elements.</td>\n</tr>\n</table>\n<p><code>column</code> and <code>row</code> can also consume index numbers instead of selectors. Indexes are starting from <code>0</code> and <code>-1</code> is specific for the last element.</p>\n<p>Selectors for <code>column</code> and <code>row</code> are directly appended to <code>table</code> selector like this: <code>f\"{table} &gt;&gt; {row}\" .</code></p>\n<table border=\"1\">\n<tr>\n<th>GitHub</th>\n<th>Slack</th>\n<th>Real Name</th>\n</tr>\n<tr>\n<td>mkorpela</td>\n<td>@mkorpela</td>\n<td>Mikko Korpela</td>\n</tr>\n<tr>\n<td>aaltat</td>\n<td>@aaltat</td>\n<td>Tatu Aalto</td>\n</tr>\n<tr>\n<td>xylix</td>\n<td>@Kerkko Pelttari</td>\n<td>Kerkko Pelttari</td>\n</tr>\n<tr>\n<td>Snooz82</td>\n<td>@Ren\u00e9</td>\n<td>Ren\u00e9 Rohner</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    [id=\"Get Table Cell Element\"] &gt;&gt; div.kw-docs table &gt;&gt; nth=1\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"Real Name\"    \"aaltat\"   # Returns element with text <code>Tatu Aalto</code>\nGet Text    ${e}    ==    Tatu Aalto\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"Slack\"    \"Mikko Korpela\"   # Returns element with text <code>@mkorpela</code>\nGet Text    ${e}    ==    @mkorpela\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    \"mkorpela\"    \"Kerkko Pelttari\"   # column does not need to be in row 0\nGet Text    ${e}    ==    @mkorpela\n${e}=    <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>    ${table}    2    -1   # Index is also directly possible\nGet Text    ${e}    ==    Ren\u00e9 Rohner\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4282\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the Web Element that has the same column index and same row index as the selected elements.", "tags": ["Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 696}, {"name": "Get Table Cell Index", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the index (0 based) of a table cell within its row.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    id=<a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a> &gt;&gt; div.kw-docs table   #Table of keyword <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>\n${idx}=    <a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a>    ${table} &gt;&gt; \"Real Name\"\nShould Be Equal    ${idx}    ${2}\n<a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a>    ${table} &gt;&gt; \"@aaltat\"    ==    1\n</pre>\n<p>Optionally asserts that the index matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4283\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the index (0 based) of a table cell within its row.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 751}, {"name": "Get Table Row Index", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: int | str = 0"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the index (0 based) of a table row.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>can select any <code>&lt;th&gt;</code> or <code>&lt;td&gt;</code> element or one of their descendants. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${table}=    Set Variable    id=<a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a> &gt;&gt; div.kw-docs table   #Table of keyword <a href=\"#Get%20Table%20Cell%20Element\" class=\"name\">Get Table Cell Element</a>\n${idx}=    <a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a>    ${table} &gt;&gt; \"@Ren\u00e9\"\nShould Be Equal    ${idx}    ${4}\n<a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a>    ${table} &gt;&gt; \"@aaltat\"    ==    2\n</pre>\n<p>Optionally asserts that the index matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4284\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the index (0 based) of a table row.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 794}, {"name": "Get Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns text attribute of the element found by <code>selector</code>.</p>\n<p>Keyword can also return <span class=\"name\">input</span> or <span class=\"name\">textarea</span> value property text. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Optionally asserts that the text matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default, assertion is not done.</p>\n<p>Example:</p>\n<pre>\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=important                            # Returns element text without assertion.\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=important    ==    Important text    # Returns element text with assertion.\n${text} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    //input         ==    root              # Returns input element text with assertion.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4285\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns text attribute of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 160}, {"name": "Get Title", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the title of the current page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that title matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4286\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the title of the current page.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 124}, {"name": "Get Url", "args": [{"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the current URL.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the state</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that it matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p><a href=\"https://forum.robotframework.org/t//4287\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the current URL.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 59}, {"name": "Get Viewport Size", "args": [{"name": "key", "type": {"name": "SizeFields", "typedoc": "SizeFields", "nested": [], "union": false}, "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns the current viewport dimensions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Optionally filters the returned values. If keys is set to <code>ALL</code> (default) it will return the viewport size as dictionary, otherwise it will just return the single value selected by the key. Note: If a single value is retrieved, an assertion does <b>not</b> need a <code>validate</code> combined with a cast of <code>value</code>.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value for the counting</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message for assertion.</td>\n</tr>\n</table>\n<p>Optionally asserts that the state matches the specified assertion. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. By default assertion is not done.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>    ALL    ==    {'width':1280, 'height':720}\n<a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>    width    &gt;=    1200\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4288\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns the current viewport dimensions.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 645}, {"name": "Go Back", "args": [], "returnType": null, "doc": "<p>Navigates to the previous page in history.</p>\n<p><a href=\"https://forum.robotframework.org/t//4289\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the previous page in history.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 51}, {"name": "Go Forward", "args": [], "returnType": null, "doc": "<p>Navigates to the next page in history.</p>\n<p><a href=\"https://forum.robotframework.org/t//4290\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the next page in history.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 41}, {"name": "Go To", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": null, "doc": "<p>Navigates to the given <code>url</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>URL to be navigated to.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>time to wait page to load. If not defined will use the library default timeout.</td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Returns the HTTP status code for the navigation request as integer or 0 if non received.</p>\n<p><a href=\"https://forum.robotframework.org/t//4291\">Comment &gt;&gt;</a></p>", "shortdoc": "Navigates to the given ``url``.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 61}, {"name": "Grant Permissions", "args": [{"name": "permissions", "type": {"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*permissions: Permission"}, {"name": "origin", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "origin: str | None = None"}], "returnType": null, "doc": "<p>Grants permissions to the current context.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>permissions</code></td>\n<td>is a list of permissions to grant. Permissions can be one of the following: geolocation, notifications, camera, microphone,</td>\n</tr>\n<tr>\n<td><code>origin</code></td>\n<td>The origin to grant permissions to, e.g. \"<a href=\"https://example.com\">https://example.com</a>\".</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#Grant%20Permissions\" class=\"name\">Grant Permissions</a>    geolocation\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4292\">Comment &gt;&gt;</a></p>", "shortdoc": "Grants permissions to the current context.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 523}, {"name": "Handle Future Dialogs", "args": [{"name": "action", "type": {"name": "DialogAction", "typedoc": "DialogAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}], "returnType": null, "doc": "<p>Handle next dialog on page with <code>action</code>.</p>\n<p>Dialog can be any of alert, beforeunload, confirm or prompt. Handling dialogue must be called before the action, like example click, that triggers the dialogue.</p>\n<p>If a handler is not set dialogs are dismissed by default.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>How to handle the alert. Can be <code>accept</code> or <code>dismiss</code>.</td>\n</tr>\n<tr>\n<td><code>prompt_input</code></td>\n<td>The value to enter into prompt. Only valid if <code>action</code> argument equals <code>accept</code>. Defaults to empty string.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a>    action=accept\n<a href=\"#Click\" class=\"name\">Click</a>                    \\#alerts\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4293\">Comment &gt;&gt;</a></p>", "shortdoc": "Handle next dialog on page with ``action``.", "tags": ["PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 827}, {"name": "Highlight Elements", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "duration", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:05", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration: timedelta = 0:00:05"}, {"name": "width", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "2px", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width: str = 2px"}, {"name": "style", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "dotted", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = dotted"}, {"name": "color", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "blue", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "color: str = blue"}], "returnType": null, "doc": "<p>Adds a highlight to elements matched by the <code>selector</code>. Provides a style adjustment.</p>\n<p>Returns the number of highlighted elements. Keyword does not fail, if <span class=\"name\">locator</span> matched zero elements in the page. Keyword does not scroll elements to viewport and highlighted element might be outside the viewport. Use <a href=\"#Scroll%20To%20Element\" class=\"name\">Scroll To Element</a> keyword to scroll element in viewport.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selectors which shall be highlighted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>duration</code></td>\n<td>Sets for how long the selector shall be highlighted. Defaults to <code>5s</code> =&gt; 5 seconds.</td>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>Sets the width of the higlight border. Defaults to 2px.</td>\n</tr>\n<tr>\n<td><code>style</code></td>\n<td>Sets the style of the border. Defaults to dotted.</td>\n</tr>\n<tr>\n<td><code>color</code></td>\n<td>Sets the color of the border. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></td>\n</tr>\n</table>\n<p>Keyword does not fail if selector resolves to multiple elements.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    input#login_button    duration=200ms\n${count} =    <a href=\"#Highlight%20Elements\" class=\"name\">Highlight Elements</a>    input#login_button    duration=200ms    width=4px    style=solid    color=\\#FF00FF\nShould Be Equal    ${count}    ${5}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4294\">Comment &gt;&gt;</a></p>", "shortdoc": "Adds a highlight to elements matched by the ``selector``. Provides a style adjustment.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 82}, {"name": "Hover", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_x: float | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_y: float | None = None"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}], "returnType": null, "doc": "<p>Moves the virtual mouse and scrolls to the element found by <code>selector</code>.</p>\n<p>This method hovers over an element matching <code>selector</code> by performing the following steps:</p>\n<ul>\n<li>Find an element match matching <code>selector</code>. If there is none, wait until a matching element is attached to the DOM.</li>\n<li>Wait for actionability checks on the matched element, unless <code>force</code> option is set. If the element is detached during the checks, the whole action is retried.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a> to hover over the center of the element, or the specified <code>position</code>.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to hover. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>position_x</code> &amp; <code>position_y</code></td>\n<td>A point to hover relative to the top-left corner of element bounding box. If not specified, hovers over some visible point of the element. Only positive values within the bounding-box are allowed.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the hover, and then restores current modifiers back. If not specified, currently pressed modifiers are used.</td>\n<td></td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Hover\" class=\"name\">Hover</a>    h1\n<a href=\"#Hover\" class=\"name\">Hover</a>    h1    10   20    Alt\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4295\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves the virtual mouse and scrolls to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 480}, {"name": "Http", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "RequestMethod", "typedoc": "RequestMethod", "nested": [], "union": false}, "defaultValue": "GET", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "method: RequestMethod = GET"}, {"name": "body", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "body: str | None = None"}, {"name": "headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers: dict | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Performs an HTTP request in the current browser context</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>The request url, e.g. <code>/api/foo</code>.</td>\n</tr>\n<tr>\n<td><code>method</code></td>\n<td>The HTTP method for the request. Defaults to GET.</td>\n</tr>\n<tr>\n<td><code>body</code></td>\n<td>The request body. GET requests cannot have a body. If the body can be parsed as JSON, the <code>Content-Type</code> header for the request will be automatically set to <code>application/json</code>. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>headers</code></td>\n<td>A dictionary of additional request headers. Defaults to None.</td>\n</tr>\n</table>\n<p>The response is a Python dictionary with following attributes:</p>\n<ul>\n<li><code>status</code> &lt;int&gt; The status code of the response.</li>\n<li><code>statusText</code> &lt;str&gt; Status text corresponding to <code>status</code>, e.g OK or INTERNAL SERVER ERROR. This may not be available for all browser.</li>\n<li><code>body</code> &lt;dict&gt; | &lt;str&gt; The response body. If the body can be parsed as a JSON obejct, it will be returned as Python dictionary, otherwise it is returned as a string.</li>\n<li><code>headers</code> &lt;dict&gt; A dictionary containing all response headers.</li>\n<li><code>ok</code> &lt;bool&gt; Whether the request was successfull, i.e. the <code>status</code> is range 200-299.</li>\n</ul>\n<p>Here's an example of using Robot Framework dictionary variables and extended variable syntax to do assertions on the response object:</p>\n<pre>\n&amp;{res}=             <a href=\"#Http\" class=\"name\">HTTP</a>                       /api/endpoint\nShould Be Equal     ${res.status}              200\nShould Be Equal     ${res.body.some_field}     some value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4296\">Comment &gt;&gt;</a></p>", "shortdoc": "Performs an HTTP request in the current browser context", "tags": ["HTTP"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 59}, {"name": "Keyboard Input", "args": [{"name": "action", "type": {"name": "KeyboardInputAction", "typedoc": "KeyboardInputAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyboardInputAction"}, {"name": "input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input: str"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int | timedelta = 0:00:00"}], "returnType": null, "doc": "<p>Input text into page with virtual keyboard.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td><code>insertText</code>: Dispatches only input event, does not emit the keydown, keyup or keypress events. <code>type</code>: Sends a keydown, keypress/input, and keyup event for each character in the text.</td>\n</tr>\n<tr>\n<td><code>input</code></td>\n<td>The inputstring to be typed. <i>No special keys possible.</i></td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Time to wait between key presses in Robot Framework's time format. Defaults to 0.</td>\n</tr>\n</table>\n<p><b>Attention:</b> Argument type <span class=\"name\">int</span> for 'delay' in milliseconds has been changed to <a href=\"#type-timedelta\" class=\"name\">timedelta</a> in Browser 14.0.0. Use Robot Framework time format with units instead.</p>\n<p>Note: To press a special key, like Control or ArrowDown, use keyboard.press. Modifier keys DO NOT effect these methods. For testing modifier effects use single key presses with <code>Keyboard Key  press</code></p>\n<p>Example:</p>\n<pre>\n<a href=\"#Keyboard%20Input\" class=\"name\">Keyboard Input</a>    insertText    0123456789\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4297\">Comment &gt;&gt;</a></p>", "shortdoc": "Input text into page with virtual keyboard.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1211}, {"name": "Keyboard Key", "args": [{"name": "action", "type": {"name": "KeyAction", "typedoc": "KeyAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyAction"}, {"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "returnType": null, "doc": "<p>Press a keyboard key on the virtual keyboard or set a key up or down.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>Determine whether the key should be released (<code>up</code>), hold (<code>down</code>) or pressed once (<code>press</code>). <code>down</code> or <code>up</code> are useful for combinations i.e. with Shift.</td>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The key to be pressed. An example of valid keys are: <code>F1</code> - <code>F12</code>, <code>Digit0</code> - <code>Digit9</code>, <code>KeyA</code> - <code>KeyZ</code>, <code>Backquote</code>, <code>Minus</code>, <code>Equal</code>, <code>Backslash</code>, <code>Backspace</code>, <code>Tab</code>, <code>Delete</code>, <code>Escape</code>, <code>ArrowDown</code>, <code>End</code>, <code>Enter</code>, <code>Home</code>, <code>Insert</code>, <code>PageDown</code>, <code>PageUp</code>, <code>ArrowRight</code>, <code>ArrowUp</code> , etc.</td>\n</tr>\n</table>\n<p>Useful keys for <code>down</code> and <code>up</code> for example are: <code>Shift</code>, <code>Control</code>, <code>Alt</code>, <code>Meta</code>, <code>ShiftLeft</code></p>\n<p>Example excecution:</p>\n<pre>\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    S\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    down     Shift\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    ArrowLeft\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    press    Delete\n<a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a>    up       Shift\n</pre>\n<p>Note: Capital letters don't need to be written by the help of Shift. You can type them in directly.</p>\n<p><a href=\"https://forum.robotframework.org/t//4298\">Comment &gt;&gt;</a></p>", "shortdoc": "Press a keyboard key on the virtual keyboard or set a key up or down.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1182}, {"name": "Launch Browser Server", "args": [{"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "firefoxUserPrefs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "firefoxUserPrefs: Dict[str, str | int | float | bool] | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "port", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "port: int | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "reuse_existing", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "reuse_existing: bool = True"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "wsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "wsPath: str | None = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Launches a new playwright Browser server with specified options.</p>\n<p>Returns a websocket endpoint (wsEndpoint) string that can be used to connect to the server.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>port</code></td>\n<td>Port to use for the browser server. Defaults to 0, which results in a random free port being assigned.</td>\n</tr>\n<tr>\n<td><code>wsPath</code></td>\n<td>If set, Playwright will listen on the given path in addition to the main port. For security, this defaults to an unguessable string.</td>\n</tr>\n</table>\n<p>Check <a href=\"#New%20Browser\" class=\"name\">New Browser</a> for the other argument docs.</p>\n<p>The launched browser server can be used to connect to it with <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a> keyword. This keyword can also be used from command line with <code>rfbrowser launch-browser-server</code> command.</p>\n<p>see <a href=\"https://playwright.dev/docs/api/class-browserserver#browser-server\">Playwright documentation</a> for more information.</p>\n<p><a href=\"https://forum.robotframework.org/t//4306\">Comment &gt;&gt;</a></p>", "shortdoc": "Launches a new playwright Browser server with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 431}, {"name": "LocalStorage Clear", "args": [{"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove all saved data from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>      Foo    bar\n<a href=\"#LocalStorage%20Clear\" class=\"name\">LocalStorage Clear</a>\n${item} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Foo\nShould Be Equal    ${item}    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4299\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove all saved data from the local storage.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 124}, {"name": "LocalStorage Get Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Get saved data from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Named key of the item in the storage.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>Assertion operator to use. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value to compare with.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Custom error message to use.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Key    ==    Value    My error\n${value} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Key\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4300\">Comment &gt;&gt;</a></p>", "shortdoc": "Get saved data from the local storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 42}, {"name": "LocalStorage Remove Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove saved data with key from the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the item which shall be deleted.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>      Foo    bar\n<a href=\"#LocalStorage%20Remove%20Item\" class=\"name\">LocalStorage Remove Item</a>    Foo\n${item} =    <a href=\"#LocalStorage%20Get%20Item\" class=\"name\">Local Storage Get Item</a>    Foo\nShould Be Equal    ${item}    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4301\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove saved data with key from the local storage.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 103}, {"name": "LocalStorage Set Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Save data to the local storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the key under which it should be saved.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>The value which shall be saved as a string.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the LocalStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#LocalStorage%20Set%20Item\" class=\"name\">Local Storage Set Item</a>    Key    Value\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4302\">Comment &gt;&gt;</a></p>", "shortdoc": "Save data to the local storage.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 81}, {"name": "Mouse Button", "args": [{"name": "action", "type": {"name": "MouseButtonAction", "typedoc": "MouseButtonAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: MouseButtonAction"}, {"name": "x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float | None = None"}, {"name": "y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float | None = None"}, {"name": "button", "type": {"name": "MouseButton", "typedoc": "MouseButton", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "clickCount", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int | timedelta = 0:00:00"}], "returnType": null, "doc": "<p>Clicks, presses or releases a mouse button.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>Defines if it is a mouseclick (<code>click</code>), holding down a button (<code>down</code>) or releasing it (<code>up</code>).</td>\n</tr>\n<tr>\n<td><code>x</code>, <code>y</code></td>\n<td>Coordinates to move before action is executed.</td>\n</tr>\n<tr>\n<td><code>button</code></td>\n<td>One of <code>left</code>, <code>middle</code> or <code>up</code>. Defaults to <code>left</code>.</td>\n</tr>\n<tr>\n<td><code>clickCount</code></td>\n<td>Determine how often the button shall be clicked if action is equal to <code>click</code>. Defaults to 1.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay in Robot Framework time format between the mousedown and mouseup event. Can only be set if the action is <code>click</code>.</td>\n</tr>\n</table>\n<p><b>Attention:</b> Argument type <span class=\"name\">int</span> for 'delay' in milliseconds has been changed to <a href=\"#type-timedelta\" class=\"name\">timedelta</a> in Browser 14.0.0. Use Robot Framework time format instead. For refactoring just add 'ms' after the delay number.</p>\n<p>Delay Example:</p>\n<pre>\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>    click    100 ms\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>    click    ${dyn_delay} ms\n</pre>\n<p>Moving the mouse between holding down and releasing it, is possible with <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Hover\" class=\"name\">Hover</a>                     \"Obstacle\"           # Move mouse over the element\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>              down                 # Press mouse button down\n<a href=\"#Mouse%20Move%20Relative%20To\" class=\"name\">Mouse Move Relative To</a>    \"Obstacle\"    500    # Drag mouse\n<a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a>              up                   # Release mouse button\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4303\">Comment &gt;&gt;</a></p>", "shortdoc": "Clicks, presses or releases a mouse button.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 913}, {"name": "Mouse Move", "args": [{"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: float"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: float"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>Are absolute coordinates starting at the top left of the page.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Number of intermediate steps for the mouse event. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>    400    400\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4304\">Comment &gt;&gt;</a></p>", "shortdoc": "Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1142}, {"name": "Mouse Move Relative To", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "x", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "returnType": null, "doc": "<p>Moves the mouse cursor relative to the selected element.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Identifies the element, which center is the start-point.</td>\n</tr>\n<tr>\n<td><code>x</code> &amp; <code>y</code></td>\n<td>Are relative coordinates to the center of the elements bounding box.</td>\n</tr>\n<tr>\n<td><code>steps</code></td>\n<td>Number of intermediate steps for the mouse event. Often it is nessesary to send more than one intermediate event to get the desired result. Defaults to 1.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Mouse%20Move%20Relative%20To\" class=\"name\">Mouse Move Relative To</a>    id=indicator    -100\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4305\">Comment &gt;&gt;</a></p>", "shortdoc": "Moves the mouse cursor relative to the selected element.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1102}, {"name": "Mouse Wheel", "args": [{"name": "deltaX", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deltaX: int"}, {"name": "deltaY", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deltaY: int"}], "returnType": null, "doc": "<p>Simulates the user rotation of a mouse wheel.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>deltaX</code> &amp; <code>deltaY</code></td>\n<td>Pixels that are scrolled horizontally &amp; vertically.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n# Before doing a mouse wheel interaction. A mouse needs to be posisioned on the browser window.\n<a href=\"#Hover\" class=\"name\">Hover</a>    body\n<a href=\"#Mouse%20Wheel\" class=\"name\">Mouse Wheel</a>    0    250\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5186\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates the user rotation of a mouse wheel.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1162}, {"name": "New Browser", "args": [{"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "firefoxUserPrefs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "firefoxUserPrefs: Dict[str, str | int | float | bool] | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "reuse_existing", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "reuse_existing: bool = True"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Create a new playwright Browser with specified options.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Returns a stable identifier for the created browser.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Opens the specified <a href=\"#type-SupportedBrowsers\">browser</a>. Defaults to chromium.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>Set to False if you want a GUI. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>args</code></td>\n<td>Additional arguments to pass to the browser instance. The list of Chromium flags can be found <a href=\"http://peter.sh/experiments/chromium-command-line-switches/\">here</a>. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>channel</code></td>\n<td>Allows to operate against the stock Google Chrome and Microsoft Edge browsers. For more details see: <a href=\"https://playwright.dev/docs/browsers#google-chrome--microsoft-edge\">Playwright documentation</a>.</td>\n</tr>\n<tr>\n<td><code>chromiumSandbox</code></td>\n<td>Enable Chromium sandboxing. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>devtools</code></td>\n<td>Chromium-only Whether to auto-open a Developer Tools panel for each tab.</td>\n</tr>\n<tr>\n<td><code>downloadsPath</code></td>\n<td>If specified, accepted downloads are downloaded into this folder. Otherwise, temporary folder is created and is deleted when browser is closed. Regarding file deletion, see the docs of <a href=\"#Download\" class=\"name\">Download</a> and <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a>.</td>\n</tr>\n<tr>\n<td><code>env</code></td>\n<td>Specifies environment variables that will be visible to the browser. Dictionary keys are variable names, values are the content. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>executablePath</code></td>\n<td>Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>firefoxUserPrefs</code> |Firefox user preferences. Learn more about the Firefox user preferences at <a href=\"https://support.mozilla.org/en-US/kb/about-config-editor-firefox\">about:config</a>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>handleSIGHUP</code></td>\n<td>Close the browser process on SIGHUP. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>handleSIGINT</code></td>\n<td>Close the browser process on Ctrl-C. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>handleSIGTERM</code></td>\n<td>Close the browser process on SIGTERM. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>ignoreDefaultArgs</code></td>\n<td>If True, Playwright does not pass its own configurations args and only uses the ones from args. If a list is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>proxy</code></td>\n<td>Network <a href=\"#type-Proxy\">Proxy</a> settings. Structure: <code>{'server': &lt;str&gt;, 'bypass': &lt;Optional[str]&gt;, 'username': &lt;Optional[str]&gt;, 'password': &lt;Optional[str]&gt;}</code></td>\n</tr>\n<tr>\n<td><code>reuse_existing</code></td>\n<td>If set to True, an existing browser instance, that matches the same arguments, will be reused. If no same configured Browser exist, a new one is started. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>slowMo</code></td>\n<td>Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to no delay.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Maximum time in Robot Framework time format to wait for the browser instance to start. Defaults to 30 seconds. Pass 0 to disable timeout.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4306\">Comment &gt;&gt;</a></p>", "shortdoc": "Create a new playwright Browser with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 360}, {"name": "New Context", "args": [{"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "acceptDownloads", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "acceptDownloads: bool = True"}, {"name": "baseURL", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "baseURL: str | None = None"}, {"name": "bypassCSP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "colorScheme", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ColorScheme", "typedoc": "ColorScheme", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "colorScheme: ColorScheme | None = None"}, {"name": "defaultBrowserType", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "defaultBrowserType: SupportedBrowsers | None = None"}, {"name": "deviceScaleFactor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "deviceScaleFactor: float | None = None"}, {"name": "extraHTTPHeaders", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] | None = None"}, {"name": "forcedColors", "type": {"name": "ForcedColors", "typedoc": "ForcedColors", "nested": [], "union": false}, "defaultValue": "none", "kind": "NAMED_ONLY", "required": false, "repr": "forcedColors: ForcedColors = none"}, {"name": "geolocation", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "GeoLocation", "typedoc": "GeoLocation", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "geolocation: GeoLocation | None = None"}, {"name": "hasTouch", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "hasTouch: bool | None = None"}, {"name": "httpCredentials", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HttpCredentials", "typedoc": "HttpCredentials", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "httpCredentials: HttpCredentials | None = None"}, {"name": "ignoreHTTPSErrors", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "isMobile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "isMobile: bool | None = None"}, {"name": "javaScriptEnabled", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "locale: str | None = None"}, {"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "offline: bool = False"}, {"name": "permissions", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "permissions: List[Permission] | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "recordHar", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordHar", "typedoc": "RecordHar", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordHar: RecordHar | None = None"}, {"name": "recordVideo", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordVideo", "typedoc": "RecordVideo", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordVideo: RecordVideo | None = None"}, {"name": "reducedMotion", "type": {"name": "ReduceMotion", "typedoc": "ReduceMotion", "nested": [], "union": false}, "defaultValue": "no_preference", "kind": "NAMED_ONLY", "required": false, "repr": "reducedMotion: ReduceMotion = no_preference"}, {"name": "screen", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "screen: Dict[str, int] | None = None"}, {"name": "serviceWorkers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ServiceWorkersPermissions", "typedoc": "ServiceWorkersPermissions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "allow", "kind": "NAMED_ONLY", "required": false, "repr": "serviceWorkers: ServiceWorkersPermissions | None = allow"}, {"name": "storageState", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "storageState: str | None = None"}, {"name": "timezoneId", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timezoneId: str | None = None"}, {"name": "tracing", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "tracing: str | None = None"}, {"name": "userAgent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "userAgent: str | None = None"}, {"name": "viewport", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "{'width': 1280, 'height': 720}", "kind": "NAMED_ONLY", "required": false, "repr": "viewport: ViewportDimensions | None = {'width': 1280, 'height': 720}"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Create a new BrowserContext with specified options.</p>\n<p>See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about BrowserContext.</p>\n<p>Returns a stable identifier for the created context that can be used in <a href=\"#Switch%20Context\" class=\"name\">Switch Context</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>acceptDownloads</code></td>\n<td>Whether to automatically download all the attachments. Defaults to True where all the downloads are accepted.</td>\n</tr>\n<tr>\n<td><code>baseURL</code></td>\n<td>When using <a href=\"#Go%20To\" class=\"name\">Go To</a>, <a href=\"#Wait%20For%20Request\" class=\"name\">Wait For Request</a> or <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a> it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples: <code>baseURL=http://localhost:3000</code> and navigating to <code>/bar.html</code> results in <code>http://localhost:3000/bar.html</code>. <code>baseURL=http://localhost:3000/foo/</code> and navigating to <code>./bar.html</code> results in <code>http://localhost:3000/foo/bar.html</code>. <code>baseURL=http://localhost:3000/foo</code> (without trailing slash) and navigating to <code>./bar.html</code> results in <code>http://localhost:3000/bar.html</code>.</td>\n</tr>\n<tr>\n<td><code>bypassCSP</code></td>\n<td>Toggles bypassing page's Content-Security-Policy. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>colorScheme</code></td>\n<td>Emulates <span class=\"name\">'prefers-colors-scheme'</span> media feature, supported values are <span class=\"name\">'light'</span>, <span class=\"name\">'dark'</span>, <span class=\"name\">'no-preference'</span>.</td>\n</tr>\n<tr>\n<td><code>defaultBrowserType</code></td>\n<td>If no browser is open and <a href=\"#New%20Context\" class=\"name\">New Context</a> opens a new browser with defaults, it now uses this setting. Very useful together with <a href=\"#Get%20Device\" class=\"name\">Get Device</a> keyword.</td>\n</tr>\n<tr>\n<td><code>deviceScaleFactor</code></td>\n<td>Specify device scale factor (can be thought of as dpr). Defaults to <code>1</code>.</td>\n</tr>\n<tr>\n<td><code>extraHTTPHeaders</code></td>\n<td>A dictionary containing additional HTTP headers to be sent with every request. All header values must be strings.</td>\n</tr>\n<tr>\n<td><code>forcedColors</code></td>\n<td>Emulates <span class=\"name\">forced-colors</span> media feature, supported values are <span class=\"name\">active</span> and <a href=\"#type-None\" class=\"name\">none</a>.</td>\n</tr>\n<tr>\n<td><code>geolocation</code></td>\n<td>A dictionary containing <code>latitude</code> and <code>longitude</code> or <code>accuracy</code> to emulate. If <code>latitude</code> or <code>longitude</code> is not specified, the device geolocation won't be overriden.</td>\n</tr>\n<tr>\n<td><code>hasTouch</code></td>\n<td>Specifies if viewport supports touch events. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>httpCredentials</code></td>\n<td>Credentials for <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication\">HTTP authentication</a>.</td>\n</tr>\n<tr>\n<td><code>ignoreHTTPSErrors</code></td>\n<td>Whether to ignore HTTPS errors during navigation. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>isMobile</code></td>\n<td>Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>javaScriptEnabled</code></td>\n<td>Whether or not to enable JavaScript in the context. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>locale</code></td>\n<td>Specify user locale, for example <code>en-GB</code>, <code>de-DE</code>, etc.</td>\n</tr>\n<tr>\n<td><code>offline</code></td>\n<td>Toggles browser's offline mode. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>permissions</code></td>\n<td>A list containing permissions to grant to all pages in this context. All permissions that are not listed here will be automatically denied.</td>\n</tr>\n<tr>\n<td><code>proxy</code></td>\n<td>Network proxy settings to use with this context. Defaults to None. <b>NOTE:</b> For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example <code>proxy={ server: '<a href=\"http://per-context\">http://per-context</a>' }</code>.</td>\n</tr>\n<tr>\n<td><code>recordHar</code></td>\n<td>Enables <a href=\"http://www.softwareishard.com/blog/har-12-spec/\">HAR</a> recording for all pages into to a file. Must be path to file, example ${OUTPUT_DIR}/har.file. If not specified, the HAR is not recorded. Make sure to await context to close for the to be saved.</td>\n</tr>\n<tr>\n<td><code>recordVideo</code></td>\n<td>Enables video recording for all pages into a folder. If not specified videos are not recorded. Make sure to close context for videos to be saved. Video is not support in remote browsers.</td>\n</tr>\n<tr>\n<td><code>reduceMotion</code></td>\n<td>Emulates <span class=\"name\">prefers-reduced-motion</span> media feature, supported values are <span class=\"name\">reduce</span>, <span class=\"name\">no-preference</span>.</td>\n</tr>\n<tr>\n<td><code>screen</code></td>\n<td>Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set. Example {'width': 414, 'height': 896}</td>\n</tr>\n<tr>\n<td><code>serviceWorkers</code></td>\n<td>Whether to allow sites to register Service workers. Defaults to 'allow'.</td>\n</tr>\n<tr>\n<td><code>storageState</code></td>\n<td>Restores the storage stated created by the <a href=\"#Save%20Storage%20State\" class=\"name\">Save Storage State</a> keyword. Must mbe full path to the file.</td>\n</tr>\n<tr>\n<td><code>timezoneId</code></td>\n<td>Changes the timezone of the context. See <a href=\"https://source.chromium.org/chromium/chromium/src/+/master:third_party/icu/source/data/misc/metaZones.txt\">ICU`s metaZones.txt</a> for a list of supported timezone IDs.</td>\n</tr>\n<tr>\n<td><code>tracing</code></td>\n<td>File name where the <a href=\"https://playwright.dev/docs/api/class-tracing/\">tracing</a> file is saved. Example trace.zip will be saved to ${OUTPUT_DIR}/traces.zip. Temporary trace files will be saved to ${OUTPUT_DIR}/Browser/traces. If file name is defined, tracing will be enabled for all pages in the context. Tracing is automatically closed when context is closed. Temporary trace files will be automatically deleted at start of each test execution. Trace file can be opened after the test execution by running command from shell: <code>rfbrowser show-trace /path/to/trace.zip</code>.</td>\n</tr>\n<tr>\n<td><code>userAgent</code></td>\n<td>Specific user agent to use in this context.</td>\n</tr>\n<tr>\n<td><code>viewport</code></td>\n<td>A dictionary containing <code>width</code> and <code>height</code>. Emulates consistent viewport for each page. Defaults to 1280x720. null disables the default viewport. If <code>width</code> and <code>height</code> is  <code>0</code>, the viewport will scale with the window.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nTest an iPhone\n    ${device}=    <a href=\"#Get%20Device\" class=\"name\">Get Device</a>    iPhone X\n    <a href=\"#New%20Context\" class=\"name\">New Context</a>    &amp;{device}        # unpacking here with &amp;\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"http://example.com\">http://example.com</a>\n</pre>\n<p>A BrowserContext is the Playwright object that controls a single browser profile. Within a context caches and cookies are shared. See <a href=\"https://playwright.dev/docs/api/class-browser#browsernewcontextoptions\">Playwright browser.newContext</a> for a list of supported options.</p>\n<p>If there's no open Browser this keyword will open one. Does not create pages.</p>\n<p><a href=\"https://forum.robotframework.org/t//4307\">Comment &gt;&gt;</a></p>", "shortdoc": "Create a new BrowserContext with specified options.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 517}, {"name": "New Page", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": {"name": "NewPageDetails", "typedoc": "NewPageDetails", "nested": [], "union": false}, "doc": "<p>Open a new Page.</p>\n<p>A Page is the Playwright equivalent to a tab. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page concept.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Optional URL to navigate the page to. The url should include protocol, e.g. <span class=\"name\">https://</span></td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Returns <a href=\"#type-NewPageDetails\" class=\"name\">NewPageDetails</a> as dictionary for created page. <a href=\"#type-NewPageDetails\" class=\"name\">NewPageDetails</a> (dict) contains the keys <code>page_id</code> and <code>video_path</code>. <code>page_id</code> is a stable identifier for the created page. <code>video_path</code> is path to the created video or empty if video is not created.</p>\n<p>When a <a href=\"#New%20Page\" class=\"name\">New Page</a> is called without an open browser, <a href=\"#New%20Browser\" class=\"name\">New Browser</a> and <a href=\"#New%20Context\" class=\"name\">New Context</a> are executed with default values first.</p>\n<p><a href=\"https://forum.robotframework.org/t//4308\">Comment &gt;&gt;</a></p>", "shortdoc": "Open a new Page.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 861}, {"name": "New Persistent Context", "args": [{"name": "userDataDir", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "userDataDir: str = "}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "acceptDownloads", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "acceptDownloads: bool = True"}, {"name": "args", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "args: List[str] | None = None"}, {"name": "baseURL", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "baseURL: str | None = None"}, {"name": "bypassCSP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "channel", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "channel: str | None = None"}, {"name": "chromiumSandbox", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "chromiumSandbox: bool = False"}, {"name": "colorScheme", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ColorScheme", "typedoc": "ColorScheme", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "colorScheme: ColorScheme | None = None"}, {"name": "defaultBrowserType", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "defaultBrowserType: SupportedBrowsers | None = None"}, {"name": "deviceScaleFactor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "deviceScaleFactor: float | None = None"}, {"name": "devtools", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "devtools: bool = False"}, {"name": "downloadsPath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "downloadsPath: str | None = None"}, {"name": "env", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "env: Dict | None = None"}, {"name": "executablePath", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "executablePath: str | None = None"}, {"name": "extraHTTPHeaders", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] | None = None"}, {"name": "forcedColors", "type": {"name": "ForcedColors", "typedoc": "ForcedColors", "nested": [], "union": false}, "defaultValue": "none", "kind": "NAMED_ONLY", "required": false, "repr": "forcedColors: ForcedColors = none"}, {"name": "geolocation", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "GeoLocation", "typedoc": "GeoLocation", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "geolocation: GeoLocation | None = None"}, {"name": "handleSIGHUP", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "handleSIGINT", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "hasTouch", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "hasTouch: bool | None = None"}, {"name": "httpCredentials", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "HttpCredentials", "typedoc": "HttpCredentials", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "httpCredentials: HttpCredentials | None = None"}, {"name": "ignoreDefaultArgs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreDefaultArgs: List[str] | bool | None = None"}, {"name": "ignoreHTTPSErrors", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "isMobile", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "isMobile: bool | None = None"}, {"name": "javaScriptEnabled", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "locale: str | None = None"}, {"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "offline: bool = False"}, {"name": "permissions", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "Permission", "typedoc": "Permission", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "permissions: List[Permission] | None = None"}, {"name": "proxy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Proxy", "typedoc": "Proxy", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "proxy: Proxy | None = None"}, {"name": "recordHar", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordHar", "typedoc": "RecordHar", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordHar: RecordHar | None = None"}, {"name": "recordVideo", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "RecordVideo", "typedoc": "RecordVideo", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "recordVideo: RecordVideo | None = None"}, {"name": "reducedMotion", "type": {"name": "ReduceMotion", "typedoc": "ReduceMotion", "nested": [], "union": false}, "defaultValue": "no_preference", "kind": "NAMED_ONLY", "required": false, "repr": "reducedMotion: ReduceMotion = no_preference"}, {"name": "screen", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "screen: Dict[str, int] | None = None"}, {"name": "serviceWorkers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ServiceWorkersPermissions", "typedoc": "ServiceWorkersPermissions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "allow", "kind": "NAMED_ONLY", "required": false, "repr": "serviceWorkers: ServiceWorkersPermissions | None = allow"}, {"name": "slowMo", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "NAMED_ONLY", "required": false, "repr": "slowMo: timedelta = 0:00:00"}, {"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:30", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "timezoneId", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timezoneId: str | None = None"}, {"name": "tracing", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "tracing: str | None = None"}, {"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "url: str | None = None"}, {"name": "userAgent", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "userAgent: str | None = None"}, {"name": "viewport", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "ViewportDimensions", "typedoc": "ViewportDimensions", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "{'width': 1280, 'height': 720}", "kind": "NAMED_ONLY", "required": false, "repr": "viewport: ViewportDimensions | None = {'width': 1280, 'height': 720}"}], "returnType": null, "doc": "<p>Open a new <a href=\"https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context\">persistent context</a>.</p>\n<p><a href=\"#New%20Persistent%20Context\" class=\"name\">New Persistent Context</a> does basically executes <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> in one step with setting a profile at the same time.</p>\n<p>This keyword returns a tuple of browser id, context id and page details. (New in Browser 15.0.0)</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>userDataDir</code></td>\n<td>Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for Chromium and Firefox. Note that Chromium's user data directory is the parent directory of the \"Profile Path\" seen at <a href=\"chrome://version\">chrome://version</a>. Pass an empty string to use a temporary directory instead.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Browser type to use. Default is Chromium.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>Whether to run browser in headless mode. Defaults to <code>True</code>.</td>\n</tr>\n<tr>\n<td>other arguments</td>\n<td>Please see <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> for more information about the other arguments.</td>\n</tr>\n</table>\n<p>If you want to use extensions you need to download the extension as a .zip, enable loading the extension, and load the extensions using chromium arguments like below. Extensions only work with chromium and with a headful browser.</p>\n<pre>\n${launch_args}=  Set Variable  [\"--disable-extensions-except=./ublock/uBlock0.chromium\", \"--load-extension=./ublock/uBlock0.chromium\"]\n${browserId}  ${contextId}  ${pageDetails}=  <a href=\"#New%20Persistent%20Context\" class=\"name\">New Persistent Context</a>  browser=chromium  headless=False  url=https://robocon,io  args=${launch_args}\n</pre>\n<p>Check <a href=\"#New%20Browser\" class=\"name\">New Browser</a>, <a href=\"#New%20Context\" class=\"name\">New Context</a> and <a href=\"#New%20Page\" class=\"name\">New Page</a> for the specific argument docs.</p>\n<p><a href=\"https://forum.robotframework.org/t//4309\">Comment &gt;&gt;</a></p>", "shortdoc": "Open a new [https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context | persistent context].", "tags": [], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 634}, {"name": "Open Browser", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "browser", "type": {"name": "SupportedBrowsers", "typedoc": "SupportedBrowsers", "nested": [], "union": false}, "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = False"}, {"name": "pause_on_failure", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pause_on_failure: bool = True"}, {"name": "bypassCSP", "type": null, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bypassCSP=True"}], "returnType": null, "doc": "<p>Opens a new browser instance. Use this keyword for quick experiments or debugging sessions.</p>\n<p>Use <a href=\"#New%20Page\" class=\"name\">New Page</a> directly instead of <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> for production and automated execution. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<p>Creates a new browser, context and page with specified settings.</p>\n<table border=\"1\">\n<tr>\n<th>Argument</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Navigates to URL if provided. Defaults to None.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>Specifies which browser to use. The supported browsers are listed in the table below.</td>\n</tr>\n<tr>\n<td><code>headless</code></td>\n<td>If set to False, a GUI is provided otherwise it is hidden. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>pause_on_failure</code></td>\n<td>Stop execution when failure detected and leave browser open. Defaults to True.</td>\n</tr>\n<tr>\n<td><code>bypassCSP</code></td>\n<td>Defaults to bypassing CSP and enabling custom script attach to the page.</td>\n</tr>\n</table>\n<p>Browsers:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td><a href=\"https://www.mozilla.org/en-US/firefox/new\">Firefox</a></td>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td><a href=\"https://www.chromium.org/Home\">Chromium</a></td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td><a href=\"https://webkit.org/\">webkit</a></td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4310\">Comment &gt;&gt;</a></p>", "shortdoc": "Opens a new browser instance. Use this keyword for quick experiments or debugging sessions.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 76}, {"name": "Press Keys", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "keys", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "returnType": null, "doc": "<p>Types the given key combination into element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*keys</code></td>\n<td>Keys to be press after each other. Using + to chain combine modifiers with a single keypress <code>Control+Shift+T</code> is supported.</td>\n</tr>\n</table>\n<p>Supports values like \"a, b\" which will be automatically typed.</p>\n<p>Also supports identifiers for keys like <code>ArrowLeft</code> or <code>Backspace</code>.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See playwright's documentation for a more comprehensive list of supported input keys. <a href=\"https://playwright.dev/docs/api/class-page#page-press\">Playwright docs for press.</a></p>\n<p>Example:</p>\n<pre>\n# Keyword         Selector                    *Keys\n<a href=\"#Press%20Keys\" class=\"name\">Press Keys</a>      //*[@id=\"username_field\"]    h    e   l   o   ArrowLeft   l\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4311\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given key combination into element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 255}, {"name": "Promise To", "args": [{"name": "kw", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kw: str"}, {"name": "args", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "returnType": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Wrap a Browser library keyword and make it a promise.</p>\n<p>Promised keyword is executed and started on background. Test execution continues without waiting for <code>kw</code> to finish.</p>\n<p>Returns reference to the promised keyword.</p>\n<p><code>kw</code> Keyword that will work async on background.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>kw</code></td>\n<td>Keyword that will work async on background.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>Keyword arguments as normally used.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${promise}=     <a href=\"#Promise%20To\" class=\"name\">Promise To</a>            Wait For Response     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>           \\#delayed_request\n${body}=        <a href=\"#Wait%20For\" class=\"name\">Wait For</a>              ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4312\">Comment &gt;&gt;</a></p>", "shortdoc": "Wrap a Browser library keyword and make it a promise.", "tags": ["Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 39}, {"name": "Promise To Upload File", "args": [{"name": "path", "type": {"name": "PathLike", "typedoc": "Path", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "returnType": null, "doc": "<p>Returns a promise that resolves when file from <code>path</code> has been uploaded.</p>\n<p>Fails if the upload has not happened during timeout.</p>\n<p>Upload file from <code>path</code> into next file chooser dialog on page.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Path to file to be uploaded.</td>\n</tr>\n</table>\n<p>Example use:</p>\n<pre>\n${promise}=    <a href=\"#Promise%20To%20Upload%20File\" class=\"name\">Promise To Upload File</a>    ${CURDIR}/test_upload_file.txt\n<a href=\"#Click\" class=\"name\">Click</a>          id=open_file_chooser_button\n${upload_result}=    <a href=\"#Wait%20For\" class=\"name\">Wait For</a>    ${promise}\n</pre>\n<p>Alternatively, you can use <a href=\"#Upload%20File%20By%20Selector\" class=\"name\">Upload File By Selector</a> keyword.</p>\n<p><a href=\"https://forum.robotframework.org/t//4313\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise that resolves when file from ``path`` has been uploaded.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 268}, {"name": "Promise To Wait For Download", "args": [{"name": "saveAs", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}, {"name": "wait_for_finished", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_for_finished: bool = True"}, {"name": "download_timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "download_timeout: timedelta | None = None"}], "returnType": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Returns a promise that waits for next download event on page.</p>\n<p>To enable downloads context's <code>acceptDownloads</code> needs to be true.</p>\n<p>With default filepath downloaded files are deleted when Context the download happened in is closed.</p>\n<p>If browser is connected remotely with <a href=\"#Connect%20To%20Browser\" class=\"name\">Connect To Browser</a> then <code>saveAs</code> must be set to store it locally where the browser runs!</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>Defines path where the file is saved persistently. File will also temporarily be saved in playwright context's default download location. If empty, generated unique path (GUID) is used and file is deleted when the context is closed.</td>\n</tr>\n<tr>\n<td><code>wait_for_finished</code></td>\n<td>If true, promise will wait for download to finish. If false, promise will resolve immediately after download has started.</td>\n</tr>\n<tr>\n<td><code>download_timeout</code></td>\n<td>Maximum time to wait for download to finish, if <code>wait_for_finished</code> is set to <code>True</code>. If download is not finished during this time, keyword will be fail.</td>\n</tr>\n</table>\n<p>Keyword returns dictionary of type <a href=\"#type-DownloadInfo\" class=\"name\">DownloadInfo</a> which contains downloaded file path and suggested filename as well as state and downloadID. Example:</p>\n<pre>\n{\n  \"saveAs\": \"/tmp/robotframework-browser/downloads/2f1b3b7c-1b1b-4b1b-9b1b-1b1b1b1b1b1b\",\n  \"suggestedFilename\": \"downloaded_file.txt\"\n}\n</pre>\n<p>The keyword <a href=\"#New%20Browser\" class=\"name\">New Browser</a> has a <code>downloadsPath</code> setting which can be used to set the default download directory. If <span class=\"name\">saveAs</span> is set to a relative path, the file will be saved relative to the browser's <code>downloadsPath</code> setting or if that is not set, relative to the Playwright's working directory. If <code>saveAs</code> is set to an absolute path, the file will be saved to that absolute path independent of <code>downloadsPath</code>.</p>\n<p>If the URL for the file to download shall be used, <a href=\"#Download\" class=\"name\">Download</a> keyword may be a simpler alternative way to download the file.</p>\n<p>Waited promise returns a dictionary which contains saveAs and suggestedFilename as keys. The saveAs contains where the file is downloaded and suggestedFilename contains the name suggested name for the download. The suggestedFilename is typically computed by the browser from the Content-Disposition response header or the download attribute. See the spec on <a href=\"https://html.spec.whatwg.org/#downloading-resources\">whatwg</a>. Different browsers can use different logic for computing it.</p>\n<p>Example usage:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>            acceptDownloads=True\n<a href=\"#New%20Page\" class=\"name\">New Page</a>               ${LOGIN_URL}\n${dl_promise}          <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a>    /path/to/download/file.name\n<a href=\"#Click\" class=\"name\">Click</a>                  id=file_download\n${file_obj}=           <a href=\"#Wait%20For\" class=\"name\">Wait For</a>    ${dl_promise}\nFile Should Exist      ${file_obj}[saveAs]\nShould Be True         ${file_obj.suggestedFilename}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4314\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise that waits for next download event on page.", "tags": ["BrowserControl", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 140}, {"name": "Record Selector", "args": [{"name": "label", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label: str | None = None"}], "returnType": null, "doc": "<p>Record the selector that is under mouse.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>label</code></td>\n<td>text to show when on the box in the page while recording.</td>\n</tr>\n</table>\n<p>Focus on the page and move mouse over the element you want to select.</p>\n<p>Example:</p>\n<pre>\n${selector} =    <a href=\"#Record%20Selector\" class=\"name\">Record Selector</a>   Button\n<a href=\"#Click\" class=\"name\">Click</a>  ${selector}\n${selector2} =    <a href=\"#Record%20Selector\" class=\"name\">Record Selector</a>  Page header\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>  ${selector2}  ==  Expected text\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4315\">Comment &gt;&gt;</a></p>", "shortdoc": "Record the selector that is under mouse.", "tags": ["PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 450}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}, {"name": "args", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args: str"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Global", "kind": "NAMED_ONLY", "required": false, "repr": "scope: Scope = Global"}], "returnType": {"name": "DelayedKeyword", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Sets the keyword to execute, when a Browser keyword fails.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>keyword</code></td>\n<td>The name of a keyword that will be executed if a Browser keyword fails. It is possible to use any available keyword, including user keywords or keywords from other libraries.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>The arguments to the keyword if any.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of this setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <span class=\"name\">Scope Settings</span> for more details.</td>\n</tr>\n</table>\n<p>The initial keyword to use is set when <a href=\"#Importing\" class=\"name\">importing</a> the library, and the keyword that is used by default is <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.</p>\n<p>It is possible to use string <code>NONE</code> or any other robot falsy name, case-insensitively, as well as Python <code>None</code> to disable this feature altogether.</p>\n<p>This keyword returns an object which contains the the previously registered failure keyword. The return value can be always used to restore the original value later. The returned object contains keyword name and the possible arguments used to for the keyword.</p>\n<p>If <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> keyword, without arguments, is register as run on failure keyword, then filename argument default value is not used as screenshot file name. Instead, ${TEST NAME}_FAILURE_SCREENSHOT_{index} is used as file name. If there is need to use the filename argument default value, use robotframework-browser-screenshot-{index} as filename argument value.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    # Uses ${TEST NAME}_FAILURE_SCREENSHOT_{index} as filename\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    robotframework-browser-screenshot-{index}    # Uses robotframework-browser-screenshot-{index} as filename\n${previous kw}=    <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    NONE    # Disables run on failure functionality.\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    ${previous kw}\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    fullPage=True\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    Take Screenshot    failure-{index}    fullPage=True\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4316\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the keyword to execute, when a Browser keyword fails.", "tags": ["Config"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/runonfailure.py", "lineno": 31}, {"name": "Reload", "args": [], "returnType": null, "doc": "<p>Reloads current active page.</p>\n<p><a href=\"https://forum.robotframework.org/t//4317\">Comment &gt;&gt;</a></p>", "shortdoc": "Reloads current active page.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 513}, {"name": "Save Storage State", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Saves the current active context storage state to a file.</p>\n<p>Web apps use cookie-based or token-based authentication, where authenticated state is stored as <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies\">cookies</a> or in <a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Storage\">local storage</a>. Keyword retrieves the storage state from authenticated contexts and save it to disk. Then <a href=\"#New%20Context\" class=\"name\">New Context</a> can be created with prepopulated state.</p>\n<p>Please note state file may contains secrets and should not be shared with people outside of your organisation.</p>\n<p>The file is created in ${OUTPUTDIR}/browser/state folder and file(s) are automatically deleted when new test execution starts. File path is returned by the keyword.</p>\n<p>Example:</p>\n<pre>\nTest Case\n    <a href=\"#New%20Context\" class=\"name\">New context</a>\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"https://login.page.html\">https://login.page.html</a>\n    #  Perform login\n    <a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    id=username    $username\n    <a href=\"#Fill%20Secret\" class=\"name\">Fill Secret</a>    id=password    $password\n    <a href=\"#Click\" class=\"name\">Click</a>    id=button\n    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=header    ==    Something\n    #  Save storage to disk\n    ${state_file} =    <a href=\"#Save%20Storage%20State\" class=\"name\">Save Storage State</a>\n    #  Create new context with saved state\n    <a href=\"#New%20Context\" class=\"name\">New context</a>    storageState=${state_file}\n    <a href=\"#New%20Page\" class=\"name\">New Page</a>    <a href=\"https://login.page.html\">https://login.page.html</a>\n    #  Login is not needed because authentication is read from state file\n    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=header    ==    Something\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4318\">Comment &gt;&gt;</a></p>", "shortdoc": "Saves the current active context storage state to a file.", "tags": ["BrowserControl", "Getter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1493}, {"name": "Scroll By", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "vertical", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "height", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = height"}, {"name": "horizontal", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = 0"}, {"name": "behavior", "type": {"name": "ScrollBehavior", "typedoc": "ScrollBehavior", "nested": [], "union": false}, "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "returnType": null, "doc": "<p>Scrolls an element or the page relative from current position by the given values.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. If the selector is <code>${None}</code> or <code>${Empty}</code> the page itself is scrolled. To ensure an element is in view use <a href=\"#Hover\" class=\"name\">Hover</a> instead. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>vertical</code></td>\n<td>defines how far and in which direction to scroll vertically. It can be a positive or negative number. Positive scrolls down, like <code>50</code>, negative scrolls up, like <code>-50</code>. It can be a percentage value of the absolute scrollable size, like <code>9.95%</code> or negative like <code>-10%</code>. It can be the string <code>height</code> to defining to scroll exactly one visible height down or up with <code>-height</code>. <i>Be aware that some pages do lazy loading and load more content once you scroll down.</i> The percentage of the current scrollable height is used and may change.</td>\n</tr>\n<tr>\n<td><code>horizontal</code></td>\n<td>defines where to scroll horizontally. Works same as vertical but defines positive values for right and negative values for left. <code>width</code> defines to scroll exactly one visible range to the right.</td>\n</tr>\n<tr>\n<td><code>behavior</code></td>\n<td>defines whether the scroll happens directly or it scrolls smoothly.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4319\">Comment &gt;&gt;</a></p>", "shortdoc": "Scrolls an element or the page relative from current position by the given values.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 589}, {"name": "Scroll To", "args": [{"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "vertical", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "top", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = top"}, {"name": "horizontal", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = left"}, {"name": "behavior", "type": {"name": "ScrollBehavior", "typedoc": "ScrollBehavior", "nested": [], "union": false}, "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "returnType": null, "doc": "<p>Scrolls an element or the page to an absolute position based on given coordinates.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the element. If the selector is <code>${None}</code> or <code>${Empty}</code> the page itself is scrolled. To ensure an element is in view use <a href=\"#Hover\" class=\"name\">Hover</a> instead. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>vertical</code></td>\n<td>defines where to scroll vertically. It can be a positive number, like <code>300</code>. It can be a percentage value of the absolute scrollable size, like <code>50%</code>. It can be a string defining that top or the bottom of the scroll area. &lt; <code>top</code></td>\n<td><code>bottom</code> &gt; <i>Be aware that some pages do lazy loading and load more content once you scroll down.</i> Bottom defines the current known bottom coordinate.</td>\n</tr>\n<tr>\n<td><code>horizontal</code></td>\n<td>defines where to scroll horizontally. Works same as vertical but defines &lt; <code>left</code></td>\n<td><code>right</code> &gt; as start and end.</td>\n</tr>\n<tr>\n<td><code>behavior</code></td>\n<td>defines whether the scroll happens directly or it scrolls smoothly.</td>\n<td></td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p><a href=\"https://forum.robotframework.org/t//4320\">Comment &gt;&gt;</a></p>", "shortdoc": "Scrolls an element or the page to an absolute position based on given coordinates.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 552}, {"name": "Scroll To Element", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "returnType": null, "doc": "<p>This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is already visible.</p>\n<p><a href=\"https://forum.robotframework.org/t//4321\">Comment &gt;&gt;</a></p>", "shortdoc": "This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 626}, {"name": "Select Options By", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "type": {"name": "SelectAttribute", "typedoc": "SelectAttribute", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: SelectAttribute"}, {"name": "values", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "doc": "<p>Selects options from select element found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the <code>&lt;select&gt;</code> tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>attribute</code></td>\n<td>Attribute to select options by. Can be <code>value</code>, <code>label</code>, <code>text</code> or <code>index</code>. Where <code>label</code> and <code>text</code> are same.</td>\n</tr>\n<tr>\n<td><code>*values</code></td>\n<td>Values to select.</td>\n</tr>\n</table>\n<p>Returns list of options which keyword was able to select. The type of list item matches to <code>attribute</code> definition. Example if <code>attribute</code> equals to <span class=\"name\">label</span> returned list contains label values. Or in case of <span class=\"name\">index</span> it contains list of selected indexes.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>If no values to select are passed will deselect options in element.</p>\n<p>Example:</p>\n<pre>\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=preferred_channel]    label    Direct mail\nList Should Contain Value    ${selected}    Direct mail\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=interests]    value    males    females    others\nList Should Contain Value    ${selected}    males\nList Should Contain Value    ${selected}    females\nList Should Contain Value    ${selected}    others\nLength Should Be    ${selected}    3\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=possible_channels]    index    0    2\nList Should Contain Value    ${selected}    0\nList Should Contain Value    ${selected}    2\n${selected} =    <a href=\"#Select%20Options%20By\" class=\"name\">Select Options By</a>    select[name=interests]    text     Males    Females\nList Should Contain Value    ${selected}    Males\nList Should Contain Value    ${selected}    Females\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4322\">Comment &gt;&gt;</a></p>", "shortdoc": "Selects options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 693}, {"name": "SessionStorage Clear", "args": [{"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove all saved data from the session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    mykey3    myvalue3\n <a href=\"#SessionStorage%20Clear\" class=\"name\">SessionStorage Clear</a>\n<a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>    mykey3    ==    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4323\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove all saved data from the session storage.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 229}, {"name": "SessionStorage Get Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AssertionOperator", "typedoc": "AssertionOperator", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator | None = None"}, {"name": "assertion_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Any", "typedoc": "Any", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Get saved data from from session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>Named key of the item in the storage.</td>\n</tr>\n<tr>\n<td><code>assertion_operator</code></td>\n<td>Assertion operator to use. See <a href=\"#Assertions\" class=\"name\">Assertions</a> for more information.</td>\n</tr>\n<tr>\n<td><code>assertion_expected</code></td>\n<td>Expected value to compare with.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Custom error message to use.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    key2    value2\n${item} =    <a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>    key1\nShould Be Equal    ${item}    value2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4324\">Comment &gt;&gt;</a></p>", "shortdoc": "Get saved data from from session storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 146}, {"name": "SessionStorage Remove Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Remove saved data with key from the session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the item which shall be deleted.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>       mykey2    myvalue2\n<a href=\"#SessionStorage%20Remove%20Item\" class=\"name\">SessionStorage Remove Item</a>    mykey2\n<a href=\"#SessionStorage%20Get%20Item\" class=\"name\">SessionStorage Get Item</a>       mykey2    ==    ${None}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4325\">Comment &gt;&gt;</a></p>", "shortdoc": "Remove saved data with key from the session storage.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 206}, {"name": "SessionStorage Set Item", "args": [{"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "frame_selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "frame_selector: str | None = None"}], "returnType": null, "doc": "<p>Save data to session storage.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>key</code></td>\n<td>The name of the key under which it should be saved.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>The value which shall be saved as a string.</td>\n</tr>\n<tr>\n<td><code>frame_selector</code></td>\n<td>If this selector points to an element inside an iframe, the SessionStorage of that frame is used. Example: <code>iframe[name=\"test\"] &gt;&gt;&gt; body</code></td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#SessionStorage%20Set%20Item\" class=\"name\">SessionStorage Set Item</a>    key2    value2\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4326\">Comment &gt;&gt;</a></p>", "shortdoc": "Save data to session storage.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 185}, {"name": "Set Assertion Formatters", "args": [{"name": "formatters", "type": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "FormatterKeywords", "typedoc": "FormatterKeywords", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "FormatingRules", "typedoc": "FormatingRules", "nested": [], "union": false}, {"name": "LambdaFunction", "typedoc": "LambdaFunction", "nested": [], "union": false}], "union": true}], "union": false}], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "formatters: Dict[FormatterKeywords, List[FormatingRules | LambdaFunction]]"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}], "union": false}, "doc": "<p>Set keywords formatters for assertions.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>formatters</code></td>\n<td>Dictionary of keywords and formatters, where key is the keyword name where formatters are applied. Dictionary value is a list of formatter which are applied. Formatters for a defined keyword are always overwritten. An empty list will clear all formatters for the keyword. If <code>formatters</code> is empty dictionary, then all formatters are cleared from all keywords.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Defines the lifetime of the formatter, possible values are Global, Suite and Test.</td>\n</tr>\n</table>\n<p>See type documentation of <span class=\"name\">FormatterTypes</span> for more information.</p>\n<p>It is possible to define own formatters as lambda functions.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Set%20Assertion%20Formatters\" class=\"name\">Set Assertion Formatters</a>    {\"Get Text\": [\"strip\", \"normalize spaces\"]}  # This will convert all kind of spaces to single space and removes spaces from start and end of the string.\n<a href=\"#Set%20Assertion%20Formatters\" class=\"name\">Set Assertion Formatters</a>    {\"Get Title\": [\"apply to expected\",\"lambda x: x.replace(' ', '')\"]}  # This will remove all spaces from the string.\n${value} =    <a href=\"#Get%20Text\" class=\"name\">Get Text</a>    //div    ==    ${SPACE}Expected${SPACE * 2}Text\nShould Be Equal    ${value}    Expected Text\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4327\">Comment &gt;&gt;</a></p>", "shortdoc": "Set keywords formatters for assertions.", "tags": ["Config"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/formatter.py", "lineno": 98}, {"name": "Set Browser Timeout", "args": [{"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the timeout used by most input and getter keywords.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout of it is for current playwright context and for new contexts. Supports Robot Framework <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">time format</a> . Returns the previous value of the timeout.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <span class=\"name\">Scope Settings</span> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${old_timeout} =    <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    1m 30 seconds\nClick     //button\n<a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    ${old_timeout}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4328\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the timeout used by most input and getter keywords.", "tags": ["Config", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 316}, {"name": "Set Default Run Before Unload", "args": [{"name": "runBeforeUnload", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "runBeforeUnload: bool"}], "returnType": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "doc": "<p>Set default runBeforeUnload value when <a href=\"#Close%20Page\" class=\"name\">Close Page</a> is called indirectly.</p>\n<p>Close Page is called indirectly when <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html#Automatic%20page%20and%20context%20closing\">automatic page closing</a> is done. The default value is false and this keyword can be used to change value. Returns the old runBeforeUnload value.</p>\n<p><a href=\"https://forum.robotframework.org/t/6203\">Comment &gt;&gt;</a></p>", "shortdoc": "Set default runBeforeUnload value when `Close Page` is called indirectly.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 308}, {"name": "Set Geolocation", "args": [{"name": "latitude", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude: float"}, {"name": "longitude", "type": {"name": "float", "typedoc": "float", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude: float"}, {"name": "accuracy", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "accuracy: float | None = None"}], "returnType": null, "doc": "<p>Updated the correct Context's geolocation.</p>\n<p>Latitude can be between -90 and 90 and longitude can be between -180 and 180. Accuracy of the location must be positive number and defaults to 0. When creating context, grant <code>geolocation</code> permission for pages to read its geolocation.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>latitude</code></td>\n<td>Latitude between -90 and 90.</td>\n</tr>\n<tr>\n<td><code>longitude</code></td>\n<td>Longitude between -180 and 180.</td>\n</tr>\n<tr>\n<td><code>accuracy</code></td>\n<td>Non-negative accuracy value. Defaults to 0.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${permissions} =    Create List    geolocation\n<a href=\"#New%20Context\" class=\"name\">New Context</a>    permissions=${permissions}\n<a href=\"#Set%20Geolocation\" class=\"name\">Set Geolocation</a>    60.173708, 24.982263    3    # Points to Korkeasaari in Helsinki.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4329\">Comment &gt;&gt;</a></p>", "shortdoc": "Updated the correct Context's geolocation.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 482}, {"name": "Set Offline", "args": [{"name": "offline", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "offline: bool = True"}], "returnType": null, "doc": "<p>Toggles current Context's offline emulation.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>offline</code></td>\n<td>Toggles the offline mode. Set to False to switch back to online mode. Defaults to True.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4330\">Comment &gt;&gt;</a></p>", "shortdoc": "Toggles current Context's offline emulation.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 469}, {"name": "Set Retry Assertions For", "args": [{"name": "timeout", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the timeout used in retrying assertions when they fail.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Assertion retry timeout will determine how long Browser library will retry an assertion to be true.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>The other keyword <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser timeout</a> controls how long Playwright will perform waiting in the node side for Elements to fulfill the requirements of the specific keyword.</p>\n<p>Returns the previous value of the assertion retry timeout.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>    10 seconds\n${old} =    <a href=\"#Set%20Retry%20Assertions%20For\" class=\"name\">Set Retry Assertions For</a>    30s\n<a href=\"#Get%20Title\" class=\"name\">Get Title</a>    ==    Login Page\n<a href=\"#Set%20Retry%20Assertions%20For\" class=\"name\">Set Retry Assertions For</a>    ${old}\n</pre>\n<p>Example waits 10 seconds on Playwright to get the page title and library will retry 30 seconds to make sure that title is correct.</p>\n<p><a href=\"https://forum.robotframework.org/t//4331\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the timeout used in retrying assertions when they fail.", "tags": ["Config", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 348}, {"name": "Set Selector Prefix", "args": [{"name": "prefix", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "prefix: str | None"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the prefix for all selectors in the given scope.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>prefix</code></td>\n<td>Prefix for all selectors. Prefix and selector will be separated by a single space. Use <code>${None}</code> or <code>${EMPTY}</code> to disable the prefix.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Returns the previous value of the prefix.</p>\n<p>Example:</p>\n<pre>\n${old} =    <a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>    iframe#embedded_page &gt;&gt;&gt;\n<a href=\"#Click\" class=\"name\">Click</a>    button#login_btn       # Clicks on button inside iframe with the selector <code>iframe#embedded_page &gt;&gt;&gt; button#login_btn</code>\n<a href=\"#Set%20Selector%20Prefix\" class=\"name\">Set Selector Prefix</a>    ${old}\n</pre>\n<p>Example will click on button with id <code>login_btn</code> inside iframe with id <code>embedded_page</code>. The resulting selector will be <code>iframe#embedded_page &gt;&gt;&gt; button#login_btn</code>.</p>\n<p>The effect of this prefix can be disable by prefixing any selector with <code>!prefix </code>, with a trailing space, for single keyword calls. i.e. <code>!prefix id=btn_outside_a_frame</code></p>\n<p><a href=\"#Get%20Element\" class=\"name\">Get Element</a>, <a href=\"#Get%20Elements\" class=\"name\">Get Elements</a>, <a href=\"#Get%20Element%20By\" class=\"name\">Get Element By</a> and <a href=\"#Get%20Element%20By%20Role\" class=\"name\">Get Element By Role</a> do automatically prefix the returned selector with <code>!prefix </code> so that it is possible to use them directly without setting the prefix to <code>${None}</code> before usage.</p>\n<p><a href=\"https://forum.robotframework.org/t//4741\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets the prefix for all selectors in the given scope.", "tags": ["Config", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 379}, {"name": "Set Strict Mode", "args": [{"name": "mode", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "mode: bool"}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": null, "doc": "<p>Controls library strict mode.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>mode</code></td>\n<td>When set to <code>True</code>, keywords that are searching elements will use Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-query-selector\">strict mode</a>. Keyword changes library strict mode value and keyword also return the previous strict mode value.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${old_mode} =      Set Strict Mode    False\nGet Text           //input            # Does not fail if selector points to one or more elements\nSet Strict Mode    ${old_mode}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4332\">Comment &gt;&gt;</a></p>", "shortdoc": "Controls library strict mode.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/strict_mode.py", "lineno": 20}, {"name": "Set Viewport Size", "args": [{"name": "width", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}], "returnType": null, "doc": "<p>Sets current Pages viewport size to specified dimensions.</p>\n<p>In the case of multiple pages in a single browser, each page can have its own viewport size. However, <a href=\"#New%20Context\" class=\"name\">New Context</a> allows to set viewport size (and more) for all later opened pages in the context at once.</p>\n<p><a href=\"#Set%20Viewport%20Size\" class=\"name\">Set Viewport Size</a> will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport size before navigating to the page with <a href=\"#New%20Context\" class=\"name\">New Context</a> before opening the page itself.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>Sets the width size.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>Sets the height size.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4333\">Comment &gt;&gt;</a></p>", "shortdoc": "Sets current Pages viewport size to specified dimensions.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 443}, {"name": "Show Keyword Banner", "args": [{"name": "show", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "show: bool = True"}, {"name": "style", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = "}, {"name": "scope", "type": {"name": "Scope", "typedoc": "Scope", "nested": [], "union": false}, "defaultValue": "Suite", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scope: Scope = Suite"}], "returnType": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}], "union": false}, "doc": "<p>Controls if the keyword banner is shown on page or not.</p>\n<p>Keyword call banner is a css overlay that shows the currently executed keyword directly on page. This is useful for debugging and for showing the test execution on video recordings. By default, the banner is not shown on page except when running in presenter mode.</p>\n<p>The banner can be controlled by an import setting of Browser library. (see <a href=\"#Importing\" class=\"name\">Importing</a> section)</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>show</code></td>\n<td>If <span class=\"name\">True</span> banner is shown on page. If <span class=\"name\">False</span> banner is not shown on page. If <a href=\"#type-None\" class=\"name\">None</a> banner is shown on page only when running in presenter mode.</td>\n</tr>\n<tr>\n<td><code>style</code></td>\n<td>Additional css styles to be applied to the banner. These styles are css settings and may override the existing ones for the banner.</td>\n</tr>\n<tr>\n<td><code>scope</code></td>\n<td>Scope defines the live time of that setting. Available values are <code>Global</code>, <code>Suite</code> or <code>Test</code> / <code>Task</code>. See <a href=\"#type-Scope\" class=\"name\">Scope</a> for more details.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nShow Keyword Banner     True    top: 5px; bottom: auto; left: 5px; background-color: #00909077; font-size: 9px; color: black;   # Show banner on top left corner with custom styles\nShow Keyword Banner     False   # Hide banner\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4716\">Comment &gt;&gt;</a></p>", "shortdoc": "Controls if the keyword banner is shown on page or not.", "tags": ["Config", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 412}, {"name": "Switch Browser", "args": [{"name": "id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the currently active Browser to another open Browser.</p>\n<p>Returns a stable identifier for the previous browser. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Browser and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>id</td>\n<td>The id of the browser to switch to. Example: <code>browser=96207191-8147-44e7-b9ac-5e04f2709c1d</code>. A browser id is returned by <a href=\"#New%20Browser\" class=\"name\">New Browser</a> when it is started or can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>.</td>\n</tr>\n</table>\n<p><a href=\"https://forum.robotframework.org/t//4334\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the currently active Browser to another open Browser.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1181}, {"name": "Switch Context", "args": [{"name": "id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the active BrowserContext to another open context.</p>\n<p>Returns a stable identifier for the previous context. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Context and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The id of the context to switch to. Example: <code>context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089</code>. A context id is returned by <a href=\"#New%20Context\" class=\"name\">New Context</a> when it is started or can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser in which to search for that context. <code>CURRENT</code> for the currently active browser, <code>ALL</code> to search in all open browsers or the id of the browser where to switch context.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${first_context} =     <a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#New%20Page\" class=\"name\">New Page</a>             ${URL1}\n${second_context} =    <a href=\"#New%20Context\" class=\"name\">New Context</a>\n<a href=\"#New%20Page\" class=\"name\">New Page</a>             ${URL2}\n<a href=\"#Switch%20Context\" class=\"name\">Switch Context</a>       ${first_context}    # Switches back to first context and page.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4335\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the active BrowserContext to another open context.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1199}, {"name": "Switch Page", "args": [{"name": "id", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "NewPageDetails", "typedoc": "NewPageDetails", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: NewPageDetails | str"}, {"name": "context", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType | str = CURRENT"}, {"name": "browser", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "SelectionType", "typedoc": "SelectionType", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType | str = CURRENT"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Switches the active browser page to another open page by <code>id</code> or <code>NEW</code>.</p>\n<p>Returns a stable identifier <code>id</code> for the previous page. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about Page and related concepts.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The id or alias of the page to switch to. Example: <code>page=8baf2991-5eaf-444d-a318-8045f914e96a</code> or <code>NEW</code>. Can be a string or a dictionary returned by <a href=\"#New%20Page\" class=\"name\">New Page</a> Keyword. A page id can be fetched from the browser catalog when returned by <a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a>. <code>NEW</code> can be used to switch to a pop-up that just has been opened by the webpage, <code>CURRENT</code> can be used to switch to the active page of a different context or browser, identified by their id.</td>\n</tr>\n<tr>\n<td><code>context</code></td>\n<td>The context in which to search for that page. <code>CURRENT</code> for the currently active context, <code>ALL</code> to search in all open contexts or the id of the context where to switch page.</td>\n</tr>\n<tr>\n<td><code>browser</code></td>\n<td>The browser in which to search for that page. <code>CURRENT</code> for the currently active browser, <code>ALL</code> to search in all open browsers or the id of the browser where to switch page.</td>\n</tr>\n</table>\n<p><code>New</code> may timeout if no new pages exists before library timeout.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>           button#pops_up    # Open new page\n${previous} =    <a href=\"#Switch%20Page\" class=\"name\">Switch Page</a>      NEW\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4336\">Comment &gt;&gt;</a></p>", "shortdoc": "Switches the active browser page to another open page by ``id`` or ``NEW``.", "tags": ["BrowserControl", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 1255}, {"name": "Take Screenshot", "args": [{"name": "filename", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "robotframework-browser-screenshot-{index}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str | None = robotframework-browser-screenshot-{index}"}, {"name": "selector", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str | None = None"}, {"name": "", "type": null, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "crop", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "BoundingBox", "typedoc": "BoundingBox", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "crop: BoundingBox | None = None"}, {"name": "disableAnimations", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "disableAnimations: bool = False"}, {"name": "fileType", "type": {"name": "ScreenshotFileTypes", "typedoc": "ScreenshotFileTypes", "nested": [], "union": false}, "defaultValue": "png", "kind": "NAMED_ONLY", "required": false, "repr": "fileType: ScreenshotFileTypes = png"}, {"name": "fullPage", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "fullPage: bool = False"}, {"name": "log_screenshot", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "NAMED_ONLY", "required": false, "repr": "log_screenshot: bool = True"}, {"name": "mask", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "NAMED_ONLY", "required": false, "repr": "mask: List[str] | str = "}, {"name": "maskColor", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "maskColor: str | None = None"}, {"name": "omitBackground", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "omitBackground: bool = False"}, {"name": "quality", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "quality: int | None = None"}, {"name": "scale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Scale", "typedoc": "Scale", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "scale: Scale | None = None"}, {"name": "return_as", "type": {"name": "ScreenshotReturnType", "typedoc": "ScreenshotReturnType", "nested": [], "union": false}, "defaultValue": "path_string", "kind": "NAMED_ONLY", "required": false, "repr": "return_as: ScreenshotReturnType = path_string"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "bytes", "typedoc": "bytes", "nested": [], "union": false}, {"name": "Path", "typedoc": "Path", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "doc": "<p>Takes a screenshot of the current window or element and saves it to disk.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>filename</code></td>\n<td>Filename into which to save. The file will be saved into the robot framework  ${OUTPUTDIR}/browser/screenshot directory by default, but it can be overwritten by providing custom path or filename. String <code>{index}</code> in filename will be replaced with a rolling  number. Use this to not override filenames. If filename equals to EMBED (case insensitive) or ${NONE},  then screenshot is embedded as Base64 image to the log.html. The image is saved temporally  to the disk and warning is displayed if removing the temporary file fails. The ${OUTPUTDIR}/browser/ is removed at the first suite startup.</td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Take a screenshot of the element matched by selector. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors. If not provided take a screenshot of current viewport.</td>\n</tr>\n<tr>\n<td><code>crop</code></td>\n<td>Crops the taken screenshot to the given box. It takes same dictionary as returned from <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>. Cropping only works on page screenshot, so if no selector is given.</td>\n</tr>\n<tr>\n<td><code>disableAnimations</code></td>\n<td>When set to <code>True</code>, stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:  - finite animations are fast-forwarded to completion, so they'll fire transitionend event.  - infinite animations are canceled to initial state, and then played over after the screenshot.</td>\n</tr>\n<tr>\n<td><code>fileType</code></td>\n<td><code>png</code> or <code>jpeg</code> Specify screenshot type, defaults to <code>png</code> .</td>\n</tr>\n<tr>\n<td><code>fullPage</code></td>\n<td>When True, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to False.</td>\n</tr>\n<tr>\n<td><code>log_screenshot</code></td>\n<td>When set to <code>False</code> the screenshot is taken but not logged into log.html.</td>\n</tr>\n<tr>\n<td><code>mask</code></td>\n<td>Specify selectors that should be masked when the screenshot is taken. Masked elements will be overlayed with a pink box <code>#FF00FF</code> that completely covers its bounding box. Argument can take a single selector string or a list of selector strings if multiple different elements should be masked.</td>\n</tr>\n<tr>\n<td><code>maskColor</code></td>\n<td>Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink #FF00FF.</td>\n</tr>\n<tr>\n<td><code>omitBackground</code></td>\n<td>Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images.</td>\n</tr>\n<tr>\n<td><code>quality</code></td>\n<td>The quality of the image, between 0-100. Not applicable to png images.</td>\n</tr>\n<tr>\n<td><code>scale</code></td>\n<td><code>css</code> or <code>device</code>. <code>css</code> will reduce the image size and <code>device</code> keeps image in original size. Defaults to <code>device</code>.</td>\n</tr>\n<tr>\n<td><code>return_as</code></td>\n<td>Defines what this keyword returns. Possible values are documented in <a href=\"#type-ScreenshotReturnType\" class=\"name\">ScreenshotReturnType</a>. It can be either a path to the screenshot file as string or Path object, or the image data as bytes or base64 encoded string.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Maximum time how long taking screenshot can last, defaults to library timeout. Supports Robot Framework time format, like 10s or 1 min, pass 0 to disable timeout. The default value can be changed by using the <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a> keyword.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode if selector is defined. See <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>                                 # Takes screenshot from page with default filename\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   selector=id=username_field    # Captures element in image\n# Takes screenshot with jpeg extension, defines image quality and timeout how long taking screenhost should last\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   fullPage=True    fileType=jpeg    quality=50    timeout=10s\n<a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a>   EMBED                         # Screenshot is embedded as Base64 image to the log.html.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4337\">Comment &gt;&gt;</a></p>", "shortdoc": "Takes a screenshot of the current window or element and saves it to disk.", "tags": ["PageContent"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 123}, {"name": "Tap", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "modifiers", "type": {"name": "KeyboardModifier", "typedoc": "KeyboardModifier", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "position_x", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_x: int | None = None"}, {"name": "position_y", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "position_y: int | None = None"}, {"name": "trial", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "NAMED_ONLY", "required": false, "repr": "trial: bool = False"}], "returnType": null, "doc": "<p>Simulates tap on the element found by <code>selector</code>.</p>\n<p>Requires that the <code>hasTouch</code> option of the <a href=\"#New%20Context\" class=\"name\">New Context</a> be set to true. This method taps the element by performing the following steps:</p>\n<ul>\n<li>Wait for actionability checks on the element, unless force option is set.</li>\n<li>Scroll the element into view if needed.</li>\n<li>Use page.touchscreen to tap the center of the element, or the specified position.</li>\n<li>Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>*modifiers</code></td>\n<td>Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used. Modifiers can be specified in any order, and multiple modifiers can be specified. Valid modifier keys are <code>Control</code>, <code>Alt</code>, <code>Shift</code> and <code>Meta</code>.</td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Whether to bypass the actionability checks. Defaults to false.</td>\n</tr>\n<tr>\n<td><code>noWaitAfter</code></td>\n<td>Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to <code>False</code>.</td>\n</tr>\n<tr>\n<td><code>position_x</code> <code>position_y</code></td>\n<td>A point to click relative to the top-left corner of element bounding-box. Only positive values within the bounding-box are allowed. If not specified, clicks to some visible point of the element.</td>\n</tr>\n<tr>\n<td><code>trial</code></td>\n<td>When set, this method only performs the actionability checks and skips the action. Defaults to <code>False</code>.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\nNew Context    hasTouch=${False}\nNew Page    ${URL}\nTap    css=input#login_button\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5939\">Comment &gt;&gt;</a></p>", "shortdoc": "Simulates tap on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 394}, {"name": "Type Secret", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "delay", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given secret from <code>variable_name</code> into the text field found by <code>selector</code>.</p>\n<p>This keyword does not log secret in Robot Framework logs, if keyword resolves the variable value internally. If <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>secret</code></td>\n<td>Environment variable name with % prefix or a local variable with $ prefix that has the secret text value. Variable names can be used with and without curly braces.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay between the single key strokes. It may be either a number or a Robot Framework time string. Time strings are fully explained in an appendix of Robot Framework User Guide. Defaults to <code>0 ms</code>. Example: <code>50 ms</code></td>\n</tr>\n<tr>\n<td><code>clear</code></td>\n<td>Set to false, if the field shall not be cleared before typing. Defaults to true.</td>\n</tr>\n</table>\n<p>This keyword does not log secret in Robot Framework logs, when keyword resolves the <code>secret</code> variable internally. When <code>secret</code> variable is prefixed with <span class=\"name\">$</span>, without the curly braces, library will resolve the corresponding Robot Framework variable.</p>\n<p>If <code>secret</code> variable is prefixed with <span class=\"name\">%</span>, library will resolve corresponding environment variable. Example <span class=\"name\">$Password</span>` will resolve to <code>${Password}</code> Robot Framework variable. Also <code>%ENV_PWD</code> will resolve to <code>%{ENV_PWD}</code> environment variable.</p>\n<p><b>Using normal Robot Framework variables like <code>${password}</code> will not work!</b></p>\n<p><b>Normal plain text will not work.</b> If you want to use plain text, use <a href=\"#Type%20Text\" class=\"name\">Type Text</a> keyword instead.</p>\n<p>This keyword will also work with a give cryptographic cipher text, that has been encrypted by Crypto library. See <a href=\"https://github.com/Snooz82/robotframework-crypto\">Crypto Library</a> for more details.</p>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for details.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    $username      # Keyword resolves ${username} variable value from Robot Framework variables\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    %username      # Keyword resolves $USERNAME/%USERNAME% variable value from environment variables\n<a href=\"#Type%20Secret\" class=\"name\">Type Secret</a>    input#username_field    ${username}    # Robot Framework resolves the variable value, but secrect can leak to Robot framework output files.\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4338\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 133}, {"name": "Type Text", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "delay", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given <code>txt</code> into the text field found by <code>selector</code>.</p>\n<p>Sends a <code>keydown</code>, <code>keypress/input</code>, and <code>keyup</code> event for each character in the text.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>txt</code></td>\n<td>Text for the text field.</td>\n</tr>\n<tr>\n<td><code>delay</code></td>\n<td>Delay between the single key strokes. It may be either a number or a Robot Framework time string. Time strings are fully explained in an appendix of Robot Framework User Guide. Defaults to <code>0 ms</code>. Example: <code>50 ms</code></td>\n</tr>\n<tr>\n<td><code>clear</code></td>\n<td>Set to false, if the field shall not be cleared before typing. Defaults to true.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for direct filling of the full text at once.</p>\n<p>Example</p>\n<pre>\n<a href=\"#Type%20Text\" class=\"name\">Type Text</a>    input#username_field    user\n<a href=\"#Type%20Text\" class=\"name\">Type Text</a>    input#username_field    user    delay=10 ms    clear=No\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4339\">Comment &gt;&gt;</a></p>", "shortdoc": "Types the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 47}, {"name": "Uncheck Checkbox", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "force", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}], "returnType": null, "doc": "<p>Unchecks the checkbox found by <code>selector</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n<td></td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>force</code></td>\n<td>Set to True to skip Playwright's [<a href=\"https://playwright.dev/docs/actionability\">https://playwright.dev/docs/actionability</a></td>\n<td>Actionability checks].</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Does nothing if the element is not checked/selected.</p>\n<p><a href=\"https://forum.robotframework.org/t//4340\">Comment &gt;&gt;</a></p>", "shortdoc": "Unchecks the checkbox found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 670}, {"name": "Upload File By Selector", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "path", "type": {"name": "PathLike", "typedoc": "Path", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "returnType": null, "doc": "<p>Uploads file from <a href=\"#type-Path\" class=\"name\">path</a> to file input element matched by selector.</p>\n<p>Fails if upload is not done before library timeout. Therefor it may be necessary to increase the timeout with <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Identifies the file input element.</td>\n</tr>\n<tr>\n<td><code>path</code></td>\n<td>Path to the file to be uploaded.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Upload%20File%20By%20Selector\" class=\"name\">Upload File By Selector</a>    //input[@type='file']    big_file.zip\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4341\">Comment &gt;&gt;</a></p>", "shortdoc": "Uploads file from `path` to file input element matched by selector.", "tags": ["PageContent", "Setter"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 1259}, {"name": "Wait For", "args": [{"name": "promises", "type": {"name": "Future", "typedoc": null, "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*promises: Future"}], "returnType": null, "doc": "<p>Waits for promises to finish and returns results from them.</p>\n<p>Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.</p>\n<p>See <a href=\"#Promise%20To\" class=\"name\">Promise To</a> for more information about promises.</p>\n<p>For general waiting of elements please see <a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>promises</code></td>\n<td>Promises to wait for.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n${promise}=    <a href=\"#Promise%20To\" class=\"name\">Promise To</a>            <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>         \\#delayed_request\n${body}=       <a href=\"#Wait%20For\" class=\"name\">Wait For</a>              ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4342\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for promises to finish and returns results from them.", "tags": ["Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 227}, {"name": "Wait For Alert", "args": [{"name": "action", "type": {"name": "DialogAction", "typedoc": "DialogAction", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}, {"name": "text", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text: str | None = None"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Returns a promise to wait for next dialog on page, handles it with <code>action</code> and optionally verifies the dialogs text.</p>\n<p>Dialog/alert can be any of alert, beforeunload, confirm or prompt.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>action</code></td>\n<td>How to handle the alert. Can be <code>accept</code> or <code>dismiss</code>.</td>\n</tr>\n<tr>\n<td><code>prompt_input</code></td>\n<td>The value to enter into prompt. Only valid if <code>action</code> argument equals <code>accept</code>. Defaults to empty string.</td>\n</tr>\n<tr>\n<td><code>text</code></td>\n<td>Optional text to verify the dialogs text.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Optional timeout in Robot Framework time format.</td>\n</tr>\n</table>\n<p>The main difference between this keyword and <a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a> is that <a href=\"#Handle%20Future%20Dialogs\" class=\"name\">Handle Future Dialogs</a> keyword is automatically set as promise. But this keyword must be called as argument to <a href=\"#Promise%20To\" class=\"name\">Promise To</a> keyword. Also this keyword can optionally verify the dialogue text and return it. If <code>text</code> is argument <code>None</code> or is not set, dialogue text is not verified.</p>\n<p>Example with returning text:</p>\n<pre>\n${promise} =         <a href=\"#Promise%20To\" class=\"name\">Promise To</a>    <a href=\"#Wait%20For%20Alert\" class=\"name\">Wait For Alert</a>    action=accept\n<a href=\"#Click\" class=\"name\">Click</a>              id=alerts\n${text} =            <a href=\"#Wait%20For\" class=\"name\">Wait For</a>      ${promise}\nShould Be Equal      ${text}         Am an alert\n</pre>\n<p>Example with text verify:</p>\n<pre>\n${promise} =       Promise To    Wait For Alert    action=accept    text=Am an alert\nClick              id=alerts\n${text} =          Wait For      ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4343\">Comment &gt;&gt;</a></p>", "shortdoc": "Returns a promise to wait for next dialog on page, handles it with ``action`` and optionally verifies the dialogs text.", "tags": ["PageContent", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 856}, {"name": "Wait For All Promises", "args": [], "returnType": null, "doc": "<p>Waits for all promises to finish.</p>\n<p>If one promises fails, then this keyword will fail.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Promise%20To\" class=\"name\">Promise To</a>               Wait For Response     matcher=     timeout=3\n<a href=\"#Click\" class=\"name\">Click</a>                    \\#delayed_request\n<a href=\"#Wait%20For%20All%20Promises\" class=\"name\">Wait For All Promises</a>\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4344\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for all promises to finish.", "tags": ["Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 253}, {"name": "Wait For Condition", "args": [{"name": "condition", "type": {"name": "ConditionInputs", "typedoc": "ConditionInputs", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "condition: ConditionInputs"}, {"name": "args", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args: Any"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Waits for a condition, defined with Browser getter keywords to become True.</p>\n<p>This Keyword is basically just a wrapper around our assertion keywords, but with a timeout. It can be used to wait for anything that also can be asserted with our keywords.</p>\n<p>In comparison to Robot Frameworks <span class=\"name\">Wait Until Keywords Succeeds</span> this keyword is more readable and easier to use but is limited to Browser libraries assertion keywords.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>condition</code></td>\n<td>A condition, defined with Browser getter keywords, without the word <code>Get</code>.</td>\n</tr>\n<tr>\n<td><code>*args</code></td>\n<td>Arguments to pass to the condition keyword.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timout to wait for the condition to become True. Uses default timeout of the library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>Overrides the default error message.</td>\n</tr>\n</table>\n<p>The easiest way to use this keyword is first starting with an assertion keyword with assertion like: <a href=\"#Get%20Text\" class=\"name\">Get Text</a></p>\n<p>Start:</p>\n<pre>\n<a href=\"#Get%20Text\" class=\"name\">Get Text</a>    id=status_bar   contains    Done\n</pre>\n<p>Then you replace the word <span class=\"name\">Get</span> with <a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition    </a> and if necessary add the timeout argument.</p>\n<p>End:</p>\n<pre>\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Text    id=status_bar   contains    Done\n</pre>\n<p>Example usage:</p>\n<pre>\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Element States    id=cdk-overlay-0    ==    detached\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Element States     //h1    contains    visible    editable    enabled    timeout=2 s\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Title    should start with    Robot\n<a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a>    Url    should end with    robotframework.org\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//5269\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for a condition, defined with Browser getter keywords to become True.", "tags": ["PageContent", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/waiter.py", "lineno": 231}, {"name": "Wait For Elements State", "args": [{"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "state", "type": {"name": "ElementState", "typedoc": "ElementState", "nested": [], "union": false}, "defaultValue": "visible", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: ElementState = visible"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Waits for the element found by <code>selector</code> to satisfy state option.</p>\n<p>Note that Browser library has <a href=\"#Implicit%20waiting\" class=\"name\">Implicit waiting</a> mechanisms. Depending on the situation you might not need to use <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait for Elements State</a>.</p>\n<p>State options could be either appear/disappear from dom, or become visible/hidden. If at the moment of calling the keyword, the selector already satisfies the condition, the keyword will return immediately.</p>\n<p>If the selector doesn't satisfy the condition within the timeout the keyword will FAIL.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>See <a href=\"#type-ElementState\" class=\"name\">ElementState</a> for explanation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>uses default timeout from library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message. The <code>message</code> argument accepts <span class=\"name\">{selector}</span>, <span class=\"name\">{function}</span>, and <span class=\"name\">{timeout}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options. The <span class=\"name\">{function}</span> formatter is same <code>state</code> argument value.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a>    //h1    visible    timeout=2 s\n<a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a>    //hi    focused    1s\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4345\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for the element found by ``selector`` to satisfy state option.", "tags": ["PageContent", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/waiter.py", "lineno": 39}, {"name": "Wait For Function", "args": [{"name": "function", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: str"}, {"name": "selector", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}, {"name": "polling", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}], "union": true}, "defaultValue": "raf", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "polling: str | timedelta = raf"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>function</code></td>\n<td>A valid javascript function or a javascript function body. For example <code>() =&gt; true</code> and <code>true</code> will behave similarly.</td>\n</tr>\n<tr>\n<td><code>selector</code></td>\n<td>Selector to resolve and pass to the JavaScript function. This will be the first argument the function receives. If given a selector a function is necessary, with an argument to capture the elementhandle. For example <code>(element) =&gt; document.activeElement === element</code> See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</td>\n</tr>\n<tr>\n<td><code>polling</code></td>\n<td>Default polling value of \"raf\" polls in a callback for <code>requestAnimationFrame</code>. Any other value for polling will be parsed as a robot framework time for interval between polls.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Uses default timeout of the library if not set.</td>\n</tr>\n<tr>\n<td><code>message</code></td>\n<td>overrides the default error message. The <code>message</code> argument accepts <span class=\"name\">{selector}</span>, <span class=\"name\">{function}</span>, and <span class=\"name\">{timeout}</span> <a href=\"https://docs.python.org/3/library/stdtypes.html#str.format\">format</a> options.</td>\n</tr>\n</table>\n<p>Keyword uses strict mode, see <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> for more details about strict mode.</p>\n<p>Example usage:</p>\n<pre>\n${promise}      <a href=\"#Promise%20To\" class=\"name\">Promise To</a>      <a href=\"#Wait%20For%20Function\" class=\"name\">Wait For Function</a>    element =&gt; element.style.width==\"100%\"    selector=\\#progress_bar    timeout=4s\n<a href=\"#Click\" class=\"name\">Click</a>         \\#progress_bar\n<a href=\"#Wait%20For\" class=\"name\">Wait For</a>      ${promise}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4346\">Comment &gt;&gt;</a></p>", "shortdoc": "Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.", "tags": ["PageContent", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/waiter.py", "lineno": 155}, {"name": "Wait For Load State", "args": [{"name": "state", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: PageLoadStates = load"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Waits that the page reaches the required load state.</p>\n<p>This resolves when the page reaches a required load state, load by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>State to wait for, defaults to <span class=\"name\">load</span>. Possible values are <span class=\"name\">load|domcontentloaded|networkidle</span></td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses browser timeout if not set.</td>\n</tr>\n</table>\n<p>If the state has been already reached while loading current document, the underlying Playwright will resolve immediately. Can be one of:</p>\n<pre>\n'load' - wait for the load event to be fired.\n'domcontentloaded' - wait for the DOMContentLoaded event to be fired.\n'networkidle' - DISCOURAGED wait until there are no network connections for at least 500 ms.\n</pre>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                         ${URL}\n<a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a>    domcontentloaded    timeout=3s\n</pre>", "shortdoc": "Waits that the page reaches the required load state.", "tags": ["PageContent", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/waiter.py", "lineno": 300}, {"name": "Wait For Navigation", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str | RegExp"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "wait_until", "type": {"name": "PageLoadStates", "typedoc": "PageLoadStates", "nested": [], "union": false}, "defaultValue": "load", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "wait_until: PageLoadStates = load"}], "returnType": null, "doc": "<p>Waits until page has navigated to given <code>url</code>.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>url</code></td>\n<td>Expected navigation target address either the exact match or a JavaScript-like regex wrapped in <code>/</code> symbols.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n<tr>\n<td><code>wait_until</code></td>\n<td>When to consider operation succeeded, defaults to load. Events can be either: <code>domcontentloaded</code> - consider operation to be finished when the DOMContentLoaded event is fired. <code>load</code> - consider operation to be finished when the load event is fired. <code>networkidle</code> - consider operation to be finished when there are no network connections for at least 500 ms. <code>commit</code> - consider operation to be finished when network response is received and the document started loading.</td>\n</tr>\n</table>\n<p>Keyword works only when page is loaded and does not work if URL fragment changes. Example if <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html\">https://marketsquare.github.io/robotframework-browser/Browser.html</a> changes to <a href=\"https://marketsquare.github.io/robotframework-browser/Browser.html#Wait%20For%20Navigation\">https://marketsquare.github.io/robotframework-browser/Browser.html#Wait%20For%20Navigation</a> keyword will fail.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                  ${ROOT_URL}/redirector.html\n<a href=\"#Wait%20For%20Navigation\" class=\"name\">Wait for navigation</a>    ${ROOT_URL}/posted.html    wait_until=${wait_until}\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4347\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits until page has navigated to given ``url``.", "tags": ["HTTP", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 265}, {"name": "Wait For Request", "args": [{"name": "matcher", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str | RegExp = "}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Waits for request matching matcher to be made.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>matcher</code></td>\n<td>Request URL matcher. Can be a string (Glob-Pattern), JavaScript RegExp (encapsulated in / with following flags) or JavaScript arrow-function that receives the <a href=\"https://playwright.dev/docs/api/class-request\">Request</a> object and returns a boolean. By default (with empty string) matches first available request. For additional information, see the Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-wait-for-request\">waitForRequest</a> documentation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n</table>\n<p>See <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a> for more details.</p>\n<p><b>CAUTION:</b> Before Browser library 17.0.0, the <code>matcher</code> argument was always either a regex or JS function. But the regex did not needed to be in slashes. The most simple way to migrate to the new syntax is to add slashes around the matcher. So <code>/api/get/json</code> becomes <code>//api/get/json/</code>.</p>\n<p><a href=\"https://forum.robotframework.org/t//4348\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for request matching matcher to be made.", "tags": ["HTTP", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 129}, {"name": "Wait For Response", "args": [{"name": "matcher", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "RegExp", "typedoc": "RegExp", "nested": [], "union": false}], "union": true}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str | RegExp = "}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "DotDict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": true}, "doc": "<p>Waits for response matching matcher and returns the response as robot dict.</p>\n<p>The response, which is returned by this keyword, is a robot dictionary with following attributes:</p>\n<ul>\n<li><code>status</code> &lt;int&gt; The status code of the response.</li>\n<li><code>statusText</code> &lt;str&gt; Status text corresponding to <code>status</code>, e.g OK or INTERNAL SERVER ERROR. This may not be available for all browser.</li>\n<li><code>body</code> &lt;dict | str&gt; The response body. If the body can be parsed as a JSON object, it will be returned as Python dictionary, otherwise it is returned as a string.</li>\n<li><code>headers</code> &lt;dict&gt; A dictionary containing all response headers.</li>\n<li><code>ok</code> &lt;bool&gt; Whether the request was successful, i.e. the <code>status</code> is range 200-299.</li>\n<li><code>request</code> &lt;dict&gt; containing <code>method</code> &lt;str&gt;, <code>headers</code> &lt;dict&gt; and <code>postData</code> &lt;dict&gt; | &lt;str&gt;</li>\n<li><code>url</code> &lt;str&gt; url of the request.</li>\n</ul>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>matcher</code></td>\n<td>Request URL matcher. Can be a string (Glob-Pattern), JavaScript RegExp (encapsulated in / with following flags) or JavaScript arrow-function that receives the Response object and returns a boolean. By default (with empty string) matches first available request. For additional information, see the Playwright <a href=\"https://playwright.dev/docs/api/class-page#page-wait-for-response\">page.waitForResponse</a> documentation.</td>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses default timeout if not set.</td>\n</tr>\n</table>\n<p><b>CAUTION:</b> Before Browser library 17.0.0, the <code>matcher</code> argument was always either a regex or JS function. But the regex did not needed to be in slashes. The most simple way to migrate to the new syntax is to add slashes around the matcher. So <code>/api/get/json</code> becomes <code>//api/get/json/</code>.</p>\n<h3>Matcher Examples:</h3>\n<h4>Glob-Pattern:</h4>\n<p>Glob-Patterns are strings that can contain wildcards. The following wildcards are supported:</p>\n<p>Possible wildcards/patterns are:</p>\n<ul>\n<li><code>*</code> matches any number of characters, except <code>/</code></li>\n<li><code>**</code> matches any number of characters, including <code>/</code></li>\n<li><code>?</code> matches one character, except <code>/</code></li>\n<li><code>[abc]</code> matches one character in the brackets (in this example <code>a</code>, <code>b</code> or <code>c</code>)</li>\n<li><code>[a-z]</code> matches one character in the range (in this example <code>a</code> to <code>z</code>)</li>\n<li><code>{foo,bar,baz}</code> matches one of the strings in the braces (in this example <code>foo</code>, <code>bar</code> or <code>baz</code>)</li>\n</ul>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    **/api/get/text    # matches any request with url ending with /api/get/text. example: <a href=\"https://browser.fi/api/get/text\">https://browser.fi/api/get/text</a>\n</pre>\n<h4>RegExp:</h4>\n<p>Regular Expressions are JavaScript regular expressions encapsulated in <code>/</code> with optional following flags: Be aware that backslashes need to be escaped in Robot Framework, e.g. <code>\\\\w</code> instead of <code>\\w</code>. See <a href=\"https://regex101.com\">regex101</a> for more information on Regular Expressions.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    /http://\\\\w+:\\\\d+/api/get/text/i    # matches any request with url ending with /api/get/text and containing http:// followed by any word and port. example: <a href=\"http://localhost:8080/api/get/text\">http://localhost:8080/api/get/text</a>\n</pre>\n<h4>JavaScript Arrow-Function:</h4>\n<p>JavaScript Arrow-Functions are anonymous JavaScript functions that receive the <a href=\"https://playwright.dev/docs/api/class-response\">Response</a> object and return a boolean.</p>\n<p>Example:</p>\n<pre>\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    response =&gt; response.url() === '<a href=\"http://localhost/api/post\">http://localhost/api/post</a>' &amp;&amp; response.status() === 200    # matches any response with url <a href=\"http://localhost/api/post\">http://localhost/api/post</a> and status code 200\n</pre>\n<h3>Robot Examples:</h3>\n<p>Synchronous Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>                \\#delayed_request    # Creates response which should be waited before next actions\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    matcher=/http://\\\\w+:\\\\d+/api/get/text/i\n<a href=\"#Click\" class=\"name\">Click</a>                \\#save\n</pre>\n<p>Asynchronous Example:</p>\n<pre>\n${promise} =    <a href=\"#Promise%20To\" class=\"name\">Promise To</a>    <a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>    timeout=60s\n<a href=\"#Click\" class=\"name\">Click</a>           \\#delayed_request    # Creates response which should be waited before pressing save.\n<a href=\"#Click\" class=\"name\">Click</a>           \\#next\n<a href=\"#Wait%20For\" class=\"name\">Wait For</a>        ${promise}            # Waits for the response\n<a href=\"#Click\" class=\"name\">Click</a>           \\#save\n</pre>\n<p>JavaScript Function Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>               \\#delayed_request    # Creates response which should be waited before pressing save.\n<a href=\"#Wait%20For%20Response\" class=\"name\">Wait For Response</a>   <a href=\"https://playwright.dev/docs/api/class-response/\">response</a> =&gt; response.url().endsWith('json') &amp;&amp; response.request().method() === 'GET'\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4349\">Comment &gt;&gt;</a></p>", "shortdoc": "Waits for response matching matcher and returns the response as robot dict.", "tags": ["HTTP", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 155}, {"name": "Wait Until Network Is Idle", "args": [{"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p><b>DEPRECATED!!</b> Use <a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a> instead. rfbrowser transform --wait-until-network-is-idle path/to/test command automatically transforms keyword to new format.</p>\n<p>If you have:</p>\n<pre>\n<a href=\"#Wait%20Until%20Network%20Is%20Idle\" class=\"name\">Wait Until Network Is Idle</a>    timeout=3s\n</pre>\n<p>then chnnage it to:</p>\n<pre>\n<a href=\"#Wait%20For%20Load%20State\" class=\"name\">Wait For Load State</a>    networkidle    timeout=3s\n</pre>\n<p>Waits until there has been at least one instance of 500 ms of no network traffic on the page after loading.</p>\n<p>Doesn't wait for network traffic that wasn't initiated within 500ms of page load.</p>\n<table border=\"1\">\n<tr>\n<th>Arguments</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>timeout</code></td>\n<td>Timeout supports Robot Framework time format. Uses browser timeout if not set.</td>\n</tr>\n</table>\n<p>Example:</p>\n<pre>\n<a href=\"#Go%20To\" class=\"name\">Go To</a>                         ${URL}\n<a href=\"#Wait%20Until%20Network%20Is%20Idle\" class=\"name\">Wait Until Network Is Idle</a>    timeout=3s\n</pre>\n<p><a href=\"https://forum.robotframework.org/t//4350\">Comment &gt;&gt;</a></p>", "shortdoc": "*DEPRECATED!!* Use `Wait For Load State` instead. rfbrowser transform --wait-until-network-is-idle path/to/test command automatically transforms keyword to new format.", "tags": ["HTTP", "Wait"], "source": "/Users/tatuaalto/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 241, "deprecated": true}], "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Evaluate JavaScript", "Get Attribute", "Get BoundingBox", "Get Browser Catalog", "Get Client Size", "Get Console Log", "Get Download State", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Style", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Http", "LocalStorage Get Item", "Select Options By", "SessionStorage Get Item", "Wait For Condition", "Wait For Request", "Wait For Response"], "accepts": ["Any"]}, {"type": "Enum", "name": "AreaFields", "doc": "<p>Enumeration that defines which coordinates of an area should be selected.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "usages": ["Get Scroll Position"], "accepts": ["string"], "members": [{"name": "top", "value": "1"}, {"name": "left", "value": "2"}, {"name": "bottom", "value": "3"}, {"name": "right", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"type": "Enum", "name": "AssertionOperator", "doc": "<p>Currently supported assertion operators are:</p>\n<table border=\"1\">\n<tr>\n<th>Operator</th>\n<th>Alternative Operators</th>\n<th>Description</th>\n<th>Validate Equivalent</th>\n</tr>\n<tr>\n<td><code>==</code></td>\n<td><code>equal</code>, <code>equals</code>, <code>should be</code></td>\n<td>Checks if returned value is equal to expected value.</td>\n<td><code>value == expected</code></td>\n</tr>\n<tr>\n<td><code>!=</code></td>\n<td><code>inequal</code>, <code>should not be</code></td>\n<td>Checks if returned value is not equal to expected value.</td>\n<td><code>value != expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;</code></td>\n<td><code>greater than</code></td>\n<td>Checks if returned value is greater than expected value.</td>\n<td><code>value &gt; expected</code></td>\n</tr>\n<tr>\n<td><code>&gt;=</code></td>\n<td></td>\n<td>Checks if returned value is greater than or equal to expected value.</td>\n<td><code>value &gt;= expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;</code></td>\n<td><code>less than</code></td>\n<td>Checks if returned value is less than expected value.</td>\n<td><code>value &lt; expected</code></td>\n</tr>\n<tr>\n<td><code>&lt;=</code></td>\n<td></td>\n<td>Checks if returned value is less than or equal to expected value.</td>\n<td><code>value &lt;= expected</code></td>\n</tr>\n<tr>\n<td><code>*=</code></td>\n<td><code>contains</code></td>\n<td>Checks if returned value contains expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td></td>\n<td><code>not contains</code></td>\n<td>Checks if returned value does not contain expected value as substring.</td>\n<td><code>expected in value</code></td>\n</tr>\n<tr>\n<td><code>^=</code></td>\n<td><code>should start with</code>, <code>starts</code></td>\n<td>Checks if returned value starts with expected value.</td>\n<td><code>re.search(f\"^{expected}\", value)</code></td>\n</tr>\n<tr>\n<td><code>$=</code></td>\n<td><code>should end with</code>, <code>ends</code></td>\n<td>Checks if returned value ends with expected value.</td>\n<td><code>re.search(f\"{expected}$\", value)</code></td>\n</tr>\n<tr>\n<td><code>matches</code></td>\n<td></td>\n<td>Checks if given RegEx matches minimum once in returned value.</td>\n<td><code>re.search(expected, value)</code></td>\n</tr>\n<tr>\n<td><code>validate</code></td>\n<td></td>\n<td>Checks if given Python expression evaluates to <code>True</code>.</td>\n<td></td>\n</tr>\n<tr>\n<td><code>evaluate</code></td>\n<td><code>then</code></td>\n<td>When using this operator, the keyword does return the evaluated Python expression.</td>\n<td></td>\n</tr>\n</table>\n<p>Currently supported formatters for assertions are:</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Substitutes multiple spaces to single space from the value</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from the beginning and end of the value</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts value to lower case before comparing</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies rules also for the expected value</td>\n</tr>\n</table>\n<p>Formatters are applied to the value before assertion is performed and keywords returns a value where rule is applied. Formatter is only applied to the value which keyword returns and not all rules are valid for all assertion operators. If <code>apply to expected</code> formatter is defined, then formatters are then formatter are also applied to expected value.</p>", "usages": ["Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Download State", "Get Element Count", "Get Element States", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "LocalStorage Get Item", "SessionStorage Get Item"], "accepts": ["string"], "members": [{"name": "equal", "value": "=="}, {"name": "equals", "value": "=="}, {"name": "==", "value": "=="}, {"name": "should be", "value": "=="}, {"name": "inequal", "value": "!="}, {"name": "!=", "value": "!="}, {"name": "should not be", "value": "!="}, {"name": "less than", "value": "<"}, {"name": "<", "value": "<"}, {"name": "greater than", "value": ">"}, {"name": ">", "value": ">"}, {"name": "<=", "value": "<="}, {"name": ">=", "value": ">="}, {"name": "contains", "value": "*="}, {"name": "not contains", "value": "not contains"}, {"name": "*=", "value": "*="}, {"name": "starts", "value": "^="}, {"name": "^=", "value": "^="}, {"name": "should start with", "value": "^="}, {"name": "ends", "value": "$="}, {"name": "should end with", "value": "$="}, {"name": "$=", "value": "$="}, {"name": "matches", "value": "$"}, {"name": "validate", "value": "validate"}, {"name": "then", "value": "then"}, {"name": "evaluate", "value": "then"}]}, {"type": "Enum", "name": "AutoClosingLevel", "doc": "<p>Controls when contexts and pages are closed during the test execution.</p>\n<p>If automatic closing level is <span class=\"name\">TEST</span>, contexts and pages that are created during a single test are automatically closed when the test ends. Contexts and pages that are created during suite setup are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">SUITE</span>, all contexts and pages that are created during the test suite are closed when the suite teardown ends.</p>\n<p>If automatic closing level is <span class=\"name\">MANUAL</span>, nothing is closed automatically while the test execution is ongoing. All browsers, context and pages are automatically closed when test execution ends.</p>\n<p>If automatic closing level is <span class=\"name\">KEEP</span>, nothing is closed automatically while the test execution is ongoing. Also, nothing is closed when test execution ends, including the node process. Therefore, it is users responsibility to close all browsers, context and pages and ensure that all process that are left running after the test execution end are closed. This level is only intended for test case development and must not be used when running tests in CI or similar environments.</p>\n<p>Automatic closing can be configured or switched off with the auto_closing_level library import parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "SUITE", "value": "1"}, {"name": "TEST", "value": "2"}, {"name": "MANUAL", "value": "3"}, {"name": "KEEP", "value": "4"}]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__", "Add Cookie", "Check Checkbox", "Click With Options", "Close Page", "Connect To Browser", "Download", "Evaluate JavaScript", "Fill Secret", "Fill Text", "Get Checkbox State", "Get Console Log", "Get Element By", "Get Element By Role", "Get Page Errors", "Hover", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Open Browser", "Promise To Wait For Download", "Set Default Run Before Unload", "Set Offline", "Set Strict Mode", "Show Keyword Banner", "Take Screenshot", "Tap", "Type Secret", "Type Text", "Uncheck Checkbox"], "accepts": ["string", "integer", "float", "None"]}, {"type": "TypedDict", "name": "BoundingBox", "doc": "<p>Bounding box of an element.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>x</code></td>\n<td>The amount of pixel between the left border of the page and the left border of the element.</td>\n</tr>\n<tr>\n<td><code>y</code></td>\n<td>The amount of pixel between the top border of the page and the top border of the element.</td>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>The width of the element, excluding margins.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>The height of the element, excluding margins.</td>\n</tr>\n</table>", "usages": ["Get BoundingBox", "Take Screenshot"], "accepts": ["string", "Mapping"], "items": [{"key": "x", "type": "float", "required": false}, {"key": "y", "type": "float", "required": false}, {"key": "width", "type": "float", "required": false}, {"key": "height", "type": "float", "required": false}]}, {"type": "Enum", "name": "BoundingBoxFields", "doc": "<p>Enumeration that defines which location information of an element should be selected.</p>\n<p><code>x</code> / <code>y</code> defines the position of the top left corner of an element.</p>\n<p><code>width</code> / <code>height</code> defines the size of an elements bounding box.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "usages": ["Get BoundingBox"], "accepts": ["string"], "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "x", "value": "3"}, {"name": "y", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"type": "TypedDict", "name": "BrowserInfo", "doc": "<p>Dictionary that contains information about a browser instance.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>The browser type. e.g. chromium, firefox or webkit.</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>The unique id of the browser instance.</td>\n</tr>\n<tr>\n<td><code>contexts</code></td>\n<td>List of context information opened by the browser.</td>\n</tr>\n<tr>\n<td><code>activeContext</code></td>\n<td>The id of the active context.</td>\n</tr>\n<tr>\n<td><code>activeBrowser</code></td>\n<td>Boolean if the browser is the currently active browser.</td>\n</tr>\n</table>\n<p>Structure:</p>\n<pre>\n{\n  'type': <span class=\"name\">str</span>,\n  'id': <span class=\"name\">str</span>,\n  'contexts': [\n      {\n          'type': <span class=\"name\">str</span>,\n          'id': <span class=\"name\">str</span>,\n          'activePage': <span class=\"name\">str</span>,\n          'pages': [\n              {\n                  'type': <span class=\"name\">str</span>,\n                  'title': <span class=\"name\">str</span>,\n                  'url': <span class=\"name\">str</span>,\n                  'id': <span class=\"name\">str</span>,\n                  'timestamp': <a href=\"#type-float\" class=\"name\">float</a>\n              },\n              ...\n          ]\n      },\n      ...\n  ],\n  'activeContext': <span class=\"name\">str</span>,\n  'activeBrowser': <span class=\"name\">bool</span>\n}\n</pre>", "usages": ["Get Browser Catalog"], "accepts": ["string", "Mapping"], "items": [{"key": "type", "type": "str", "required": true}, {"key": "id", "type": "str", "required": true}, {"key": "contexts", "type": "typing.List[Browser.utils.data_types.ContextInfo]", "required": true}, {"key": "activeContext", "type": "str", "required": true}, {"key": "activeBrowser", "type": "bool", "required": true}]}, {"type": "Standard", "name": "bytes", "doc": "<p>Strings are converted to bytes so that each Unicode code point below 256 is directly mapped to a matching byte. Higher code points are not allowed. Robot Framework's <code>\\xHH</code> escape syntax is convenient with bytes having non-printable values.</p>\n<p>Examples: <code>good</code>, <code>hyv\u00e4</code> (same as <code>hyv\\xE4</code>), <code>\\x00</code> (the null byte)</p>", "usages": ["Take Screenshot"], "accepts": ["string", "bytearray"]}, {"type": "Enum", "name": "ColorScheme", "doc": "<p>Emulates 'prefers-colors-scheme' media feature.</p>\n<p>See <a href=\"https://playwright.dev/docs/api/class-page?_highlight=emulatemedia#pageemulatemediaparams\">emulateMedia(options)</a> for more details.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "dark", "value": "1"}, {"name": "light", "value": "2"}, {"name": "no-preference", "value": "3"}]}, {"type": "Enum", "name": "ConditionInputs", "doc": "<p>Following values are allowed and represent the assertion keywords to use:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Keyword</th>\n</tr>\n<tr>\n<td><code>Attribute</code></td>\n<td><a href=\"#Get%20Attribute\" class=\"name\">Get Attribute</a></td>\n</tr>\n<tr>\n<td><code>Attribute Names</code></td>\n<td><a href=\"#Get%20Attribute%20Names\" class=\"name\">Get Attribute Names</a></td>\n</tr>\n<tr>\n<td><code>BoundingBox</code></td>\n<td><a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a></td>\n</tr>\n<tr>\n<td><code>Browser Catalog</code></td>\n<td><a href=\"#Get%20Browser%20Catalog\" class=\"name\">Get Browser Catalog</a></td>\n</tr>\n<tr>\n<td><code>Checkbox State</code></td>\n<td><a href=\"#Get%20Checkbox%20State\" class=\"name\">Get Checkbox State</a></td>\n</tr>\n<tr>\n<td><code>Classes</code></td>\n<td><a href=\"#Get%20Classes\" class=\"name\">Get Classes</a></td>\n</tr>\n<tr>\n<td><code>Client Size</code></td>\n<td><a href=\"#Get%20Client%20Size\" class=\"name\">Get Client Size</a></td>\n</tr>\n<tr>\n<td><code>Download State</code></td>\n<td><a href=\"#Get%20Download%20State\" class=\"name\">Get Download State</a></td>\n</tr>\n<tr>\n<td><code>Element Count</code></td>\n<td><a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a></td>\n</tr>\n<tr>\n<td><code>Element States</code></td>\n<td><a href=\"#Get%20Element%20States\" class=\"name\">Get Element States</a></td>\n</tr>\n<tr>\n<td><code>Page Source</code></td>\n<td><a href=\"#Get%20Page%20Source\" class=\"name\">Get Page Source</a></td>\n</tr>\n<tr>\n<td><code>Property</code></td>\n<td><a href=\"#Get%20Property\" class=\"name\">Get Property</a></td>\n</tr>\n<tr>\n<td><code>Scroll Position</code></td>\n<td><a href=\"#Get%20Scroll%20Position\" class=\"name\">Get Scroll Position</a></td>\n</tr>\n<tr>\n<td><code>Scroll Size</code></td>\n<td><a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a></td>\n</tr>\n<tr>\n<td><code>Select Options</code></td>\n<td><a href=\"#Get%20Select%20Options\" class=\"name\">Get Select Options</a></td>\n</tr>\n<tr>\n<td><code>Selected Options</code></td>\n<td><a href=\"#Get%20Selected%20Options\" class=\"name\">Get Selected Options</a></td>\n</tr>\n<tr>\n<td><code>Style</code></td>\n<td><a href=\"#Get%20Style\" class=\"name\">Get Style</a></td>\n</tr>\n<tr>\n<td><code>Table Cell Index</code></td>\n<td><a href=\"#Get%20Table%20Cell%20Index\" class=\"name\">Get Table Cell Index</a></td>\n</tr>\n<tr>\n<td><code>Table Row Index</code></td>\n<td><a href=\"#Get%20Table%20Row%20Index\" class=\"name\">Get Table Row Index</a></td>\n</tr>\n<tr>\n<td><code>Text</code></td>\n<td><a href=\"#Get%20Text\" class=\"name\">Get Text</a></td>\n</tr>\n<tr>\n<td><code>Title</code></td>\n<td><a href=\"#Get%20Title\" class=\"name\">Get Title</a></td>\n</tr>\n<tr>\n<td><code>Url</code></td>\n<td><a href=\"#Get%20Url\" class=\"name\">Get Url</a></td>\n</tr>\n<tr>\n<td><code>Viewport Size</code></td>\n<td><a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a></td>\n</tr>\n</table>", "usages": ["Wait For Condition"], "accepts": ["string"], "members": [{"name": "attribute", "value": "get_attribute"}, {"name": "attribute_names", "value": "get_attribute_names"}, {"name": "bounding_box", "value": "get_bounding_box"}, {"name": "browser_catalog", "value": "get_browser_catalog"}, {"name": "checkbox_state", "value": "get_checkbox_state"}, {"name": "classes", "value": "get_classes"}, {"name": "client_size", "value": "get_client_size"}, {"name": "download_state", "value": "get_download_state"}, {"name": "element_count", "value": "get_element_count"}, {"name": "element_states", "value": "get_element_states"}, {"name": "page_source", "value": "get_page_source"}, {"name": "property", "value": "get_property"}, {"name": "scroll_position", "value": "get_scroll_position"}, {"name": "scroll_size", "value": "get_scroll_size"}, {"name": "select_options", "value": "get_select_options"}, {"name": "selected_options", "value": "get_selected_options"}, {"name": "style", "value": "get_style"}, {"name": "table_cell_index", "value": "get_table_cell_index"}, {"name": "table_row_index", "value": "get_table_row_index"}, {"name": "text", "value": "get_text"}, {"name": "title", "value": "get_title"}, {"name": "url", "value": "get_url"}, {"name": "viewport_size", "value": "get_viewport_size"}]}, {"type": "Enum", "name": "CookieSameSite", "doc": "<p>Enum that defines the Cookie SameSite type.</p>\n<p>It controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).</p>\n<p>The possible attribute values are:</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>Strict</code></td>\n<td>Means that the browser sends the cookie only for same-site requests, that is, requests originating from the same site that set the cookie. If a request originates from a different domain or scheme (even with the same domain), no cookies with the SameSite=Strict attribute are sent.</td>\n</tr>\n<tr>\n<td><code>Lax</code></td>\n<td>Means that the cookie is not sent on cross-site requests, such as on requests to load images or frames, but is sent when a user is navigating to the origin site from an external site (for example, when following a link). This is the default behavior if the SameSite attribute is not specified.</td>\n</tr>\n<tr>\n<td><code>None</code></td>\n<td>means that the browser sends the cookie with both cross-site and same-site requests. The Secure attribute must also be set when setting this value.</td>\n</tr>\n</table>\n<p>See <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie\">MDN Set-Cookie</a> for more information.</p>", "usages": ["Add Cookie"], "accepts": ["string"], "members": [{"name": "Strict", "value": "Strict"}, {"name": "Lax", "value": "Lax"}, {"name": "None", "value": "None"}]}, {"type": "Enum", "name": "CookieType", "doc": "<p>Enum that defines the Cookie type.</p>", "usages": ["Get Cookie", "Get Cookies"], "accepts": ["string"], "members": [{"name": "dictionary", "value": "1"}, {"name": "dict", "value": "1"}, {"name": "string", "value": "2"}, {"name": "str", "value": "2"}]}, {"type": "Enum", "name": "DialogAction", "doc": "<p>Enum that defines how to handle a dialog.</p>", "usages": ["Handle Future Dialogs", "Wait For Alert"], "accepts": ["string"], "members": [{"name": "accept", "value": "1"}, {"name": "dismiss", "value": "2"}]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["__init__", "Get Console Log", "Get Cookie", "Get Cookies", "Get Device", "Get Devices", "Get Page Errors", "Get Style", "Http", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Set Assertion Formatters", "Show Keyword Banner", "Wait For Response"], "accepts": ["string", "Mapping"]}, {"type": "TypedDict", "name": "Dimensions", "doc": "<p>Dimensions of an object in pixels.</p>", "usages": ["Get Client Size", "Get Scroll Size"], "accepts": ["string", "Mapping"], "items": [{"key": "width", "type": "int", "required": true}, {"key": "height", "type": "int", "required": true}]}, {"type": "TypedDict", "name": "DownloadInfo", "doc": "<p>Downloaded file information.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>saveAs</code></td>\n<td>is the path where downloaded file is saved. empty string if the file is not yet fully downloaded.</td>\n</tr>\n<tr>\n<td><code>suggestedFilename</code></td>\n<td>is the suggested filename that was computed from the <code>Content-Disposition</code> response header.</td>\n</tr>\n<tr>\n<td><code>state</code></td>\n<td>is the state of the download. i.e. <code>in_progress</code>, <code>finished</code> or <code>canceled</code>.</td>\n</tr>\n<tr>\n<td><code>downloadID</code></td>\n<td>is the unique id of the download.</td>\n</tr>\n</table>", "usages": ["Cancel Download", "Download", "Get Download State"], "accepts": ["string", "Mapping"], "items": [{"key": "saveAs", "type": "str", "required": true}, {"key": "suggestedFilename", "type": "str", "required": true}, {"key": "state", "type": "str", "required": true}, {"key": "downloadID", "type": "typing.Optional[str]", "required": true}]}, {"type": "Enum", "name": "ElementRole", "doc": "<p>Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.</p>\n<p>Many html elements have an implicitly <a href=\"https://w3c.github.io/html-aam/#html-element-role-mappings\">defined role</a> that is recognized by the role selector. You can find all the <a href=\"https://www.w3.org/TR/wai-aria-1.2/#role_definitions\">supported roles</a> here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.</p>", "usages": ["Get Element By Role"], "accepts": ["string"], "members": [{"name": "ALERT", "value": "1"}, {"name": "ALERTDIALOG", "value": "2"}, {"name": "APPLICATION", "value": "3"}, {"name": "ARTICLE", "value": "4"}, {"name": "BANNER", "value": "5"}, {"name": "BLOCKQUOTE", "value": "6"}, {"name": "BUTTON", "value": "7"}, {"name": "CAPTION", "value": "8"}, {"name": "CELL", "value": "9"}, {"name": "CHECKBOX", "value": "10"}, {"name": "CODE", "value": "11"}, {"name": "COLUMNHEADER", "value": "12"}, {"name": "COMBOBOX", "value": "13"}, {"name": "COMPLEMENTARY", "value": "14"}, {"name": "CONTENTINFO", "value": "15"}, {"name": "DEFINITION", "value": "16"}, {"name": "DELETION", "value": "17"}, {"name": "DIALOG", "value": "18"}, {"name": "DIRECTORY", "value": "19"}, {"name": "DOCUMENT", "value": "20"}, {"name": "EMPHASIS", "value": "21"}, {"name": "FEED", "value": "22"}, {"name": "FIGURE", "value": "23"}, {"name": "FORM", "value": "24"}, {"name": "GENERIC", "value": "25"}, {"name": "GRID", "value": "26"}, {"name": "GRIDCELL", "value": "27"}, {"name": "GROUP", "value": "28"}, {"name": "HEADING", "value": "29"}, {"name": "IMG", "value": "30"}, {"name": "INSERTION", "value": "31"}, {"name": "LINK", "value": "32"}, {"name": "LIST", "value": "33"}, {"name": "LISTBOX", "value": "34"}, {"name": "LISTITEM", "value": "35"}, {"name": "LOG", "value": "36"}, {"name": "MAIN", "value": "37"}, {"name": "MARQUEE", "value": "38"}, {"name": "MATH", "value": "39"}, {"name": "METER", "value": "40"}, {"name": "MENU", "value": "41"}, {"name": "MENUBAR", "value": "42"}, {"name": "MENUITEM", "value": "43"}, {"name": "MENUITEMCHECKBOX", "value": "44"}, {"name": "MENUITEMRADIO", "value": "45"}, {"name": "NAVIGATION", "value": "46"}, {"name": "NONE", "value": "47"}, {"name": "NOTE", "value": "48"}, {"name": "OPTION", "value": "49"}, {"name": "PARAGRAPH", "value": "50"}, {"name": "PRESENTATION", "value": "51"}, {"name": "PROGRESSBAR", "value": "52"}, {"name": "RADIO", "value": "53"}, {"name": "RADIOGROUP", "value": "54"}, {"name": "REGION", "value": "55"}, {"name": "ROW", "value": "56"}, {"name": "ROWGROUP", "value": "57"}, {"name": "ROWHEADER", "value": "58"}, {"name": "SCROLLBAR", "value": "59"}, {"name": "SEARCH", "value": "60"}, {"name": "SEARCHBOX", "value": "61"}, {"name": "SEPARATOR", "value": "62"}, {"name": "SLIDER", "value": "63"}, {"name": "SPINBUTTON", "value": "64"}, {"name": "STATUS", "value": "65"}, {"name": "STRONG", "value": "66"}, {"name": "SUBSCRIPT", "value": "67"}, {"name": "SUPERSCRIPT", "value": "68"}, {"name": "SWITCH", "value": "69"}, {"name": "TAB", "value": "70"}, {"name": "TABLE", "value": "71"}, {"name": "TABLIST", "value": "72"}, {"name": "TABPANEL", "value": "73"}, {"name": "TERM", "value": "74"}, {"name": "TEXTBOX", "value": "75"}, {"name": "TIME", "value": "76"}, {"name": "TIMER", "value": "77"}, {"name": "TOOLBAR", "value": "78"}, {"name": "TOOLTIP", "value": "79"}, {"name": "TREE", "value": "80"}, {"name": "TREEGRID", "value": "81"}, {"name": "TREEITEM", "value": "82"}]}, {"type": "Enum", "name": "ElementState", "doc": "<p>Enum that defines the state an element can have.</p>\n<p>The following <code>states</code> are possible:</p>\n<table border=\"1\">\n<tr>\n<th>State</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>attached</code></td>\n<td>to be present in DOM.</td>\n</tr>\n<tr>\n<td><code>detached</code></td>\n<td>to not be present in DOM.</td>\n</tr>\n<tr>\n<td><code>visible</code></td>\n<td>to have non or empty bounding box and no visibility:hidden.</td>\n</tr>\n<tr>\n<td><code>hidden</code></td>\n<td>to be detached from DOM, or have an empty bounding box or visibility:hidden.</td>\n</tr>\n<tr>\n<td><code>enabled</code></td>\n<td>to not be <code>disabled</code>.</td>\n</tr>\n<tr>\n<td><code>disabled</code></td>\n<td>to be <code>disabled</code>. Can be used on &lt;button&gt;, &lt;fieldset&gt;, &lt;input&gt;, &lt;optgroup&gt;, &lt;option&gt;, &lt;select&gt; and &lt;textarea&gt;.</td>\n</tr>\n<tr>\n<td><code>editable</code></td>\n<td>to not be <code>readOnly</code>.</td>\n</tr>\n<tr>\n<td><code>readonly</code></td>\n<td>to be <code>readOnly</code>. Can be used on &lt;input&gt; and &lt;textarea&gt;.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>to be <code>selected</code>. Can be used on &lt;option&gt;.</td>\n</tr>\n<tr>\n<td><code>deselected</code></td>\n<td>to not be <code>selected</code>.</td>\n</tr>\n<tr>\n<td><code>focused</code></td>\n<td>to be the <code>activeElement</code>.</td>\n</tr>\n<tr>\n<td><code>defocused</code></td>\n<td>to not be the <code>activeElement</code>.</td>\n</tr>\n<tr>\n<td><code>checked</code></td>\n<td>to be <code>checked</code>. Can be used on &lt;input&gt;.</td>\n</tr>\n<tr>\n<td><code>unchecked</code></td>\n<td>to not be <code>checked</code>.</td>\n</tr>\n<tr>\n<td><code>stable</code></td>\n<td>to be both <code>visible</code> and <code>stable</code>.</td>\n</tr>\n</table>", "usages": ["Get Element States", "Wait For Elements State"], "accepts": ["string", "integer"], "members": [{"name": "attached", "value": "1"}, {"name": "detached", "value": "2"}, {"name": "visible", "value": "4"}, {"name": "hidden", "value": "8"}, {"name": "enabled", "value": "16"}, {"name": "disabled", "value": "32"}, {"name": "editable", "value": "64"}, {"name": "readonly", "value": "128"}, {"name": "selected", "value": "256"}, {"name": "deselected", "value": "512"}, {"name": "focused", "value": "1024"}, {"name": "defocused", "value": "2048"}, {"name": "checked", "value": "4096"}, {"name": "unchecked", "value": "8192"}, {"name": "stable", "value": "16384"}]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Click With Options", "Drag And Drop By Coordinates", "Drag And Drop Relative To", "Get BoundingBox", "Get Scroll Position", "Get Scroll Size", "Hover", "Launch Browser Server", "Mouse Button", "Mouse Move", "Mouse Move Relative To", "New Browser", "New Context", "New Persistent Context", "Set Geolocation"], "accepts": ["string", "Real"]}, {"type": "Enum", "name": "ForcedColors", "doc": "<p>Emulates <span class=\"name\">forced-colors</span> media feature, supported values are <span class=\"name\">active</span>, <a href=\"#type-None\" class=\"name\">none</a>.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "active", "value": "1"}, {"name": "none", "value": "2"}]}, {"type": "Enum", "name": "FormatingRules", "doc": "<p>Enum that defines the available formatters.</p>\n<table border=\"1\">\n<tr>\n<th>Formatter</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>normalize spaces</code></td>\n<td>Replaces all kind of spaces with a single space.</td>\n</tr>\n<tr>\n<td><code>strip</code></td>\n<td>Removes spaces from start and end of the string.</td>\n</tr>\n<tr>\n<td><code>apply to expected</code></td>\n<td>Applies the formatter also to the expected value.</td>\n</tr>\n<tr>\n<td><code>case insensitive</code></td>\n<td>Converts the string to lower case.</td>\n</tr>\n</table>", "usages": ["Set Assertion Formatters"], "accepts": ["string"], "members": [{"name": "normalize spaces", "value": "1"}, {"name": "strip", "value": "2"}, {"name": "apply to expected", "value": "3"}, {"name": "case insensitive", "value": "4"}]}, {"type": "Enum", "name": "FormatterKeywords", "doc": "<p>Enum that defines the available keywords for formatters.</p>\n<p>Keywords that are not listed here, do not support formatters.</p>", "usages": ["Set Assertion Formatters"], "accepts": ["string"], "members": [{"name": "Get Url", "value": "1"}, {"name": "Get Page Source", "value": "2"}, {"name": "Get Title", "value": "3"}, {"name": "Get Text", "value": "4"}, {"name": "Get Property", "value": "5"}, {"name": "Get Attribute", "value": "6"}, {"name": "Get Select Options", "value": "7"}, {"name": "Get Style", "value": "8"}, {"name": "Get Browser Catalog", "value": "9"}, {"name": "LocalStorage Get Item", "value": "10"}, {"name": "SessionStorage Get Item", "value": "11"}]}, {"type": "TypedDict", "name": "GeoLocation", "doc": "<p>Defines the geolocation.</p>\n<ul>\n<li><code>latitude</code> Latitude between -90 and 90.</li>\n<li><code>longitude</code> Longitude between -180 and 180.</li>\n<li><code>accuracy</code> <b>Optional</b> Non-negative accuracy value. Defaults to 0.</li>\n</ul>\n<p>Example usage: <code>{'latitude': 59.95, 'longitude': 30.31667}</code></p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "longitude", "type": "float", "required": true}, {"key": "latitude", "type": "float", "required": true}, {"key": "accuracy", "type": "float", "required": false}]}, {"type": "TypedDict", "name": "HighLightElement", "doc": "<p>Presenter mode configuration options.</p>\n<p><code>duration</code> Sets for how long the selector shall be highlighted. Defaults to <code>5s</code> =&gt; 5 seconds.</p>\n<p><code>width</code> Sets the width of the higlight border. Defaults to 2px.</p>\n<p><code>style</code> Sets the style of the border. Defaults to dotted.</p>\n<p><code>color</code> Sets the color of the border, default is blue. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></p>", "usages": ["__init__"], "accepts": ["string", "Mapping"], "items": [{"key": "duration", "type": "timedelta", "required": true}, {"key": "width", "type": "str", "required": true}, {"key": "style", "type": "str", "required": true}, {"key": "color", "type": "str", "required": true}]}, {"type": "TypedDict", "name": "HttpCredentials", "doc": "<p>Sets the credentials for http basic-auth.</p>\n<p><code>origin</code>: Restrain sending http credentials on specific origin (<a href=\"scheme://host:port\">scheme://host:port</a>). Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.</p>\n<p>Can be defined as robot dictionary or as string literal. Does not reveal secrets in Robot Framework logs. Instead, username and password values are resolved internally. Please note that if <code>enable_playwright_debug</code> is enabled in the library import, secret will be always visible as plain text in the playwright debug logs, regardless of the Robot Framework log level.</p>\n<p>Example as literal:</p>\n<pre>\n${pwd} =    Set Variable    1234\n${username} =    Set Variable    admin\n<a href=\"#New%20Context\" class=\"name\">New Context</a>\n...    httpCredentials={'username': '$username', 'password': '$pwd'}\n</pre>\n<p>Example as robot variable</p>\n<pre>\n<b>***</b> <b>Variables</b> <b>***</b>\n${username}=       admin\n${pwd}=            1234\n${credentials}=    username=$username    password=$pwd\n\n<b>***</b> <b>Keywords</b> <b>***</b>\nOpen Context\n   <a href=\"#New%20Context\" class=\"name\">New Context</a>    httpCredentials=${credentials}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "username", "type": "str", "required": true}, {"key": "password", "type": "str", "required": true}, {"key": "origin", "type": "str", "required": false}]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__", "Click With Options", "Crawl Site", "Drag And Drop", "Drag And Drop By Coordinates", "Drag And Drop Relative To", "Get BoundingBox", "Get Console Log", "Get Element By Role", "Get Element Count", "Get Page Errors", "Get Scroll Size", "Get Selected Options", "Get Table Cell Index", "Get Table Row Index", "Keyboard Input", "Launch Browser Server", "Mouse Button", "Mouse Move", "Mouse Move Relative To", "Mouse Wheel", "New Browser", "New Context", "New Persistent Context", "Set Viewport Size", "Take Screenshot", "Tap"], "accepts": ["string", "float"]}, {"type": "Enum", "name": "KeyAction", "doc": "<p>Enum that defines which <a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a> action to perform.</p>", "usages": ["Keyboard Key"], "accepts": ["string"], "members": [{"name": "down", "value": "1"}, {"name": "up", "value": "2"}, {"name": "press", "value": "3"}]}, {"type": "Enum", "name": "KeyboardInputAction", "doc": "<p>Enum that defines how <a href=\"#Keyboard%20Input\" class=\"name\">Keyboard Input</a> adds the text into the page.</p>\n<p><code>insertText</code> is mostly similar to pasting of text.</p>\n<p><code>type</code> is similar to typing by pressing keys on the keyboard.</p>", "usages": ["Keyboard Input"], "accepts": ["string"], "members": [{"name": "insertText", "value": "1"}, {"name": "type", "value": "2"}]}, {"type": "Enum", "name": "KeyboardModifier", "doc": "<p>Modifier keys to press while doing other actions.</p>\n<p>Modifiers that are pressed during the <a href=\"#Hover\" class=\"name\">Hover</a> or <a href=\"#Click\" class=\"name\">Click</a>.</p>", "usages": ["Click With Options", "Hover", "Tap"], "accepts": ["string"], "members": [{"name": "Alt", "value": "1"}, {"name": "Control", "value": "2"}, {"name": "Meta", "value": "3"}, {"name": "Shift", "value": "4"}]}, {"type": "Custom", "name": "LambdaFunction", "doc": "<p>Python lambda function.</p>\n<p>The string must start with <code>lambda</code> and the function must accept one argument.</p>\n<p>Example: <code>lambda value: value.lower().replace(' ', '')</code></p>", "usages": ["Set Assertion Formatters"], "accepts": ["string"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["__init__", "Get Attribute Names", "Get Browser Catalog", "Get Browser Ids", "Get Classes", "Get Context Ids", "Get Cookies", "Get Element States", "Get Elements", "Get Page Ids", "Get Select Options", "Get Selected Options", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Select Options By", "Set Assertion Formatters", "Take Screenshot"], "accepts": ["string", "Sequence"]}, {"type": "Enum", "name": "MouseButton", "doc": "<p>Enum that defines which mouse button to use.</p>", "usages": ["Click", "Click With Options", "Mouse Button"], "accepts": ["string"], "members": [{"name": "left", "value": "1"}, {"name": "middle", "value": "2"}, {"name": "right", "value": "3"}]}, {"type": "Enum", "name": "MouseButtonAction", "doc": "<p>Enum that defines which <a href=\"#Mouse%20Button\" class=\"name\">Mouse Button</a> action to perform.</p>", "usages": ["Mouse Button"], "accepts": ["string"], "members": [{"name": "click", "value": "1"}, {"name": "down", "value": "2"}, {"name": "up", "value": "3"}]}, {"type": "TypedDict", "name": "NewPageDetails", "doc": "<p>Return value of <a href=\"#New%20Page\" class=\"name\">New Page</a> keyword.</p>\n<p><code>page_id</code> is the UUID of the opened page. <code>video_path</code> path to the video or empty string if video is not created.</p>", "usages": ["New Page", "Switch Page"], "accepts": ["string", "Mapping"], "items": [{"key": "page_id", "type": "str", "required": true}, {"key": "video_path", "type": "str", "required": true}]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__", "Add Cookie", "Click With Options", "Crawl Site", "Download", "Evaluate JavaScript", "Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Download State", "Get Element By Role", "Get Element Count", "Get Element States", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Go To", "Grant Permissions", "Hover", "Http", "Launch Browser Server", "LocalStorage Clear", "LocalStorage Get Item", "LocalStorage Remove Item", "LocalStorage Set Item", "Mouse Button", "New Browser", "New Context", "New Page", "New Persistent Context", "Open Browser", "Promise To Wait For Download", "Record Selector", "Register Keyword To Run On Failure", "Scroll By", "Scroll To", "SessionStorage Clear", "SessionStorage Get Item", "SessionStorage Remove Item", "SessionStorage Set Item", "Set Geolocation", "Set Selector Prefix", "Show Keyword Banner", "Take Screenshot", "Tap", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Load State", "Wait For Navigation", "Wait For Request", "Wait For Response", "Wait Until Network Is Idle"], "accepts": ["string"]}, {"type": "Enum", "name": "PageLoadStates", "doc": "<p>Enum that defines available page load states.</p>", "usages": ["Go To", "New Page", "Wait For Load State", "Wait For Navigation"], "accepts": ["string"], "members": [{"name": "load", "value": "1"}, {"name": "domcontentloaded", "value": "2"}, {"name": "networkidle", "value": "3"}, {"name": "commit", "value": "4"}]}, {"type": "Standard", "name": "Path", "doc": "<p>Strings are converted <a href=\"https://docs.python.org/library/pathlib.html\">Path</a> objects. On Windows <code>/</code> is converted to <code>\\</code> automatically.</p>\n<p>Examples: <code>/tmp/absolute/path</code>, <code>relative/path/to/file.ext</code>, <code>name.txt</code></p>", "usages": ["Promise To Upload File", "Take Screenshot", "Upload File By Selector"], "accepts": ["string", "PurePath"]}, {"type": "Enum", "name": "Permission", "doc": "<p>Enum that defines the permission to grant to a context.</p>\n<p>See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions\">grantPermissions(permissions)</a> for more details.</p>", "usages": ["Grant Permissions", "New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "geolocation", "value": "geolocation"}, {"name": "midi", "value": "midi"}, {"name": "midi_sysex", "value": "midi-sysex"}, {"name": "midi-sysex", "value": "midi-sysex"}, {"name": "notifications", "value": "notifications"}, {"name": "camera", "value": "camera"}, {"name": "microphone", "value": "microphone"}, {"name": "background_sync", "value": "background-sync"}, {"name": "background-sync", "value": "background-sync"}, {"name": "ambient_light_sensor", "value": "ambient-light-sensor"}, {"name": "ambient-light-sensor", "value": "ambient-light-sensor"}, {"name": "accelerometer", "value": "accelerometer"}, {"name": "gyroscope", "value": "gyroscope"}, {"name": "magnetometer", "value": "magnetometer"}, {"name": "accessibility_events", "value": "accessibility-events"}, {"name": "accessibility-events", "value": "accessibility-events"}, {"name": "clipboard_read", "value": "clipboard-read"}, {"name": "clipboard-read", "value": "clipboard-read"}, {"name": "clipboard_write", "value": "clipboard-write"}, {"name": "clipboard-write", "value": "clipboard-write"}, {"name": "payment_handler", "value": "payment-handler"}, {"name": "payment-handler", "value": "payment-handler"}]}, {"type": "Enum", "name": "PlaywrightLogTypes", "doc": "<p>Enable low level debug information from the playwright to playwright-log.txt file.</p>\n<p>It is possible to disable the creation of playwright-log.txt totally. Mainly useful for the library developers and for debugging purposes. Will log everything as plain text, also including secrets. If playwright-log.txt file can not be deleted, time.time_ns() is added at the end of file name. Example playwright-log-12345.txt</p>\n<p><code>disabled</code>: playwright-log.txt is not created at all. All node side logging is lost. <code>library</code>: Default, only logging from Browser library node side is written to the playwright-log.txt file. <code>playwright</code>: Also includes Playwright log messages to the playwright-log.txt file. <code>false</code>: Same as <span class=\"name\">library</span> and for backwards compatability. <code>true</code>: Same as <span class=\"name\">playwright</span> and for backwards compatibility.</p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "disabled", "value": "1"}, {"name": "library", "value": "2"}, {"name": "playwright", "value": "3"}, {"name": "false", "value": "2"}, {"name": "true", "value": "3"}]}, {"type": "TypedDict", "name": "Proxy", "doc": "<p>Network proxy settings.</p>\n<p><code>server</code> Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example <a href=\"http://myproxy.com:3128\">http://myproxy.com:3128</a> or <a href=\"socks5://myproxy.com:3128\">socks5://myproxy.com:3128</a>. Short form myproxy.com:3128 is considered an HTTP proxy.</p>\n<p><code>bypass</code> <b>Optional</b> coma-separated domains to bypass proxy, for example \".com, chromium.org, .domain.com\".</p>\n<p><code>username</code> <b>Optional</b> username to use if HTTP proxy requires authentication.</p>\n<p><code>password</code> <b>Optional</b> password to use if HTTP proxy requires authentication.</p>", "usages": ["Launch Browser Server", "New Browser", "New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "server", "type": "str", "required": true}, {"key": "bypass", "type": "str", "required": false}, {"key": "username", "type": "str", "required": false}, {"key": "password", "type": "str", "required": false}]}, {"type": "TypedDict", "name": "RecordHar", "doc": "<p>Enables HAR recording for all pages into to a file.</p>\n<p>If not specified, the HAR is not recorded. Make sure to await context to close for the <a href=\"http://www.softwareishard.com/blog/har-12-spec/\">HAR</a> to be saved.</p>\n<p><span class=\"name\">omitContent</span>: Optional setting to control whether to omit request content from the HAR. Default is False</p>\n<p><a href=\"#type-Path\" class=\"name\">path</a>: Path on the filesystem to write the HAR file to.</p>\n<p>Example:</p>\n<pre>\n${har} =    Create Dictionary     path=/path/to/har.file    omitContent=True\nNew Context    recordHar=${har}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "omitContent", "type": "bool", "required": false}, {"key": "path", "type": "str", "required": false}]}, {"type": "TypedDict", "name": "RecordVideo", "doc": "<p>Enables Video recording</p>\n<p>Examples:</p>\n<pre>\n New Context  recordVideo={'dir':'videos', 'size':{'width':400, 'height':200}}\n New Context  recordVideo={'dir': 'd:/automation/video'}\n</pre>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "dir", "type": "str", "required": false}, {"key": "size", "type": "ViewportDimensions", "required": false}]}, {"type": "Enum", "name": "ReduceMotion", "doc": "<p>Emulates <span class=\"name\">prefers-reduced-motion</span> media feature, supported values are <span class=\"name\">reduce</span>, <span class=\"name\">no-preference</span>.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "reduce", "value": "1"}, {"name": "no_preference", "value": "2"}]}, {"type": "Custom", "name": "RegExp", "doc": "<p>Create a (JavaScript) RegExp object from a string.</p>\n<p>The matcher must start with a slash and end with a slash and can be followed by flags.</p>\n<p>Example: <code>/hello world/gi</code> Which is equivalent to <code>new RegExp(\"hello world\", \"gi\")</code> in JavaScript.</p>\n<p>Following flags are supported:</p>\n<table border=\"1\">\n<tr>\n<th>Flag</th>\n<th>Description</th>\n</tr>\n<tr>\n<td>g</td>\n<td>Global search.</td>\n</tr>\n<tr>\n<td>i</td>\n<td>Case-insensitive search.</td>\n</tr>\n<tr>\n<td>m</td>\n<td>Allows <code>^</code> and <code>$</code> to match newline characters.</td>\n</tr>\n<tr>\n<td>s</td>\n<td>Allows <code>.</code> to match newline characters.</td>\n</tr>\n<tr>\n<td>u</td>\n<td>\"unicode\"; treat a pattern as a sequence of unicode code points.</td>\n</tr>\n<tr>\n<td>y</td>\n<td>Perform a \"sticky\" search that matches starting at the current position in the target string.</td>\n</tr>\n</table>\n<p>See <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp\">RegExp Object</a> and <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions\">RegExp Guide</a> for more information.</p>", "usages": ["Get Element By", "Get Element By Role", "Wait For Navigation", "Wait For Request", "Wait For Response"], "accepts": ["string"]}, {"type": "Enum", "name": "RequestMethod", "doc": "<p>Enum that defines the request type.</p>", "usages": ["Http"], "accepts": ["string"], "members": [{"name": "HEAD", "value": "1"}, {"name": "GET", "value": "2"}, {"name": "POST", "value": "3"}, {"name": "PUT", "value": "4"}, {"name": "PATCH", "value": "5"}, {"name": "DELETE", "value": "6"}]}, {"type": "Enum", "name": "Scale", "doc": "<p>Enum that defines the scale of the screenshot.</p>\n<p>When set to \"css\", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using \"device\" option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger.</p>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "css", "value": "1"}, {"name": "device", "value": "2"}]}, {"type": "Enum", "name": "Scope", "doc": "<p>Some keywords which manipulates library settings have a scope argument. With that scope argument one can set the \"live time\" of that setting. Available Scopes are: <code>Global</code>, <code>Suite</code> and <code>Test</code> / <code>Task</code>. Is a scope finished, this scoped setting, like timeout, will no longer be used and the previous higher scope setting applies again.</p>\n<p>Live Times:</p>\n<ul>\n<li>A <code>Global</code> scope will live forever until it is overwritten by another Global scope. Or locally temporarily overridden by a more narrow scope.</li>\n<li>A <code>Suite</code> scope will locally override the Global scope and live until the end of the Suite within it is set, or if it is overwritten by a later setting with Global or same scope. Children suite does inherit the setting from the parent suite but also may have its own local Suite setting that then will be inherited to its children suites.</li>\n<li>A <code>Test</code> or <code>Task</code> scope will be inherited from its parent suite but when set, lives until the end of that particular test or task.</li>\n</ul>\n<p>A new set higher order scope will always remove the lower order scope which may be in charge. So the setting of a Suite scope from a test, will set that scope to the robot file suite where that test is and removes the Test scope that may have been in place.</p>", "usages": ["Register Keyword To Run On Failure", "Set Assertion Formatters", "Set Browser Timeout", "Set Retry Assertions For", "Set Selector Prefix", "Set Strict Mode", "Show Keyword Banner"], "accepts": ["string"], "members": [{"name": "Global", "value": "1"}, {"name": "Suite", "value": "2"}, {"name": "Test", "value": "3"}, {"name": "Task", "value": "3"}]}, {"type": "Enum", "name": "ScreenshotFileTypes", "doc": "<p>Enum that defines available file types for screenshots.</p>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "png", "value": "1"}, {"name": "jpeg", "value": "2"}]}, {"type": "Enum", "name": "ScreenshotReturnType", "doc": "<p>Enum that defines what <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot</a> keyword returns.</p>\n<ul>\n<li><code>path</code> returns the path to the screenshot file as <code>pathlib.Path</code> object.</li>\n<li><code>path_string</code> returns the path to the screenshot file as string.</li>\n<li><code>bytes</code> returns the screenshot itself as bytes.</li>\n<li><code>base64</code> returns the screenshot itself as base64 encoded string.</li>\n</ul>", "usages": ["Take Screenshot"], "accepts": ["string"], "members": [{"name": "path", "value": "1"}, {"name": "path_string", "value": "2"}, {"name": "bytes", "value": "3"}, {"name": "base64", "value": "4"}]}, {"type": "Enum", "name": "ScrollBehavior", "doc": "<p>Enum that controls the behavior of scrolling.</p>\n<p><code>smooth</code></p>", "usages": ["Scroll By", "Scroll To"], "accepts": ["string"], "members": [{"name": "auto", "value": "1"}, {"name": "smooth", "value": "2"}]}, {"type": "TypedDict", "name": "ScrollPosition", "doc": "<p>Scroll position of an element.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>top</code></td>\n<td>The amount of pixel between the top border of the page and the top border of visible area.</td>\n</tr>\n<tr>\n<td><code>left</code></td>\n<td>The amount of pixel between the left border of the page and the left border of visible area.</td>\n</tr>\n<tr>\n<td><code>bottom</code></td>\n<td>The amount of pixel between the top border of the page and the bottom border of visible area.</td>\n</tr>\n<tr>\n<td><code>right</code></td>\n<td>The amount of pixel between the left border of the page and the right border of visible area.</td>\n</tr>\n</table>", "usages": ["Get Scroll Position"], "accepts": ["string", "Mapping"], "items": [{"key": "top", "type": "float", "required": true}, {"key": "left", "type": "float", "required": true}, {"key": "bottom", "type": "float", "required": true}, {"key": "right", "type": "float", "required": true}]}, {"type": "Enum", "name": "SelectAttribute", "doc": "<p>Enum that defines the attribute of an &lt;option&gt; element in a &lt;select&gt;-list.</p>\n<p>This defines by what attribute an option is selected/chosen.</p>\n<pre>\n&lt;select class=\"my_drop_down\"&gt;\n  &lt;option value=\"0: Object\"&gt;None&lt;/option&gt;\n  &lt;option value=\"1: Object\"&gt;Some&lt;/option&gt;\n  &lt;option value=\"2: Object\"&gt;Other&lt;/option&gt;\n&lt;/select&gt;\n</pre>\n<p><code>value</code> of the first option would be <code>0: Object</code>.</p>\n<p><code>label</code> / <code>text</code> both defines the innerText which would be <code>None</code> for first element.</p>\n<p><code>index</code> 0 indexed number of an option. Would be <code>0</code> for the first element.</p>", "usages": ["Get Selected Options", "Select Options By"], "accepts": ["string"], "members": [{"name": "value", "value": "1"}, {"name": "label", "value": "2"}, {"name": "text", "value": "2"}, {"name": "index", "value": "3"}]}, {"type": "Enum", "name": "SelectionStrategy", "doc": "<p>SelectionStrategy to be used. Refers to Playwrights <code>page.getBy***</code> functions. See <a href=\"https://playwright.dev/docs/locators\">Playwright Locators</a></p>\n<h3>AltText</h3>\n<p>All images should have an alt attribute that describes the image. You can locate an image based on the text alternative using page.getByAltText().</p>\n<p>For example, consider the following DOM structure.</p>\n<pre>\n&lt;img alt=\"playwright logo\" src=\"/img/playwright-logo.svg\" width=\"100\" /&gt;\n</pre>\n<h3>Label</h3>\n<p>Allows locating input elements by the text of the associated <code>&lt;label&gt;</code> or <code>aria-labelledby</code> element, or by the <code>aria-label</code> attribute.</p>\n<p>For example, this method will find inputs by label \"Username\" and \"Password\" in the following DOM:</p>\n<pre>\n&lt;input aria-label=\"Username\"&gt;\n&lt;label for=\"password-input\"&gt;Password:&lt;/label&gt;\n&lt;input id=\"password-input\"&gt;\n</pre>\n<h3>Placeholder</h3>\n<p>Allows locating input elements by the placeholder text.</p>\n<p>Example:</p>\n<pre>\n&lt;input type=\"email\" placeholder=\"name@example.com\" /&gt;\n</pre>\n<h3>TestId</h3>\n<p>Locate element by the test id.</p>\n<p>Currently only the exact attribute <code>data-testid</code> is supported.</p>\n<p>Example:</p>\n<pre>\n&lt;button data-testid=\"directions\"&gt;Itin\u00e9raire&lt;/button&gt;\n</pre>\n<h3>Text</h3>\n<p>Allows locating elements that contain given text.</p>\n<p>Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace. Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text \"Log in\" matches &lt;input type=button value=\"Log in\"&gt;.</p>\n<h3>Title</h3>\n<p>Allows locating elements by their title attribute.</p>\n<p>Example:</p>\n<pre>\n&lt;img alt=\"playwright logo\" src=\"/img/playwright-logo.svg\" title=\"Playwright\" width=\"100\" /&gt;\n</pre>", "usages": ["Get Element By"], "accepts": ["string"], "members": [{"name": "AltText", "value": "AltText"}, {"name": "Label", "value": "Label"}, {"name": "Placeholder", "value": "Placeholder"}, {"name": "TestID", "value": "TestId"}, {"name": "Text", "value": "Text"}, {"name": "Title", "value": "Title"}]}, {"type": "Enum", "name": "SelectionType", "doc": "<p>Enum that defines if the current id or all ids shall be returned.</p>\n<p><code>ACTIVE</code> / <code>CURRENT</code> defines to return only the id of the currently active instance of a Browser/Context/Page.</p>\n<p><code>ALL</code> / <code>ANY</code> defines to return ids of all instances.</p>", "usages": ["Close Browser", "Close Context", "Close Page", "Get Browser Ids", "Get Context Ids", "Get Page Ids", "Switch Context", "Switch Page"], "accepts": ["string"], "members": [{"name": "CURRENT", "value": "CURRENT"}, {"name": "ACTIVE", "value": "CURRENT"}, {"name": "ALL", "value": "ALL"}, {"name": "ANY", "value": "ALL"}]}, {"type": "TypedDict", "name": "SelectOptions", "doc": "<p>Dictionary with the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<table border=\"1\">\n<tr>\n<th>Keys</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>index</code></td>\n<td>0 based index of the option.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Value attribute of the option.</td>\n</tr>\n<tr>\n<td><code>label</code></td>\n<td>Label/Text of the option.</td>\n</tr>\n<tr>\n<td><code>selected</code></td>\n<td>Boolean if the option is selected.</td>\n</tr>\n</table>", "usages": ["Get Select Options"], "accepts": ["string", "Mapping"], "items": [{"key": "index", "type": "int", "required": true}, {"key": "value", "type": "str", "required": true}, {"key": "label", "type": "str", "required": true}, {"key": "selected", "type": "bool", "required": true}]}, {"type": "Enum", "name": "ServiceWorkersPermissions", "doc": "<p>Whether to allow sites to register Service workers.</p>\n<p><code>allow</code>: Service Workers can be registered.</p>\n<p><code>block</code>: Playwright will block all registration of Service Workers.</p>", "usages": ["New Context", "New Persistent Context"], "accepts": ["string"], "members": [{"name": "allow", "value": "1"}, {"name": "block", "value": "2"}]}, {"type": "Enum", "name": "SizeFields", "doc": "<p>Enum that defines how the returned size is filtered.</p>\n<p><code>ALL</code> defines that the size is returned as a dictionary. <code>{'width': &lt;float&gt;, 'height': &lt;float&gt;}.</code></p>\n<p><code>width</code> / <code>height</code> will return a single float value of the chosen dimension.</p>", "usages": ["Get Client Size", "Get Scroll Size", "Get Viewport Size"], "accepts": ["string"], "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "ALL", "value": "3"}]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Add Cookie", "Add Style Tag", "Cancel Download", "Check Checkbox", "Clear Text", "Click", "Click With Options", "Close Browser", "Close Browser Server", "Close Context", "Close Page", "Connect To Browser", "Crawl Site", "Deselect Options", "Download", "Drag And Drop", "Drag And Drop Relative To", "Evaluate JavaScript", "Fill Secret", "Fill Text", "Focus", "Get Attribute", "Get Attribute Names", "Get BoundingBox", "Get Browser Catalog", "Get Browser Ids", "Get Checkbox State", "Get Classes", "Get Client Size", "Get Console Log", "Get Cookie", "Get Cookies", "Get Device", "Get Download State", "Get Element", "Get Element By", "Get Element By Role", "Get Element Count", "Get Element States", "Get Elements", "Get Page Errors", "Get Page Source", "Get Property", "Get Scroll Position", "Get Scroll Size", "Get Select Options", "Get Selected Options", "Get Style", "Get Table Cell Element", "Get Table Cell Index", "Get Table Row Index", "Get Text", "Get Title", "Get Url", "Get Viewport Size", "Go To", "Grant Permissions", "Handle Future Dialogs", "Highlight Elements", "Hover", "Http", "Keyboard Input", "Keyboard Key", "Launch Browser Server", "LocalStorage Clear", "LocalStorage Get Item", "LocalStorage Remove Item", "LocalStorage Set Item", "Mouse Move Relative To", "New Browser", "New Context", "New Page", "New Persistent Context", "Open Browser", "Press Keys", "Promise To", "Promise To Wait For Download", "Record Selector", "Register Keyword To Run On Failure", "Save Storage State", "Scroll By", "Scroll To", "Scroll To Element", "Select Options By", "SessionStorage Clear", "SessionStorage Get Item", "SessionStorage Remove Item", "SessionStorage Set Item", "Set Assertion Formatters", "Set Browser Timeout", "Set Retry Assertions For", "Set Selector Prefix", "Show Keyword Banner", "Switch Browser", "Switch Context", "Switch Page", "Take Screenshot", "Tap", "Type Secret", "Type Text", "Uncheck Checkbox", "Upload File By Selector", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Navigation", "Wait For Request", "Wait For Response"], "accepts": ["Any"]}, {"type": "Enum", "name": "SupportedBrowsers", "doc": "<p>Defines which browser shall be started.</p>\n<table border=\"1\">\n<tr>\n<th>Browser</th>\n<th>Browser with this engine</th>\n</tr>\n<tr>\n<td><code>chromium</code></td>\n<td>Google Chrome, Microsoft Edge (since 2020), Opera</td>\n</tr>\n<tr>\n<td><code>firefox</code></td>\n<td>Mozilla Firefox</td>\n</tr>\n<tr>\n<td><code>webkit</code></td>\n<td>Apple Safari, Mail, AppStore on MacOS and iOS</td>\n</tr>\n</table>\n<p>Since <a href=\"https://github.com/microsoft/playwright\">Playwright</a> comes with a pack of builtin binaries for all browsers, no additional drivers e.g. geckodriver are needed.</p>\n<p>All these browsers that cover more than 85% of the world wide used browsers, can be tested on Windows, Linux and MacOS. Theres is not need for dedicated machines anymore.</p>", "usages": ["__init__", "Connect To Browser", "Launch Browser Server", "New Browser", "New Context", "New Persistent Context", "Open Browser"], "accepts": ["string"], "members": [{"name": "chromium", "value": "1"}, {"name": "firefox", "value": "2"}, {"name": "webkit", "value": "3"}]}, {"type": "Standard", "name": "timedelta", "doc": "<p>Strings are expected to represent a time interval in one of the time formats Robot Framework supports:</p>\n<ul>\n<li>a number representing seconds like <code>42</code> or <code>10.5</code></li>\n<li>a time string like <code>1 hour 2 seconds</code> or <code>1h 2s</code></li>\n<li>a \"timer\" string like <code>01:02</code> (1 minute 2 seconds) or <code>01:00:03</code> (1 hour 3 seconds)</li>\n</ul>\n<p>Integers and floats are considered to be seconds.</p>\n<p>See the <a href=\"https://robotframework.org/robotframework/\">Robot Framework User Guide</a> for more details about the supported time formats.</p>", "usages": ["__init__", "Click With Options", "Download", "Get Console Log", "Get Page Errors", "Go To", "Highlight Elements", "Keyboard Input", "Launch Browser Server", "Mouse Button", "New Browser", "New Persistent Context", "Promise To Wait For Download", "Set Browser Timeout", "Set Retry Assertions For", "Take Screenshot", "Type Secret", "Type Text", "Wait For Alert", "Wait For Condition", "Wait For Elements State", "Wait For Function", "Wait For Load State", "Wait For Navigation", "Wait For Request", "Wait For Response", "Wait Until Network Is Idle"], "accepts": ["string", "integer", "float"]}, {"type": "TypedDict", "name": "ViewportDimensions", "doc": "<p>Viewport dimensions.</p>\n<p>Viewport is the browsers inner window size that is used to display the page.</p>\n<table border=\"1\">\n<tr>\n<th>Key</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>width</code></td>\n<td>page width in pixels.</td>\n</tr>\n<tr>\n<td><code>height</code></td>\n<td>page height in pixels.</td>\n</tr>\n</table>", "usages": ["Get Viewport Size", "New Context", "New Persistent Context"], "accepts": ["string", "Mapping"], "items": [{"key": "width", "type": "int", "required": true}, {"key": "height", "type": "int", "required": true}]}]}
+</script>
+<title></title>
+<script async src="https://www.googletagmanager.com/gtag/js?id=UA-106835747-3"></script><script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', 'UA-106835747-3', {
+            'anonymize_ip': true,
+            'page_path': location.pathname+location.search+location.hash });
+      window.onhashchange = function() {
+            gtag('event', 'HashChange', {
+            'event_category': 'Subsection',
+            'event_label': window.location.hash
+            });
+       }
+    </script></head>
+<body>
+<div id="javascript-disabled">
+<h1>Opening library documentation failed</h1>
+<ul>
+<li>Verify that you have <b>JavaScript enabled</b> in your browser.</li>
+<li>Make sure you are using a <b>modern enough browser</b>. If using Internet Explorer, version 11 is required.</li>
+<li>Check are there messages in your browser's <b>JavaScript error log</b>. Please report the problem if you suspect you have encountered a bug.</li>
+</ul>
+</div>
+<script type="text/javascript">
+    // Not using jQuery here for speed and to support ancient browsers.
+    document.getElementById('javascript-disabled').style.display = 'none';
+    window.addEventListener("hashchange", function() {
+      document.getElementsByClassName("hamburger-menu")[0].checked = false;
+    }, false);
+    window.addEventListener("hashchange", function() {
+        if (window.location.hash.indexOf('#type-') == 0) {
+            const hash = '#type-modal-' + decodeURI(window.location.hash.slice(6));
+            const typeDoc = document.querySelector(".data-types").querySelector(hash);
+            if (typeDoc) {
+              showModal(typeDoc);
+            }
+        }
+    }, false);
+</script>
+<script type="text/javascript">
+
+    $(document).ready(function() {
+        parseTemplates();
+        document.title = libdoc.name;
+        storage.init('libdoc');
+        setTheme();
+        renderTemplate('base', libdoc, $('body'));
+        if (libdoc.inits.length) {
+            libdoc.typedocs.map(function(type) {
+                var index = type.usages.indexOf('__init__');
+                if (index != -1) type.usages[index] = 'Importing';
+            });
+            renderTemplate('importing', libdoc);
+        }
+        renderTemplate('shortcuts', libdoc);
+        renderTemplate('keyword-shortcuts', libdoc);
+        renderTemplate('keywords', libdoc);
+        renderTemplate('data-types', libdoc);
+        renderTemplate('footer', libdoc);
+        const params = util.parseQueryString(window.location.search.slice(1));
+        let selectedTag = "";
+        if ("tag" in params) {
+            selectedTag = params["tag"];
+            tagSearch(selectedTag, window.location.hash);
+        }
+        if (libdoc.tags.length) {
+          libdoc.selectedTag = selectedTag;
+          renderTemplate('tags-shortcuts', libdoc);
+        }
+        scrollToHash();
+        setTimeout(function() {
+          document.getElementById("keyword-statistics-header").innerText = '' + libdoc.keywords.length;
+          if (storage.get('keyword-wall') === 'open') {
+            openKeywordWall();
+          }
+      }, 0);
+        createModal();
+    });
+
+    function setTheme(theme) {
+        document.documentElement.setAttribute('data-theme', theme || getTheme());
+    }
+
+    function getTheme() {
+        if (libdoc['theme']) {
+            return libdoc['theme'];
+        } else if (window.matchMedia('(prefers-color-scheme: dark)').matches) {
+            return 'dark';
+        } else {
+            return 'light;'
+        }
+    }
+
+    function parseTemplates() {
+        $('script[type="text/x-jquery-tmpl"]').map(function (idx, elem) {
+            $.template(elem.id, elem.text);
+        });
+    }
+
+    function renderTemplate(name, arguments, container) {
+      if (!container) {
+          container = $('#' + name + '-container');
+          container.empty();
+      }
+      if (!arguments.search) {
+          arguments.search = false;
+      }
+      $.tmpl(name + '-template', arguments).appendTo(container);
+    }
+
+    function scrollToHash() {
+        if (window.location.hash) {
+            var hash = window.location.hash.substring(1);
+            var id = decodeURIComponent(hash);
+            document.getElementById(id).scrollIntoView();
+        }
+    }
+
+    function tagSearch(tag, hash) {
+      document.getElementsByClassName('search-input')[0].value = '';
+      const include = {tags: true, tagsExact: true};
+      const url = window.location.pathname + "?tag=" + tag + (hash || "");
+      markMatches(tag, include);
+      highlightMatches(tag, include);
+      history.replaceState && history.replaceState(null, '', url);
+      document.getElementById('keyword-shortcuts-container').scrollTop = 0;
+    }
+
+    function clearTagSearch() {
+      document.getElementsByClassName('search-input')[0].value = '';
+      history.replaceState && history.replaceState(null, '', window.location.pathname);
+      resetKeywords();
+    }
+
+    function closeMenu() {
+      document.getElementById('hamburger-menu-input').checked = false;
+    }
+
+    function markMatches(pattern, include, givenSearchTime, callback) {
+       if (givenSearchTime && givenSearchTime !== searchTime) {
+         return;
+       }
+        let patternRegexp = util.regexpEscape(pattern);
+        if (include.tagsExact) {
+            patternRegexp = '^' + patternRegexp + '$';
+        }
+        let regexp = new RegExp(patternRegexp, 'i');
+        let test = regexp.test.bind(regexp);
+        let result = {};
+        let keywordMatchCount = 0;
+        result.keywords = util.map(libdoc.keywords, function (kw) {
+            kw = $.extend({}, kw);
+            kw.hidden =  !(include.name && test(kw.name)) &&
+                         !(include.args && test(kw.args)) &&
+                          !(include.doc && test($(kw.doc).text())) &&
+                          !(include.tags && util.any(util.map(kw.tags, test)));
+            if (!kw.hidden)
+                keywordMatchCount++;
+            return kw;
+        });
+        renderTemplate('keyword-shortcuts', result);
+        renderTemplate('keywords', result);
+        if (libdoc.tags.length) {
+          libdoc.selectedTag = include.tagsExact ? pattern : "";
+          renderTemplate('tags-shortcuts', libdoc);
+        }
+        document.getElementById("keyword-statistics-header").innerText = keywordMatchCount + ' / ' + result.keywords.length;
+        if (keywordMatchCount === 0)
+            $('#keywords-container').find('table').empty();
+        if (callback) {
+          requestAnimationFrame(callback);
+        }
+    }
+
+    function highlightMatches(string, include, givenSearchTime) {
+       if (givenSearchTime && givenSearchTime !== searchTime) {
+         return;
+       }
+        const shortcuts = $('#shortcuts-container').find('.match');
+        const keywords = $('#keywords-container').find('.match');
+        if (include.name) {
+            shortcuts.highlight(string);
+            keywords.find('.kw').highlight(string);
+        }
+        if (include.args) {
+            keywords.find('.args').highlight(string);
+        }
+        if (include.doc) {
+            keywords.find('.doc').highlight(string);
+        }
+        if (include.tags) {
+            var matches = keywords.find('.tags').find('a').add(
+                    $('#tags-shortcuts-container').find('a'));
+            if (include.tagsExact) {
+                matches = matches.filter(function (index, tag) {
+                    return $(tag).text().toUpperCase() === string.toUpperCase();
+                });
+            }
+            matches.highlight(string);
+        }
+    }
+
+    function clearSearch() {
+      document.getElementsByClassName('search-input')[0].value = '';
+      const tagsSelect = document.getElementById('tags-shortcuts-container');
+      if (tagsSelect) {
+        tagsSelect.selectedIndex = 0;
+      }
+      resetKeywords();
+    }
+
+    let searchTime = 0;
+
+    function searching() {
+      searchTime = Date.now();
+      const value = document.getElementsByClassName('search-input')[0].value;
+      const include = {name: true,
+                       args: true,
+                       doc: true,
+                       tags: true};
+      if (value) {
+        requestAnimationFrame(function () {
+          markMatches(value, include, searchTime,
+                  function () {
+                    highlightMatches(value, include, searchTime);
+                    document.getElementById('keyword-shortcuts-container').scrollTop = 0;
+                  }
+          );
+        });
+      } else {
+          resetKeywords();
+      }
+    }
+
+    function toggleShortcuts() {
+      const shortcuts = document.getElementsByClassName("shortcuts")[0];
+      if (shortcuts.classList.contains("keyword-wall")) {
+        closeKeywordWall();
+      } else {
+        openKeywordWall();
+      }
+    }
+
+    function openKeywordWall() {
+      const shortcuts = document.getElementsByClassName("shortcuts")[0];
+      shortcuts.classList.add("keyword-wall");
+      storage.set("keyword-wall", 'open');
+      const button = document.getElementById("toggle-keyword-shortcuts")
+      button.innerText = '-';
+    }
+
+    function closeKeywordWall() {
+      const shortcuts = document.getElementsByClassName("shortcuts")[0];
+      shortcuts.classList.remove("keyword-wall");
+      storage.set("keyword-wall", 'close');
+      const button = document.getElementById("toggle-keyword-shortcuts")
+      button.innerText = '+';
+    }
+
+    function resetKeywords() {
+        renderTemplate('keyword-shortcuts', libdoc);
+        renderTemplate('keywords', libdoc);
+        renderTemplate('data-types', libdoc);
+        if (libdoc.tags.length) {
+            renderTemplate('tags', libdoc);
+        }
+        document.getElementById("keyword-statistics-header").innerText = ''+libdoc.keywords.length;
+        if (libdoc.typedocs.length) {
+            document.getElementById("type-statistics-header").innerText = '' + libdoc.typedocs.length;
+        }
+        history.replaceState && history.replaceState(null, '', location.pathname);
+    }
+
+    function createModal() {
+        const modalBackground = document.createElement('div');
+        modalBackground.id = 'modal-background';
+        modalBackground.classList.add('modal-background');
+        modalBackground.addEventListener('click', ({ target }) => {
+            if (target.id === 'modal-background') hideModal()
+        })
+
+        const modalCloseButton = document.createElement('button');
+        modalCloseButton.innerHTML = `<svg xmlns="
+      http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="2em" height="2em" className="block" data-v-2754030d="" data-v-512b0344="">
+              <path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"
+                    data-v-2754030d="" fill="var(--text-color)"></path></svg>`;
+        modalCloseButton.classList.add('modal-close-button');
+        const modalCloseButtonContainer = document.createElement('div');
+        modalCloseButtonContainer.classList.add('modal-close-button-container');
+        modalCloseButtonContainer.appendChild(modalCloseButton);
+        modalCloseButton.addEventListener('click', () => {
+            hideModal()
+        })
+        modalBackground.appendChild(modalCloseButtonContainer);
+        modalCloseButtonContainer.addEventListener('click', () => {
+            hideModal()
+        })
+
+        const modal = document.createElement('div');
+        modal.id = 'modal';
+        modal.classList.add('modal');
+        modal.addEventListener('click', ({ target }) => {
+            if (target.tagName.toUpperCase() === 'A') hideModal()
+        })
+
+
+        const modalContent = document.createElement('div');
+        modalContent.id = 'modal-content';
+        modalContent.classList.add('modal-content');
+        modal.appendChild(modalContent);
+
+        modalBackground.appendChild(modal);
+        document.body.appendChild(modalBackground);
+        document.addEventListener('keydown', ({ key }) => {
+            if (key === 'Escape') hideModal()
+        })
+    }
+    function showModal(content) {
+        const modalBackground = document.getElementById('modal-background');
+        const modal = document.getElementById('modal');
+        const modalContent = document.getElementById('modal-content');
+        modalBackground.classList.add('visible');
+        modal.classList.add('visible');
+        modalContent.appendChild(content.cloneNode(true));
+        document.body.style.overflow = 'hidden';
+    }
+    function hideModal() {
+        const modalBackground = document.getElementById('modal-background');
+        const modal = document.getElementById('modal');
+        const modalContent = document.getElementById('modal-content');
+
+        modalBackground.classList.remove('visible');
+        modal.classList.remove('visible');
+        document.body.style.overflow = 'auto';
+        if (window.location.hash.indexOf('#type-') == 0)
+            history.pushState("", document.title, window.location.pathname);
+        // modal is hidden with a fading transition, timeout prevents premature emptying of modal
+        setTimeout(() => {
+            modalContent.innerHTML = '';
+        }, 200);
+    }
+
+    // http://stackoverflow.com/a/18484799
+    var delay = (function () {
+        var timer = 0;
+        return function(callback, ms) {
+            clearTimeout(timer);
+            timer = setTimeout(callback, ms);
+        };
+    })();
+</script>
+<script id="base-template" type="text/x-jquery-tmpl">
+  <div class="base-container">
+    <input id="hamburger-menu-input" class="hamburger-menu" type="checkbox" />
+    <span class="hamburger-menu hamburger-menu-1"></span>
+    <span class="hamburger-menu hamburger-menu-2"></span>
+    <span class="hamburger-menu hamburger-menu-3"></span>
+    <div class="libdoc-overview"><div id="shortcuts-container"></div></div>
+    <div class="libdoc-details">
+      <table class="metadata">
+          {{if version}}<tr><th>Library version:</th><td>${version}</td></tr>{{/if}}
+          {{if scope}}<tr><th>Library scope:</th><td>${scope}</td></tr>{{/if}}
+      </table>
+      <div id="introduction-container">
+          <h2 id="Introduction">Introduction</h2>
+          <div class="doc">{{html doc}}</div>
+      </div>
+      <div id="importing-container"></div>
+      <div id="keywords-container"></div>
+      <div id="data-types-container"></div>
+      <div id="footer-container"></div>
+    </div>
+    <a class="libdoc-title" href="#library-documentation-top">
+          <h1>${name}</h1>
+          <svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   viewBox="0 0 202.4325 202.34125"
+   height="42"
+   width="42"
+   xml:space="preserve"
+   version="1.1"><metadata
+     id="metadata8"><rdf:RDF><cc:Work
+         rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><defs
+     id="defs6"><clipPath
+       id="clipPath16"
+       clipPathUnits="userSpaceOnUse"><path
+         id="path18"
+         d="m 0,161.873 161.946,0 L 161.946,0 0,0 0,161.873 Z" /></clipPath></defs><g
+     transform="matrix(1.25,0,0,-1.25,0,202.34125)"
+     id="g10"><g
+       id="g12"><g
+         clip-path="url(#clipPath16)"
+         id="g14"><g
+           transform="translate(52.4477,88.1268)"
+           id="g20"><path
+             id="robot-svg-path"
+             d="m 0,0 c 0,7.6 6.179,13.779 13.77,13.779 7.6,0 13.779,-6.179 13.779,-13.779 0,-2.769 -2.238,-5.007 -4.998,-5.007 -2.761,0 -4.999,2.238 -4.999,5.007 0,2.078 -1.695,3.765 -3.782,3.765 C 11.693,3.765 9.997,2.078 9.997,0 9.997,-2.769 7.76,-5.007 4.999,-5.007 2.238,-5.007 0,-2.769 0,0 m 57.05,-23.153 c 0,-2.771 -2.237,-5.007 -4.998,-5.007 l -46.378,0 c -2.761,0 -4.999,2.236 -4.999,5.007 0,2.769 2.238,5.007 4.999,5.007 l 46.378,0 c 2.761,0 4.998,-2.238 4.998,-5.007 M 35.379,-2.805 c -1.545,2.291 -0.941,5.398 1.35,6.943 l 11.594,7.83 c 2.273,1.58 5.398,0.941 6.943,-1.332 1.545,-2.29 0.941,-5.398 -1.35,-6.943 l -11.594,-7.83 c -0.852,-0.586 -1.829,-0.87 -2.788,-0.87 -1.607,0 -3.187,0.781 -4.155,2.202 m 31.748,-30.786 c 0,-0.945 -0.376,-1.852 -1.045,-2.522 l -8.617,-8.617 c -0.669,-0.668 -1.576,-1.045 -2.523,-1.045 l -52.833,0 c -0.947,0 -1.854,0.377 -2.523,1.045 l -8.617,8.617 c -0.669,0.67 -1.045,1.577 -1.045,2.522 l 0,52.799 c 0,0.947 0.376,1.854 1.045,2.522 l 8.617,8.619 c 0.669,0.668 1.576,1.044 2.523,1.044 l 52.833,0 c 0.947,0 1.854,-0.376 2.523,-1.044 l 8.617,-8.619 c 0.669,-0.668 1.045,-1.575 1.045,-2.522 l 0,-52.799 z m 7.334,61.086 -11.25,11.25 c -1.705,1.705 -4.018,2.663 -6.428,2.663 l -56.523,0 c -2.412,0 -4.725,-0.959 -6.43,-2.665 L -17.412,27.494 c -1.704,-1.705 -2.661,-4.016 -2.661,-6.427 l 0,-56.515 c 0,-2.411 0.958,-4.725 2.663,-6.428 l 11.25,-11.25 c 1.705,-1.705 4.017,-2.662 6.428,-2.662 l 56.515,0 c 2.41,0 4.723,0.957 6.428,2.662 l 11.25,11.25 c 1.705,1.703 2.663,4.017 2.663,6.428 l 0,56.514 c 0,2.412 -0.958,4.724 -2.663,6.429" /></g></g></g></g></svg>
+    </a>
+  </div>
+</script>
+<script id="importing-template" type="text/x-jquery-tmpl">
+    <h2 id="Importing">Importing</h2>
+    <div class="keywords">
+        {{each inits}}
+        <div class="kw-row">
+          <div class="kw-overview">
+          {{if args.length}}
+              <div class="args">
+                <h4>Arguments</h4>
+                <div class="arguments-list-container">
+                  <div class="arguments-list">
+                  {{each args}}
+                    {{tmpl($value) 'argument-template'}}
+                  {{/each}}
+                  </div>
+                </div>
+              </div>
+          {{/if}}
+          {{if $value.doc}}
+            <div class="kw-docs">
+              <h4>Documentation</h4>
+              <div class="kwdoc doc">{{html $value.doc}}</div>
+            </div>
+          {{/if}}
+        </div>
+        {{/each}}
+    </div>
+</script>
+<script id="shortcuts-template" type="text/x-jquery-tmpl">
+    <div class="keywords-overview">
+      <div class="keyword-search-box">
+        <input placeholder="Search" type="text" class="search-input" onkeydown="delay(searching, 150)"/>
+        <button class="clear-search" onclick="clearSearch()">&#10005;</button>
+      </div>
+      {{if tags.length}}
+      <select id="tags-shortcuts-container" onchange="location = this.value;">
+      </select>
+      {{/if}}
+      <div class="keywords-overview-header-row">
+      <h4>Keywords (<span id="keyword-statistics-header"></span>)
+      </h4>
+      <button id="toggle-keyword-shortcuts" onclick="toggleShortcuts()">+</button>
+      </div>
+      <ul class="shortcuts" id="keyword-shortcuts-container">
+      </ul>
+    </div>
+</script>
+<script id="keyword-shortcuts-template" type="text/x-jquery-tmpl">
+    {{each keywords}}
+    {{if !$value.hidden}}
+    <li>
+    <a href="#${encodeURIComponent($value.name)}"
+       onclick="closeMenu()"
+       class="match"
+       title="${$value.shortdoc}">${$value.name}</a>
+    </li>
+    {{/if}}
+    {{/each}}
+    {{each keywords}}
+    {{if $value.hidden}}
+    <li>
+    <a href="#${encodeURIComponent($value.name)}"
+       onclick="closeMenu()"
+       class="no-match"
+       title="${$value.shortdoc}">${$value.name}</a>
+    </li>
+    {{/if}}
+    {{/each}}
+</script>
+<script id="tags-shortcuts-template" type="text/x-jquery-tmpl">
+  <option value="javascript:clearTagSearch()" {{if selectedTag === ""}}selected{{/if}}>- Show all tags -</option>
+  {{each tags}}
+    <option value="javascript:tagSearch('${$value}')" {{if selectedTag === $value}}selected{{/if}}>${$value}</a>
+    </option>
+  {{/each}}
+</script>
+<script id="keywords-template" type="text/x-jquery-tmpl">
+    <h2 id="Keywords">Keywords</h2>
+    <div class="keywords">
+        {{each keywords}}
+        {{if !$value.hidden}}
+            {{tmpl($value) 'keyword-template'}}
+        {{/if}}
+        {{/each}}
+        {{each keywords}}
+        {{if $value.hidden}}
+            {{tmpl($value) 'keyword-template'}}
+        {{/if}}
+        {{/each}}
+    </div>
+</script>
+<script id="keyword-template" type="text/x-jquery-tmpl">
+    <div class="keyword-container {{if hidden}}no-{{/if}}match" id="${name}">
+       <div class="keyword-name">
+            <h2>
+            <a class="kw-name" href="#${encodeURIComponent(name)}"
+               title="Link to this keyword">${name}</a>
+            </h2>
+       </div>
+       <div class="keyword-content">
+          <div class="kw-overview">
+            {{if args.length}}
+              <div class="args">
+                <h4>Arguments</h4>
+                <div class="arguments-list-container">
+                  <div class="arguments-list">
+                  {{each args}}
+                    {{tmpl($value) 'argument-template'}}
+                  {{/each}}
+                  </div>
+                </div>
+              </div>
+            {{/if}}
+            {{if returnType}}
+            <div class="return-type">
+              <h4>Return Type</h4>
+              <span class="arg-type">
+              {{tmpl(returnType) 'type-info-template'}}
+              </span>
+            </div>
+            {{/if}}
+            {{if libdoc.tags.length && tags.length}}
+              <div class="tags">
+                <h4>Tags</h4>
+                <span class="kw-tags">
+                {{each tags}}
+                  <a href="javascript:tagSearch('${$value}')"
+                    title="Show keywords with this tag">${$value}</a>{{if $index < tags.length-1}},<br>{{/if}}
+                {{/each}}
+                </span>
+              </div>
+            {{/if}}
+          </div>
+          {{if doc}}
+            <div class="kw-docs">
+              <h4>Documentation</h4>
+              <div class="kwdoc doc">{{html doc}}</div>
+            </div>
+          {{/if}}
+       </div>
+    </div>
+</script>
+<script id="argument-template" type="text/x-jquery-tmpl">
+<span class="arg-name {{if required}}arg-required{{else}}arg-optional{{/if}}" title="Argument name">
+{{if kind === 'VAR_POSITIONAL'}}<span class="arg-kind" title="Variable number of arguments">*</span>{{/if}}
+{{if kind === 'VAR_NAMED'}}<span class="arg-kind" title="Variable number of named arguments">**</span>{{/if}}
+{{if kind === 'NAMED_ONLY'}}<span class="arg-kind" title="Named only argument">&#x1F3F7;</span>{{/if}}
+{{if kind === 'POSITIONAL_ONLY'}}<span class="arg-kind" title="Positional only argument">&#x27F6;</span>{{/if}}
+${name}
+</span>
+
+{{if defaultValue !== null}}
+  <div class="arg-default-container">
+    <span class="arg-default-eq">=</span>
+    <span class="arg-default-value" title="Default value that is used if no value is given">${defaultValue}</span>
+  </div>
+{{/if}}
+
+{{if type}}
+  <span class="arg-type">
+      {{tmpl(type) 'type-info-template'}}
+  </span>
+{{/if}}
+</script>
+<script id="type-info-template" type="text/x-jquery-tmpl">
+  <!-- Store last index to variable. Checking it the 'each' loop didn't work. -->
+  ${$item.lastIndex=nested.length-1, ""}
+  {{if union}}
+    {{each nested}}
+      {{tmpl($value) 'type-info-template'}}
+      {{if $index < $item.lastIndex}}|{{/if}}
+    {{/each}}
+  {{else}}
+    {{if typedoc}}
+      <a style="cursor: pointer;" class="type" title="Click to show type information" onclick="showModal(document.querySelector('#type-modal-${typedoc}'))">${name}</a>
+    {{else}}
+      <span class="type">${name}</span>
+    {{/if}}
+    {{if nested.length}}
+      [
+      {{each nested}}
+        {{tmpl($value) 'type-info-template'}}
+        {{if $index < $item.lastIndex}},{{/if}}
+      {{/each}}
+      ]
+    {{/if}}
+  {{/if}}
+</script>
+<script id="data-types-template" type="text/x-jquery-tmpl">
+  {{if typedocs.length}}
+    <h2 id="Data types">Data types</h2>
+    <div class="data-types">
+      {{each typedocs}}
+        {{tmpl($value) 'data-type-template'}}
+      {{/each}}
+    </div>
+  {{/if}}
+</script>
+<script id="data-type-template" type="text/x-jquery-tmpl">
+    <div class="data-type-container {{if hidden}}no-{{/if}}match" id="type-modal-${name}">
+       <div class="data-type-name">
+            <h2>${name} (${type})</h2>
+       </div>
+       <div class="data-type-content">
+          {{if doc}}
+            <div class="dt-docs">
+              <h4>Documentation</h4>
+              <div class="dtdoc doc">{{html doc}}</div>
+            </div>
+          {{/if}}
+          {{if members}}
+            <div class="dt-members">
+              <h4>Allowed Values</h4>
+              <ul class="enum-type-members">
+                {{each members}}
+                <li>
+                  <span class="enum-member">${$value.name}</span>
+                  {{if accepts.indexOf("integer") != -1}}
+                    &nbsp; (<span class="enum-member">${$value.value}</span>)
+                  {{/if}}
+                </li>
+                {{/each}}
+              </ul>
+            </div>
+          {{else items}}
+            <div class="dt-items">
+              <h4>Dictionary Structure</h4>
+                <div class="typed-dict-annotation">
+                <span class="typed-dict-item"
+                >{{{each items}}<br><span
+                  {{if required !== null}}
+                    class="td-item {{if required}}required-key{{else}}optional-key{{/if}}"
+                    title="{{if required}}required-key{{else}}optional-key{{/if}}"
+                  {{else}}
+                    class="td-item"
+                  {{/if}}
+                 >'${key}': </span>
+                   <span class="td-type">&lt;${type}&gt;</span>{{/each}}<br>}</span>
+                </div>
+            </div>
+          {{/if}}
+          {{if accepts.length}}
+            <div class="dt-docs">
+              <h4>Converted Types</h4>
+              <ul class="dt-usages-list">
+              {{each accepts}}
+                <li>${$value}</li>
+              {{/each}}
+              </ul>
+            </div>
+          {{/if}}
+          {{if usages.length}}
+            <div class="dt-usages">
+              <h4>Usages</h4>
+              <ul class="dt-usages-list">
+                {{each usages}}
+                  <li><a href="#${encodeURIComponent($value)}">${$value}</a></li>
+                {{/each}}
+              </ul>
+            </div>
+          {{/if}}
+       </div>
+    </div>
+</script>
+<script id="footer-template" type="text/x-jquery-tmpl">
+    <p class="footer">
+        Generated by <a href="http://robotframework.org/robotframework/#built-in-tools">Libdoc</a> on ${generated}.
+    </p>
+</script>
+</body>
+</html>