Nothing
R/children.R
In selenider: Concise, Lazy and Reliable Wrapper for 'chromote' and 'selenium'
Defines functions
elem_descendants
elem_children
elem_siblings
elem_parent
elem_ancestors
Documented in
elem_ancestors
elem_children
elem_descendants
elem_parent
elem_siblings
#' Get the DOM family of an element
#'
#' @description
#' Find all elements with a certain relative position to an HTML element.
#'
#' `elem_ancestors()` selects every element which contains the current element
#' (children, grand-children, etc.).
#'
#' `elem_parent()` selects the element that contains the current element.
#'
#' `elem_siblings()` selects every element which has the same parent as the
#' current element.
#'
#' `elem_children()` selects every element which is connected to and directly
#' below the current element.
#'
#' `elem_descendants()` selects every element that is contained by the current
#' element. The current element does not have to be a direct parent, but must
#' be some type of ancestor.
#'
#' @param x A `selenider_element` object.
#'
#' @details
#' All functions except `elem_children()` and `elem_descendants()` use XPath
#' selectors, so may be slow, especially when using `chromote` as a backend.
#'
#' @returns All functions return a `selenider_elements` object, except
#' `elem_parent()`, which returns a `selenider_element` object (since an
#' element can only have one parent).
#'
#' @seealso
#' * <http://web.simmons.edu/~grovesd/comm244/notes/week4/document-tree> for a
#' simple and visual explanation of the document tree.
#' * [find_element()] and [find_elements()] for other ways of selecting
#' elements. These functions allow you to select ancestors using one or more
#' conditions (e.g. CSS selectors).
#' * [elem_filter()] and [elem_find()] for filtering element collections.
#'
#' @examplesIf selenider::selenider_available(online = FALSE)
#' html <- "
#' <html>
#' <body>
#' <div>
#' <div id='current'>
#' <p></p>
#' <div>
#' <p></p>
#' <br>
#' </div>
#' </div>
#' <div></div>
#' <p></p>
#' </div>
#' </body>
#' </html>
#' "
#'
#' session <- minimal_selenider_session(html)
#'
#' current <- s("#current")
#'
#' # Get all the names of an element collection
#' elem_names <- function(x) {
#' x |>
#' as.list() |>
#' vapply(elem_name, FUN.VALUE = character(1))
#' }
#'
#' current |>
#' elem_ancestors() |>
#' elem_expect(has_length(3)) |>
#' elem_names() # html, div, body
#'
#' current |>
#' elem_parent() |>
#' elem_name() # div
#'
#' current |>
#' elem_siblings() |>
#' elem_expect(has_length(2)) |>
#' elem_names() # div, p
#'
#' current |>
#' elem_children() |>
#' elem_expect(has_length(2)) |>
#' elem_names() # p, div
#'
#' current |>
#' elem_descendants() |>
#' elem_expect(has_length(4)) |>
#' elem_names() # p, div, p, br
#'
#' @export
elem_ancestors <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = "./ancestor::*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_ancestor_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_parent <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(xpath = "./..")
class(selector) <- c("selenider_parent_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_siblings <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = "./following-sibling::* | ./preceding-sibling::*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_sibling_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_children <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = "./*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_child_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_descendants <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = ".//*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_descendant_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
Try the selenider package in your browser
Any scripts or data that you put into this service are public.
selenider documentation built on April 3, 2025, 5:51 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions elem_descendants elem_children elem_siblings elem_parent elem_ancestors
Documented in elem_ancestors elem_children elem_descendants elem_parent elem_siblings
#' Get the DOM family of an element
#'
#' @description
#' Find all elements with a certain relative position to an HTML element.
#'
#' `elem_ancestors()` selects every element which contains the current element
#' (children, grand-children, etc.).
#'
#' `elem_parent()` selects the element that contains the current element.
#'
#' `elem_siblings()` selects every element which has the same parent as the
#' current element.
#'
#' `elem_children()` selects every element which is connected to and directly
#' below the current element.
#'
#' `elem_descendants()` selects every element that is contained by the current
#' element. The current element does not have to be a direct parent, but must
#' be some type of ancestor.
#'
#' @param x A `selenider_element` object.
#'
#' @details
#' All functions except `elem_children()` and `elem_descendants()` use XPath
#' selectors, so may be slow, especially when using `chromote` as a backend.
#'
#' @returns All functions return a `selenider_elements` object, except
#' `elem_parent()`, which returns a `selenider_element` object (since an
#' element can only have one parent).
#'
#' @seealso
#' * <http://web.simmons.edu/~grovesd/comm244/notes/week4/document-tree> for a
#' simple and visual explanation of the document tree.
#' * [find_element()] and [find_elements()] for other ways of selecting
#' elements. These functions allow you to select ancestors using one or more
#' conditions (e.g. CSS selectors).
#' * [elem_filter()] and [elem_find()] for filtering element collections.
#'
#' @examplesIf selenider::selenider_available(online = FALSE)
#' html <- "
#' <html>
#' <body>
#' <div>
#' <div id='current'>
#' <p></p>
#' <div>
#' <p></p>
#' <br>
#' </div>
#' </div>
#' <div></div>
#' <p></p>
#' </div>
#' </body>
#' </html>
#' "
#'
#' session <- minimal_selenider_session(html)
#'
#' current <- s("#current")
#'
#' # Get all the names of an element collection
#' elem_names <- function(x) {
#' x |>
#' as.list() |>
#' vapply(elem_name, FUN.VALUE = character(1))
#' }
#'
#' current |>
#' elem_ancestors() |>
#' elem_expect(has_length(3)) |>
#' elem_names() # html, div, body
#'
#' current |>
#' elem_parent() |>
#' elem_name() # div
#'
#' current |>
#' elem_siblings() |>
#' elem_expect(has_length(2)) |>
#' elem_names() # div, p
#'
#' current |>
#' elem_children() |>
#' elem_expect(has_length(2)) |>
#' elem_names() # p, div
#'
#' current |>
#' elem_descendants() |>
#' elem_expect(has_length(4)) |>
#' elem_names() # p, div, p, br
#'
#' @export
elem_ancestors <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = "./ancestor::*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_ancestor_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_parent <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(xpath = "./..")
class(selector) <- c("selenider_parent_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_siblings <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = "./following-sibling::* | ./preceding-sibling::*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_sibling_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_children <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = "./*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_child_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
#' @rdname elem_ancestors
#'
#' @export
elem_descendants <- function(x) {
check_class(x, "selenider_element")
selector <- new_selector(
xpath = ".//*",
filter = list(),
multiple = TRUE
)
class(selector) <- c("selenider_descendant_selector", "selenider_selector")
x$selectors <- append(x$selectors, list(selector))
x$to_be_found <- x$to_be_found + 1
class(x) <- c("selenider_elements", "list")
x
}
Try the selenider package in your browser
Any scripts or data that you put into this service are public.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.