Create a live element

This class represents a single element on the page. It is created using an existing SeleniumSession instance.

Public fields

id: The id of the element, used to uniquely identify it on the page.

Methods

Method `new()`

Initialize a WebElement object. This should not be called manually: instead use SeleniumSession$create_webelement() if you have an element id. To find elements on the page, use SeleniumSession$find_element() and SeleniumSession$find_elements().

Usage

WebElement$new(session_id, req, verbose, id)

Arguments

session_id: The id of the session that the element belongs to.
req, verbose: Private fields of a SeleniumSession object.
id: The element id.

Returns

A WebElement object.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

element <- session$find_element(using = "css selector", value = "#download")

session$close()
}

Method `shadow_root()`

A shadow DOM is a self-contained DOM tree, contained within another DOM tree. A shadow root is an element that contains a DOM subtree. This method gets the shadow root property of an element.

Usage

WebElement$shadow_root(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A ShadowRoot object.

Examples

\dontrun{
session <- SeleniumSession$new()

# Let's create our own Shadow Root using JavaScript
session$execute_script("
  const div = document.createElement('div');
  document.body.appendChild(div);
  div.attachShadow({mode: 'open'});
")

element <- session$find_element(using = "css selector", value = "div")

shadow_root <- element$shadow_root()

session$close()
}

Method `find_element()`

Find the first element matching a selector, relative to the current element.

Usage

WebElement$find_element(
  using = c("css selector", "xpath", "tag name", "link text", "partial link text"),
  value,
  request_body = NULL,
  timeout = 20
)

Arguments

using: The type of selector to use.
value: The value of the selector: a string.
request_body: A list of request body parameters to pass to the Selenium server, overriding the default body of the web request
timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A WebElement object.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

row <- session$find_element(using = "css selector", value = ".row")

logo_container <- row$find_element(using = "css selector", value = "p")

logo <- logo_container$find_element(using = "css selector", value = "img")

session$close()
}

Method `find_elements()`

Find all elements matching a selector, relative to the current element.

Usage

WebElement$find_elements(
  using = c("css selector", "xpath", "tag name", "link text", "partial link text"),
  value,
  request_body = NULL,
  timeout = 20
)

Arguments

using: The type of selector to use.
value: The value of the selector: a string.
request_body: A list of request body parameters to pass to the Selenium server, overriding the default body of the web request
timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A list of WebElement objects.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

row <- session$find_element(using = "css selector", value = ".row")

links <- row$find_elements(using = "css selector", value = "a")

session$close()
}

Method `is_selected()`

Check if an element is currently selected.

Usage

WebElement$is_selected(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A boolean value: TRUE or FALSE.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$is_selected()

session$close()
}

Method `get_attribute()`

Get an attribute from an element.

Usage

WebElement$get_attribute(name, request_body = NULL, timeout = 20)

Arguments

name: The name of the attribute.
request_body: A list of request body parameters to pass to the Selenium server, overriding the default body of the web request
timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The value of the attribute: a string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$get_attribute("href")

session$close()
}

Method `get_property()`

Get a property from an element. Properties are similar to attributes, but represent the HTML source code of the page, rather than the current state of the DOM.

Usage

WebElement$get_property(name, request_body = NULL, timeout = 20)

Arguments

name: The name of the property.
request_body: A list of request body parameters to pass to the Selenium server, overriding the default body of the web request
timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The value of the property: a string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$get_property("href")

session$close()
}

Method `get_css_value()`

Get the computed value of a CSS property.

Usage

WebElement$get_css_value(name, request_body = NULL, timeout = 20)

Arguments

name: The name of the CSS property.
request_body: A list of request body parameters to pass to the Selenium server, overriding the default body of the web request
timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The value of the CSS property: a string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$get_css_value("color")

session$close()
}

Method `get_text()`

Get the text content of an element.

Usage

WebElement$get_text(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The text content of the element: a string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$get_text()

session$close()
}

Method `get_tag_name()`

Get the tag name of an element.

Usage

WebElement$get_tag_name(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The tag name of the element: a string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$get_tag_name()

session$close()
}

Method `get_rect()`

Get the dimensions and coordinates of an element.

Usage

WebElement$get_rect(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A list containing the following elements:

x: The x-coordinate of the element.
y: The y-coordinate of the element.
width: The width of the element in pixels.
height: The height of the element in pixels.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$get_rect()

session$close()
}

Method `is_enabled()`

Check if an element is currently enabled.

Usage

WebElement$is_enabled(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A boolean value: TRUE or FALSE.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$is_enabled()

session$close()
}

Method `computed_role()`

Get the computed role of an element. The role of an element is usually "generic", but is often used when an elements tag name differs from its purpose. For example, a link that is "button-like" in nature may have a "button" role.

Usage

WebElement$computed_role(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$computed_role()

session$close()
}

Method `computed_label()`

Get the computed label of an element (i.e. The text of the label element that points to the current element).

Usage

WebElement$computed_label(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$computed_label()

session$close()
}

Method `click()`

Click on an element.

Usage

WebElement$click(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The element, invisibly.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$click()

session$close()
}

Method `clear()`

Clear the contents of a text input element.

Usage

WebElement$clear(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The element, invisibly.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.google.com")

session$find_element(using = "css selector", value = "textarea")$clear()

session$close()
}

Method `send_keys()`

Send keys to an element.

Usage

WebElement$send_keys(..., request_body = NULL, timeout = 20)

Arguments

...: The keys to send (strings). Use keys for special keys, and use key_chord() to send keys combinations.
request_body: A list of request body parameters to pass to the Selenium server, overriding the default body of the web request
timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The element, invisibly.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.google.com")

input <- session$find_element(using = "css selector", value = "textarea")

input$send_keys("Hello")

input$send_keys(key_chord(keys$control, "a"), key_chord(keys$control, "c"))

input$send_keys(keys$control, "v")

input$get_attribute("value")

session$close()
}

Method `screenshot()`

Take a screenshot of an element.

Usage

WebElement$screenshot(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

The base64-encoded PNG screenshot, as a string.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$screenshot()

session$close()
}

Method `is_displayed()`

Check if an element is displayed. This function may not work on all platforms.

Usage

WebElement$is_displayed(timeout = 20)

Arguments

timeout: How long to wait for a request to recieve a response before throwing an error.

Returns

A boolean.

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$is_displayed()

session$close()
}

Method `toJSON()`

Convert an element to JSON. This is used by SeleniumSession$execute_script().

Usage

WebElement$toJSON()

Returns

A list, which can then be converted to JSON using jsonlite::toJSON().

Examples

\dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

result <- session$find_element(using = "css selector", value = "a")$toJSON()

result

jsonlite::toJSON(result, auto_unbox = TRUE)

session$close()
}

Method `clone()`

The objects of this class are cloneable with this method.

Usage

WebElement$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.

Examples


## ------------------------------------------------
## Method `WebElement$new`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

element <- session$find_element(using = "css selector", value = "#download")

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$shadow_root`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

# Let's create our own Shadow Root using JavaScript
session$execute_script("
  const div = document.createElement('div');
  document.body.appendChild(div);
  div.attachShadow({mode: 'open'});
")

element <- session$find_element(using = "css selector", value = "div")

shadow_root <- element$shadow_root()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$find_element`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

row <- session$find_element(using = "css selector", value = ".row")

logo_container <- row$find_element(using = "css selector", value = "p")

logo <- logo_container$find_element(using = "css selector", value = "img")

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$find_elements`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

row <- session$find_element(using = "css selector", value = ".row")

links <- row$find_elements(using = "css selector", value = "a")

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$is_selected`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$is_selected()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$get_attribute`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$get_attribute("href")

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$get_property`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$get_property("href")

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$get_css_value`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$get_css_value("color")

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$get_text`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$get_text()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$get_tag_name`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$get_tag_name()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$get_rect`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "#download")$get_rect()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$is_enabled`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$is_enabled()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$computed_role`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$computed_role()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$computed_label`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$computed_label()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$click`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$click()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$clear`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.google.com")

session$find_element(using = "css selector", value = "textarea")$clear()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$send_keys`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.google.com")

input <- session$find_element(using = "css selector", value = "textarea")

input$send_keys("Hello")

input$send_keys(key_chord(keys$control, "a"), key_chord(keys$control, "c"))

input$send_keys(keys$control, "v")

input$get_attribute("value")

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$screenshot`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$screenshot()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$is_displayed`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

session$find_element(using = "css selector", value = "a")$is_displayed()

session$close()
} # }

## ------------------------------------------------
## Method `WebElement$toJSON`
## ------------------------------------------------

if (FALSE) { # \dontrun{
session <- SeleniumSession$new()

session$navigate("https://www.r-project.org")

result <- session$find_element(using = "css selector", value = "a")$toJSON()

result

jsonlite::toJSON(result, auto_unbox = TRUE)

session$close()
} # }

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Returns

Examples

Method shadow_root()

Usage

Arguments

Returns

Examples

Method find_element()

Usage

Arguments

Returns

Examples

Method find_elements()

Usage

Arguments

Returns

Examples

Method is_selected()

Usage

Arguments

Returns

Examples

Method get_attribute()

Usage

Arguments

Returns

Examples

Method get_property()

Usage

Arguments

Returns

Examples

Method get_css_value()

Usage

Arguments

Returns

Examples

Method get_text()

Usage

Arguments

Returns

Examples

Method get_tag_name()

Usage

Arguments

Returns

Examples

Method get_rect()

Usage

Arguments

Returns

Examples

Method is_enabled()

Usage

Arguments

Returns

Examples

Method computed_role()

Usage

Arguments

Returns

Examples

Method computed_label()

Usage

Arguments

Returns

Examples

Method click()

Usage

Arguments

Returns

Examples

Method clear()

Method `new()`

Method `shadow_root()`

Method `find_element()`

Method `find_elements()`

Method `is_selected()`

Method `get_attribute()`

Method `get_property()`

Method `get_css_value()`

Method `get_text()`

Method `get_tag_name()`

Method `get_rect()`

Method `is_enabled()`

Method `computed_role()`

Method `computed_label()`

Method `click()`

Method `clear()`

Method `send_keys()`

Method `screenshot()`

Method `is_displayed()`

Method `toJSON()`

Method `clone()`