RPA.Browser.Playwright

Adds a cookie to currently active browser context.

Arguments

Examples

Add Cookie   foo   bar   http://address.com/path/to/site                                     # Using url argument.
Add Cookie   foo   bar   domain=example.com                path=/foo/bar                     # Using domain and url arguments.
Add Cookie   foo   bar   http://address.com/path/to/site   expiry=2027-09-28 16:21:35        # Expiry as timestamp.
Add Cookie   foo   bar   http://address.com/path/to/site   expiry=1822137695                 # Expiry as epoch seconds.

Adds a <style type="text/css"> tag with the content.

Arguments

Examples

Add Style Tag    \#username_field:focus {background-color: aqua;}

Checks the checkbox or selects radio button found by selector.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Does nothing if the element is already checked/selected.

Clears all permissions from the current context.

Clears the text field found by selector.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

See Type Text for emulating typing text character by character. See Fill Text for direct filling of the full text at once.

Simulates mouse click on the element found by selector.

Arguments

This keyword clicks an element matching selector by performing the following steps:

• Find an element matches selector. If there is none, wait until a matching element is attached to the DOM.
• Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
• Scroll the element into view if needed.
• Use Mouse Button to click in the center of the element, or the specified position.
• Wait for initiated navigation to either succeed or fail, unless noWaitAfter option is set.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Examples

Click    id=button_location
Click    \#clickWithOptions    delay=100ms    clickCount=2

*modifiers Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used. Modifiers can be specified in any order, and multiple modifiers can be specified. Valid modifier keys are Control, Alt, Shift and Meta. Due to the fact that the argument *modifiers is a positional only argument, all preceding keyword arguments have to be specified as positional arguments before *modifiers.

Example:

Click    id=clickWithModifiers    left    1    None    None    None    False    False    Alt    Meta    Shift
Click    id=clickWithModifier    right    2    None    None    None    False    False    Shift

Closes the current browser.

Arguments

Active browser is set to the browser that was active before this one. Closes all context and pages belonging to this browser. See Browser, Context and Page for more information about Browser and related concepts.

Examples

Close Browser    ALL        # Closes all browsers
Close Browser    CURRENT    # Close current browser
Close Browser               # Close current browser
Close Browser    ${id}      # Close browser matching id

Closes a Context.

Arguments

Active context is set to the context that was active before this one. Closes pages belonging to this context. See Browser, Context and Page for more information about Context and related concepts.

Examples

Close Context                          #  Closes current context and current browser
Close Context    CURRENT    CURRENT    #  Closes current context and current browser
Close Context    ALL        CURRENT    #  Closes all context from current browser and current browser
Close Context    ALL        ALL        #  Closes all context from current browser and all browser

Closes the page in context in browser.

Arguments

Defaults to current for all three. Active page is set to the page that was active before this one. See Browser, Context and Page for more information about Page and related concepts.

Returns a list of dictionaries containing id, errors and console messages from the page.

Example

Close Page                                       # Closes current page, within the current context and browser
Close Page    CURRENT     CURRENT     CURRENT    # Closes current page, within the current context and browser
Close Page    ALL         ALL         ALL        # Closes all pages, within all contexts and browsers

Connect to a playwright Browser.

Arguments

See Browser, Context and Page for more information about Browser and related concepts.

Returns a stable identifier for the connected browser.

Web crawler is a tool to go through all the pages on a specific URL domain. This happens by finding all links going to the same site and opening those.

Arguments

returns list of crawled urls.

Deletes all cookies from the currently active browser context.

Deselects all options from select element found by selector.

Arguments

If you just want to select one or more specific options and currently more options are selected, use Select Options By keyword with the options to be selected in the end.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Download given url content.

Arguments

Keyword returns dictionary which contains downloaded file path and suggested filename as keys (saveAs and suggestedFilename). If the file URL cannot be found (the download is triggered by event handlers) use Wait For Downloadkeyword.

To enable downloads context's acceptDownloads needs to be true.

To configure download directory use New Browser's downloadsPath settings

With default filepath downloaded files are deleted when Context the download happened in is closed.

This keyword requires that there is currently an open page. The keyword uses the current pages local state (cookies, sessionstorage, localstorage) for the download to avoid authentication problems.

Examples

${file_object}=    Download    ${url}
${actual_size}=    Get File Size    ${file_object.saveAs}

Example 2:

${elem}=          Get Element   text="Download File"
${href}=          Get Property  ${elem}  href
${file_object}=   Download  ${href}
${file_path}=     Set Variable  ${file_object.saveAs}

Executes a Drag&Drop operation from the element selected by selector_from to the element selected by selector_to.

Arguments

See the Finding elements section for details about the selectors.

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.

Start- and end-point are defined by the center of the elements boundingbox.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Example

Drag And Drop    "Circle"    "Goal"

Executes a Drag&Drop operation from a coordinate to another coordinate.

Arguments

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.

Start- and end-point are defined by x and y coordinates relative to the top left corner of the pages viewport.

Examples

Drag And Drop By Coordinates
...    from_x=30    from_y=30
...    to_x=10    to_y=10    steps=20

Executes a Drag&Drop operation from the element selected by selector_from to coordinates relative to the center of that element.

Arguments

This keyword can be handy to simulate swipe actions.

See the Finding elements section for details about the selectors.

First it moves the mouse to the start-point (center of boundingbox), then presses the left mouse button, then moves to the relative position with the given intermediate steps, then releases the mouse button.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Example

Drag And Drop Relative to    "Circle"    -20    0     # Slides the element 20 pixel to the left

Eat all cookies for all easter.

Executes given javascript on the selected element(s) or on page.

Arguments

Example with all_elements=True:

 ${texts}=    Evaluate JavaScript    button
 ...    (elements, arg) => {
 ...        let text = []
 ...            for (e of elements) {
 ...                console.log(e.innerText)
 ...                text.push(e.innerText)
 ...            }
 ...        text.push(arg)
 ...        return text
 ...    }
 ...    all_elements=True
 ...    arg=Just another Text

Keyword uses strict mode if all_elements is False. See Finding elements for more details about strict mode.

Usage examples.

DEPRECATED!! Use keyword Evaluate JavaScript instead. This keyword will be removed end of 2022.

Arguments

Executes given javascript on the page.

Same functionality can be replaced with newer Evaluate JavaScript Keyword:

-    Execute JavaScript    (elem) => elem.innerText = "abc"    h1
+    Evaluate JavaScript    h1    (elem) => elem.innerText = "abc"

Example for replacement without Selector:

-    Execute JavaScript    () => document.location.hostname
+    Evaluate JavaScript    ${None}    () => document.location.hostname

Keyword uses strict mode if selector is defined. See Finding elements for more details about strict mode.

Usage examples.

Fills the given secret from variable_name into the text field found by selector.

Arguments

This keyword does not log secret in Robot Framework logs, when keyword resolves the secret variable internally. When secret variable is prefixed with $, without the curly braces, library will resolve the corresponding Robot Framework variable.

If secret variable is prefixed with %, library will resolve corresponding environment variable. Example $Password` will resolve to ${Password} Robot Framework variable. Also %ENV_PWD will resolve to %{ENV_PWD} environment variable.

Using normal Robot Framework variables will also work,

Normal plain text will not work. For now, it will just create warnings. In the future this keyword will fail with plain text. If you want to use plain text, use Fill Text keyword instead.

If enable_playwright_debug 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.

Keyword uses strict mode, see Finding elements for more details about strict mode.

See Fill Text for other details.

Examples

Fill Secret    input#username_field    $username    # Keyword resolves variable value from Robot Framework variables
Fill Secret    input#username_field    %username    # Keyword resolves variable value from environment variables

Clears and fills the given txt into the text field found by selector.

Arguments

This method waits for an element matching the selector to appear, waits for actionability checks, focuses the element, fills it and triggers an input event after filling.

If the element matching selector is not an <input>, <textarea> or [contenteditable] element, this method throws an error. Note that you can pass an empty string as txt to clear the input field.

Keyword uses strict mode, see Finding elements for more details about strict mode.

See Type Text for emulating typing text character by character.

Examples

Fill Text    css=input#username_field    username

Moves focus on to the element found by selector.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

If there's no element matching selector, the method waits until a matching element appears in the DOM. Timeouts after 10 seconds.

Returns the HTML attribute of the element found by selector.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the attribute value matches the expected value. See Assertions for further details for the assertion arguments. By default assertion is not done.

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 None. This can be used to assert check the presents or the absents of an attribute.

Example Element:

<button class="login button active" id="enabled_button" something>Login</button>

Example Code:

Get Attribute   id=enabled_button    disabled                   # FAIL => "Attribute 'disabled' not found!"
Get Attribute   id=enabled_button    disabled     ==    ${None}     # PASS => returns: None
Get Attribute   id=enabled_button    something    evaluate    value is not None    # PASS =>  returns: True
Get Attribute   id=enabled_button    disabled     evaluate    value is None        # PASS =>  returns: True

Returns all HTML attribute names of an element as a list.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that attribute names do match to the expected value. See Assertions for further details for the assertion arguments. By default assertion is not done.

Available assertions:

• == and != can work with multiple values
• contains / *= only accepts one single expected value

Other operators are not allowed.

Examples

Get Attribute Names    [name="readonly_input"]    ==    type    name    value    readonly    # Has exactly these attribute names.
Get Attribute Names    [name="readonly_input"]    contains    disabled    # Contains at least this attribute name.

Gets elements size and location as an object {x: float, y: float, width: float, height: float}.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the value matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Example use:

${bounding_box}=    Get BoundingBox    id=element                 # unfiltered
Log                 ${bounding_box}                                 # {'x': 559.09375, 'y': 75.5, 'width': 188.796875, 'height': 18}
${x}=               Get BoundingBox    id=element    x            # filtered
Log                 X: ${x}                                         # X: 559.09375

Get BoundingBox     id=element         width         >    180
Get BoundingBox     id=element         ALL           validate    value['x'] > value['y']*2

Returns all browsers, open contexts in them and open pages in these contexts.

Arguments

See Browser, Context and Page for more information about these concepts.

The data is parsed into a python list containing data representing the open Objects.

On the root level the data contains a list of open browsers.

Data can be manipulated also with assertion_operator for example to find a specific id based on index or page title with then operator.

Return value can also be asserted against expected value.

Sample:

[
  {
    "type": "chromium",
    "id": "browser=96207191-8147-44e7-b9ac-5e04f2709c1d",
    "contexts": [
      {
        "type": "context",
        "id": "context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089",
        "activePage": "page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12",
        "pages": [
          {
            "type": "page",
            "title": "Robocorp",
            "url": "https://robocorp.com/",
            "id": "page=7ac15782-22d2-48b4-8591-ff17663fa737",
            "timestamp": 1598607713.858
          },
          {
            "type": "page",
            "title": "Home - Reaktor",
            "url": "https://www.reaktor.com/",
            "id": "page=f90c97b8-eaaf-47f2-98b2-ccefd3450f12",
            "timestamp": 1598607714.702
          }
        ]
      }
    ],
    "activeContext": "context=525d8e5b-3c4e-4baa-bfd4-dfdbc6e86089",
    "activeBrowser": false
  },
  {
    "type": "firefox",
    "id": "browser=ad99abac-17a9-472b-ac7f-d6352630834e",
    "contexts": [
      {
        "type": "context",
        "id": "context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0",
        "activePage": "page=8baf2991-5eaf-444d-a318-8045f914e96a",
        "pages": [
          {
            "type": "page",
            "title": "Software-Qualitätssicherung und Softwaretest",
            "url": "https://www.imbus.de/",
            "id": "page=8baf2991-5eaf-444d-a318-8045f914e96a",
            "timestamp": 1598607716.828
          }
        ]
      }
    ],
    "activeContext": "context=bc64f1ba-5e76-46dd-9735-4bd344afb9c0",
    "activeBrowser": true
  }
]

Returns a list of ids from open browsers. See Browser, Context and Page for more information about Browser and related concepts.

Arguments

browser Defaults to ALL

• ALL / ANY Returns all ids as a list.
• ACTIVE / CURRENT Returns the id of the currently active browser as list.

The ACTIVE browser is a synonym for the CURRENT Browser.

Returns the state of the checkbox found by selector.

Arguments

Optionally asserts that the state matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

• checked => True
• unchecked => False

Keyword uses strict mode, see Finding elements for more details about strict mode.

Examples

Get Checkbox State    [name=can_send_email]    ==    checked

Returns all classes of an element as a list.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the value matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Available assertions:

• == and != can work with multiple values
• contains / *= only accepts one single expected value

Other operators are not allowed.

Examples

Get Classes    id=draggable    ==    react-draggable    box    # Element contains exactly this class name.
Get Classes    id=draggable    validate    "react-draggable-dragged" not in value    # Element does not contain react-draggable-dragged class.

Gets elements or pages client size (clientHeight, clientWidth) as object {width: float, height: float}.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the value matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

See Get BoundingBox or Get Scroll Size for examples.

Returns a list of context ids based on the browser selection. See Browser, Context and Page for more information about Context and related concepts.

Arguments

ALL and ANY are synonyms. ACTIVE and CURRENT are also synonyms.

The ACTIVE context of the ACTIVE Browser is the Current Context.

Returns information of cookie with name as a Robot Framework dot dictionary or a string.

Arguments

If return_type is dictionary or dict then keyword returns a of Robot Framework dot dictionary The dictionary contains all possible key value pairs of the cookie. If return_type is string or str, then keyword returns the cookie as a string in format: name1=value1. The return value contains only name and value keys of the cookie.

If no cookie is found with name keyword fails. The cookie dictionary contains details about the cookie. Keys available in the dictionary are documented in the table below.

See playwright documentation for details about each attribute.

Examples

${cookie}=        Get Cookie              Foobar
Should Be Equal   ${cookie.value}           Tidii
Should Be Equal   ${cookie.expiry.year}     ${2020}

Returns cookies from the current active browser context.

Arguments

If return_type is dictionary or dict then keyword returns list of Robot Framework dot dictionaries The dictionary contains all possible key value pairs of the cookie. See Get Cookie keyword documentation about the dictionary keys and values.

If return_type is string or str, then keyword returns the cookie as a string in format: name1=value1; name2=value2; name3=value3. The return value contains only name and value keys of the cookie.

Get a single device descriptor with name exactly matching name.

Arguments

Allows a concise syntax to set website testing values to exact matches of specific mobile devices.

Use by passing to a context. After creating a context with devicedescriptor, before using ensure your active page is on that context. Usage:

${device}=          Get Device       iPhone X
New Context         &{device}
New Page
Get Viewport Size   # returns { "width": 375, "height": 812 }

Returns a dict of all playwright device descriptors.

See Playwright's deviceDescriptorsSource.json for a formatted list.

Returns a reference to a Playwright Locator.

Arguments

The reference can be used in subsequent selectors.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Examples

${element} =    Get Element    \#username_field
${option_value} =    Get Property    ${element} >> optionOne    value    # Locator is resolved from the page.
${option_value} =    Get Property    ${element} >> optionTwo    value    # Locator is resolved again from the page.

Returns the count of elements found with selector.

Arguments

Optionally asserts that the state matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Examples

Get Element Count    label    >    1

DEPRECATED!! Use keyword Get Element States instead. This keyword will be removed end of 2022.

Arguments

Get the given state from the element found by selector.

Refactoring example assertion:

-    Get Element State    h1    readonly    ==    False
+    Get Element States    h1    not contains    readonly

Refactoring example asserting multiple states:

-    Get Element State    id=password    visible    ==    True
-    Get Element State    id=password    readonly    ==    False
-    Get Element State    id=password    disabled    ==    False
+    Get Element States    h1    contains    visible    editable    enabled

Refactoring example for getting state:

-    ${visibility}    Get Element State    h1    visible
+    ${visibility}    Get Element States    h1    then    bool(value & visible)  # Returns ${True} if element is visible.

If the selector does satisfy the expected state it will return True otherwise False.

selector Selector of the corresponding object. See the Finding elements section for details about the selectors.

state Defaults to visible. Possible states are

assertion_operator See Assertions for further details. Defaults to None.

assertion_expected Expected value for the counting

message overrides the default error message for assertion.

Note that element must be attached to DOM to be able to fetch the state of readonly , selected and checked. The other states are false if the requested element is not attached.

Note that element without any content or with display:none has an empty bounding box and is not considered visible.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the state matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Examples

Get Element State    h1    readonly    ==    False

Get the active states from the element found by selector.

Arguments

This Keyword returns a list of states that are valid for the selected element.

Optionally asserts that the state matches the specified assertion. See Assertions for further details for the assertion arguments. By default, assertion is not done.

This keyword internally works with Python IntFlag. Flags can be processed using bitwise operators like & (bitwise AND) and | (bitwise OR). When using the assertion operators then, evaluate or validate the value contain the states as ElementState.

Examples

Get Element States    h1    validate    value & visible   # Fails in case of an invisible element
Get Element States    h1    then    value & (visible | hidden)  # Returns either ['visible'] or ['hidden']
Get Element States    h1    then    bool(value & visible)  # Returns ${True} if element is visible

The most typical use case would be to verify if an element contains a specific state or multiple states.

Example:

Get Element States    id=checked_elem      *=    checked
Get Element States    id=checked_elem      not contains    checked
Get Element States    id=invisible_elem    contains    hidden    attached
Get Element States    id=disabled_elem     contains    visible    disabled    readonly

Elements do return the positive and negative values if applicable. As example, a checkbox does return either checked or unchecked while a text input element has none of those two states. Select elements have also either selected or unselected.

The state of animating will be set if an element is not considered stable within 300 ms.

If an element is not attached to the dom, so it can not be found within 250ms it is marked as detached as the only state.

stable state is not returned, because it would cause too high delay in that keyword.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Returns a reference to Playwright Locator for all matched elements by selector.

Arguments

Examples

${elements} =    Get Elements
${elem} =    Get From List    ${elements}    0
${option_value} =    Get Property    ${elem} >> option    value

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.

Arguments

ALL and ANY are synonyms. ACTIVE and CURRENT are also synonyms.

Examples

Test Case
    New Page    http://www.imbus.de
    New Page    http://www.reaktor.com
    ${current_page}=   Get Page IDs    ACTIVE    ACTIVE    ACTIVE
    Log                Current page ID is: ${current_page}[0]
    ${all_pages}=      Get Page IDs    CURRENT   CURRENT   ALL
    Log Many           These are all Page IDs    @{all_pages}

The ACTIVE page of the ACTIVE context of the ACTIVE Browser is the Current Page.

Gets pages HTML source as a string.

Arguments

Optionally does a string assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Returns the property of the element found by selector.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the property value matches the expected value. See Assertions for further details for the assertion arguments. By default assertion is not done.

If assertion_operator is set and property is not found, value is None and Keyword does not fail. See Get Attribute for examples.

Examples

Get Property    h1    innerText    ==    Login Page
${property} =    Get Property    h1    innerText

Gets elements or pages current scroll position as object {top: float, left: float, bottom: float, right: float}.

Arguments

It describes the rectangle which is visible of the scrollable content of that element. all values are measured from position {top: 0, left: 0}.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the value matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

See Get BoundingBox or Get Scroll Size for examples.

Gets elements or pages scrollable size as object {width: float, height: float}.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the state matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

See Get BoundingBox for more similar examples.

Example use:

${height}=         Get Scroll Size    height                          # filtered page by height
Log                Width: ${height}                                   # Height: 58425
${scroll_size}=    Get Scroll Size    id=keyword-shortcuts-container  # unfiltered element
Log                ${scroll_size}                                     # {'width': 253, 'height': 3036}

Returns attributes of options of a select element as a list of dictionaries.

Arguments

Returned dictionaries have the following keys and their values "index", "value", "label" and "selected".

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that these match the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Examples

Get Select Options     //select[2]    validate  [v["label"] for v in value] == ["Email", "Mobile"]
Get Select Options   select#names     validate  any(v["label"] == "Mikko" for v in value)

Returns the specified attribute of selected options of the select element.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that these match the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

• == and != can work with multiple values
• contains / *= only accepts one single expected value

Other operators are not allowed.

Examples

Select Options By      label                    //select[2]    Email      Mobile
${selected_list}         Get Selected Options   //select[2]                                         # getter
Get Selected Options   //select[2]              label          ==       Mobile             Mail   #assertion content
Select Options By      label                    select#names   2          4
Get Selected Options   select#names             index          ==       2                  4      #assertion index
Get Selected Options   select#names             label          *=         Mikko                     #assertion contain
Get Selected Options   select#names             label          validate   len(value) == 3           #assertion length

Gets the computed style properties of the element selected by selector.

Arguments

Optionally matches with any sequence assertion operator.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the style matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Returns the Web Element that has the same column index and same row index as the selected elements.

Arguments

column and row can also consume index numbers instead of selectors. Indexes are starting from 0 and -1 is specific for the last element.

Selectors for column and row are directly appended to table selector like this: f"{table} >> {row}" .

Examples

${table}=    Set Variable    [id="Get Table Cell Element"] >> div.kw-docs table >> nth=1
${e}=    Get Table Cell Element    ${table}    "Real Name"    "aaltat"   # Returns element with text Tatu Aalto
Get Text    ${e}    ==    Tatu Aalto
${e}=    Get Table Cell Element    ${table}    "Slack"    "Mikko Korpela"   # Returns element with text @mkorpela
Get Text    ${e}    ==    @mkorpela
${e}=    Get Table Cell Element    ${table}    "mkorpela"    "Kerkko Pelttari"   # column does not need to be in row 0
Get Text    ${e}    ==    @mkorpela
${e}=    Get Table Cell Element    ${table}    2    -1   # Index is also directly possible
Get Text    ${e}    ==    René Rohner

Returns the index (0 based) of a table cell within its row.

Arguments

Examples

${table}=    Set Variable    id=Get Table Cell Element >> div.kw-docs table   #Table of keyword Get Table Cell Element
${idx}=    Get Table Cell Index    ${table} >> "Real Name"
Should Be Equal    ${idx}    ${2}
Get Table Cell Index    ${table} >> "@aaltat"    ==    1

Optionally asserts that the index matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Returns the index (0 based) of a table row.

Arguments

Examples

${table}=    Set Variable    id=Get Table Cell Element >> div.kw-docs table   #Table of keyword Get Table Cell Element
${idx}=    Get Table Row Index    ${table} >> "@René"
Should Be Equal    ${idx}    ${4}
Get Table Row Index    ${table} >> "@aaltat"    ==    2

Optionally asserts that the index matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Returns text attribute of the element found by selector.

Arguments

Keyword can also return input or textarea value property text. See the Finding elements section for details about the selectors.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Optionally asserts that the text matches the specified assertion. See Assertions for further details for the assertion arguments. By default, assertion is not done.

Examples

${text} =    Get Text    id=important                            # Returns element text without assertion.
${text} =    Get Text    id=important    ==    Important text    # Returns element text with assertion.
${text} =    Get Text    //input         ==    root              # Returns input element text with assertion.

Returns the title of the current page.

Arguments

Optionally asserts that title matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Returns the current URL.

Arguments

Optionally asserts that it matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Returns the current viewport dimensions.

Arguments

Optionally asserts that the state matches the specified assertion. See Assertions for further details for the assertion arguments. By default assertion is not done.

Examples

Get Viewport Size    ALL    ==    {'width':1280, 'height':720}
Get Viewport Size    width    >=    1200

Navigates to the previous page in history.

Navigates to the next page in history.

Navigates to the given url.

Arguments

Grants permissions to the current context.

Arguments

Examples

New Context
Grant Permissions    geolocation

Handle next dialog on page with action.

Arguments

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.

If a handler is not set dialogs are dismissed by default.

Examples

Handle Future Dialogs    action=accept
Click                    \#alerts

Adds a highlight to elements matched by the selector. Provides a style adjustment.

Arguments

Keyword does not fail if selector resolves to multiple elements.

Examples

Highlight Elements    input#login_button    duration=200ms
Highlight Elements    input#login_button    duration=200ms    width=4px    style=solid    color=\#FF00FF

Moves the virtual mouse and scrolls to the element found by selector.

Arguments

This method hovers over an element matching selector by performing the following steps:

• Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM.
• Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
• Scroll the element into view if needed.
• Use Mouse Move to hover over the center of the element, or the specified position.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Examples

Hover    h1
Hover    h1    10   20    Alt

Performs an HTTP request in the current browser context

Arguments

The response is a Python dictionary with following attributes:

• status <int> The status code of the response.
• statusText <str> Status text corresponding to status, e.g OK or INTERNAL SERVER ERROR.
• body <dict> | <str> 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.
• headers <dict> A dictionary containing all response headers.
• ok <bool> Whether the request was successfull, i.e. the status is range 200-299.

Here's an example of using Robot Framework dictionary variables and extended variable syntax to do assertions on the response object:

&{res}=             HTTP                       /api/endpoint
Should Be Equal     ${res.status}              200
Should Be Equal     ${res.body.some_field}     some value

Input text into page with virtual keyboard.

Arguments

Attention: Argument type int for 'delay' in milliseconds has been changed to timedelta in Browser 14.0.0. Use Robot Framework time format with units instead.

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 Keyboard Key press

Examples

Keyboard Input    insertText    0123456789

Press a keyboard key on the virtual keyboard or set a key up or down.

Arguments

Useful keys for down and up for example are: Shift, Control, Alt, Meta, ShiftLeft

Example excecution:

Keyboard Key    press    S
Keyboard Key    down     Shift
Keyboard Key    press    ArrowLeft
Keyboard Key    press    Delete
Keyboard Key    up       Shift

Note: Capital letters don't need to be written by the help of Shift. You can type them in directly.

Remove all saved data from the local storage.

Examples

Local Storage Set Item      Foo    bar
LocalStorage Clear
${item} =    Local Storage Get Item    Foo
Should Be Equal    ${item}    ${None}

Get saved data from the local storage.

Arguments

See Assertions for further details for the assertion arguments. Defaults to None.

Examples

Local Storage Get Item    Key    ==    Value    My error
${value} =    Local Storage Get Item    Key

Remove saved data with key from the local storage.

Arguments

Examples

Local Storage Set Item      Foo    bar
LocalStorage Remove Item    Foo
${item} =    Local Storage Get Item    Foo
Should Be Equal    ${item}    ${None}

Save data to the local storage.

Arguments

Examples

Local Storage Set Item    Key    Value

Clicks, presses or releases a mouse button.

Arguments

Attention: Argument type int for 'delay' in milliseconds has been changed to timedelta in Browser 14.0.0. Use Robot Framework time format instead. For refactoring just add 'ms' after the delay number.

Delay Example:

Mouse Button    click    100 ms
Mouse Button    click    ${dyn_delay} ms

Moving the mouse between holding down and releasing it, is possible with Mouse Move.

Examples

Hover                     "Obstacle"           # Move mouse over the element
Mouse Button              down                 # Press mouse button down
Mouse Move Relative To    "Obstacle"    500    # Drag mouse
Mouse Button              up                   # Release mouse button

Instead of selectors command mouse with coordinates. The Click commands will leave the virtual mouse on the specified coordinates.

Arguments

Examples

Mouse Move    400    400

Moves the mouse cursor relative to the selected element.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Examples

Mouse Move Relative To    id=indicator    -100

Create a new playwright Browser with specified options.

Arguments

See Browser, Context and Page for more information about Browser and related concepts.

Returns a stable identifier for the created browser.

Old deprecated argument order: executablePath, args, ignoreDefaultArgs, proxy, downloadsPath, handleSIGINT, handleSIGTERM, handleSIGHUP, timeout, env, devtools, slowMo, channel

Create a new BrowserContext with specified options.

Arguments

See Browser, Context and Page for more information about BrowserContext.

Returns a stable identifier for the created context that can be used in Switch Context.

Old deprecated argument order: acceptDownloads, ignoreHTTPSErrors, bypassCSP, viewport, userAgent, deviceScaleFactor, isMobile, hasTouch, javaScriptEnabled, timezoneId, geolocation, locale, permissions, extraHTTPHeaders, offline, httpCredentials, colorScheme, videosPath, videoSize, defaultBrowserType, hideRfBrowser, recordVideo, recordHar, tracing, screen, storageState, reducedMotion, forcedColors

Examples

Test an iPhone
    ${device}=    Get Device    iPhone X
    New Context    &{device}        # unpacking here with &
    New Page    http://example.com

A BrowserContext is the Playwright object that controls a single browser profile. Within a context caches and cookies are shared. See Playwright browser.newContext for a list of supported options.

If there's no open Browser this keyword will open one. Does not create pages.

Open a new Page.

Arguments

A Page is the Playwright equivalent to a tab. See Browser, Context and Page for more information about Page concept.

Returns NewPageDetails as dictionary for created page. NewPageDetails (dict) contains the keys page_id and video_path. page_id is a stable identifier for the created page. video_path is path to the created video or empty if video is not created.

When a New Page is called without an open browser, New Browser and New Context are executed with default values first.

Open a new persistent context.

Arguments

New Persistent Context does basically executes New Browser, New Context and New Page in one step with setting a profile at the same time.

If you want to use extensions you need to download the extension as a .zip, enable loading the extension, and load the extensions using chromium arguments like below. Extensions only work with chromium and with a headful browser.

${launch_args}=  Set Variable  ["--disable-extensions-except=./ublock/uBlock0.chromium", "--load-extension=./ublock/uBlock0.chromium"]
`New Persistent Context  browser=chromium  headless=False  args=${launch_args}

Check New Browser or New context for the specific argument docs.

Old deprecated argument order: executablePath, args, ignoreDefaultArgs, proxy, downloadsPath, handleSIGINT, handleSIGTERM, handleSIGHUP, timeout, env, devtools, slowMo, channel, acceptDownloads, ignoreHTTPSErrors, bypassCSP, viewport, userAgent, deviceScaleFactor, isMobile, hasTouch, javaScriptEnabled, timezoneId, geolocation, locale, permissions, extraHTTPHeaders, offline, httpCredentials, colorScheme, videosPath, videoSize, defaultBrowserType, hideRfBrowser, recordVideo, recordHar, tracing, screen, storageState, reducedMotion, forcedColors, url

Opens a new browser instance. Use this keyword for quick experiments or debugging sessions.

Arguments

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.

Creates a new browser, context and page with specified settings.

Browsers:

Types the given key combination into element found by selector.

Arguments

Supports values like "a, b" which will be automatically typed.

Also supports identifiers for keys like ArrowLeft or Backspace.

Keyword uses strict mode, see Finding elements for more details about strict mode.

See playwright's documentation for a more comprehensive list of supported input keys. Playwright docs for press.

Examples

Press Keys      //*[@id="username_field"]    h    e   l   o   ArrowLeft   l

Wrap a Browser library keyword and make it a promise.

Arguments

Promised keyword is executed and started on background. Test execution continues without waiting for kw to finish.

Returns reference to the promised keyword.

kw Keyword that will work async on background.

Examples

${promise}=     Promise To            Wait For Response     matcher=     timeout=3
Click           \#delayed_request
${body}=        Wait For              ${promise}

Returns a promise that resolves when file from path has been uploaded.

Arguments

Fails if the upload has not happened during timeout.

Upload file from path into next file chooser dialog on page.

Example use:

${promise}=    Promise To Upload File    ${CURDIR}/test_upload_file.txt
Click          id=open_file_chooser_button
${upload_result}=    Wait For    ${promise}

Alternatively, you can use Upload File By Selector keyword.

Returns a promise that waits for next download event on page.

Arguments

If you can get the URL for the file to download, Download keyword should be a consistent way to download the file.

To enable downloads context's acceptDownloads needs to be true.

To configure download directory use New Browser's downloadsPath settings

With default filepath downloaded files are deleted when Context the download happened in is closed.

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 whatwg. Different browsers can use different logic for computing it.

Example usage:

New Context          acceptDownloads=True
New Page             ${LOGIN_URL}
${dl_promise}          Promise To Wait For Download    /path/to/download/file.name
Click                \#file_download
${file_obj}=           Wait For  ${dl_promise}
File Should Exist    ${file_obj}[saveAs]
Should Be True       ${file_obj.suggestedFilename}

Record the selector that is under mouse.

Arguments

Focus on the page and move mouse over the element you want to select.

Examples

${selector} =    Record Selector   Button
Click  ${selector}
${selector2} =    Record Selector  Page header
Get Text  ${selector2}  ==  Expected text

Sets the keyword to execute, when a Browser keyword fails.

Arguments

The initial keyword to use is set when importing the library, and the keyword that is used by default is Take Screenshot. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.

It is possible to use string NONE or any other robot falsy name, case-insensitively, as well as Python None to disable this feature altogether.

This keyword returns an object which contains the the previously registered failure keyword. The return value can be always used to restore the original value later. The returned object contains keyword name and the possible arguments used to for the keyword.

Examples

Register Keyword To Run On Failure    Take Screenshot
${previous kw}=    Register Keyword To Run On Failure    NONE
Register Keyword To Run On Failure    ${previous kw}
Register Keyword To Run On Failure    Take Screenshot    fullPage=True
Register Keyword To Run On Failure    Take Screenshot    failure-{index}    fullPage=True

Reloads current active page.

Saves the current active context storage state to a file.

Web apps use cookie-based or token-based authentication, where authenticated state is stored as cookies or in local storage. Keyword retrieves the storage state from authenticated contexts and save it to disk. Then New Context can be created with prepopulated state.

Please note state file may contains secrets and should not be shared with people outside of your organisation.

The file is created in ${OUTPUTDIR}/browser/state folder and file(s) are automatically deleted when new test execution starts. File path is returned by the keyword.

Examples

Test Case
    New context
    New Page    https://login.page.html
    #  Perform login
    Fill Secret    id=username    $username
    Fill Secret    id=password    $password
    Click    id=button
    Get Text    id=header    ==    Something
    #  Save storage to disk
    ${state_file} =    Save Storage State
    #  Create new context with saved state
    New context    storageState=${state_file}
    New Page    https://login.page.html
    #  Login is not needed because authentication is read from state file
    Get Text    id=header    ==    Something

Scrolls an element or the page relative from current position by the given values.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Scrolls an element or the page to an absolute position based on given coordinates.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Does nothing if the element is already visible.

Selects options from select element found by selector.

Arguments

Returns list of options which keyword was able to select. The type of list item matches to attribute definition. Example if attribute equals to label returned list contains label values. Or in case of index it contains list of selected indexes.

Keyword uses strict mode, see Finding elements for more details about strict mode.

If no values to select are passed will deselect options in element.

Examples

${selected} =    Select Options By    select[name=preferred_channel]    label    Direct mail
List Should Contain Value    ${selected}    Direct mail
${selected} =    Select Options By    select[name=interests]    value    males    females    others
List Should Contain Value    ${selected}    males
List Should Contain Value    ${selected}    females
List Should Contain Value    ${selected}    others
Length Should Be    ${selected}    3
${selected} =    Select Options By    select[name=possible_channels]    index    0    2
List Should Contain Value    ${selected}    0
List Should Contain Value    ${selected}    2
${selected} =    Select Options By    select[name=interests]    text     Males    Females
List Should Contain Value    ${selected}    Males
List Should Contain Value    ${selected}    Females

Remove all saved data from the session storage.

Examples

SessionStorage Set Item    mykey3    myvalue3
 SessionStorage Clear
SessionStorage Get Item    mykey3    ==    ${None}

Get saved data from from session storage.

Arguments

Examples

SessionStorage Set Item    key2    value2
${item} =    SessionStorage Get Item    key1
Should Be Equal    ${item}    value2

Remove saved data with key from the session storage.

Arguments

Examples

SessionStorage Set Item       mykey2    myvalue2
SessionStorage Remove Item    mykey2
SessionStorage Get Item       mykey2    ==    ${None}

Save data to session storage.

Arguments

Examples

SessionStorage Set Item    key2    value2

Set keywords formatters for assertions.

Arguments

formatters is dictionary, where key is the keyword name where formatters are applied. Dictionary value is a list of formatter which are applied. Using keywords always replaces existing formatters for keywords.

Supported formatter are: normalize space, strip and apply to expected.

Examples

Set Assertion Formatters    {"Get Text": ["strip", "normalize spaces"]}
${value} =    Get Text    //div    ==    ${SPACE}Expected${SPACE * 2}Text
Should Be Equal    ${value}    Expected Text

Sets the timeout used by most input and getter keywords.

Arguments

Examples

${old_timeout} =    Set Browser Timeout    1m 30 seconds
Click     //button
Set Browser Timeout    ${old_timeout}

Updated the correct Context's geolocation.

Arguments

Latitude can be between -90 and 90 and longitude can be between -180 and 180. Accuracy of the location must be positive number and defaults to 0. When creating context, grant geolocation permission for pages to read its geolocation.

Examples

${permissions} =    Create List    geolocation
New Context    permissions=${permissions}
Set Geolocation    60.173708, 24.982263    3    # Points to Korkeasaari in Helsinki.

Toggles current Context's offline emulation.

Arguments

Sets the timeout used in retrying assertions when they fail.

Arguments

The other keyword Set Browser timeout controls how long Playwright will perform waiting in the node side for Elements to fulfill the requirements of the specific keyword.

Returns the previous value of the assertion retry timeout.

Examples

Set Browser Timeout    10 seconds
${old} =    Set Retry Assertions For    30s
Get Title    ==    Login Page
Set Retry Assertions For    ${old}

Example waits 10 seconds on Playwright to get the page title and library will retry 30 seconds to make sure that title is correct.

Sets the prefix for all selectors in the given scope.

Arguments

Returns the previous value of the prefix.

Examples

${old} =    Set Selector Prefix    iframe#embedded_page >>>
Click    button#login_btn       # Clicks on button inside iframe with the selector iframe#embedded_page >>> button#login_btn
Set Selector Prefix    ${old}

Example will click on button with id login_btn inside iframe with id embedded_page. The resulting selector will be iframe#embedded_page >>> button#login_btn.

Controls library strict mode.

Arguments

Examples

${old_mode} =      Set Strict Mode    False
Get Text           //input            # Does not fail if selector points to one or more elements
Set Strict Mode    ${old_mode}

Sets current Pages viewport size to specified dimensions.

Arguments

In the case of multiple pages in a single browser, each page can have its own viewport size. However, New Context allows to set viewport size (and more) for all later opened pages in the context at once.

Set Viewport Size 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 New Context before opening the page itself.

Controls if the keyword banner is shown on page or not.

Arguments

Keyword call banner is a css overlay that shows the currently executed keyword directly on page. This is useful for debugging and for showing the test execution on video recordings. By default, the banner is not shown on page except when running in presenter mode.

The banner can be controlled by an import setting of Browser library. (see Importing section)

Examples

Show Keyword Banner     True    top: 5px; bottom: auto; left: 5px; background-color: #00909077; font-size: 9px; color: black;   # Show banner on top left corner with custom styles
Show Keyword Banner     False   # Hide banner

Switches the currently active Browser to another open Browser.

Arguments

Returns a stable identifier for the previous browser. See Browser, Context and Page for more information about Browser and related concepts.

Switches the active BrowserContext to another open context.

Arguments

Returns a stable identifier for the previous context. See Browser, Context and Page for more information about Context and related concepts.

Examples

${first_context} =     New Context
New Page             ${URL1}
${second_context} =    New Context
New Page             ${URL2}
Switch Context       ${first_context}    # Switches back to first context and page.

Switches the active browser page to another open page by id or NEW.

Arguments

Returns a stable identifier id for the previous page. See Browser, Context and Page for more information about Page and related concepts.

New may timeout if no new pages exists before library timeout.

Examples

Click           button#pops_up    # Open new page
${previous} =    Switch Page      NEW

Takes a screenshot of the current window or element and saves it to disk.

Arguments

Keyword uses strict mode if selector is defined. See Finding elements for more details about strict mode.

Example

Take Screenshot                                 # Takes screenshot from page with default filename
Take Screenshot   selector=id=username_field    # Captures element in image

Take Screenshot   fullPage=True    fileType=jpeg    quality=50    timeout=10s

Types the given secret from variable_name into the text field found by selector.

Arguments

This keyword does not log secret in Robot Framework logs, if keyword resolves the variable value internally. If enable_playwright_debug 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.

Keyword uses strict mode, see Finding elements for more details about strict mode.

See Type Text for details.

Example

Type Secret    input#username_field    $username      # Keyword resolves ${username} variable value from Robot Framework variables
Type Secret    input#username_field    %username      # Keyword resolves $USERNAME/%USERNAME% variable value from environment variables
Type Secret    input#username_field    ${username}    # Robot Framework resolves the variable value, but secrect can leak to Robot framework output files.

Types the given txt into the text field found by selector.

Arguments

Sends a keydown, keypress/input, and keyup event for each character in the text.

Keyword uses strict mode, see Finding elements for more details about strict mode.

See Fill Text for direct filling of the full text at once.

Example

Type Text    input#username_field    user
Type Text    input#username_field    user    delay=10 ms    clear=No

Unchecks the checkbox found by selector.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Does nothing if the element is not checked/selected.

Uploads file from path to file input element matched by selector.

Arguments

Fails if upload is not done before library timeout. Therefor it may be necessary to increase the timeout with Set Browser Timeout.

Examples

Upload File By Selector    //input[@type='file']    big_file.zip

Waits for promises to finish and returns results from them.

Arguments

Returns one result if one promise waited. Otherwise returns an array of results. If one fails, then this keyword will fail.

See Promise To for more information about promises.

For general waiting of elements please see Implicit waiting.

Examples

${promise}=    Promise To            Wait For Response     matcher=     timeout=3
Click         \#delayed_request
${body}=       Wait For              ${promise}

Returns a promise to wait for next dialog on page, handles it with action and optionally verifies the dialogs text.

Arguments

Dialog/alert can be any of alert, beforeunload, confirm or prompt.

The main difference between this keyword and Handle Future Dialogs is that Handle Future Dialogs keyword is automatically set as promise. But this keyword must be called as argument to Promise To keyword. Also this keyword can optionally verify the dialogue text and return it. If text is argument None or is not set, dialogue text is not verified.

Example with returning text:

${promise} =         Promise To    Wait For Alert    action=accept
Click              id=alerts
${text} =            Wait For      ${promise}
Should Be Equal      ${text}         Am an alert

Example with text verify:

${promise} =       Promise To    Wait For Alert    action=accept    text=Am an alert
Click              id=alerts
${text} =          Wait For      ${promise}

Waits for all promises to finish.

If one promises fails, then this keyword will fail.

Examples

Promise To               Wait For Response     matcher=     timeout=3
Click                    \#delayed_request
Wait For All Promises

Waits for a condition, defined with Browser getter keywords to become True.

Arguments

This Keyword is basically just a wrapper around our assertion keywords, but with a timeout. It can be used to wait for anything that also can be asserted with our keywords.

In comparison to Robot Frameworks Wait Until Keywords Succeeds this keyword is more readable and easier to use but is limited to Browser libraries assertion keywords.

The easiest way to use this keyword is first starting with an assertion keyword with assertion like: Get Text

Start:

Get Text    id=status_bar   contains    Done

Then you replace the word Get with Wait For Condition and if necessary add the timeout argument.

End:

Wait For Condition    Text    id=status_bar   contains    Done

Example usage:

Wait For Condition    Element States    id=cdk-overlay-0    ==    detached
Wait For Condition    Element States     //h1    contains    visible    editable    enabled    timeout=2 s
Wait For Condition    Title    should start with    Robot
Wait For Condition    Url    should end with    robotframework.org

Waits for the element found by selector to satisfy state option.

Arguments

Note that Browser library has Implicit waiting mechanisms. Depending on the situation you might not need to use Wait for Elements State.

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.

If the selector doesn't satisfy the condition within the timeout the keyword will FAIL.

Keyword uses strict mode, see Finding elements for more details about strict mode.

Examples

Wait For Elements State    //h1    visible    timeout=2 s
Wait For Elements State    //hi    focused    1s

Polls JavaScript expression or function in browser until it returns a (JavaScript) truthy value.

Arguments

Keyword uses strict mode, see Finding elements for more details about strict mode.

Example usage:

${promise}      Promise To      Wait For Function    element => element.style.width=="100%"    selector=\#progress_bar    timeout=4s
Click         \#progress_bar
Wait For      ${promise}

Waits until page has navigated to given url.

Arguments

Keyword works only when page is loaded and does not work if URL fragment changes. Example if https://marketsquare.github.io/robotframework-browser/Browser.html changes to https://marketsquare.github.io/robotframework-browser/Browser.html#Wait%20For%20Navigation keyword will fail.

Examples

Go To                  ${ROOT_URL}/redirector.html
Wait for navigation    ${ROOT_URL}/posted.html    wait_until=${wait_until}

Waits for request matching matcher to be made.

Arguments

Examples

Click               \#delayed_request
Wait For Request    timeout=1s

Async Example:

${promise} =    Promise To         Wait For Request    matcher=\\/\\/local\\w+\\:\\d+\\/api    timeout=3s
Click         \#delayed_request
Wait For      ${promise}

JavaScript Function Example:

Click               \#delayed_request    # Creates response which should be waited before pressing save.
Wait For Request    request => request.url().endsWith('api/get/json') && request.method() === 'GET'

Waits for response matching matcher and returns python dict with contents.

Arguments

The response is a Python dictionary with following attributes:

• status <int> The status code of the response.
• statusText <str> Status text corresponding to status, e.g OK or INTERNAL SERVER ERROR.
• body <dict | str> 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.
• headers <dict> A dictionary containing all response headers.
• ok <bool> Whether the request was successfull, i.e. the status is range 200-299.
• request <dict> containing method <str>, headers <dict> and postData <dict> | <str>
• url <str> url of the request.

Synchronous Example:

Click                \#delayed_request    # Creates response which should be waited before next actions
Wait For Response    matcher=\\/\\/local\\w+\\:\\d+\\/api
Click                \#save

Asynchronous Example:

${promise} =    Promise To    Wait For Response    timeout=60s
Click           \#delayed_request    # Creates response which should be waited before pressing save.
Click           \#next
Wait For        ${promise}            # Waits for the response
Click           \#save

JavaScript Function Example:

Click               \#delayed_request    # Creates response which should be waited before pressing save.
Wait For Response   response => response.url().endsWith('json') && response.request().method() === 'GET'

Waits until there has been at least one instance of 500 ms of no network traffic on the page after loading.

Arguments

Doesn't wait for network traffic that wasn't initiated within 500ms of page load.

Examples

Go To                         ${URL}
Wait Until Network Is Idle    timeout=3s