From c469cf7ef75c5ce0e439cb5a59e842ce2a31fe66 Mon Sep 17 00:00:00 2001
From: Tatu Aalto <aalto.tatu@gmail.com>
Date: Thu, 25 Mar 2021 20:59:32 +0200
Subject: [PATCH] Add old docs to repo.

---
 docs/versions/Browser-4.1.0.html | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/versions/Browser-4.1.0.html b/docs/versions/Browser-4.1.0.html
index 8366692e6..8048acdd4 100644
--- a/docs/versions/Browser-4.1.0.html
+++ b/docs/versions/Browser-4.1.0.html
@@ -7,7 +7,7 @@
 <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 4.0 (Python 3.9.2 on linux)" name="Generator"/>
+<meta content="Robot Framework 4.0 (Python 3.8.5 on linux)" 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" type="text/css">
 :root {
@@ -1102,7 +1102,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 = {"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=\"#Finding%20elements\" class=\"name\">Finding elements</a></li>\n<li><a href=\"#Assertions\" class=\"name\">Assertions</a></li>\n<li><a href=\"#Automatic%20page%20and%20context%20closing\" class=\"name\">Automatic page and context closing</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=\"#Extending%20Browser%20library%20with%20a%20JavaScript%20module\" class=\"name\">Extending Browser library with a JavaScript module</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n<li><a href=\"#Data%20types\" class=\"name\">Data types</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. Theres is not 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 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>The context layer is useful e.g. for testing different users 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>If there is no browser opened in Suite Setup and <a href=\"#New%20Page\" class=\"name\">New Page</a> is executed in Test Setup, the corresponding pages and context is closed automatically at the end of the test. The browser process remains open and will be closed at the end of execution.</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 dictionary.</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.</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<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>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class\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 concatination of different selectors seperated 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 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 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=\"Frames\">Frames</h3>\n<p>By default, selector chains do not cross frame boundaries. It means that a simple CSS selector is not able to select and element located inside an iframe or a frameset. For this usecase, 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.</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, non 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, 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 nessesary 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 an element by using <a href=\"#Get%20Element\" class=\"name\">Get Element</a> keyword. 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          element=${ref} &gt;&gt; .some_child\n</pre>\n<p>The <span class=\"name\">.some_child</span> selector in the example is relative to the element referenced by ${ref}.</p>\n<h2 id=\"Assertions\">Assertions</h2>\n<p>Keywords that accept arguments <code>assertion_operator</code> &lt;<a href=\"#AssertionOperator\" class=\"name\">AssertionOperator</a>&gt; and <code>assertion_expected</code> can optionally assert. 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>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><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>But default the keywords will provide an error message if the assertion fails, but default error message 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 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 same type. If types are not 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 returnd 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 filter and a number when filtered. These Keywords do autoconvert the expected value if a number is returned.</p>\n<p>* &lt; less or greater &gt; With Strings* Compairisons of strings with <code>greater than</code> or <code>less than</code> compares each character, starting from 0 reagarding 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']                     # Compairsion of numbers\nGet Page State    validate    \"IMPORTANT MESSAGE!\" == value['message']  # Compairsion 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=\"Automatic page and context closing\">Automatic page and context closing</h2>\n<p>Library will close pages and contexts that are created during test execution. Pages and contexts created before test in Suite Setup or Suite Teardown will be closed after that suite. This will remove the burden of closing these resources in teardowns.</p>\n<p>Browsers will not be automatically closed. A browser is expensive to create and should be reused.</p>\n<p>Automatic closing can be configured or switched off with the <code>auto_closing_level</code> library parameter.</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. 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 Browser package is <code>PLAYWRIGHT_BROWSERS_PATH=0 node Browser/wrapper/index.js PORT</code>. <code>PORT</code> is 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=\"Extending Browser library with a JavaScript module\">Extending Browser library with a JavaScript module</h2>\n<p>Browser library can be extended with JavaScript. 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(page, args, logger, playwright) {\n  logger(args.toString())\n  playwright.coolNewFeature()\n  return await page.goto(args[0]);\n}\n</pre>\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>: list of strings from Robot Framework keyword call.</p>\n<p>!! A BIT UNSTABLE AND SUBJECT TO API CHANGES !! <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<h3 id=\"Example module.js\">Example module.js</h3>\n<pre>\nasync function myGoToKeyword(page, args) {\n  await page.goto(args[0]);\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 withm custom selector with a js module</p>\n<h3 id=\"Example module keyword for custom selector registerin\">Example module keyword for custom selector registerin</h3>\n<pre>\nasync function registerMySelector(page, args, log, 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>", "version": "4.1.0", "generated": "2021-03-25 09:58:33", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/__init__.py", "lineno": 54, "tags": ["Assertion", "BrowserControl", "Config", "Getter", "HTTP", "PageContent", "Setter", "Wait"], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": "0:00:10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = 0:00:10"}, {"name": "enable_playwright_debug", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "enable_playwright_debug: bool = False"}, {"name": "auto_closing_level", "types": ["AutoClosingLevel"], "defaultValue": "TEST", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "auto_closing_level: AutoClosingLevel = TEST"}, {"name": "retry_assertions_for", "types": ["timedelta"], "defaultValue": "0:00:01", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "retry_assertions_for: timedelta = 0:00:01"}, {"name": "run_on_failure", "types": ["str"], "defaultValue": "Take Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure: str = Take Screenshot"}, {"name": "external_browser_executable", "types": ["Dict[Browser.utils.data_types.SupportedBrowsers, str]", "None"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "external_browser_executable: Dict[Browser.utils.data_types.SupportedBrowsers, str] | None = None"}, {"name": "jsextension", "types": ["str", "None"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "jsextension: str | None = None"}, {"name": "enable_presenter_mode", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "enable_presenter_mode: bool = False"}], "doc": "<p>Browser library can be taken into use with optional arguments:</p>\n<ul>\n<li><code>timeout</code> &lt;str&gt; 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.</li>\n<li><code>enable_playwright_debug</code> &lt;bool&gt; Enable low level debug information from the playwright tool. Mainly Useful for the library developers and for debugging purposes.</li>\n<li><code>auto_closing_level</code> &lt; <code>SUITE</code> | <code>TEST</code> | <code>MANUAL</code> &gt; Configure context and page automatic closing. Default is after each test. Other options are SUITE for closing after each suite and MANUAL for no automatic closing.</li>\n<li><code>retry_assertions_for</code> &lt;str&gt; 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.</li>\n<li><code>run_on_failure</code> &lt;str&gt; Sets the keyword to execute in case of a failing Browser keyword. It can be the name of any keyword that does not have any mandatory argument. If no extra action should be done after a failure, set it to <code>None</code> or any other robot falsy value.</li>\n<li><code>external_browser_executable</code> &lt;Dict &lt;SupportedBrowsers, Path&gt;&gt; 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.</li>\n<li><code>jsextension</code> &lt;str&gt; Path to Javascript module exposed as extra keywords. Module must be in CommonJS.</li>\n<li><code>enable_presenter_mode</code> &lt;bool&gt; Automatic highlights to interacted components, slowMo and a small pause at the end.</li>\n</ul>", "shortdoc": "Browser library can be taken into use with optional arguments:", "tags": [], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/browser.py", "lineno": 629}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}, {"name": "domain", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str = None"}, {"name": "path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str = None"}, {"name": "expires", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expires: str = None"}, {"name": "httpOnly", "types": ["bool"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "httpOnly: bool = None"}, {"name": "secure", "types": ["bool"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool = None"}, {"name": "sameSite", "types": ["CookieSameSite"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sameSite: CookieSameSite = None"}], "doc": "<p>Adds a cookie to currently active browser context.</p>\n<p><code>name</code> Name of the cookie.</p>\n<p><code>value</code> Given value for the cookie.</p>\n<p><code>url</code> Given url for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</p>\n<p><code>domain</code> Given domain for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</p>\n<p><code>path</code> Given path for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</p>\n<p><code>expires</code> 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.</p>\n<ul>\n<li>example: 2027-09-28 16:21:35</li>\n</ul>\n<p><code>httpOnly</code> Sets the httpOnly token.</p>\n<p><code>secure</code> Sets the secure token.</p>\n<p><code>samesite</code> Sets the samesite mode.</p>\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>   expiry=2027-09-28 16:21:35        # Expiry 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>   expiry=1822137695                 # Expiry as epoch seconds.\n</pre>", "shortdoc": "Adds a cookie to currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/cookie.py", "lineno": 90}, {"name": "Add Style Tag", "args": [{"name": "content", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "content: str"}], "doc": "<p>Adds a &lt;style type=\"text/css\"&gt; tag with the content.</p>\n<p><code>content</code> Raw CSS content to be injected into frame.</p>", "shortdoc": "Adds a <style type=\"text/css\"> tag with the content.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 85}, {"name": "Check Checkbox", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Checks the checkbox or selects radio button found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Does nothing if the element is already checked/selected.</p>", "shortdoc": "Checks the checkbox or selects radio button found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 477}, {"name": "Clear Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Clears the text field found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for emulating typing text character by character. See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for direct filling of the full text at once.</p>", "shortdoc": "Clears the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 104}, {"name": "Click", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "types": ["MouseButton"], "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "clickCount", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = None"}, {"name": "position_x", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_x: float = None"}, {"name": "position_y", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_y: float = None"}, {"name": "force", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "modifiers", "types": ["KeyboardModifier"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}], "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=\"#MouseButton\" 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<p><code>selector</code> Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>button</code> Defaults to <code>left</code> if invalid.</p>\n<p><code>clickCount</code> Defaults to 1.</p>\n<p><code>delay</code> Time to wait between mouse-down and mouse-up. Defaults to 0.</p>\n<p><code>position_x</code> &amp; <code>position_y</code> 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.</p>\n<p><code>force</code> Set to True to skip Playwright's <a href=\"https://playwright.dev/docs/actionability\">Actionability checks</a>.</p>\n<p><code>noWaitAfter</code> 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>.</p>\n<p><code>*modifiers</code> 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.</p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 251}, {"name": "Close Browser", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Closes the current browser. Activated browser is set to first active browser. 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<p><code>browser</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; If value is not <code>CURRENT</code> it should be a string referencing the id of the browser to be closed. If <code>ALL</code> is provided <span class=\"name\">Close All Browsers</span> is executed.</p>", "shortdoc": "Closes the current browser. Activated browser is set to first active browser. Closes all context and pages belonging to this browser. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 101}, {"name": "Close Context", "args": [{"name": "context", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: str = CURRENT"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Closes a Context. Activated context is set to first active context. 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<p><code>context</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Close context with specified id. If <code>ALL</code> is passed, all contexts of the specified browser are closed. Defaults to CURRENT.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Close context in specified browser. If value is not \"CURRENT\" it should be a string referencing the id of the browser where to close context.</p>", "shortdoc": "Closes a Context. Activated context is set to first active context. Closes pages belonging to this context. See `Browser, Context and Page` for more information about Context and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 125}, {"name": "Close Page", "args": [{"name": "page", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: str = CURRENT"}, {"name": "context", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: str = CURRENT"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Closes the <code>page</code> in <code>context</code> in <code>browser</code>. Defaults to current for all three. Activated page is set to first active 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<p><code>page</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Id of the page to close. If value is not \"CURRENT\" it should be a string referencing the id of the context where to close page. If <code>ALL</code> is passed, all pages of the given context are closed. Defaults to CURRENT.</p>\n<p><code>context</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Id of the context that belongs to the page to be closed. If <code>ALL</code> is passed, the requested pages of all contexts are closed. Defaults to CURRENT.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Id of the browser that belongs to the page to be closed. If <code>ALL</code> is passed, the requested pages depending of the context of all browsers are closed. Defaults to CURRENT.</p>", "shortdoc": "Closes the ``page`` in ``context`` in ``browser``. Defaults to current for all three. Activated page is set to first active page. See `Browser, Context and Page` for more information about Page and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 175}, {"name": "Connect To Browser", "args": [{"name": "wsEndpoint", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}, {"name": "browser", "types": ["SupportedBrowsers"], "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}], "doc": "<p>Connect to a playwright 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<p>Returns a stable identifier for the connected browser.</p>\n<p><code>wsEndpoint</code> Address to connect to.</p>\n<p><code>browser</code> Opens the specified browser. Defaults to chromium.</p>", "shortdoc": "Connect to a playwright Browser. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 236}, {"name": "Delete All Cookies", "args": [], "doc": "<p>Deletes all cookies from the currently active browser context.</p>", "shortdoc": "Deletes all cookies from the currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/cookie.py", "lineno": 151}, {"name": "Deselect Options", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Deselects all options from select element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the select tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>", "shortdoc": "Deselects all options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 535}, {"name": "Download", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}], "doc": "<p>Download given url content.</p>\n<p>Keyword returns dictionary which contains downloaded file path and suggested filename as keys (saveAs and suggestedFilename). See <a href=\"#Wait%20For%20Download\" class=\"name\">Wait For Download</a> for more details.</p>", "shortdoc": "Download given url content.", "tags": ["Page Content"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 95}, {"name": "Drag And Drop", "args": [{"name": "selector_from", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "selector_to", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_to: str"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "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>. 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><code>selector_from</code> identifies the element, which center is the start-point.</p>\n<p><code>selector_to</code> identifies the element, which center is the end-point.</p>\n<p><code>steps</code> defines how many intermediate mouse move events are sent.</p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to the element selected by ``selector_to``. See the `Finding elements` section for details about the selectors.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 655}, {"name": "Drag And Drop By Coordinates", "args": [{"name": "from_x", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_x: float"}, {"name": "from_y", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_y: float"}, {"name": "to_x", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_x: float"}, {"name": "to_y", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_y: float"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "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<p><code>from_x</code> &amp; <code>from_y</code> identify the the start-point.</p>\n<p><code>to_x</code> &amp; <code>to_y</code> identify the the end-point.</p>\n<p><code>steps</code> defines how many intermediate mouse move events are sent.</p>", "shortdoc": "Executes a Drag&Drop operation from a coordinate to another coordinate.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 682}, {"name": "Eat All Cookies", "args": [], "doc": "<p>Eat all cookies for all easter.</p>", "shortdoc": "Eat all cookies for all easter.", "tags": [], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/cookie.py", "lineno": 158}, {"name": "Execute JavaScript", "args": [{"name": "function", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: str"}, {"name": "selector", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}], "doc": "<p>Executes given javascript on the page.</p>\n<p><code>function</code> A valid javascript function or a javascript function body. For example <code>() =&gt; true</code> and <code>true</code> will behave similarly.</p>\n<p><code>selector</code> 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.</p>\n<p><a href=\"https://github.com/MarketSquare/robotframework-browser/tree/master/atest/test/06_Examples/js_evaluation.robot\">Usage examples.</a></p>", "shortdoc": "Executes given javascript on the page.", "tags": ["Getter", "PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 28}, {"name": "Fill Secret", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}], "doc": "<p>Fills 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 <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><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>secret</code> 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.</p>\n<p>Example: <code>$Password</code> and <code>${Password}</code> resolve the robot framework variable. <code>%ENV_PWD</code> and <code>%{ENV_PWD}</code> resolve to the environment variable <code>ENV_PWD</code>.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for other details.</p>", "shortdoc": "Fills the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 177}, {"name": "Fill Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}], "doc": "<p>Clears and fills the given <code>text</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>text</code> to clear the input field.</p>\n<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>txt</code> Text for the text field.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for emulating typing text character by character.</p>", "shortdoc": "Clears and fills the given ``text`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 82}, {"name": "Focus", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Moves focus on to the element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the element. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</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>", "shortdoc": "Moves focus on to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 374}, {"name": "Get Attribute", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the HTML <code>attribute</code> of the element found by <code>selector</code>.</p>\n<p>Optionally asserts that the attribute value matches the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>attribute</code> Requested attribute name.</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><code>message</code> overrides the default error message.</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>\nGet Attribute   id=enabled_button    disabled                   # FAIL =&gt; \"Attribute 'disabled' not found!\"\nGet Attribute   id=enabled_button    disabled     ==    None     # PASS =&gt; returns: None\nGet Attribute   id=enabled_button    something    evaluate    value is not None    # PASS =&gt;  returns: True\nGet Attribute   id=enabled_button    disabled     evaluate    value is None        # PASS =&gt;  returns: True\n</pre>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Returns the HTML ``attribute`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 221}, {"name": "Get Attribute Names", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "types": ["str", "None"], "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "doc": "<p>Returns all HTML attribute names of an element as a list.</p>\n<p>Optionally asserts that these match the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> and <code>!=</code> can work with multiple values</li>\n<li><code>contains</code> / <code>*=</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns all HTML attribute names of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 277}, {"name": "Get BoundingBox", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "types": ["BoundingBoxFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: BoundingBoxFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets elements size and location as an object <code>{x: float, y: float, width: float, height: float}</code>.</p>\n<p><code>selector</code> Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>key</code> 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>.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p>Example use:</p>\n<pre>\n${bounding_box}=    Get BoundingBox    id=element                 # unfiltered\nLog                 ${bounding_box}                               # {'x': 559.09375, 'y': 75.5, 'width': 188.796875, 'height': 18}\n${x}=               Get BoundingBox    id=element    x            # filtered\nLog                 X: ${x}                                       # X: 559.09375\n# Assertions:\nGet BoundingBox     id=element         width         &gt;    180\nGet BoundingBox     id=element         ALL           validate    value['x'] &gt; value['y']*2\n</pre>", "shortdoc": "Gets elements size and location as an object ``{x: float, y: float, width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 685}, {"name": "Get Browser Catalog", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns all browsers, open contexts in them and open pages in these contexts. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about these concepts.</p>\n<p><code>message</code> overrides the default error message.</p>\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>", "shortdoc": "Returns all browsers, open contexts in them and open pages in these contexts. See `Browser, Context and Page` for more information about these concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 593}, {"name": "Get Browser Ids", "args": [{"name": "browser", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "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<p>The ACTIVE browser is a synonym for the CURRENT Browser.</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/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 747}, {"name": "Get Checkbox State", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "expected_state", "types": ["bool", "str"], "defaultValue": "Unchecked", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expected_state: bool | str = Unchecked"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the state of the checkbox found by <code>selector</code>.</p>\n<p><code>selector</code> Selector which shall be examined. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Optionally asserts that the state matches the specified assertion.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<ul>\n<li><code>==</code> and <code>!=</code> and equivalent are allowed on boolean values</li>\n<li>other operators are not accepted.</li>\n</ul>\n<p><code>expected_state</code> 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</p>\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><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the state of the checkbox found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 471}, {"name": "Get Classes", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "types": ["str", "None"], "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "doc": "<p>Returns all classes of an element as a list.</p>\n<p>Optionally asserts that the value matches the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> and <code>!=</code> can work with multiple values</li>\n<li><code>contains</code> / <code>*=</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>", "shortdoc": "Returns all classes of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 311}, {"name": "Get Client Size", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "key", "types": ["SizeFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets elements or pages client size (<code>clientHeight</code>, <code>clientWidth</code>) as object {width: float, height: float}.</p>\n<p><code>selector</code> 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.</p>\n<p><code>key</code> 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.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</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>", "shortdoc": "Gets elements or pages client size (``clientHeight``, ``clientWidth``) as object {width: float, height: float}.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 843}, {"name": "Get Context Ids", "args": [{"name": "context", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "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<p><code>context</code> Defaults to <code>ALL</code></p>\n<ul>\n<li><code>ALL</code> Returns all context ids as a list.</li>\n<li><code>ACTIVE</code> Returns the id of the active context as a list.</li>\n</ul>\n<p><code>browser</code> Defaults to <code>ALL</code></p>\n<ul>\n<li><code>ALL</code> context ids from all open browsers shall be fetched.</li>\n<li><code>ACTIVE</code> only context ids from the active browser shall be fetched.</li>\n</ul>\n<p>The ACTIVE context of the ACTIVE Browser is the <code>Current</code> Context.</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/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 767}, {"name": "Get Cookie", "args": [{"name": "cookie", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "cookie: str"}, {"name": "return_type", "types": ["CookieType"], "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "doc": "<p>Returns information of cookie with <code>name</code> as a Robot Framework dot dictionary or a string.</p>\n<p><code>cookie</code> Name of the cookie to be retrieved.</p>\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>expiry</td>\n<td>Lifetime of a cookie. Returned as datatime object.</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}=        Get Cookie              Foobar\nShould Be Equal   ${cookie.value}         Tidii\nShould Be Equal   ${cookie.expiry.year}   ${2020}\n</pre>", "shortdoc": "Returns information of cookie with ``name`` as a Robot Framework dot dictionary or a string.", "tags": ["BrowserControl", "Getter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/cookie.py", "lineno": 174}, {"name": "Get Cookies", "args": [{"name": "return_type", "types": ["CookieType"], "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "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>", "shortdoc": "Returns cookies from the current active browser context.", "tags": ["Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/cookie.py", "lineno": 29}, {"name": "Get Device", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "doc": "<p>Get a single device decriptor with name exactly matching name.</p>\n<p><code>name</code> Given name of the requested device. See Playwright's <a href=\"https://github.com/Microsoft/playwright/blob/master/src/server/deviceDescriptors.ts\">deviceDescriptors.ts</a> for a formatted list.</p>\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}=          Get Device       iPhone X\nNew Context         &amp;{device}\nNew Page\nGet Viewport Size   # returns { \"width\": 375, \"height\": 812 }\n</pre>", "shortdoc": "Get a single device decriptor with name exactly matching name.", "tags": ["BrowserControl", "Getter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/device_descriptors.py", "lineno": 37}, {"name": "Get Devices", "args": [], "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/src/server/deviceDescriptors.ts\">deviceDescriptors.ts</a> for a formatted list.</p>", "shortdoc": "Returns a dict of all playwright device descriptors.", "tags": ["BrowserControl", "Getter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/device_descriptors.py", "lineno": 25}, {"name": "Get Element", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Returns a reference to a Playwright element handle.</p>\n<p>The reference can be used in subsequent selectors.</p>\n<p><code>selector</code> Selector from which shall be retrieved . See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>", "shortdoc": "Returns a reference to a Playwright element handle.", "tags": ["Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 603}, {"name": "Get Element Count", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "expected_value", "types": ["int", "str"], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expected_value: int | str = 0"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the count of elements found with <code>selector</code>.</p>\n<p>Optionally asserts that the count matches the specified assertion.</p>\n<p><code>selector</code> Selector which shall be counted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<p><code>expected_value</code> Expected value for the counting</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the count of elements found with ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 518}, {"name": "Get Element State", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "state", "types": ["ElementStateKey"], "defaultValue": "visible", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: ElementStateKey = visible"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: bool = True"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Get the given state from the element found by <code>selector</code>.</p>\n<p>If the selector does satisfy the expected state it will return <code>True</code> otherwise <code>False</code>.</p>\n<p><code>selector</code> Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>state</code> Defaults to visible. Possible states are:</p>\n<ul>\n<li><code>attached</code> : to be present in DOM.</li>\n<li><code>visible</code> : to have non-empty bounding box and no visibility:hidden.</li>\n<li><code>disabled</code> : 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;.</li>\n<li><code>readonly</code> : to be <code>readOnly</code>. Can be used on &lt;input&gt; and &lt;textarea&gt;.</li>\n<li><code>selected</code> : to be <code>selected</code>. Can be used on &lt;option&gt;.</li>\n<li><code>focused</code> : to be the <code>activeElement</code>.</li>\n<li><code>checked</code> : to be <code>checked</code> . Can be used on &lt;input&gt;.</li>\n</ul>\n<p>Note that element must be attached to DOM to be able to fetch the state of <code>readonly</code> , <code>selectec</code> and <code>checked</code>. The other states are false if the requested element is not attached.</p>\n<p>Note that element without any content or with display:none has an empty bounding box and is not considered visible.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Get the given state from the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 889}, {"name": "Get Elements", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Returns a reference to playwright element handle for all matched elements by <code>selector</code>.</p>\n<p><code>selector</code> Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>", "shortdoc": "Returns a reference to playwright element handle for all matched elements by ``selector``.", "tags": ["Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 616}, {"name": "Get Page Ids", "args": [{"name": "page", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType = ALL"}, {"name": "context", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "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<p><code>page</code></p>\n<ul>\n<li><code>ALL</code> Returns all page ids as a list.</li>\n<li><code>ACTIVE</code> Returns the id of the active page as a list.</li>\n</ul>\n<p><code>context</code></p>\n<ul>\n<li><code>ALL</code> page ids from all contexts shall be fetched.</li>\n<li><code>ACTIVE</code> only page ids from the active context shall be fetched.</li>\n</ul>\n<p><code>browser</code></p>\n<ul>\n<li><code>ALL</code> page ids from all open browsers shall be fetched.</li>\n<li><code>ACTIVE</code> only page ids from the active browser shall be fetched.</li>\n</ul>\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}=   Get Page IDs    ACTIVE    ACTIVE    ACTIVE\n    Log                Current page ID is: ${current_page}[0]\n    ${all_pages}=      Get Page IDs    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>", "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/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 812}, {"name": "Get Page Source", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets pages HTML source as a string.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>Optionally does a string assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Gets pages HTML source as a string.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 100}, {"name": "Get Property", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "property", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "property: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the <code>property</code> of the element found by <code>selector</code>.</p>\n<p>Optionally asserts that the property value matches the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>property</code> Requested property name.</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>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the ``property`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 175}, {"name": "Get Scroll Position", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "key", "types": ["AreaFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: AreaFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "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<p><code>top</code> uses js function scrollTop, <code>left</code> uses scrollLeft and <code>bottom</code> and <code>right</code> are calculated with the client size.</p>\n<p><code>selector</code> 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.</p>\n<p><code>key</code> 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.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</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>", "shortdoc": "Gets elements or pages current scroll position as object ``{top: float, left: float, bottom: float, right: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 788}, {"name": "Get Scroll Size", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "key", "types": ["SizeFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets elements or pages scrollable size as object <code>{width: float, height: float}</code>.</p>\n<p><code>selector</code> 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.</p>\n<p><code>key</code> 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.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</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}=         Get Scroll Size    height                          # filtered page by height\nLog                Width: ${height}                                   # Height: 58425\n${scroll_size}=    Get Scroll Size    id=keyword-shortcuts-container  # unfiltered element\nLog                ${scroll_size}                                     # {'width': 253, 'height': 3036}\n</pre>", "shortdoc": "Gets elements or pages scrollable size as object ``{width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 736}, {"name": "Get Select Options", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns attributes of options of a <code>select</code> element as a list of dictionaries. Returned dictionaries have the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<p>Optionally asserts that these match the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</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>", "shortdoc": "Returns attributes of options of a ``select`` element as a list of dictionaries. Returned dictionaries have the following keys and their values \"index\", \"value\", \"label\" and \"selected\".", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 363}, {"name": "Get Selected Options", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "option_attribute", "types": ["SelectAttribute"], "defaultValue": "label", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "option_attribute: SelectAttribute = label"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}], "doc": "<p>Returns the specified attribute of selected options of the <code>select</code> element.</p>\n<p>Optionally asserts that these match the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>option_attribute</code> Which attribute shall be returned/verified. Defaults to label.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<ul>\n<li><code>==</code> and <code>!=</code> can work with multiple values</li>\n<li><code>contains</code> / <code>*=</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>", "shortdoc": "Returns the specified attribute of selected options of the ``select`` element.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 410}, {"name": "Get Style", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "types": ["str"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: str = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "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<p><code>selector</code> 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.</p>\n<p><code>key</code> Key of the requested CSS property. Retrieves \"ALL\" styles by default.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Gets the computed style properties of the element selected by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 639}, {"name": "Get Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns text attribute of the element found by <code>selector</code>. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Optionally asserts that the text matches the specified assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns text attribute of the element found by ``selector``. See the `Finding elements` section for details about the selectors.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 148}, {"name": "Get Textfield Value", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p><b>DEPRECATED!!</b> Use keyword <a href=\"#Get%20Text\" class=\"name\">Get Text</a> instead.</p>", "shortdoc": "*DEPRECATED!!* Use keyword `Get Text` instead.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 345}, {"name": "Get Title", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the title of the current page.</p>\n<p>Optionally asserts that it matches the specified assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the title of the current page.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 124}, {"name": "Get Url", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the current URL.</p>\n<p>Optionally asserts that it matches the specified assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the current URL.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 45}, {"name": "Get Viewport Size", "args": [{"name": "key", "types": ["SizeFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the current viewport dimensions.</p>\n<p>Optionally asserts that the count matches the specified assertion.</p>\n<p><code>key</code> 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>.</p>\n<p><code>message</code> overrides the default error message.</p>\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>\nGet Viewport Size    ALL    ==    {'width':1280, 'height':720}\nGet Viewport Size    width    &gt;=    1200\n</pre>", "shortdoc": "Returns the current viewport dimensions.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/getters.py", "lineno": 553}, {"name": "Go Back", "args": [], "doc": "<p>Navigates to the previous page in history.</p>", "shortdoc": "Navigates to the previous page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 38}, {"name": "Go Forward", "args": [], "doc": "<p>Navigates to the next page in history.</p>", "shortdoc": "Navigates to the next page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 31}, {"name": "Go To", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Navigates to the given <code>url</code>.</p>\n<p><code>url</code> &lt;str&gt; URL to be navigated to. <code>timeout</code> &lt;str&gt; time to wait page to load. If not defined will use the the library default timeout.</p>", "shortdoc": "Navigates to the given ``url``.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 45}, {"name": "Handle Future Dialogs", "args": [{"name": "action", "types": ["DialogAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}], "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<p><code>action</code> How to handle the alert.</p>\n<p><code>prompt_input</code> The value to enter into prompt. Only valid if <code>action</code> equals accept. Defaults to empty string.</p>\n<p>Example:</p>\n<pre>\nHandle Future Dialogs    action=accept\nClick                    \\#alerts\n</pre>", "shortdoc": "Handle next dialog on page with ``action``.", "tags": ["PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 578}, {"name": "Highlight Elements", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "duration", "types": ["timedelta"], "defaultValue": "0:00:05", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration: timedelta = 0:00:05"}, {"name": "width", "types": ["str"], "defaultValue": "2px", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width: str = 2px"}, {"name": "style", "types": ["str"], "defaultValue": "dotted", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = dotted"}, {"name": "color", "types": ["str"], "defaultValue": "blue", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "color: str = blue"}], "doc": "<p>Adds a highlight to elements matched by the <code>selector</code>. Provides a style adjustment.</p>\n<p><code>selector</code> Selectors which shall be highlighted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</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. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></p>", "shortdoc": "Adds a highlight to elements matched by the ``selector``. Provides a style adjustment.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/evaluation.py", "lineno": 50}, {"name": "Hover", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "position_x", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_x: float = None"}, {"name": "position_y", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_y: float = None"}, {"name": "force", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}, {"name": "modifiers", "types": ["KeyboardModifier"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}], "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<p><code>selector</code> Selector element to hover. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>position_x</code> &amp; <code>position_y</code> 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.</p>\n<p><code>force</code> Set to True to skip Playwright's <a href=\"https://playwright.dev/docs/actionability\">Actionability checks</a>.</p>\n<p><code>*modifiers</code> 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.</p>", "shortdoc": "Moves the virtual mouse and scrolls to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 328}, {"name": "Http", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "types": ["RequestMethod"], "defaultValue": "GET", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "method: RequestMethod = GET"}, {"name": "body", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "body: str = None"}, {"name": "headers", "types": ["dict"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers: dict = None"}], "doc": "<p>Performs an HTTP request in the current browser context</p>\n<p>Accepts the following arguments:</p>\n<ul>\n<li><code>url</code> The request url, e.g. <code>/api/foo</code>.</li>\n<li><code>method</code> The HTTP method for the request. Defaults to GET.</li>\n<li><code>body</code> 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.</li>\n<li><code>headers</code> A dictionary of additional request headers. Defaults to None.</li>\n</ul>\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.</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}=             HTTP                       /api/endpoint\nShould Be Equal     ${res.status}              200\nShould Be Equal     ${res.body.some_field}     some value\n</pre>", "shortdoc": "Performs an HTTP request in the current browser context", "tags": ["HTTP"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/network.py", "lineno": 60}, {"name": "Keyboard Input", "args": [{"name": "action", "types": ["KeyboardInputAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyboardInputAction"}, {"name": "input", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input: str"}, {"name": "delay", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=0"}], "doc": "<p>Input text into page with virtual keyboard.</p>\n<p><code>action</code></p>\n<ul>\n<li><code>insertText</code> Dispatches only input event, does not emit the keydown, keyup or keypress events.</li>\n</ul>\n<ul>\n<li><code>type</code> Sends a keydown, keypress/input, and keyup event for each character in the text.</li>\n</ul>\n<p><code>input</code> The inputstring to be typed. No special keys possible.</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>", "shortdoc": "Input text into page with virtual keyboard.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 792}, {"name": "Keyboard Key", "args": [{"name": "action", "types": ["KeyAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyAction"}, {"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p>Press a keyboard key on the virtual keyboard or set a key up or down.</p>\n<p><code>action</code> Determine whether the key should be released, hold or pressed. <code>down</code> or <code>up</code> are useful for combinations i.e. with Shift.</p>\n<p><code>key</code> The key to be pressed. An example of valid keys are:</p>\n<p><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.</p>\n<p>Useful keys for <code>down</code> and <code>up</code> for example are:</p>\n<p><code>Shift</code>, <code>Control</code>, <code>Alt</code>, <code>Meta</code>, <code>ShiftLeft</code></p>\n<p>Example excecution:</p>\n<pre>\nKeyboard Key    press    S\nKeyboard Key    down     Shift\nKeyboard Key    press    ArrowLeft\nKeyboard Key    press    Delete\nKeyboard Key    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>", "shortdoc": "Press a keyboard key on the virtual keyboard or set a key up or down.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 758}, {"name": "LocalStorage Clear", "args": [], "doc": "<p>Remove all saved data from the local storage.</p>", "shortdoc": "Remove all saved data from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 89}, {"name": "LocalStorage Get Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Get saved data from the local storage.</p>\n<p><code>key</code> Named key of the item in the storage.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Get saved data from the local storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 29}, {"name": "LocalStorage Remove Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p>Remove saved data with key from the local storage.</p>\n<p><code>key</code> Name of the item which shall be deleted.</p>", "shortdoc": "Remove saved data with key from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 74}, {"name": "LocalStorage Set Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Save data to the local storage.</p>\n<p><code>key</code> The name of the key under which it should be saved.</p>\n<p><code>value</code> The value which shall be saved as a string.</p>", "shortdoc": "Save data to the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 57}, {"name": "Mouse Button", "args": [{"name": "action", "types": ["MouseButtonAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: MouseButtonAction"}, {"name": "x", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = None"}, {"name": "y", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = None"}, {"name": "button", "types": ["MouseButton"], "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "clickCount", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "types": ["int"], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int = 0"}], "doc": "<p>Clicks, presses or releases a mouse button.</p>\n<p><code>action</code> Determines if it is a mouseclick, holding down a key or releasing it.</p>\n<p><code>x</code> and <code>y</code> Coordinates to move before.</p>\n<p><code>button</code> Defaults to <code>left</code>.</p>\n<p><code>clickCount</code> Determine how often shall be clicked. Defaults to 1.</p>\n<p><code>delay</code> Delay in ms between the mousedown and mouseup event. Can only be set if the action is click.</p>\n<p>Moving the mouse between holding down and releasing it, is possible with <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>.</p>", "shortdoc": "Clicks, presses or releases a mouse button.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 607}, {"name": "Mouse Move", "args": [{"name": "x", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: float"}, {"name": "y", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: float"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "doc": "<p>Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.</p>\n<p><code>x</code> <code>y</code> are absolute coordinates starting at the top left of the page.</p>\n<p><code>steps</code> Number of intermediate steps for the mouse event.</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/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 742}, {"name": "Mouse Move Relative To", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "x", "types": ["float"], "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "types": ["float"], "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "doc": "<p>Moves the mouse cursor relative to the selected element.</p>\n<p><code>x</code> <code>y</code> are relative coordinates to the center of the elements bounding box.</p>\n<p><code>steps</code> Number of intermediate steps for the mouse event. This is sometime needed for websites to recognize the movement.</p>", "shortdoc": "Moves the mouse cursor relative to the selected element.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 713}, {"name": "New Browser", "args": [{"name": "browser", "types": ["SupportedBrowsers"], "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "executablePath", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "executablePath: str = None"}, {"name": "args", "types": ["List[str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "args: List[str] = None"}, {"name": "ignoreDefaultArgs", "types": ["List[str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignoreDefaultArgs: List[str] = None"}, {"name": "proxy", "types": ["Proxy"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy: Proxy = None"}, {"name": "downloadsPath", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "downloadsPath: str = None"}, {"name": "handleSIGINT", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "handleSIGHUP", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "0:00:30", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "env", "types": ["Dict"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "env: Dict = None"}, {"name": "devtools", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "devtools: bool = False"}, {"name": "slowMo", "types": ["timedelta"], "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "slowMo: timedelta = 0:00:00"}], "doc": "<p>Create a new playwright Browser with specified options. 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<p><code>browser</code> Opens the specified browser. Defaults to chromium.</p>\n<p><code>headless</code> Set to False if you want a GUI. Defaults to False.</p>\n<p><code>executablePath</code> 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.</p>\n<p><code>args</code> 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.</p>\n<p><code>ignoreDefaultArgs</code> If an array is given, then filters out the given default arguments. Defaults to None.</p>\n<p><code>proxy</code> Network proxy settings.</p>\n<ul>\n<li>server &lt;string&gt; Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example <code>http://myproxy.com:3128</code> or <code>socks5://myproxy.com:3128</code>. Short form <code>myproxy.com:3128</code> is considered an HTTP proxy.</li>\n<li>bypass &lt;string&gt; Optional coma-separated domains to bypass proxy, for example <code>\".com, chromium.org, .domain.com\"</code>.</li>\n<li>username &lt;string&gt; Optional username to use if HTTP proxy requires authentication.</li>\n<li>password &lt;string&gt; Optional password to use if HTTP proxy requires authentication.</li>\n</ul>\n<p><code>downloadsPath</code> If specified, accepted downloads are downloaded into this folder. Otherwise, temporary folder is created and is deleted when browser is closed.</p>\n<p><code>handleSIGINT</code> Close the browser process on Ctrl-C. Defaults to True.</p>\n<p><code>handleSIGTERM</code> Close the browser process on SIGTERM. Defaults to True.</p>\n<p><code>handleSIGHUP</code> Close the browser process on SIGHUP. Defaults to True.</p>\n<p><code>timeout</code> Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.</p>\n<p><code>env</code> &lt;Dict&lt;str, str|int|bool&gt;&gt; Specify environment variables that will be visible to the browser. Defaults to None.</p>\n<p><code>devtools</code> Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option is true, the headless option will be set false.</p>\n<p><code>slowMo</code> Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to no delay.</p>", "shortdoc": "Create a new playwright Browser with specified options. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 256}, {"name": "New Context", "args": [{"name": "acceptDownloads", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "acceptDownloads: bool = False"}, {"name": "ignoreHTTPSErrors", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "bypassCSP", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "viewport", "types": ["ViewportDimensions"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "viewport: ViewportDimensions = None"}, {"name": "userAgent", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "userAgent: str = None"}, {"name": "deviceScaleFactor", "types": ["float"], "defaultValue": "1.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "deviceScaleFactor: float = 1.0"}, {"name": "isMobile", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "isMobile: bool = False"}, {"name": "hasTouch", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "hasTouch: bool = False"}, {"name": "javaScriptEnabled", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "timezoneId", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timezoneId: str = None"}, {"name": "geolocation", "types": ["GeoLocation"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "geolocation: GeoLocation = None"}, {"name": "locale", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locale: str = None"}, {"name": "permissions", "types": ["List[str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "permissions: List[str] = None"}, {"name": "extraHTTPHeaders", "types": ["Dict[str, str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] = None"}, {"name": "offline", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "offline: bool = False"}, {"name": "httpCredentials", "types": ["HttpCredentials"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "httpCredentials: HttpCredentials = None"}, {"name": "colorScheme", "types": ["ColorScheme"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "colorScheme: ColorScheme = None"}, {"name": "proxy", "types": ["Proxy"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy: Proxy = None"}, {"name": "videosPath", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "videosPath: str = None"}, {"name": "videoSize", "types": ["ViewportDimensions"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "videoSize: ViewportDimensions = None"}, {"name": "defaultBrowserType", "types": ["SupportedBrowsers"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "defaultBrowserType: SupportedBrowsers = None"}, {"name": "hideRfBrowser", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "hideRfBrowser: bool = False"}, {"name": "recordVideo", "types": ["RecordVideo"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recordVideo: RecordVideo = None"}, {"name": "recordHar", "types": ["RecordHar"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recordHar: RecordHar = None"}], "doc": "<p>Create a new BrowserContext with specified options. 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<p><code>acceptDownloads</code> Whether to automatically downloads all the attachments. Defaults to False where all the downloads are canceled.</p>\n<p><code>ignoreHTTPSErrors</code> Whether to ignore HTTPS errors during navigation. Defaults to False.</p>\n<p><code>bypassCSP</code> Toggles bypassing page's Content-Security-Policy. Defaults to False.</p>\n<p><code>viewport</code> Sets a consistent viewport for each page. Defaults to an <code>{'width': 1280, 'height': 720}</code> viewport. Value of <code>viewport</code> can be a dict or a string representation of a dictionary.</p>\n<p><code>userAgent</code> Specific user agent to use in this context.</p>\n<p><code>deviceScaleFactor</code> Specify device scale factor (can be thought of as dpr). Defaults to 1.</p>\n<p><code>isMobile</code> Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to False. Not supported in Firefox.</p>\n<p><code>hasTouch</code> Specifies if viewport supports touch events. Defaults to False.</p>\n<p><code>javaScriptEnabled</code> Whether or not to enable JavaScript in the context. Defaults to True.</p>\n<p><code>timezoneId</code> 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\u2019s metaZones.txt</a> for a list of supported timezone IDs.</p>\n<p><code>geolocation</code> Sets the geolocation. No location is set by default.</p>\n<ul>\n<li><code>latitude</code> &lt;number&gt; Latitude between -90 and 90.</li>\n<li><code>longitude</code> &lt;number&gt; Longitude between -180 and 180.</li>\n<li><code>accuracy</code> Optional &lt;number&gt; Non-negative accuracy value. Defaults to 0.</li>\n</ul>\n<p>Example usage: <code>{'latitude': 59.95, 'longitude': 30.31667}</code></p>\n<p><code>locale</code> Specify user locale, for example <code>en-GB</code>, <code>de-DE</code>, etc. Locale will affect <code>navigator.language</code> value, <code>Accept-Language</code> request header value as well as number and date formatting rules.</p>\n<p><code>permissions</code> A list of permissions to grant to all pages in this context. See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browsercontextgrantpermissionspermissions-options\">grantPermissions</a> for more details.</p>\n<p><code>extraHTTPHeaders</code> A dictionary containing additional HTTP headers to be sent with every request. All header values must be strings.</p>\n<p><code>offline</code> Whether to emulate network being offline. Defaults to False.</p>\n<p><code>httpCredentials</code> Credentials for <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication\">HTTP authentication</a>.</p>\n<ul>\n<li>example: <code>{'username': 'admin', 'password': '123456'}</code></li>\n<li><code>username</code></li>\n<li><code>password</code></li>\n</ul>\n<p><code>colorScheme</code> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See <a href=\"https://playwright.dev/docs/api/class-page#pageemulatemediaparams\">emulateMedia(options)</a> for more details. Defaults to <code>light</code>.</p>\n<p><code>proxy</code> Network proxy settings to use with this context. Note that 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</p>\n<p><code>videosPath</code> is deprecated by playwright, use recordVideo instead. Enables video recording for all pages to videosPath folder. If videosPath is not existing folder, videosPath folder is created under ${OUTPUT_DIR}/browser/video/ folder. If videosPath is not specified, videos are not recorded.</p>\n<p><code>videoSize</code> is deprecated by playwright, use recordVideo instead. Specifies dimensions of the automatically recorded video. Can only be used if videosPath is set. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.</p>\n<ul>\n<li>Example {\"width\": 1280, \"height\": 720}</li>\n</ul>\n<p><code>defaultBrowserType</code> 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:</p>\n<p><code>recordVideo</code> 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. <code>recordVideo</code> is dictionary containing <span class=\"name\">dir</span> and <span class=\"name\">size</span> keys. If <span class=\"name\">dir</span> is not existing folder, videosPath folder is created under ${OUTPUT_DIR}/browser/video/ folder. <span class=\"name\">size</span> Optional dimensions of the recorded videos. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of each page will be scaled down if necessary to fit the specified size. <span class=\"name\">size</span> is dictionary containing <span class=\"name\">width</span> (Video frame width) and  <span class=\"name\">height</span> (Video frame height) keys.</p>\n<p><code>recordHar</code> 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.</p>\n<p><span class=\"name\">omitContent</span>: Optional setting to control whether to omit request content from the HAR. Default is False <span class=\"name\">path</span>: Path on the filesystem to write the HAR file to.</p>\n<p>The ${OUTPUTDIR}/browser/ is removed at the first suite startup.</p>\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>", "shortdoc": "Create a new BrowserContext with specified options. See `Browser, Context and Page` for more information about BrowserContext.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/utils/deprecated.py", "lineno": 346}, {"name": "New Page", "args": [{"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}], "doc": "<p>Open a new Page. 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. Returns a stable identifier for the created page.</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><code>url</code> If specified it will open the new page to the specified URL.</p>", "shortdoc": "Open a new Page. A Page is the Playwright equivalent to a tab. See `Browser, Context and Page` for more information about Page concept. Returns a stable identifier for the created page.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 553}, {"name": "Open Browser", "args": [{"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}, {"name": "browser", "types": ["SupportedBrowsers"], "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = False"}, {"name": "pause_on_failure", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pause_on_failure: bool = True"}], "doc": "<p>Opens a new browser instance. Use this keyword for quick experiments or debugging sessions. 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. Only supports some of the settings Create _ Keywords do</p>\n<p><code>url</code> Navigates to URL if provided. Defaults to None.</p>\n<p><code>browser</code> Specifies which browser to use. The supported browsers are listed in the table below. The browser names are case-sensitive.</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td>firefox</td>\n<td><a href=\"https://www.mozilla.org/en-US/firefox/new\">Firefox</a></td>\n</tr>\n<tr>\n<td>chromium</td>\n<td><a href=\"https://www.chromium.org/Home\">Chromium</a></td>\n</tr>\n<tr>\n<td>webkit</td>\n<td><a href=\"https://webkit.org/\">webkit</a></td>\n</tr>\n</table>\n<p><code>headless</code> If set to False, a GUI is provided otherwise it is hidden. Defaults to False.</p>\n<p><code>pause_on_failure</code> Stop execution when failure detected and leave browser open. Defaults to True.</p>", "shortdoc": "Opens a new browser instance. Use this keyword for quick experiments or debugging sessions. Use `New Page` directly instead of `Open Browser` for production and automated execution. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 63}, {"name": "Press Keys", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "keys", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "doc": "<p>Types the given key combination into element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Supports values like \"a, b\" which will be automatically typed. . Also supports identifiers for keys like <code>ArrowLeft</code> or <code>Backspace</code>. Using + to chain combine modifiers with a single keypress <code>Control+Shift+T</code> is supported.</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#pagepressselector-key-options\">Playwright docs for press.</a></p>\n<p>Example:</p>\n<pre>\n# Keyword       Selector                    *Keys\nPress Keys      //*[@id=\"username_field\"]    h    e   l   o   ArrowLeft   l\n</pre>", "shortdoc": "Types the given key combination into element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 225}, {"name": "Promise To", "args": [{"name": "kw", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kw: str"}, {"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Wrap a Browser library keyword and make it a promise. Returns that promise and executes the keyword on background.</p>\n<p><code>kw</code> Keyword that will work async on background.</p>\n<p>Example:</p>\n<pre>\n${promise}=     Promise To            Wait For Response     matcher=     timeout=3\nClick           \\#delayed_request\n${body}=        Wait For              ${promise}\n</pre>", "shortdoc": "Wrap a Browser library keyword and make it a promise. Returns that promise and executes the keyword on background.", "tags": ["Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/promises.py", "lineno": 35}, {"name": "Promise To Upload File", "args": [{"name": "path", "types": ["PathLike"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "doc": "<p>Returns a promise that resolves when file from <code>path</code> has been uploaded. 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<p><code>path</code> Path to file to be uploaded.</p>\n<p>Example use:</p>\n<pre>\n${promise}=  Promise To Upload File    ${CURDIR}/test_upload_file\nClick          \\#file_chooser\n${upload_result}=  Wait For  ${promise}\n</pre>", "shortdoc": "Returns a promise that resolves when file from ``path`` has been uploaded. Fails if the upload has not happened during timeout.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/promises.py", "lineno": 140}, {"name": "Promise To Wait For Download", "args": [{"name": "saveAs", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}], "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><code>saveAs</code> defines path where the file is saved. File will also temporarily be saved in playwright context's default download location.</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>\nNew Context          acceptDownloads=True\nNew Page             ${LOGIN_URL}\n${dl_promise}        Promise To Wait For Download    /path/to/download/folder\nClick                \\#file_download\n${file_obj}=         Wait For  ${dl_promise}\nFile Should Exist    ${file_obj}[saveAs]\nShould Be True       ${file_obj.suggestedFilename}\n</pre>", "shortdoc": "Returns a promise that waits for next download event on page.", "tags": ["BrowserControl", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/promises.py", "lineno": 63}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": ["str", "None"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}], "doc": "<p>Sets the keyword to execute, when a Browser keyword fails.</p>\n<p><code>keyword</code> is 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, but the keyword must not take any arguments.</p>\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 the name of the previously registered failure keyword or Python <code>None</code> if this functionality was previously disabled. The return value can be always used to restore the original value later.</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\n${previous kw}=    <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    NONE\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    ${previous kw}\n</pre>", "shortdoc": "Sets the keyword to execute, when a Browser keyword fails.", "tags": ["Config"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/runonfailure.py", "lineno": 30}, {"name": "Reload", "args": [], "doc": "<p>Reloads current active page.</p>", "shortdoc": "Reloads current active page.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 234}, {"name": "Scroll By", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "vertical", "types": ["str"], "defaultValue": "height", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = height"}, {"name": "horizontal", "types": ["str"], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = 0"}, {"name": "behavior", "types": ["ScrollBehavior"], "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "doc": "<p>Scrolls an element or the page relative from current position by the given values.</p>\n<p><code>selector</code> 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.</p>\n<p><code>vertical</code> 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.</p>\n<p><code>horizontal</code> 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.</p>\n<p><code>behavior</code> defines whether the scroll happens directly or it scrolls smoothly.</p>", "shortdoc": "Scrolls an element or the page relative from current position by the given values.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 432}, {"name": "Scroll To", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "vertical", "types": ["str"], "defaultValue": "top", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = top"}, {"name": "horizontal", "types": ["str"], "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = left"}, {"name": "behavior", "types": ["ScrollBehavior"], "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "doc": "<p>Scrolls an element or the page to an absolute position based on given coordinates.</p>\n<p><code>selector</code> 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.</p>\n<p><code>vertical</code> 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> | <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.</p>\n<p><code>horizontal</code> defines where to scroll horizontally. Works same as vertical but defines &lt; <code>left</code> | <code>right</code> &gt; as start and end.</p>\n<p><code>behavior</code> defines whether the scroll happens directly or it scrolls smoothly.</p>", "shortdoc": "Scrolls an element or the page to an absolute position based on given coordinates.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 388}, {"name": "Select Options By", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "types": ["SelectAttribute"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: SelectAttribute"}, {"name": "values", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values"}], "doc": "<p>Selects options from select element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the select tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Matches based on the chosen attribute with list of <code>values</code>. Possible attributes to match options by: <code>attribute</code></p>\n<p>If no values to select are passed will deselect options in element.</p>", "shortdoc": "Selects options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 505}, {"name": "SessionStorage Clear", "args": [], "doc": "<p>Remove all saved data from the session storage.</p>", "shortdoc": "Remove all saved data from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 163}, {"name": "SessionStorage Get Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}], "doc": "<p>Get saved data from from session storage.</p>\n<p><code>key</code> Named key of the item in the storage.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Get saved data from from session storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 103}, {"name": "SessionStorage Remove Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p>Remove saved data with key from the session storage.</p>\n<p><code>key</code> Name of the item which shall be deleted.</p>", "shortdoc": "Remove saved data with key from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 148}, {"name": "SessionStorage Set Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Save data to session storage.</p>\n<p><code>key</code> The name of the key under which it should be saved.</p>\n<p><code>value</code> The value which shall be saved as a string.</p>", "shortdoc": "Save data to session storage.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/webapp_state.py", "lineno": 131}, {"name": "Set Browser Timeout", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}], "doc": "<p>Sets the timeout used by most input and getter keywords.</p>\n<p><code>timeout</code> Timeout of it is for current playwright context.</p>\n<p>Returns the previous value of the timeout.</p>", "shortdoc": "Sets the timeout used by most input and getter keywords.", "tags": ["Config", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 149}, {"name": "Set Geolocation", "args": [{"name": "latitude", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude: float"}, {"name": "longitude", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude: float"}, {"name": "accuracy", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "accuracy: float = None"}], "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.</p>", "shortdoc": "Updated the correct Context's geolocation.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 217}, {"name": "Set Offline", "args": [{"name": "offline", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "offline: bool = True"}], "doc": "<p>Toggles current Context's offline emulation.</p>\n<p><code>offline</code> Toggles the offline mode. Set to False to switch back to online mode. Defaults to True.</p>", "shortdoc": "Toggles current Context's offline emulation.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 206}, {"name": "Set Retry Assertions For", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}], "doc": "<p>Sets the timeout used in retrying assertions when they fail.</p>\n<p><code>timeout</code></p>\n<p>Returns the previous value of the retry_assertions_until.</p>", "shortdoc": "Sets the timeout used in retrying assertions when they fail.", "tags": ["Config", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 170}, {"name": "Set Viewport Size", "args": [{"name": "width", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}], "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<p><code>width</code> Sets the width size.</p>\n<p><code>height</code> Sets the heigth size.</p>", "shortdoc": "Sets current Pages viewport size to specified dimensions.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 182}, {"name": "Switch Browser", "args": [{"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "doc": "<p>Switches the currently active Browser to another open Browser. 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<p><code>id</code> Id of the browser to be changed to. Starting at 0.</p>", "shortdoc": "Switches the currently active Browser to another open Browser. Returns a stable identifier for the previous browser. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 681}, {"name": "Switch Context", "args": [{"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Switches the active BrowserContext to another open context. 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<p><code>id</code> Id of the context to be changed to. Randomly generated UUID.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | str&gt; Switch context in specified browser. If value is not \"CURRENT\" it should be an the id of the browser where to switch context.</p>", "shortdoc": "Switches the active BrowserContext to another open context. Returns a stable identifier for the previous context. See `Browser, Context and Page` for more information about Context and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 694}, {"name": "Switch Page", "args": [{"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}, {"name": "context", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: str = CURRENT"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Switches the active browser page to another open page by <code>id</code> or <code>NEW</code>. 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<p><code>id</code> &lt; <code>CURRENT</code> | <code>NEW </code> | str&gt; Id of the page to be changed to or</p>\n<p><code>NEW</code> for a page opened after the current page. This may timeout if no new pages exists before library timeout. See <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a> for how to change the timeout.</p>\n<p>With <code>CURRENT</code> you can get the <code>id</code> of the \"CURRENT\" page</p>\n<p><code>context</code> &lt; <code>CURRENT</code> | str&gt; Switch page in specified context. If value is not \"CURRENT\" it should be the id of the context where to switch page.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | str&gt; Switch page in specified browser. If value is not \"CURRENT\" it should be the id of the browser where to switch page.</p>", "shortdoc": "Switches the active browser page to another open page by ``id`` or ``NEW``. Returns a stable identifier ``id`` for the previous page. See `Browser, Context and Page` for more information about Page and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/playwright_state.py", "lineno": 711}, {"name": "Take Screenshot", "args": [{"name": "filename", "types": ["str"], "defaultValue": "robotframework-browser-screenshot-{index}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = robotframework-browser-screenshot-{index}"}, {"name": "selector", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}, {"name": "fullPage", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullPage: bool = False"}], "doc": "<p>Takes a screenshot of the current window and saves it to <code>path</code>. Saves it as a png.</p>\n<p><code>filename</code> Filename into which to save. The file will be saved into the robot framework ${OUTPUTDIR}/browser/screenshot directory by default, but it can 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), 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.</p>\n<p>The ${OUTPUTDIR}/browser/ is removed at the first suite startup.</p>\n<p><code>selector</code> 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.</p>\n<p><code>fullPage</code> When True, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to False.</p>", "shortdoc": "Takes a screenshot of the current window and saves it to ``path``. Saves it as a png.", "tags": ["PageContent"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/browser_control.py", "lineno": 74}, {"name": "Type Secret", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "delay", "types": ["timedelta"], "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "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 <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><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>secret</code> 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.</p>\n<p>Example: <code>$Password</code> and <code>${Password}</code> resolve the robot framework variable. <code>%ENV_PWD</code> and <code>%{ENV_PWD}</code> resolve to the environment variable <code>ENV_PWD</code>.</p>\n<p><code>delay</code> 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></p>\n<p><code>clear</code> Set to false, if the field shall not be cleared before typing. Defaults to true.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for details.</p>", "shortdoc": "Types the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 119}, {"name": "Type Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "delay", "types": ["timedelta"], "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "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<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>txt</code> Text for the text field.</p>\n<p><code>delay</code> 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></p>\n<p><code>clear</code> Set to false, if the field shall not be cleared before typing. Defaults to true.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for direct filling of the full text at once.</p>", "shortdoc": "Types the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 51}, {"name": "Uncheck Checkbox", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Unchecks the checkbox found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Does nothing if the element is not checked/selected.</p>", "shortdoc": "Unchecks the checkbox found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/interaction.py", "lineno": 490}, {"name": "Upload File", "args": [{"name": "path", "types": ["PathLike"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "doc": "<p><b>DEPRECATED!!</b> Use keyword <a href=\"#Promise%20To%20Upload%20File\" class=\"name\">Promise To Upload File</a> instead. Upload file from <code>path</code> into next file chooser dialog on page.</p>\n<p><code>path</code> Path to file to be uploaded.</p>\n<p>Example use:</p>\n<pre>\nUpload File    ${CURDIR}/test_upload_file\nClick          \\#file_chooser\n</pre>", "shortdoc": "*DEPRECATED!!* Use keyword `Promise To Upload File` instead. Upload file from ``path`` into next file chooser dialog on page.", "tags": ["PageContent", "Setter"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/promises.py", "lineno": 161}, {"name": "Wait For", "args": [{"name": "promises", "types": ["Future"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*promises: Future"}], "doc": "<p>Waits for promises to finish and returns results from them. Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.</p>\n<p><code>promises</code> <b>Work in progress</b></p>\n<p>Example:</p>\n<pre>\n${promise}=     Promise To            Wait For Response     matcher=     timeout=3\nClick           \\#delayed_request\n${body}=        Wait For              ${promise}\n</pre>", "shortdoc": "Waits for promises to finish and returns results from them. Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.", "tags": ["Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/promises.py", "lineno": 113}, {"name": "Wait For All Promises", "args": [], "doc": "<p>Waits for all promises to finish. If one fails, then this keyword will fail.</p>", "shortdoc": "Waits for all promises to finish. If one fails, then this keyword will fail.", "tags": ["Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/promises.py", "lineno": 132}, {"name": "Wait For Download", "args": [{"name": "saveAs", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}], "doc": "<p><b>DEPRECATED!!</b> Use keyword <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> instead.</p>", "shortdoc": "*DEPRECATED!!* Use keyword `Promise To Wait For Download` instead.", "tags": ["BrowserControl", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/promises.py", "lineno": 93}, {"name": "Wait For Elements State", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "state", "types": ["ElementState"], "defaultValue": "visible", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: ElementState = visible"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits for the element found by <code>selector</code> to satisfy state option.</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<p><code>selector</code> Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>state</code> See <a href=\"#ElementState\" class=\"name\">ElementState</a> for explaination.</p>\n<p>Note that element without any content or with display:none has an empty bounding box and is not considered visible.</p>\n<p><code>timeout</code> uses default timeout of 10 seconds if not set.</p>\n<p><code>message</code> 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.</p>", "shortdoc": "Waits for the element found by ``selector`` to satisfy state option.", "tags": ["PageContent", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/waiter.py", "lineno": 26}, {"name": "Wait For Function", "args": [{"name": "function", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: str"}, {"name": "selector", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}, {"name": "polling", "types": ["str", "timedelta"], "defaultValue": "raf", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "polling: str | timedelta = raf"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.</p>\n<p><code>function</code> A valid javascript function or a javascript function body. For example <code>() =&gt; true</code> and <code>true</code> will behave similarly.</p>\n<p><code>selector</code> 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.</p>\n<p><code>polling</code> 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.</p>\n<p><code>timeout</code> Uses default timeout of 10 seconds if not set.</p>\n<p><code>message</code> 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.</p>\n<p>Example usage:</p>\n<pre>\n${promise}    Promise To      Wait For Function    element =&gt; element.style.width==\"100%\"    selector=\\#progress_bar    timeout=4s\nClick         \\#progress_bar\nWait For      ${promise}\n</pre>", "shortdoc": "Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.", "tags": ["PageContent", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/waiter.py", "lineno": 107}, {"name": "Wait For Navigation", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Waits until page has navigated to given <code>url</code>.</p>\n<p><code>url</code>  expected navigation target address.</p>\n<p><code>timeout</code> Timeout in milliseconds. Uses default timeout of 10 seconds if not set.</p>", "shortdoc": "Waits until page has navigated to given ``url``.", "tags": ["HTTP", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/network.py", "lineno": 178}, {"name": "Wait For Request", "args": [{"name": "matcher", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str = "}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Waits for request matching matcher to be made.</p>\n<p><code>matcher</code> Request URL string, JavaScript regex or JavaScript function to match request by. By default (with empty string) matches first available request.</p>\n<p><code>timeout</code> Timeout in seconds. Uses default timeout if not set.</p>", "shortdoc": "Waits for request matching matcher to be made.", "tags": ["HTTP", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/network.py", "lineno": 127}, {"name": "Wait For Response", "args": [{"name": "matcher", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str = "}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Waits for response matching matcher and returns python dict with contents.</p>\n<p><code>matcher</code> Request URL string, JavaScript regex or JavaScript function to match request by. By default (with empty string) matches first available request.</p>\n<p><code>timeout</code> Timeout in seconds. Uses default timeout if not set.</p>\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.</li>\n<li><code>body</code> &lt;dict | 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<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</ul>", "shortdoc": "Waits for response matching matcher and returns python dict with contents.", "tags": ["HTTP", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/network.py", "lineno": 141}, {"name": "Wait Until Network Is Idle", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<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<p><code>timeout</code> Timeout in milliseconds. Uses default timeout of 10 seconds if not set.</p>", "shortdoc": "Waits until there has been at least one instance of 500 ms of no network traffic on the page after loading.", "tags": ["HTTP", "Wait"], "source": "/home/kerkko/Code/robotframework/robotframework-browser/Browser/keywords/network.py", "lineno": 163}], "dataTypes": {"enums": [{"name": "AreaFields", "type": "Enum", "doc": "<p>Enumeration that defines which coordinates of an area should be selected.</p>\n<p>Used by <a href=\"#Get%20Scroll%20Position\" class=\"name\">Get Scroll Position</a>.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "members": [{"name": "top", "value": "1"}, {"name": "left", "value": "2"}, {"name": "bottom", "value": "3"}, {"name": "right", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"name": "AssertionOperator", "type": "Enum", "doc": "<p>Enum that defines the <code>assertion_operator</code> &lt;<a href=\"#AssertionOperator\" class=\"name\">AssertionOperator</a>&gt;.</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>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>* &lt; less or greater &gt; With Strings* Compairisons of strings with <code>greater than</code> or <code>less than</code> compares each character, starting from 0 reagarding 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<h3>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>", "members": [{"name": "equal", "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"}]}, {"name": "AutoClosingLevel", "type": "Enum", "doc": "<p>Library will close pages and contexts that are created during test execution.</p>\n<p>Pages and contexts created before test in Suite Setup or Suite Teardown will be closed after that suite. This will remove the burden of closing these resources in teardowns. <b>Browsers will not be automatically closed.</b> A browser is expensive to create and should be reused. Automatic closing can be configured or switched off with the auto_closing_level library parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>", "members": [{"name": "SUITE", "value": "1"}, {"name": "TEST", "value": "2"}, {"name": "MANUAL", "value": "3"}]}, {"name": "BoundingBoxFields", "type": "Enum", "doc": "<p>Enumeration that defines which location information of an element should be selected.</p>\n<p>Used by <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>.</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>", "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "x", "value": "3"}, {"name": "y", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"name": "ColorScheme", "type": "Enum", "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>\n<p>Used by <a href=\"#New%20Context\" class=\"name\">New Context</a>.</p>", "members": [{"name": "dark", "value": "1"}, {"name": "light", "value": "2"}, {"name": "no-preference", "value": "3"}]}, {"name": "CookieSameSite", "type": "Enum", "doc": "<p>An enumeration.</p>", "members": [{"name": "Strict", "value": "Strict"}, {"name": "Lax", "value": "Lax"}, {"name": "None", "value": "None"}]}, {"name": "CookieType", "type": "Enum", "doc": "<p>Enum that defines the Cookie type.</p>", "members": [{"name": "dictionary", "value": "1"}, {"name": "dict", "value": "1"}, {"name": "string", "value": "2"}, {"name": "str", "value": "2"}]}, {"name": "DialogAction", "type": "Enum", "doc": "<p>Enum that defines how to handle a dialog.</p>", "members": [{"name": "accept", "value": "1"}, {"name": "dismiss", "value": "2"}]}, {"name": "ElementState", "type": "Enum", "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</table>\n<p>Used by: <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a></p>", "members": [{"name": "attached", "value": "1"}, {"name": "detached", "value": "2"}, {"name": "visible", "value": "3"}, {"name": "hidden", "value": "4"}, {"name": "enabled", "value": "5"}, {"name": "disabled", "value": "6"}, {"name": "editable", "value": "7"}, {"name": "readonly", "value": "8"}, {"name": "selected", "value": "9"}, {"name": "deselected", "value": "10"}, {"name": "focused", "value": "11"}, {"name": "defocused", "value": "12"}, {"name": "checked", "value": "13"}, {"name": "unchecked", "value": "14"}]}, {"name": "ElementStateKey", "type": "Enum", "doc": "<p>Enum that defines the state an element can have directly.</p>\n<p>See <a href=\"#ElementState\" class=\"name\">ElementState</a> for explaination.</p>\n<p>Used by: <a href=\"#Get%20Element%20State\" class=\"name\">Get Element State</a></p>", "members": [{"name": "attached", "value": "1"}, {"name": "visible", "value": "2"}, {"name": "disabled", "value": "3"}, {"name": "readonly", "value": "4"}, {"name": "selected", "value": "5"}, {"name": "focused", "value": "6"}, {"name": "checked", "value": "7"}]}, {"name": "KeyAction", "type": "Enum", "doc": "<p>Enum that defines which <a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a> action to perform.</p>", "members": [{"name": "down", "value": "1"}, {"name": "up", "value": "2"}, {"name": "press", "value": "3"}]}, {"name": "KeyboardInputAction", "type": "Enum", "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>", "members": [{"name": "insertText", "value": "1"}, {"name": "type", "value": "2"}]}, {"name": "KeyboardModifier", "type": "Enum", "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>", "members": [{"name": "Alt", "value": "1"}, {"name": "Control", "value": "2"}, {"name": "Meta", "value": "3"}, {"name": "Shift", "value": "4"}]}, {"name": "MouseButton", "type": "Enum", "doc": "<p>Enum that defines which mouse button to use.</p>\n<p>Used by: <a href=\"#Click\" class=\"name\">Click</a> and <a href=\"#MouseButton\" class=\"name\">Mouse Button</a>.</p>", "members": [{"name": "left", "value": "1"}, {"name": "middle", "value": "2"}, {"name": "right", "value": "3"}]}, {"name": "MouseButtonAction", "type": "Enum", "doc": "<p>Enum that defines which <a href=\"#MouseButton\" class=\"name\">Mouse Button</a> action to perform.</p>", "members": [{"name": "click", "value": "1"}, {"name": "down", "value": "2"}, {"name": "up", "value": "3"}]}, {"name": "RequestMethod", "type": "Enum", "doc": "<p>Enum that defines the request type.</p>\n<p>Used by: <a href=\"#Http\" class=\"name\">HTTP</a> .</p>", "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"}]}, {"name": "ScrollBehavior", "type": "Enum", "doc": "<p>Enum that controls the behavior of scrolling.</p>\n<p><code>smooth</code></p>", "members": [{"name": "auto", "value": "1"}, {"name": "smooth", "value": "2"}]}, {"name": "SelectAttribute", "type": "Enum", "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>", "members": [{"name": "value", "value": "1"}, {"name": "label", "value": "2"}, {"name": "text", "value": "2"}, {"name": "index", "value": "3"}]}, {"name": "SelectionType", "type": "Enum", "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>\n<p>Used by: <a href=\"#Get%20Browser%20Ids\" class=\"name\">Get Browser IDs</a> <a href=\"#Get%20Context%20Ids\" class=\"name\">Get Context IDs</a> and <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>.</p>", "members": [{"name": "ACTIVE", "value": "1"}, {"name": "CURRENT", "value": "1"}, {"name": "ALL", "value": "2"}, {"name": "ANY", "value": "2"}]}, {"name": "SizeFields", "type": "Enum", "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>\n<p>Used by: <a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>, <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> and <a href=\"#Get%20Client%20Size\" class=\"name\">Get Client Size</a>.</p>", "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "ALL", "value": "3"}]}, {"name": "SupportedBrowsers", "type": "Enum", "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>", "members": [{"name": "chromium", "value": "1"}, {"name": "firefox", "value": "2"}, {"name": "webkit", "value": "3"}]}], "typedDicts": [{"name": "GeoLocation", "type": "TypedDict", "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. Example usage: <code>{'latitude': 59.95, 'longitude': 30.31667}</code></li>\n</ul>", "items": [{"key": "longitude", "type": "float", "required": true}, {"key": "latitude", "type": "float", "required": true}, {"key": "accuracy", "type": "float", "required": false}]}, {"name": "HttpCredentials", "type": "TypedDict", "doc": "<p>Sets the credentials for http basic-auth.</p>\n<p>Can be defined as robot dictionary or as string literal.</p>\n<p>Example as literal:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>    httpCredentials={'username': 'admin', 'password': '123456'}\n</pre>\n<p>Example as robot variable</p>\n<pre>\n<b>***</b> <b>Variables</b> <b>***</b>\n&amp;{credentials}=    username=admin    password=123456\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>", "items": [{"key": "username", "type": "str", "required": true}, {"key": "password", "type": "str", "required": true}]}, {"name": "Proxy", "type": "TypedDict", "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>", "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}]}, {"name": "RecordHar", "type": "TypedDict", "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><span class=\"name\">path</span>: 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>", "items": [{"key": "omitContent", "type": "bool", "required": false}, {"key": "path", "type": "str", "required": false}]}, {"name": "RecordVideo", "type": "TypedDict", "doc": "", "items": [{"key": "dir", "type": "str", "required": false}, {"key": "size", "type": "ViewportDimensions", "required": false}]}, {"name": "ViewportDimensions", "type": "TypedDict", "doc": "", "items": [{"key": "width", "type": "int", "required": true}, {"key": "height", "type": "int", "required": true}]}]}}
+libdoc = {"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=\"#Finding%20elements\" class=\"name\">Finding elements</a></li>\n<li><a href=\"#Assertions\" class=\"name\">Assertions</a></li>\n<li><a href=\"#Automatic%20page%20and%20context%20closing\" class=\"name\">Automatic page and context closing</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=\"#Extending%20Browser%20library%20with%20a%20JavaScript%20module\" class=\"name\">Extending Browser library with a JavaScript module</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n<li><a href=\"#Data%20types\" class=\"name\">Data types</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. Theres is not 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 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>The context layer is useful e.g. for testing different users 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>If there is no browser opened in Suite Setup and <a href=\"#New%20Page\" class=\"name\">New Page</a> is executed in Test Setup, the corresponding pages and context is closed automatically at the end of the test. The browser process remains open and will be closed at the end of execution.</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 dictionary.</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.</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<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>Example:</p>\n<pre>\n<a href=\"#Click\" class=\"name\">Click</a>  span &gt; button.some_class\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 concatination of different selectors seperated 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 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 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=\"Frames\">Frames</h3>\n<p>By default, selector chains do not cross frame boundaries. It means that a simple CSS selector is not able to select and element located inside an iframe or a frameset. For this usecase, 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.</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, non 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, 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 nessesary 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 an element by using <a href=\"#Get%20Element\" class=\"name\">Get Element</a> keyword. 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          element=${ref} &gt;&gt; .some_child\n</pre>\n<p>The <span class=\"name\">.some_child</span> selector in the example is relative to the element referenced by ${ref}.</p>\n<h2 id=\"Assertions\">Assertions</h2>\n<p>Keywords that accept arguments <code>assertion_operator</code> &lt;<a href=\"#AssertionOperator\" class=\"name\">AssertionOperator</a>&gt; and <code>assertion_expected</code> can optionally assert. 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>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><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>But default the keywords will provide an error message if the assertion fails, but default error message 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 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 same type. If types are not 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 returnd 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 filter and a number when filtered. These Keywords do autoconvert the expected value if a number is returned.</p>\n<p>* &lt; less or greater &gt; With Strings* Compairisons of strings with <code>greater than</code> or <code>less than</code> compares each character, starting from 0 reagarding 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']                     # Compairsion of numbers\nGet Page State    validate    \"IMPORTANT MESSAGE!\" == value['message']  # Compairsion 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=\"Automatic page and context closing\">Automatic page and context closing</h2>\n<p>Library will close pages and contexts that are created during test execution. Pages and contexts created before test in Suite Setup or Suite Teardown will be closed after that suite. This will remove the burden of closing these resources in teardowns.</p>\n<p>Browsers will not be automatically closed. A browser is expensive to create and should be reused.</p>\n<p>Automatic closing can be configured or switched off with the <code>auto_closing_level</code> library parameter.</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. 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 Browser package is <code>PLAYWRIGHT_BROWSERS_PATH=0 node Browser/wrapper/index.js PORT</code>. <code>PORT</code> is 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=\"Extending Browser library with a JavaScript module\">Extending Browser library with a JavaScript module</h2>\n<p>Browser library can be extended with JavaScript. 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(page, args, logger, playwright) {\n  logger(args.toString())\n  playwright.coolNewFeature()\n  return await page.goto(args[0]);\n}\n</pre>\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>: list of strings from Robot Framework keyword call.</p>\n<p>!! A BIT UNSTABLE AND SUBJECT TO API CHANGES !! <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<h3 id=\"Example module.js\">Example module.js</h3>\n<pre>\nasync function myGoToKeyword(page, args) {\n  await page.goto(args[0]);\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 withm custom selector with a js module</p>\n<h3 id=\"Example module keyword for custom selector registerin\">Example module keyword for custom selector registerin</h3>\n<pre>\nasync function registerMySelector(page, args, log, 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>", "version": "4.1.0", "generated": "2021-03-25 20:59:11", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/home/tatu/workspace/robotframework-playwright/Browser/__init__.py", "lineno": 54, "tags": ["Assertion", "BrowserControl", "Config", "Getter", "HTTP", "PageContent", "Setter", "Wait"], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": "0:00:10", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = 0:00:10"}, {"name": "enable_playwright_debug", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "enable_playwright_debug: bool = False"}, {"name": "auto_closing_level", "types": ["AutoClosingLevel"], "defaultValue": "TEST", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "auto_closing_level: AutoClosingLevel = TEST"}, {"name": "retry_assertions_for", "types": ["timedelta"], "defaultValue": "0:00:01", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "retry_assertions_for: timedelta = 0:00:01"}, {"name": "run_on_failure", "types": ["str"], "defaultValue": "Take Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure: str = Take Screenshot"}, {"name": "external_browser_executable", "types": ["Dict[Browser.utils.data_types.SupportedBrowsers, str]", "None"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "external_browser_executable: Dict[Browser.utils.data_types.SupportedBrowsers, str] | None = None"}, {"name": "jsextension", "types": ["str", "None"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "jsextension: str | None = None"}, {"name": "enable_presenter_mode", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "enable_presenter_mode: bool = False"}], "doc": "<p>Browser library can be taken into use with optional arguments:</p>\n<ul>\n<li><code>timeout</code> &lt;str&gt; 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.</li>\n<li><code>enable_playwright_debug</code> &lt;bool&gt; Enable low level debug information from the playwright tool. Mainly Useful for the library developers and for debugging purposes.</li>\n<li><code>auto_closing_level</code> &lt; <code>SUITE</code> | <code>TEST</code> | <code>MANUAL</code> &gt; Configure context and page automatic closing. Default is after each test. Other options are SUITE for closing after each suite and MANUAL for no automatic closing.</li>\n<li><code>retry_assertions_for</code> &lt;str&gt; 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.</li>\n<li><code>run_on_failure</code> &lt;str&gt; Sets the keyword to execute in case of a failing Browser keyword. It can be the name of any keyword that does not have any mandatory argument. If no extra action should be done after a failure, set it to <code>None</code> or any other robot falsy value.</li>\n<li><code>external_browser_executable</code> &lt;Dict &lt;SupportedBrowsers, Path&gt;&gt; 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.</li>\n<li><code>jsextension</code> &lt;str&gt; Path to Javascript module exposed as extra keywords. Module must be in CommonJS.</li>\n<li><code>enable_presenter_mode</code> &lt;bool&gt; Automatic highlights to interacted components, slowMo and a small pause at the end.</li>\n</ul>", "shortdoc": "Browser library can be taken into use with optional arguments:", "tags": [], "source": "/home/tatu/workspace/robotframework-playwright/Browser/browser.py", "lineno": 629}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}, {"name": "domain", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str = None"}, {"name": "path", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str = None"}, {"name": "expires", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expires: str = None"}, {"name": "httpOnly", "types": ["bool"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "httpOnly: bool = None"}, {"name": "secure", "types": ["bool"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool = None"}, {"name": "sameSite", "types": ["CookieSameSite"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sameSite: CookieSameSite = None"}], "doc": "<p>Adds a cookie to currently active browser context.</p>\n<p><code>name</code> Name of the cookie.</p>\n<p><code>value</code> Given value for the cookie.</p>\n<p><code>url</code> Given url for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</p>\n<p><code>domain</code> Given domain for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</p>\n<p><code>path</code> Given path for the cookie. Defaults to None. Either <code>url</code> or <code>domain</code> / <code>path</code> pair must be set.</p>\n<p><code>expires</code> 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.</p>\n<ul>\n<li>example: 2027-09-28 16:21:35</li>\n</ul>\n<p><code>httpOnly</code> Sets the httpOnly token.</p>\n<p><code>secure</code> Sets the secure token.</p>\n<p><code>samesite</code> Sets the samesite mode.</p>\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>   expiry=2027-09-28 16:21:35        # Expiry 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>   expiry=1822137695                 # Expiry as epoch seconds.\n</pre>", "shortdoc": "Adds a cookie to currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 90}, {"name": "Add Style Tag", "args": [{"name": "content", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "content: str"}], "doc": "<p>Adds a &lt;style type=\"text/css\"&gt; tag with the content.</p>\n<p><code>content</code> Raw CSS content to be injected into frame.</p>", "shortdoc": "Adds a <style type=\"text/css\"> tag with the content.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 85}, {"name": "Check Checkbox", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Checks the checkbox or selects radio button found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Does nothing if the element is already checked/selected.</p>", "shortdoc": "Checks the checkbox or selects radio button found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 477}, {"name": "Clear Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Clears the text field found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for emulating typing text character by character. See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for direct filling of the full text at once.</p>", "shortdoc": "Clears the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 104}, {"name": "Click", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "button", "types": ["MouseButton"], "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "clickCount", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = None"}, {"name": "position_x", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_x: float = None"}, {"name": "position_y", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_y: float = None"}, {"name": "force", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}, {"name": "noWaitAfter", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "noWaitAfter: bool = False"}, {"name": "modifiers", "types": ["KeyboardModifier"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}], "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=\"#MouseButton\" 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<p><code>selector</code> Selector element to click. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>button</code> Defaults to <code>left</code> if invalid.</p>\n<p><code>clickCount</code> Defaults to 1.</p>\n<p><code>delay</code> Time to wait between mouse-down and mouse-up. Defaults to 0.</p>\n<p><code>position_x</code> &amp; <code>position_y</code> 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.</p>\n<p><code>force</code> Set to True to skip Playwright's <a href=\"https://playwright.dev/docs/actionability\">Actionability checks</a>.</p>\n<p><code>noWaitAfter</code> 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>.</p>\n<p><code>*modifiers</code> 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.</p>", "shortdoc": "Simulates mouse click on the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 251}, {"name": "Close Browser", "args": [{"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Closes the current browser. Activated browser is set to first active browser. 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<p><code>browser</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; If value is not <code>CURRENT</code> it should be a string referencing the id of the browser to be closed. If <code>ALL</code> is provided <span class=\"name\">Close All Browsers</span> is executed.</p>", "shortdoc": "Closes the current browser. Activated browser is set to first active browser. Closes all context and pages belonging to this browser. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 101}, {"name": "Close Context", "args": [{"name": "context", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: str = CURRENT"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Closes a Context. Activated context is set to first active context. 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<p><code>context</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Close context with specified id. If <code>ALL</code> is passed, all contexts of the specified browser are closed. Defaults to CURRENT.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Close context in specified browser. If value is not \"CURRENT\" it should be a string referencing the id of the browser where to close context.</p>", "shortdoc": "Closes a Context. Activated context is set to first active context. Closes pages belonging to this context. See `Browser, Context and Page` for more information about Context and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 125}, {"name": "Close Page", "args": [{"name": "page", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: str = CURRENT"}, {"name": "context", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: str = CURRENT"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Closes the <code>page</code> in <code>context</code> in <code>browser</code>. Defaults to current for all three. Activated page is set to first active 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<p><code>page</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Id of the page to close. If value is not \"CURRENT\" it should be a string referencing the id of the context where to close page. If <code>ALL</code> is passed, all pages of the given context are closed. Defaults to CURRENT.</p>\n<p><code>context</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Id of the context that belongs to the page to be closed. If <code>ALL</code> is passed, the requested pages of all contexts are closed. Defaults to CURRENT.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | <code>ALL</code> | str &gt; Id of the browser that belongs to the page to be closed. If <code>ALL</code> is passed, the requested pages depending of the context of all browsers are closed. Defaults to CURRENT.</p>", "shortdoc": "Closes the ``page`` in ``context`` in ``browser``. Defaults to current for all three. Activated page is set to first active page. See `Browser, Context and Page` for more information about Page and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 175}, {"name": "Connect To Browser", "args": [{"name": "wsEndpoint", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "wsEndpoint: str"}, {"name": "browser", "types": ["SupportedBrowsers"], "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}], "doc": "<p>Connect to a playwright 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<p>Returns a stable identifier for the connected browser.</p>\n<p><code>wsEndpoint</code> Address to connect to.</p>\n<p><code>browser</code> Opens the specified browser. Defaults to chromium.</p>", "shortdoc": "Connect to a playwright Browser. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 236}, {"name": "Delete All Cookies", "args": [], "doc": "<p>Deletes all cookies from the currently active browser context.</p>", "shortdoc": "Deletes all cookies from the currently active browser context.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 151}, {"name": "Deselect Options", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Deselects all options from select element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the select tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>", "shortdoc": "Deselects all options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 535}, {"name": "Download", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}], "doc": "<p>Download given url content.</p>\n<p>Keyword returns dictionary which contains downloaded file path and suggested filename as keys (saveAs and suggestedFilename). See <a href=\"#Wait%20For%20Download\" class=\"name\">Wait For Download</a> for more details.</p>", "shortdoc": "Download given url content.", "tags": ["Page Content"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 95}, {"name": "Drag And Drop", "args": [{"name": "selector_from", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_from: str"}, {"name": "selector_to", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector_to: str"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "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>. 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><code>selector_from</code> identifies the element, which center is the start-point.</p>\n<p><code>selector_to</code> identifies the element, which center is the end-point.</p>\n<p><code>steps</code> defines how many intermediate mouse move events are sent.</p>", "shortdoc": "Executes a Drag&Drop operation from the element selected by ``selector_from`` to the element selected by ``selector_to``. See the `Finding elements` section for details about the selectors.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 655}, {"name": "Drag And Drop By Coordinates", "args": [{"name": "from_x", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_x: float"}, {"name": "from_y", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "from_y: float"}, {"name": "to_x", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_x: float"}, {"name": "to_y", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "to_y: float"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "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<p><code>from_x</code> &amp; <code>from_y</code> identify the the start-point.</p>\n<p><code>to_x</code> &amp; <code>to_y</code> identify the the end-point.</p>\n<p><code>steps</code> defines how many intermediate mouse move events are sent.</p>", "shortdoc": "Executes a Drag&Drop operation from a coordinate to another coordinate.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 682}, {"name": "Eat All Cookies", "args": [], "doc": "<p>Eat all cookies for all easter.</p>", "shortdoc": "Eat all cookies for all easter.", "tags": [], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 158}, {"name": "Execute JavaScript", "args": [{"name": "function", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: str"}, {"name": "selector", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}], "doc": "<p>Executes given javascript on the page.</p>\n<p><code>function</code> A valid javascript function or a javascript function body. For example <code>() =&gt; true</code> and <code>true</code> will behave similarly.</p>\n<p><code>selector</code> 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.</p>\n<p><a href=\"https://github.com/MarketSquare/robotframework-browser/tree/master/atest/test/06_Examples/js_evaluation.robot\">Usage examples.</a></p>", "shortdoc": "Executes given javascript on the page.", "tags": ["Getter", "PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 28}, {"name": "Fill Secret", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}], "doc": "<p>Fills 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 <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><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>secret</code> 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.</p>\n<p>Example: <code>$Password</code> and <code>${Password}</code> resolve the robot framework variable. <code>%ENV_PWD</code> and <code>%{ENV_PWD}</code> resolve to the environment variable <code>ENV_PWD</code>.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for other details.</p>", "shortdoc": "Fills the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 177}, {"name": "Fill Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}], "doc": "<p>Clears and fills the given <code>text</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>text</code> to clear the input field.</p>\n<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>txt</code> Text for the text field.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for emulating typing text character by character.</p>", "shortdoc": "Clears and fills the given ``text`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 82}, {"name": "Focus", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Moves focus on to the element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the element. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</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>", "shortdoc": "Moves focus on to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 374}, {"name": "Get Attribute", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the HTML <code>attribute</code> of the element found by <code>selector</code>.</p>\n<p>Optionally asserts that the attribute value matches the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>attribute</code> Requested attribute name.</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><code>message</code> overrides the default error message.</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>\nGet Attribute   id=enabled_button    disabled                   # FAIL =&gt; \"Attribute 'disabled' not found!\"\nGet Attribute   id=enabled_button    disabled     ==    None     # PASS =&gt; returns: None\nGet Attribute   id=enabled_button    something    evaluate    value is not None    # PASS =&gt;  returns: True\nGet Attribute   id=enabled_button    disabled     evaluate    value is None        # PASS =&gt;  returns: True\n</pre>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Returns the HTML ``attribute`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 221}, {"name": "Get Attribute Names", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "types": ["str", "None"], "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "doc": "<p>Returns all HTML attribute names of an element as a list.</p>\n<p>Optionally asserts that these match the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> and <code>!=</code> can work with multiple values</li>\n<li><code>contains</code> / <code>*=</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns all HTML attribute names of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 277}, {"name": "Get BoundingBox", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "types": ["BoundingBoxFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: BoundingBoxFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets elements size and location as an object <code>{x: float, y: float, width: float, height: float}</code>.</p>\n<p><code>selector</code> Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>key</code> 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>.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p>Example use:</p>\n<pre>\n${bounding_box}=    Get BoundingBox    id=element                 # unfiltered\nLog                 ${bounding_box}                               # {'x': 559.09375, 'y': 75.5, 'width': 188.796875, 'height': 18}\n${x}=               Get BoundingBox    id=element    x            # filtered\nLog                 X: ${x}                                       # X: 559.09375\n# Assertions:\nGet BoundingBox     id=element         width         &gt;    180\nGet BoundingBox     id=element         ALL           validate    value['x'] &gt; value['y']*2\n</pre>", "shortdoc": "Gets elements size and location as an object ``{x: float, y: float, width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 685}, {"name": "Get Browser Catalog", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns all browsers, open contexts in them and open pages in these contexts. See <a href=\"#Browser%2C%20Context%20and%20Page\" class=\"name\">Browser, Context and Page</a> for more information about these concepts.</p>\n<p><code>message</code> overrides the default error message.</p>\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>", "shortdoc": "Returns all browsers, open contexts in them and open pages in these contexts. See `Browser, Context and Page` for more information about these concepts.", "tags": ["BrowserControl", "Getter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 593}, {"name": "Get Browser Ids", "args": [{"name": "browser", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "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<p>The ACTIVE browser is a synonym for the CURRENT Browser.</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/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 747}, {"name": "Get Checkbox State", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "expected_state", "types": ["bool", "str"], "defaultValue": "Unchecked", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expected_state: bool | str = Unchecked"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the state of the checkbox found by <code>selector</code>.</p>\n<p><code>selector</code> Selector which shall be examined. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Optionally asserts that the state matches the specified assertion.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<ul>\n<li><code>==</code> and <code>!=</code> and equivalent are allowed on boolean values</li>\n<li>other operators are not accepted.</li>\n</ul>\n<p><code>expected_state</code> 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</p>\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><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the state of the checkbox found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 471}, {"name": "Get Classes", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}, {"name": "message", "types": ["str", "None"], "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "message: str | None = None"}], "doc": "<p>Returns all classes of an element as a list.</p>\n<p>Optionally asserts that the value matches the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<p>Available assertions:</p>\n<ul>\n<li><code>==</code> and <code>!=</code> can work with multiple values</li>\n<li><code>contains</code> / <code>*=</code> only accepts one single expected value</li>\n</ul>\n<p>Other operators are not allowed.</p>", "shortdoc": "Returns all classes of an element as a list.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 311}, {"name": "Get Client Size", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "key", "types": ["SizeFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets elements or pages client size (<code>clientHeight</code>, <code>clientWidth</code>) as object {width: float, height: float}.</p>\n<p><code>selector</code> 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.</p>\n<p><code>key</code> 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.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</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>", "shortdoc": "Gets elements or pages client size (``clientHeight``, ``clientWidth``) as object {width: float, height: float}.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 843}, {"name": "Get Context Ids", "args": [{"name": "context", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "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<p><code>context</code> Defaults to <code>ALL</code></p>\n<ul>\n<li><code>ALL</code> Returns all context ids as a list.</li>\n<li><code>ACTIVE</code> Returns the id of the active context as a list.</li>\n</ul>\n<p><code>browser</code> Defaults to <code>ALL</code></p>\n<ul>\n<li><code>ALL</code> context ids from all open browsers shall be fetched.</li>\n<li><code>ACTIVE</code> only context ids from the active browser shall be fetched.</li>\n</ul>\n<p>The ACTIVE context of the ACTIVE Browser is the <code>Current</code> Context.</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/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 767}, {"name": "Get Cookie", "args": [{"name": "cookie", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "cookie: str"}, {"name": "return_type", "types": ["CookieType"], "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "doc": "<p>Returns information of cookie with <code>name</code> as a Robot Framework dot dictionary or a string.</p>\n<p><code>cookie</code> Name of the cookie to be retrieved.</p>\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>expiry</td>\n<td>Lifetime of a cookie. Returned as datatime object.</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}=        Get Cookie              Foobar\nShould Be Equal   ${cookie.value}         Tidii\nShould Be Equal   ${cookie.expiry.year}   ${2020}\n</pre>", "shortdoc": "Returns information of cookie with ``name`` as a Robot Framework dot dictionary or a string.", "tags": ["BrowserControl", "Getter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 174}, {"name": "Get Cookies", "args": [{"name": "return_type", "types": ["CookieType"], "defaultValue": "dictionary", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_type: CookieType = dictionary"}], "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>", "shortdoc": "Returns cookies from the current active browser context.", "tags": ["Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/cookie.py", "lineno": 29}, {"name": "Get Device", "args": [{"name": "name", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "doc": "<p>Get a single device decriptor with name exactly matching name.</p>\n<p><code>name</code> Given name of the requested device. See Playwright's <a href=\"https://github.com/Microsoft/playwright/blob/master/src/server/deviceDescriptors.ts\">deviceDescriptors.ts</a> for a formatted list.</p>\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}=          Get Device       iPhone X\nNew Context         &amp;{device}\nNew Page\nGet Viewport Size   # returns { \"width\": 375, \"height\": 812 }\n</pre>", "shortdoc": "Get a single device decriptor with name exactly matching name.", "tags": ["BrowserControl", "Getter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/device_descriptors.py", "lineno": 37}, {"name": "Get Devices", "args": [], "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/src/server/deviceDescriptors.ts\">deviceDescriptors.ts</a> for a formatted list.</p>", "shortdoc": "Returns a dict of all playwright device descriptors.", "tags": ["BrowserControl", "Getter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/device_descriptors.py", "lineno": 25}, {"name": "Get Element", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Returns a reference to a Playwright element handle.</p>\n<p>The reference can be used in subsequent selectors.</p>\n<p><code>selector</code> Selector from which shall be retrieved . See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>", "shortdoc": "Returns a reference to a Playwright element handle.", "tags": ["Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 603}, {"name": "Get Element Count", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "expected_value", "types": ["int", "str"], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expected_value: int | str = 0"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the count of elements found with <code>selector</code>.</p>\n<p>Optionally asserts that the count matches the specified assertion.</p>\n<p><code>selector</code> Selector which shall be counted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<p><code>expected_value</code> Expected value for the counting</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the count of elements found with ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 518}, {"name": "Get Element State", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "state", "types": ["ElementStateKey"], "defaultValue": "visible", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: ElementStateKey = visible"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: bool = True"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Get the given state from the element found by <code>selector</code>.</p>\n<p>If the selector does satisfy the expected state it will return <code>True</code> otherwise <code>False</code>.</p>\n<p><code>selector</code> Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>state</code> Defaults to visible. Possible states are:</p>\n<ul>\n<li><code>attached</code> : to be present in DOM.</li>\n<li><code>visible</code> : to have non-empty bounding box and no visibility:hidden.</li>\n<li><code>disabled</code> : 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;.</li>\n<li><code>readonly</code> : to be <code>readOnly</code>. Can be used on &lt;input&gt; and &lt;textarea&gt;.</li>\n<li><code>selected</code> : to be <code>selected</code>. Can be used on &lt;option&gt;.</li>\n<li><code>focused</code> : to be the <code>activeElement</code>.</li>\n<li><code>checked</code> : to be <code>checked</code> . Can be used on &lt;input&gt;.</li>\n</ul>\n<p>Note that element must be attached to DOM to be able to fetch the state of <code>readonly</code> , <code>selectec</code> and <code>checked</code>. The other states are false if the requested element is not attached.</p>\n<p>Note that element without any content or with display:none has an empty bounding box and is not considered visible.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Get the given state from the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 889}, {"name": "Get Elements", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Returns a reference to playwright element handle for all matched elements by <code>selector</code>.</p>\n<p><code>selector</code> Selector from which shall be retrieved. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>", "shortdoc": "Returns a reference to playwright element handle for all matched elements by ``selector``.", "tags": ["Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 616}, {"name": "Get Page Ids", "args": [{"name": "page", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page: SelectionType = ALL"}, {"name": "context", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: SelectionType = ALL"}, {"name": "browser", "types": ["SelectionType"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SelectionType = ALL"}], "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<p><code>page</code></p>\n<ul>\n<li><code>ALL</code> Returns all page ids as a list.</li>\n<li><code>ACTIVE</code> Returns the id of the active page as a list.</li>\n</ul>\n<p><code>context</code></p>\n<ul>\n<li><code>ALL</code> page ids from all contexts shall be fetched.</li>\n<li><code>ACTIVE</code> only page ids from the active context shall be fetched.</li>\n</ul>\n<p><code>browser</code></p>\n<ul>\n<li><code>ALL</code> page ids from all open browsers shall be fetched.</li>\n<li><code>ACTIVE</code> only page ids from the active browser shall be fetched.</li>\n</ul>\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}=   Get Page IDs    ACTIVE    ACTIVE    ACTIVE\n    Log                Current page ID is: ${current_page}[0]\n    ${all_pages}=      Get Page IDs    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>", "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/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 812}, {"name": "Get Page Source", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets pages HTML source as a string.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>Optionally does a string assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Gets pages HTML source as a string.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 100}, {"name": "Get Property", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "property", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "property: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the <code>property</code> of the element found by <code>selector</code>.</p>\n<p>Optionally asserts that the property value matches the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>property</code> Requested property name.</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>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the ``property`` of the element found by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 175}, {"name": "Get Scroll Position", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "key", "types": ["AreaFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: AreaFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "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<p><code>top</code> uses js function scrollTop, <code>left</code> uses scrollLeft and <code>bottom</code> and <code>right</code> are calculated with the client size.</p>\n<p><code>selector</code> 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.</p>\n<p><code>key</code> 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.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</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>", "shortdoc": "Gets elements or pages current scroll position as object ``{top: float, left: float, bottom: float, right: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 788}, {"name": "Get Scroll Size", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "key", "types": ["SizeFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Gets elements or pages scrollable size as object <code>{width: float, height: float}</code>.</p>\n<p><code>selector</code> 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.</p>\n<p><code>key</code> 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.</p>\n<p><code>message</code> overrides the default error message.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</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}=         Get Scroll Size    height                          # filtered page by height\nLog                Width: ${height}                                   # Height: 58425\n${scroll_size}=    Get Scroll Size    id=keyword-shortcuts-container  # unfiltered element\nLog                ${scroll_size}                                     # {'width': 253, 'height': 3036}\n</pre>", "shortdoc": "Gets elements or pages scrollable size as object ``{width: float, height: float}``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 736}, {"name": "Get Select Options", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns attributes of options of a <code>select</code> element as a list of dictionaries. Returned dictionaries have the following keys and their values \"index\", \"value\", \"label\" and \"selected\".</p>\n<p>Optionally asserts that these match the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</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>", "shortdoc": "Returns attributes of options of a ``select`` element as a list of dictionaries. Returned dictionaries have the following keys and their values \"index\", \"value\", \"label\" and \"selected\".", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 363}, {"name": "Get Selected Options", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "option_attribute", "types": ["SelectAttribute"], "defaultValue": "label", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "option_attribute: SelectAttribute = label"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*assertion_expected"}], "doc": "<p>Returns the specified attribute of selected options of the <code>select</code> element.</p>\n<p>Optionally asserts that these match the specified assertion.</p>\n<p><code>selector</code> 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.</p>\n<p><code>option_attribute</code> Which attribute shall be returned/verified. Defaults to label.</p>\n<p><code>assertion_operator</code> See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details. Defaults to None.</p>\n<ul>\n<li><code>==</code> and <code>!=</code> can work with multiple values</li>\n<li><code>contains</code> / <code>*=</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>", "shortdoc": "Returns the specified attribute of selected options of the ``select`` element.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 410}, {"name": "Get Style", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "key", "types": ["str"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: str = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "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<p><code>selector</code> 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.</p>\n<p><code>key</code> Key of the requested CSS property. Retrieves \"ALL\" styles by default.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Gets the computed style properties of the element selected by ``selector``.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 639}, {"name": "Get Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns text attribute of the element found by <code>selector</code>. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Optionally asserts that the text matches the specified assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns text attribute of the element found by ``selector``. See the `Finding elements` section for details about the selectors.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 148}, {"name": "Get Textfield Value", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p><b>DEPRECATED!!</b> Use keyword <a href=\"#Get%20Text\" class=\"name\">Get Text</a> instead.</p>", "shortdoc": "*DEPRECATED!!* Use keyword `Get Text` instead.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 345}, {"name": "Get Title", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the title of the current page.</p>\n<p>Optionally asserts that it matches the specified assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the title of the current page.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 124}, {"name": "Get Url", "args": [{"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the current URL.</p>\n<p>Optionally asserts that it matches the specified assertion.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>\n<p><code>message</code> overrides the default error message.</p>", "shortdoc": "Returns the current URL.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 45}, {"name": "Get Viewport Size", "args": [{"name": "key", "types": ["SizeFields"], "defaultValue": "ALL", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "key: SizeFields = ALL"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Returns the current viewport dimensions.</p>\n<p>Optionally asserts that the count matches the specified assertion.</p>\n<p><code>key</code> 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>.</p>\n<p><code>message</code> overrides the default error message.</p>\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>\nGet Viewport Size    ALL    ==    {'width':1280, 'height':720}\nGet Viewport Size    width    &gt;=    1200\n</pre>", "shortdoc": "Returns the current viewport dimensions.", "tags": ["Assertion", "BrowserControl", "Getter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/getters.py", "lineno": 553}, {"name": "Go Back", "args": [], "doc": "<p>Navigates to the previous page in history.</p>", "shortdoc": "Navigates to the previous page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 38}, {"name": "Go Forward", "args": [], "doc": "<p>Navigates to the next page in history.</p>", "shortdoc": "Navigates to the next page in history.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 31}, {"name": "Go To", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Navigates to the given <code>url</code>.</p>\n<p><code>url</code> &lt;str&gt; URL to be navigated to. <code>timeout</code> &lt;str&gt; time to wait page to load. If not defined will use the the library default timeout.</p>", "shortdoc": "Navigates to the given ``url``.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 45}, {"name": "Handle Future Dialogs", "args": [{"name": "action", "types": ["DialogAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: DialogAction"}, {"name": "prompt_input", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt_input: str = "}], "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<p><code>action</code> How to handle the alert.</p>\n<p><code>prompt_input</code> The value to enter into prompt. Only valid if <code>action</code> equals accept. Defaults to empty string.</p>\n<p>Example:</p>\n<pre>\nHandle Future Dialogs    action=accept\nClick                    \\#alerts\n</pre>", "shortdoc": "Handle next dialog on page with ``action``.", "tags": ["PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 578}, {"name": "Highlight Elements", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "duration", "types": ["timedelta"], "defaultValue": "0:00:05", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "duration: timedelta = 0:00:05"}, {"name": "width", "types": ["str"], "defaultValue": "2px", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width: str = 2px"}, {"name": "style", "types": ["str"], "defaultValue": "dotted", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "style: str = dotted"}, {"name": "color", "types": ["str"], "defaultValue": "blue", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "color: str = blue"}], "doc": "<p>Adds a highlight to elements matched by the <code>selector</code>. Provides a style adjustment.</p>\n<p><code>selector</code> Selectors which shall be highlighted. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</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. Valid colors i.e. are: <code>red</code>, <code>blue</code>, <code>yellow</code>, <code>pink</code>, <code>black</code></p>", "shortdoc": "Adds a highlight to elements matched by the ``selector``. Provides a style adjustment.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/evaluation.py", "lineno": 50}, {"name": "Hover", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "position_x", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_x: float = None"}, {"name": "position_y", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "position_y: float = None"}, {"name": "force", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "force: bool = False"}, {"name": "modifiers", "types": ["KeyboardModifier"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*modifiers: KeyboardModifier"}], "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<p><code>selector</code> Selector element to hover. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>position_x</code> &amp; <code>position_y</code> 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.</p>\n<p><code>force</code> Set to True to skip Playwright's <a href=\"https://playwright.dev/docs/actionability\">Actionability checks</a>.</p>\n<p><code>*modifiers</code> 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.</p>", "shortdoc": "Moves the virtual mouse and scrolls to the element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 328}, {"name": "Http", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "types": ["RequestMethod"], "defaultValue": "GET", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "method: RequestMethod = GET"}, {"name": "body", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "body: str = None"}, {"name": "headers", "types": ["dict"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers: dict = None"}], "doc": "<p>Performs an HTTP request in the current browser context</p>\n<p>Accepts the following arguments:</p>\n<ul>\n<li><code>url</code> The request url, e.g. <code>/api/foo</code>.</li>\n<li><code>method</code> The HTTP method for the request. Defaults to GET.</li>\n<li><code>body</code> 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.</li>\n<li><code>headers</code> A dictionary of additional request headers. Defaults to None.</li>\n</ul>\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.</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}=             HTTP                       /api/endpoint\nShould Be Equal     ${res.status}              200\nShould Be Equal     ${res.body.some_field}     some value\n</pre>", "shortdoc": "Performs an HTTP request in the current browser context", "tags": ["HTTP"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 60}, {"name": "Keyboard Input", "args": [{"name": "action", "types": ["KeyboardInputAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyboardInputAction"}, {"name": "input", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "input: str"}, {"name": "delay", "types": [], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=0"}], "doc": "<p>Input text into page with virtual keyboard.</p>\n<p><code>action</code></p>\n<ul>\n<li><code>insertText</code> Dispatches only input event, does not emit the keydown, keyup or keypress events.</li>\n</ul>\n<ul>\n<li><code>type</code> Sends a keydown, keypress/input, and keyup event for each character in the text.</li>\n</ul>\n<p><code>input</code> The inputstring to be typed. No special keys possible.</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>", "shortdoc": "Input text into page with virtual keyboard.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 792}, {"name": "Keyboard Key", "args": [{"name": "action", "types": ["KeyAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: KeyAction"}, {"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p>Press a keyboard key on the virtual keyboard or set a key up or down.</p>\n<p><code>action</code> Determine whether the key should be released, hold or pressed. <code>down</code> or <code>up</code> are useful for combinations i.e. with Shift.</p>\n<p><code>key</code> The key to be pressed. An example of valid keys are:</p>\n<p><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.</p>\n<p>Useful keys for <code>down</code> and <code>up</code> for example are:</p>\n<p><code>Shift</code>, <code>Control</code>, <code>Alt</code>, <code>Meta</code>, <code>ShiftLeft</code></p>\n<p>Example excecution:</p>\n<pre>\nKeyboard Key    press    S\nKeyboard Key    down     Shift\nKeyboard Key    press    ArrowLeft\nKeyboard Key    press    Delete\nKeyboard Key    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>", "shortdoc": "Press a keyboard key on the virtual keyboard or set a key up or down.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 758}, {"name": "LocalStorage Clear", "args": [], "doc": "<p>Remove all saved data from the local storage.</p>", "shortdoc": "Remove all saved data from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 89}, {"name": "LocalStorage Get Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Get saved data from the local storage.</p>\n<p><code>key</code> Named key of the item in the storage.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Get saved data from the local storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 29}, {"name": "LocalStorage Remove Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p>Remove saved data with key from the local storage.</p>\n<p><code>key</code> Name of the item which shall be deleted.</p>", "shortdoc": "Remove saved data with key from the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 74}, {"name": "LocalStorage Set Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Save data to the local storage.</p>\n<p><code>key</code> The name of the key under which it should be saved.</p>\n<p><code>value</code> The value which shall be saved as a string.</p>", "shortdoc": "Save data to the local storage.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 57}, {"name": "Mouse Button", "args": [{"name": "action", "types": ["MouseButtonAction"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "action: MouseButtonAction"}, {"name": "x", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = None"}, {"name": "y", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = None"}, {"name": "button", "types": ["MouseButton"], "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "button: MouseButton = left"}, {"name": "clickCount", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clickCount: int = 1"}, {"name": "delay", "types": ["int"], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: int = 0"}], "doc": "<p>Clicks, presses or releases a mouse button.</p>\n<p><code>action</code> Determines if it is a mouseclick, holding down a key or releasing it.</p>\n<p><code>x</code> and <code>y</code> Coordinates to move before.</p>\n<p><code>button</code> Defaults to <code>left</code>.</p>\n<p><code>clickCount</code> Determine how often shall be clicked. Defaults to 1.</p>\n<p><code>delay</code> Delay in ms between the mousedown and mouseup event. Can only be set if the action is click.</p>\n<p>Moving the mouse between holding down and releasing it, is possible with <a href=\"#Mouse%20Move\" class=\"name\">Mouse Move</a>.</p>", "shortdoc": "Clicks, presses or releases a mouse button.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 607}, {"name": "Mouse Move", "args": [{"name": "x", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: float"}, {"name": "y", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: float"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "doc": "<p>Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.</p>\n<p><code>x</code> <code>y</code> are absolute coordinates starting at the top left of the page.</p>\n<p><code>steps</code> Number of intermediate steps for the mouse event.</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/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 742}, {"name": "Mouse Move Relative To", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "x", "types": ["float"], "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "x: float = 0.0"}, {"name": "y", "types": ["float"], "defaultValue": "0.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "y: float = 0.0"}, {"name": "steps", "types": ["int"], "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "steps: int = 1"}], "doc": "<p>Moves the mouse cursor relative to the selected element.</p>\n<p><code>x</code> <code>y</code> are relative coordinates to the center of the elements bounding box.</p>\n<p><code>steps</code> Number of intermediate steps for the mouse event. This is sometime needed for websites to recognize the movement.</p>", "shortdoc": "Moves the mouse cursor relative to the selected element.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 713}, {"name": "New Browser", "args": [{"name": "browser", "types": ["SupportedBrowsers"], "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = True"}, {"name": "executablePath", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "executablePath: str = None"}, {"name": "args", "types": ["List[str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "args: List[str] = None"}, {"name": "ignoreDefaultArgs", "types": ["List[str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignoreDefaultArgs: List[str] = None"}, {"name": "proxy", "types": ["Proxy"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy: Proxy = None"}, {"name": "downloadsPath", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "downloadsPath: str = None"}, {"name": "handleSIGINT", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "handleSIGINT: bool = True"}, {"name": "handleSIGTERM", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "handleSIGTERM: bool = True"}, {"name": "handleSIGHUP", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "handleSIGHUP: bool = True"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "0:00:30", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = 0:00:30"}, {"name": "env", "types": ["Dict"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "env: Dict = None"}, {"name": "devtools", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "devtools: bool = False"}, {"name": "slowMo", "types": ["timedelta"], "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "slowMo: timedelta = 0:00:00"}], "doc": "<p>Create a new playwright Browser with specified options. 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<p><code>browser</code> Opens the specified browser. Defaults to chromium.</p>\n<p><code>headless</code> Set to False if you want a GUI. Defaults to False.</p>\n<p><code>executablePath</code> 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.</p>\n<p><code>args</code> 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.</p>\n<p><code>ignoreDefaultArgs</code> If an array is given, then filters out the given default arguments. Defaults to None.</p>\n<p><code>proxy</code> Network proxy settings.</p>\n<ul>\n<li>server &lt;string&gt; Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example <code>http://myproxy.com:3128</code> or <code>socks5://myproxy.com:3128</code>. Short form <code>myproxy.com:3128</code> is considered an HTTP proxy.</li>\n<li>bypass &lt;string&gt; Optional coma-separated domains to bypass proxy, for example <code>\".com, chromium.org, .domain.com\"</code>.</li>\n<li>username &lt;string&gt; Optional username to use if HTTP proxy requires authentication.</li>\n<li>password &lt;string&gt; Optional password to use if HTTP proxy requires authentication.</li>\n</ul>\n<p><code>downloadsPath</code> If specified, accepted downloads are downloaded into this folder. Otherwise, temporary folder is created and is deleted when browser is closed.</p>\n<p><code>handleSIGINT</code> Close the browser process on Ctrl-C. Defaults to True.</p>\n<p><code>handleSIGTERM</code> Close the browser process on SIGTERM. Defaults to True.</p>\n<p><code>handleSIGHUP</code> Close the browser process on SIGHUP. Defaults to True.</p>\n<p><code>timeout</code> Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.</p>\n<p><code>env</code> &lt;Dict&lt;str, str|int|bool&gt;&gt; Specify environment variables that will be visible to the browser. Defaults to None.</p>\n<p><code>devtools</code> Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option is true, the headless option will be set false.</p>\n<p><code>slowMo</code> Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to no delay.</p>", "shortdoc": "Create a new playwright Browser with specified options. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 256}, {"name": "New Context", "args": [{"name": "acceptDownloads", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "acceptDownloads: bool = False"}, {"name": "ignoreHTTPSErrors", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignoreHTTPSErrors: bool = False"}, {"name": "bypassCSP", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bypassCSP: bool = False"}, {"name": "viewport", "types": ["ViewportDimensions"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "viewport: ViewportDimensions = None"}, {"name": "userAgent", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "userAgent: str = None"}, {"name": "deviceScaleFactor", "types": ["float"], "defaultValue": "1.0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "deviceScaleFactor: float = 1.0"}, {"name": "isMobile", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "isMobile: bool = False"}, {"name": "hasTouch", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "hasTouch: bool = False"}, {"name": "javaScriptEnabled", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "javaScriptEnabled: bool = True"}, {"name": "timezoneId", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timezoneId: str = None"}, {"name": "geolocation", "types": ["GeoLocation"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "geolocation: GeoLocation = None"}, {"name": "locale", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locale: str = None"}, {"name": "permissions", "types": ["List[str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "permissions: List[str] = None"}, {"name": "extraHTTPHeaders", "types": ["Dict[str, str]"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "extraHTTPHeaders: Dict[str, str] = None"}, {"name": "offline", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "offline: bool = False"}, {"name": "httpCredentials", "types": ["HttpCredentials"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "httpCredentials: HttpCredentials = None"}, {"name": "colorScheme", "types": ["ColorScheme"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "colorScheme: ColorScheme = None"}, {"name": "proxy", "types": ["Proxy"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy: Proxy = None"}, {"name": "videosPath", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "videosPath: str = None"}, {"name": "videoSize", "types": ["ViewportDimensions"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "videoSize: ViewportDimensions = None"}, {"name": "defaultBrowserType", "types": ["SupportedBrowsers"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "defaultBrowserType: SupportedBrowsers = None"}, {"name": "hideRfBrowser", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "hideRfBrowser: bool = False"}, {"name": "recordVideo", "types": ["RecordVideo"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recordVideo: RecordVideo = None"}, {"name": "recordHar", "types": ["RecordHar"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recordHar: RecordHar = None"}], "doc": "<p>Create a new BrowserContext with specified options. 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<p><code>acceptDownloads</code> Whether to automatically downloads all the attachments. Defaults to False where all the downloads are canceled.</p>\n<p><code>ignoreHTTPSErrors</code> Whether to ignore HTTPS errors during navigation. Defaults to False.</p>\n<p><code>bypassCSP</code> Toggles bypassing page's Content-Security-Policy. Defaults to False.</p>\n<p><code>viewport</code> Sets a consistent viewport for each page. Defaults to an <code>{'width': 1280, 'height': 720}</code> viewport. Value of <code>viewport</code> can be a dict or a string representation of a dictionary.</p>\n<p><code>userAgent</code> Specific user agent to use in this context.</p>\n<p><code>deviceScaleFactor</code> Specify device scale factor (can be thought of as dpr). Defaults to 1.</p>\n<p><code>isMobile</code> Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to False. Not supported in Firefox.</p>\n<p><code>hasTouch</code> Specifies if viewport supports touch events. Defaults to False.</p>\n<p><code>javaScriptEnabled</code> Whether or not to enable JavaScript in the context. Defaults to True.</p>\n<p><code>timezoneId</code> 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\u2019s metaZones.txt</a> for a list of supported timezone IDs.</p>\n<p><code>geolocation</code> Sets the geolocation. No location is set by default.</p>\n<ul>\n<li><code>latitude</code> &lt;number&gt; Latitude between -90 and 90.</li>\n<li><code>longitude</code> &lt;number&gt; Longitude between -180 and 180.</li>\n<li><code>accuracy</code> Optional &lt;number&gt; Non-negative accuracy value. Defaults to 0.</li>\n</ul>\n<p>Example usage: <code>{'latitude': 59.95, 'longitude': 30.31667}</code></p>\n<p><code>locale</code> Specify user locale, for example <code>en-GB</code>, <code>de-DE</code>, etc. Locale will affect <code>navigator.language</code> value, <code>Accept-Language</code> request header value as well as number and date formatting rules.</p>\n<p><code>permissions</code> A list of permissions to grant to all pages in this context. See <a href=\"https://playwright.dev/docs/api/class-browsercontext#browsercontextgrantpermissionspermissions-options\">grantPermissions</a> for more details.</p>\n<p><code>extraHTTPHeaders</code> A dictionary containing additional HTTP headers to be sent with every request. All header values must be strings.</p>\n<p><code>offline</code> Whether to emulate network being offline. Defaults to False.</p>\n<p><code>httpCredentials</code> Credentials for <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication\">HTTP authentication</a>.</p>\n<ul>\n<li>example: <code>{'username': 'admin', 'password': '123456'}</code></li>\n<li><code>username</code></li>\n<li><code>password</code></li>\n</ul>\n<p><code>colorScheme</code> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See <a href=\"https://playwright.dev/docs/api/class-page#pageemulatemediaparams\">emulateMedia(options)</a> for more details. Defaults to <code>light</code>.</p>\n<p><code>proxy</code> Network proxy settings to use with this context. Note that 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</p>\n<p><code>videosPath</code> is deprecated by playwright, use recordVideo instead. Enables video recording for all pages to videosPath folder. If videosPath is not existing folder, videosPath folder is created under ${OUTPUT_DIR}/browser/video/ folder. If videosPath is not specified, videos are not recorded.</p>\n<p><code>videoSize</code> is deprecated by playwright, use recordVideo instead. Specifies dimensions of the automatically recorded video. Can only be used if videosPath is set. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.</p>\n<ul>\n<li>Example {\"width\": 1280, \"height\": 720}</li>\n</ul>\n<p><code>defaultBrowserType</code> 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:</p>\n<p><code>recordVideo</code> 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. <code>recordVideo</code> is dictionary containing <span class=\"name\">dir</span> and <span class=\"name\">size</span> keys. If <span class=\"name\">dir</span> is not existing folder, videosPath folder is created under ${OUTPUT_DIR}/browser/video/ folder. <span class=\"name\">size</span> Optional dimensions of the recorded videos. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of each page will be scaled down if necessary to fit the specified size. <span class=\"name\">size</span> is dictionary containing <span class=\"name\">width</span> (Video frame width) and  <span class=\"name\">height</span> (Video frame height) keys.</p>\n<p><code>recordHar</code> 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.</p>\n<p><span class=\"name\">omitContent</span>: Optional setting to control whether to omit request content from the HAR. Default is False <span class=\"name\">path</span>: Path on the filesystem to write the HAR file to.</p>\n<p>The ${OUTPUTDIR}/browser/ is removed at the first suite startup.</p>\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>", "shortdoc": "Create a new BrowserContext with specified options. See `Browser, Context and Page` for more information about BrowserContext.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/utils/deprecated.py", "lineno": 346}, {"name": "New Page", "args": [{"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}], "doc": "<p>Open a new Page. 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. Returns a stable identifier for the created page.</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><code>url</code> If specified it will open the new page to the specified URL.</p>", "shortdoc": "Open a new Page. A Page is the Playwright equivalent to a tab. See `Browser, Context and Page` for more information about Page concept. Returns a stable identifier for the created page.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 553}, {"name": "Open Browser", "args": [{"name": "url", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str = None"}, {"name": "browser", "types": ["SupportedBrowsers"], "defaultValue": "chromium", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: SupportedBrowsers = chromium"}, {"name": "headless", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headless: bool = False"}, {"name": "pause_on_failure", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pause_on_failure: bool = True"}], "doc": "<p>Opens a new browser instance. Use this keyword for quick experiments or debugging sessions. 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. Only supports some of the settings Create _ Keywords do</p>\n<p><code>url</code> Navigates to URL if provided. Defaults to None.</p>\n<p><code>browser</code> Specifies which browser to use. The supported browsers are listed in the table below. The browser names are case-sensitive.</p>\n<table border=\"1\">\n<tr>\n<th>Value</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td>firefox</td>\n<td><a href=\"https://www.mozilla.org/en-US/firefox/new\">Firefox</a></td>\n</tr>\n<tr>\n<td>chromium</td>\n<td><a href=\"https://www.chromium.org/Home\">Chromium</a></td>\n</tr>\n<tr>\n<td>webkit</td>\n<td><a href=\"https://webkit.org/\">webkit</a></td>\n</tr>\n</table>\n<p><code>headless</code> If set to False, a GUI is provided otherwise it is hidden. Defaults to False.</p>\n<p><code>pause_on_failure</code> Stop execution when failure detected and leave browser open. Defaults to True.</p>", "shortdoc": "Opens a new browser instance. Use this keyword for quick experiments or debugging sessions. Use `New Page` directly instead of `Open Browser` for production and automated execution. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 63}, {"name": "Press Keys", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "keys", "types": ["str"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "doc": "<p>Types the given key combination into element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Supports values like \"a, b\" which will be automatically typed. . Also supports identifiers for keys like <code>ArrowLeft</code> or <code>Backspace</code>. Using + to chain combine modifiers with a single keypress <code>Control+Shift+T</code> is supported.</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#pagepressselector-key-options\">Playwright docs for press.</a></p>\n<p>Example:</p>\n<pre>\n# Keyword       Selector                    *Keys\nPress Keys      //*[@id=\"username_field\"]    h    e   l   o   ArrowLeft   l\n</pre>", "shortdoc": "Types the given key combination into element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 225}, {"name": "Promise To", "args": [{"name": "kw", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kw: str"}, {"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}], "doc": "<p>Wrap a Browser library keyword and make it a promise. Returns that promise and executes the keyword on background.</p>\n<p><code>kw</code> Keyword that will work async on background.</p>\n<p>Example:</p>\n<pre>\n${promise}=     Promise To            Wait For Response     matcher=     timeout=3\nClick           \\#delayed_request\n${body}=        Wait For              ${promise}\n</pre>", "shortdoc": "Wrap a Browser library keyword and make it a promise. Returns that promise and executes the keyword on background.", "tags": ["Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 35}, {"name": "Promise To Upload File", "args": [{"name": "path", "types": ["PathLike"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "doc": "<p>Returns a promise that resolves when file from <code>path</code> has been uploaded. 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<p><code>path</code> Path to file to be uploaded.</p>\n<p>Example use:</p>\n<pre>\n${promise}=  Promise To Upload File    ${CURDIR}/test_upload_file\nClick          \\#file_chooser\n${upload_result}=  Wait For  ${promise}\n</pre>", "shortdoc": "Returns a promise that resolves when file from ``path`` has been uploaded. Fails if the upload has not happened during timeout.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 140}, {"name": "Promise To Wait For Download", "args": [{"name": "saveAs", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}], "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><code>saveAs</code> defines path where the file is saved. File will also temporarily be saved in playwright context's default download location.</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>\nNew Context          acceptDownloads=True\nNew Page             ${LOGIN_URL}\n${dl_promise}        Promise To Wait For Download    /path/to/download/folder\nClick                \\#file_download\n${file_obj}=         Wait For  ${dl_promise}\nFile Should Exist    ${file_obj}[saveAs]\nShould Be True       ${file_obj.suggestedFilename}\n</pre>", "shortdoc": "Returns a promise that waits for next download event on page.", "tags": ["BrowserControl", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 63}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "types": ["str", "None"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}], "doc": "<p>Sets the keyword to execute, when a Browser keyword fails.</p>\n<p><code>keyword</code> is 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, but the keyword must not take any arguments.</p>\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 the name of the previously registered failure keyword or Python <code>None</code> if this functionality was previously disabled. The return value can be always used to restore the original value later.</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\n${previous kw}=    <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    NONE\n<a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a>    ${previous kw}\n</pre>", "shortdoc": "Sets the keyword to execute, when a Browser keyword fails.", "tags": ["Config"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/runonfailure.py", "lineno": 30}, {"name": "Reload", "args": [], "doc": "<p>Reloads current active page.</p>", "shortdoc": "Reloads current active page.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 234}, {"name": "Scroll By", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "vertical", "types": ["str"], "defaultValue": "height", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = height"}, {"name": "horizontal", "types": ["str"], "defaultValue": "0", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = 0"}, {"name": "behavior", "types": ["ScrollBehavior"], "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "doc": "<p>Scrolls an element or the page relative from current position by the given values.</p>\n<p><code>selector</code> 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.</p>\n<p><code>vertical</code> 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.</p>\n<p><code>horizontal</code> 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.</p>\n<p><code>behavior</code> defines whether the scroll happens directly or it scrolls smoothly.</p>", "shortdoc": "Scrolls an element or the page relative from current position by the given values.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 432}, {"name": "Scroll To", "args": [{"name": "selector", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = None"}, {"name": "vertical", "types": ["str"], "defaultValue": "top", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "vertical: str = top"}, {"name": "horizontal", "types": ["str"], "defaultValue": "left", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "horizontal: str = left"}, {"name": "behavior", "types": ["ScrollBehavior"], "defaultValue": "auto", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "behavior: ScrollBehavior = auto"}], "doc": "<p>Scrolls an element or the page to an absolute position based on given coordinates.</p>\n<p><code>selector</code> 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.</p>\n<p><code>vertical</code> 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> | <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.</p>\n<p><code>horizontal</code> defines where to scroll horizontally. Works same as vertical but defines &lt; <code>left</code> | <code>right</code> &gt; as start and end.</p>\n<p><code>behavior</code> defines whether the scroll happens directly or it scrolls smoothly.</p>", "shortdoc": "Scrolls an element or the page to an absolute position based on given coordinates.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 388}, {"name": "Select Options By", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "attribute", "types": ["SelectAttribute"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: SelectAttribute"}, {"name": "values", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values"}], "doc": "<p>Selects options from select element found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the select tag. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Matches based on the chosen attribute with list of <code>values</code>. Possible attributes to match options by: <code>attribute</code></p>\n<p>If no values to select are passed will deselect options in element.</p>", "shortdoc": "Selects options from select element found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 505}, {"name": "SessionStorage Clear", "args": [], "doc": "<p>Remove all saved data from the session storage.</p>", "shortdoc": "Remove all saved data from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 163}, {"name": "SessionStorage Get Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "assertion_operator", "types": ["AssertionOperator"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_operator: AssertionOperator = None"}, {"name": "assertion_expected", "types": ["Any"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "assertion_expected: Any = None"}], "doc": "<p>Get saved data from from session storage.</p>\n<p><code>key</code> Named key of the item in the storage.</p>\n<p>See <a href=\"#Assertions\" class=\"name\">Assertions</a> for further details for the assertion arguments. Defaults to None.</p>", "shortdoc": "Get saved data from from session storage.", "tags": ["Assertion", "Getter", "PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 103}, {"name": "SessionStorage Remove Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "doc": "<p>Remove saved data with key from the session storage.</p>\n<p><code>key</code> Name of the item which shall be deleted.</p>", "shortdoc": "Remove saved data with key from the session storage.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 148}, {"name": "SessionStorage Set Item", "args": [{"name": "key", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}, {"name": "value", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "doc": "<p>Save data to session storage.</p>\n<p><code>key</code> The name of the key under which it should be saved.</p>\n<p><code>value</code> The value which shall be saved as a string.</p>", "shortdoc": "Save data to session storage.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/webapp_state.py", "lineno": 131}, {"name": "Set Browser Timeout", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}], "doc": "<p>Sets the timeout used by most input and getter keywords.</p>\n<p><code>timeout</code> Timeout of it is for current playwright context.</p>\n<p>Returns the previous value of the timeout.</p>", "shortdoc": "Sets the timeout used by most input and getter keywords.", "tags": ["Config", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 149}, {"name": "Set Geolocation", "args": [{"name": "latitude", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "latitude: float"}, {"name": "longitude", "types": ["float"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "longitude: float"}, {"name": "accuracy", "types": ["float"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "accuracy: float = None"}], "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.</p>", "shortdoc": "Updated the correct Context's geolocation.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 217}, {"name": "Set Offline", "args": [{"name": "offline", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "offline: bool = True"}], "doc": "<p>Toggles current Context's offline emulation.</p>\n<p><code>offline</code> Toggles the offline mode. Set to False to switch back to online mode. Defaults to True.</p>", "shortdoc": "Toggles current Context's offline emulation.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 206}, {"name": "Set Retry Assertions For", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout: timedelta"}], "doc": "<p>Sets the timeout used in retrying assertions when they fail.</p>\n<p><code>timeout</code></p>\n<p>Returns the previous value of the retry_assertions_until.</p>", "shortdoc": "Sets the timeout used in retrying assertions when they fail.", "tags": ["Config", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 170}, {"name": "Set Viewport Size", "args": [{"name": "width", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "types": ["int"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}], "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<p><code>width</code> Sets the width size.</p>\n<p><code>height</code> Sets the heigth size.</p>", "shortdoc": "Sets current Pages viewport size to specified dimensions.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 182}, {"name": "Switch Browser", "args": [{"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "doc": "<p>Switches the currently active Browser to another open Browser. 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<p><code>id</code> Id of the browser to be changed to. Starting at 0.</p>", "shortdoc": "Switches the currently active Browser to another open Browser. Returns a stable identifier for the previous browser. See `Browser, Context and Page` for more information about Browser and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 681}, {"name": "Switch Context", "args": [{"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Switches the active BrowserContext to another open context. 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<p><code>id</code> Id of the context to be changed to. Randomly generated UUID.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | str&gt; Switch context in specified browser. If value is not \"CURRENT\" it should be an the id of the browser where to switch context.</p>", "shortdoc": "Switches the active BrowserContext to another open context. Returns a stable identifier for the previous context. See `Browser, Context and Page` for more information about Context and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 694}, {"name": "Switch Page", "args": [{"name": "id", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}, {"name": "context", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context: str = CURRENT"}, {"name": "browser", "types": ["str"], "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "doc": "<p>Switches the active browser page to another open page by <code>id</code> or <code>NEW</code>. 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<p><code>id</code> &lt; <code>CURRENT</code> | <code>NEW </code> | str&gt; Id of the page to be changed to or</p>\n<p><code>NEW</code> for a page opened after the current page. This may timeout if no new pages exists before library timeout. See <a href=\"#Set%20Browser%20Timeout\" class=\"name\">Set Browser Timeout</a> for how to change the timeout.</p>\n<p>With <code>CURRENT</code> you can get the <code>id</code> of the \"CURRENT\" page</p>\n<p><code>context</code> &lt; <code>CURRENT</code> | str&gt; Switch page in specified context. If value is not \"CURRENT\" it should be the id of the context where to switch page.</p>\n<p><code>browser</code> &lt; <code>CURRENT</code> | str&gt; Switch page in specified browser. If value is not \"CURRENT\" it should be the id of the browser where to switch page.</p>", "shortdoc": "Switches the active browser page to another open page by ``id`` or ``NEW``. Returns a stable identifier ``id`` for the previous page. See `Browser, Context and Page` for more information about Page and related concepts.", "tags": ["BrowserControl", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/playwright_state.py", "lineno": 711}, {"name": "Take Screenshot", "args": [{"name": "filename", "types": ["str"], "defaultValue": "robotframework-browser-screenshot-{index}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = robotframework-browser-screenshot-{index}"}, {"name": "selector", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}, {"name": "fullPage", "types": ["bool"], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "fullPage: bool = False"}], "doc": "<p>Takes a screenshot of the current window and saves it to <code>path</code>. Saves it as a png.</p>\n<p><code>filename</code> Filename into which to save. The file will be saved into the robot framework ${OUTPUTDIR}/browser/screenshot directory by default, but it can 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), 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.</p>\n<p>The ${OUTPUTDIR}/browser/ is removed at the first suite startup.</p>\n<p><code>selector</code> 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.</p>\n<p><code>fullPage</code> When True, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to False.</p>", "shortdoc": "Takes a screenshot of the current window and saves it to ``path``. Saves it as a png.", "tags": ["PageContent"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/browser_control.py", "lineno": 74}, {"name": "Type Secret", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "secret", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "secret: str"}, {"name": "delay", "types": ["timedelta"], "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "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 <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><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>secret</code> 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.</p>\n<p>Example: <code>$Password</code> and <code>${Password}</code> resolve the robot framework variable. <code>%ENV_PWD</code> and <code>%{ENV_PWD}</code> resolve to the environment variable <code>ENV_PWD</code>.</p>\n<p><code>delay</code> 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></p>\n<p><code>clear</code> Set to false, if the field shall not be cleared before typing. Defaults to true.</p>\n<p>See <a href=\"#Type%20Text\" class=\"name\">Type Text</a> for details.</p>", "shortdoc": "Types the given secret from ``variable_name`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 119}, {"name": "Type Text", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "txt", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "txt: str"}, {"name": "delay", "types": ["timedelta"], "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay: timedelta = 0:00:00"}, {"name": "clear", "types": ["bool"], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "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<p><code>selector</code> Selector of the text field. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>txt</code> Text for the text field.</p>\n<p><code>delay</code> 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></p>\n<p><code>clear</code> Set to false, if the field shall not be cleared before typing. Defaults to true.</p>\n<p>See <a href=\"#Fill%20Text\" class=\"name\">Fill Text</a> for direct filling of the full text at once.</p>", "shortdoc": "Types the given ``txt`` into the text field found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 51}, {"name": "Uncheck Checkbox", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}], "doc": "<p>Unchecks the checkbox found by <code>selector</code>.</p>\n<p><code>selector</code> Selector of the checkbox. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p>Does nothing if the element is not checked/selected.</p>", "shortdoc": "Unchecks the checkbox found by ``selector``.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/interaction.py", "lineno": 490}, {"name": "Upload File", "args": [{"name": "path", "types": ["PathLike"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: PathLike"}], "doc": "<p><b>DEPRECATED!!</b> Use keyword <a href=\"#Promise%20To%20Upload%20File\" class=\"name\">Promise To Upload File</a> instead. Upload file from <code>path</code> into next file chooser dialog on page.</p>\n<p><code>path</code> Path to file to be uploaded.</p>\n<p>Example use:</p>\n<pre>\nUpload File    ${CURDIR}/test_upload_file\nClick          \\#file_chooser\n</pre>", "shortdoc": "*DEPRECATED!!* Use keyword `Promise To Upload File` instead. Upload file from ``path`` into next file chooser dialog on page.", "tags": ["PageContent", "Setter"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 161}, {"name": "Wait For", "args": [{"name": "promises", "types": ["Future"], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*promises: Future"}], "doc": "<p>Waits for promises to finish and returns results from them. Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.</p>\n<p><code>promises</code> <b>Work in progress</b></p>\n<p>Example:</p>\n<pre>\n${promise}=     Promise To            Wait For Response     matcher=     timeout=3\nClick           \\#delayed_request\n${body}=        Wait For              ${promise}\n</pre>", "shortdoc": "Waits for promises to finish and returns results from them. Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.", "tags": ["Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 113}, {"name": "Wait For All Promises", "args": [], "doc": "<p>Waits for all promises to finish. If one fails, then this keyword will fail.</p>", "shortdoc": "Waits for all promises to finish. If one fails, then this keyword will fail.", "tags": ["Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 132}, {"name": "Wait For Download", "args": [{"name": "saveAs", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "saveAs: str = "}], "doc": "<p><b>DEPRECATED!!</b> Use keyword <a href=\"#Promise%20To%20Wait%20For%20Download\" class=\"name\">Promise To Wait For Download</a> instead.</p>", "shortdoc": "*DEPRECATED!!* Use keyword `Promise To Wait For Download` instead.", "tags": ["BrowserControl", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/promises.py", "lineno": 93}, {"name": "Wait For Elements State", "args": [{"name": "selector", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "selector: str"}, {"name": "state", "types": ["ElementState"], "defaultValue": "visible", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "state: ElementState = visible"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Waits for the element found by <code>selector</code> to satisfy state option.</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<p><code>selector</code> Selector of the corresponding object. See the <a href=\"#Finding%20elements\" class=\"name\">Finding elements</a> section for details about the selectors.</p>\n<p><code>state</code> See <a href=\"#ElementState\" class=\"name\">ElementState</a> for explaination.</p>\n<p>Note that element without any content or with display:none has an empty bounding box and is not considered visible.</p>\n<p><code>timeout</code> uses default timeout of 10 seconds if not set.</p>\n<p><code>message</code> 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.</p>", "shortdoc": "Waits for the element found by ``selector`` to satisfy state option.", "tags": ["PageContent", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/waiter.py", "lineno": 26}, {"name": "Wait For Function", "args": [{"name": "function", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "function: str"}, {"name": "selector", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "selector: str = "}, {"name": "polling", "types": ["str", "timedelta"], "defaultValue": "raf", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "polling: str | timedelta = raf"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}, {"name": "message", "types": ["str"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str = None"}], "doc": "<p>Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.</p>\n<p><code>function</code> A valid javascript function or a javascript function body. For example <code>() =&gt; true</code> and <code>true</code> will behave similarly.</p>\n<p><code>selector</code> 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.</p>\n<p><code>polling</code> 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.</p>\n<p><code>timeout</code> Uses default timeout of 10 seconds if not set.</p>\n<p><code>message</code> 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.</p>\n<p>Example usage:</p>\n<pre>\n${promise}    Promise To      Wait For Function    element =&gt; element.style.width==\"100%\"    selector=\\#progress_bar    timeout=4s\nClick         \\#progress_bar\nWait For      ${promise}\n</pre>", "shortdoc": "Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.", "tags": ["PageContent", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/waiter.py", "lineno": 107}, {"name": "Wait For Navigation", "args": [{"name": "url", "types": ["str"], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Waits until page has navigated to given <code>url</code>.</p>\n<p><code>url</code>  expected navigation target address.</p>\n<p><code>timeout</code> Timeout in milliseconds. Uses default timeout of 10 seconds if not set.</p>", "shortdoc": "Waits until page has navigated to given ``url``.", "tags": ["HTTP", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 178}, {"name": "Wait For Request", "args": [{"name": "matcher", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str = "}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Waits for request matching matcher to be made.</p>\n<p><code>matcher</code> Request URL string, JavaScript regex or JavaScript function to match request by. By default (with empty string) matches first available request.</p>\n<p><code>timeout</code> Timeout in seconds. Uses default timeout if not set.</p>", "shortdoc": "Waits for request matching matcher to be made.", "tags": ["HTTP", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 127}, {"name": "Wait For Response", "args": [{"name": "matcher", "types": ["str"], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "matcher: str = "}, {"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<p>Waits for response matching matcher and returns python dict with contents.</p>\n<p><code>matcher</code> Request URL string, JavaScript regex or JavaScript function to match request by. By default (with empty string) matches first available request.</p>\n<p><code>timeout</code> Timeout in seconds. Uses default timeout if not set.</p>\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.</li>\n<li><code>body</code> &lt;dict | 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<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</ul>", "shortdoc": "Waits for response matching matcher and returns python dict with contents.", "tags": ["HTTP", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 141}, {"name": "Wait Until Network Is Idle", "args": [{"name": "timeout", "types": ["timedelta"], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta = None"}], "doc": "<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<p><code>timeout</code> Timeout in milliseconds. Uses default timeout of 10 seconds if not set.</p>", "shortdoc": "Waits until there has been at least one instance of 500 ms of no network traffic on the page after loading.", "tags": ["HTTP", "Wait"], "source": "/home/tatu/workspace/robotframework-playwright/Browser/keywords/network.py", "lineno": 163}], "dataTypes": {"enums": [{"name": "AreaFields", "type": "Enum", "doc": "<p>Enumeration that defines which coordinates of an area should be selected.</p>\n<p>Used by <a href=\"#Get%20Scroll%20Position\" class=\"name\">Get Scroll Position</a>.</p>\n<p><code>ALL</code> defines that all fields are selected and a dictionary with all information is returned.</p>", "members": [{"name": "top", "value": "1"}, {"name": "left", "value": "2"}, {"name": "bottom", "value": "3"}, {"name": "right", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"name": "AssertionOperator", "type": "Enum", "doc": "<p>Enum that defines the <code>assertion_operator</code> &lt;<a href=\"#AssertionOperator\" class=\"name\">AssertionOperator</a>&gt;.</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>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>* &lt; less or greater &gt; With Strings* Compairisons of strings with <code>greater than</code> or <code>less than</code> compares each character, starting from 0 reagarding 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<h3>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>", "members": [{"name": "equal", "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"}]}, {"name": "AutoClosingLevel", "type": "Enum", "doc": "<p>Library will close pages and contexts that are created during test execution.</p>\n<p>Pages and contexts created before test in Suite Setup or Suite Teardown will be closed after that suite. This will remove the burden of closing these resources in teardowns. <b>Browsers will not be automatically closed.</b> A browser is expensive to create and should be reused. Automatic closing can be configured or switched off with the auto_closing_level library parameter.</p>\n<p>See: <a href=\"#Importing\" class=\"name\">Importing</a></p>", "members": [{"name": "SUITE", "value": "1"}, {"name": "TEST", "value": "2"}, {"name": "MANUAL", "value": "3"}]}, {"name": "BoundingBoxFields", "type": "Enum", "doc": "<p>Enumeration that defines which location information of an element should be selected.</p>\n<p>Used by <a href=\"#Get%20BoundingBox\" class=\"name\">Get BoundingBox</a>.</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>", "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "x", "value": "3"}, {"name": "y", "value": "4"}, {"name": "ALL", "value": "5"}]}, {"name": "ColorScheme", "type": "Enum", "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>\n<p>Used by <a href=\"#New%20Context\" class=\"name\">New Context</a>.</p>", "members": [{"name": "dark", "value": "1"}, {"name": "light", "value": "2"}, {"name": "no-preference", "value": "3"}]}, {"name": "CookieSameSite", "type": "Enum", "doc": "<p>An enumeration.</p>", "members": [{"name": "Strict", "value": "Strict"}, {"name": "Lax", "value": "Lax"}, {"name": "None", "value": "None"}]}, {"name": "CookieType", "type": "Enum", "doc": "<p>Enum that defines the Cookie type.</p>", "members": [{"name": "dictionary", "value": "1"}, {"name": "dict", "value": "1"}, {"name": "string", "value": "2"}, {"name": "str", "value": "2"}]}, {"name": "DialogAction", "type": "Enum", "doc": "<p>Enum that defines how to handle a dialog.</p>", "members": [{"name": "accept", "value": "1"}, {"name": "dismiss", "value": "2"}]}, {"name": "ElementState", "type": "Enum", "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</table>\n<p>Used by: <a href=\"#Wait%20For%20Elements%20State\" class=\"name\">Wait For Elements State</a></p>", "members": [{"name": "attached", "value": "1"}, {"name": "detached", "value": "2"}, {"name": "visible", "value": "3"}, {"name": "hidden", "value": "4"}, {"name": "enabled", "value": "5"}, {"name": "disabled", "value": "6"}, {"name": "editable", "value": "7"}, {"name": "readonly", "value": "8"}, {"name": "selected", "value": "9"}, {"name": "deselected", "value": "10"}, {"name": "focused", "value": "11"}, {"name": "defocused", "value": "12"}, {"name": "checked", "value": "13"}, {"name": "unchecked", "value": "14"}]}, {"name": "ElementStateKey", "type": "Enum", "doc": "<p>Enum that defines the state an element can have directly.</p>\n<p>See <a href=\"#ElementState\" class=\"name\">ElementState</a> for explaination.</p>\n<p>Used by: <a href=\"#Get%20Element%20State\" class=\"name\">Get Element State</a></p>", "members": [{"name": "attached", "value": "1"}, {"name": "visible", "value": "2"}, {"name": "disabled", "value": "3"}, {"name": "readonly", "value": "4"}, {"name": "selected", "value": "5"}, {"name": "focused", "value": "6"}, {"name": "checked", "value": "7"}]}, {"name": "KeyAction", "type": "Enum", "doc": "<p>Enum that defines which <a href=\"#Keyboard%20Key\" class=\"name\">Keyboard Key</a> action to perform.</p>", "members": [{"name": "down", "value": "1"}, {"name": "up", "value": "2"}, {"name": "press", "value": "3"}]}, {"name": "KeyboardInputAction", "type": "Enum", "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>", "members": [{"name": "insertText", "value": "1"}, {"name": "type", "value": "2"}]}, {"name": "KeyboardModifier", "type": "Enum", "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>", "members": [{"name": "Alt", "value": "1"}, {"name": "Control", "value": "2"}, {"name": "Meta", "value": "3"}, {"name": "Shift", "value": "4"}]}, {"name": "MouseButton", "type": "Enum", "doc": "<p>Enum that defines which mouse button to use.</p>\n<p>Used by: <a href=\"#Click\" class=\"name\">Click</a> and <a href=\"#MouseButton\" class=\"name\">Mouse Button</a>.</p>", "members": [{"name": "left", "value": "1"}, {"name": "middle", "value": "2"}, {"name": "right", "value": "3"}]}, {"name": "MouseButtonAction", "type": "Enum", "doc": "<p>Enum that defines which <a href=\"#MouseButton\" class=\"name\">Mouse Button</a> action to perform.</p>", "members": [{"name": "click", "value": "1"}, {"name": "down", "value": "2"}, {"name": "up", "value": "3"}]}, {"name": "RequestMethod", "type": "Enum", "doc": "<p>Enum that defines the request type.</p>\n<p>Used by: <a href=\"#Http\" class=\"name\">HTTP</a> .</p>", "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"}]}, {"name": "ScrollBehavior", "type": "Enum", "doc": "<p>Enum that controls the behavior of scrolling.</p>\n<p><code>smooth</code></p>", "members": [{"name": "auto", "value": "1"}, {"name": "smooth", "value": "2"}]}, {"name": "SelectAttribute", "type": "Enum", "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>", "members": [{"name": "value", "value": "1"}, {"name": "label", "value": "2"}, {"name": "text", "value": "2"}, {"name": "index", "value": "3"}]}, {"name": "SelectionType", "type": "Enum", "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>\n<p>Used by: <a href=\"#Get%20Browser%20Ids\" class=\"name\">Get Browser IDs</a> <a href=\"#Get%20Context%20Ids\" class=\"name\">Get Context IDs</a> and <a href=\"#Get%20Page%20Ids\" class=\"name\">Get Page IDs</a>.</p>", "members": [{"name": "ACTIVE", "value": "1"}, {"name": "CURRENT", "value": "1"}, {"name": "ALL", "value": "2"}, {"name": "ANY", "value": "2"}]}, {"name": "SizeFields", "type": "Enum", "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>\n<p>Used by: <a href=\"#Get%20Viewport%20Size\" class=\"name\">Get Viewport Size</a>, <a href=\"#Get%20Scroll%20Size\" class=\"name\">Get Scroll Size</a> and <a href=\"#Get%20Client%20Size\" class=\"name\">Get Client Size</a>.</p>", "members": [{"name": "width", "value": "1"}, {"name": "height", "value": "2"}, {"name": "ALL", "value": "3"}]}, {"name": "SupportedBrowsers", "type": "Enum", "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>", "members": [{"name": "chromium", "value": "1"}, {"name": "firefox", "value": "2"}, {"name": "webkit", "value": "3"}]}], "typedDicts": [{"name": "GeoLocation", "type": "TypedDict", "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. Example usage: <code>{'latitude': 59.95, 'longitude': 30.31667}</code></li>\n</ul>", "items": [{"key": "longitude", "type": "float", "required": true}, {"key": "latitude", "type": "float", "required": true}, {"key": "accuracy", "type": "float", "required": false}]}, {"name": "HttpCredentials", "type": "TypedDict", "doc": "<p>Sets the credentials for http basic-auth.</p>\n<p>Can be defined as robot dictionary or as string literal.</p>\n<p>Example as literal:</p>\n<pre>\n<a href=\"#New%20Context\" class=\"name\">New Context</a>    httpCredentials={'username': 'admin', 'password': '123456'}\n</pre>\n<p>Example as robot variable</p>\n<pre>\n<b>***</b> <b>Variables</b> <b>***</b>\n&amp;{credentials}=    username=admin    password=123456\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>", "items": [{"key": "username", "type": "str", "required": true}, {"key": "password", "type": "str", "required": true}]}, {"name": "Proxy", "type": "TypedDict", "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>", "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}]}, {"name": "RecordHar", "type": "TypedDict", "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><span class=\"name\">path</span>: 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>", "items": [{"key": "omitContent", "type": "bool", "required": false}, {"key": "path", "type": "str", "required": false}]}, {"name": "RecordVideo", "type": "TypedDict", "doc": "", "items": [{"key": "dir", "type": "str", "required": false}, {"key": "size", "type": "ViewportDimensions", "required": false}]}, {"name": "ViewportDimensions", "type": "TypedDict", "doc": "", "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>