1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/highlight-ui.R
\name{highlightUi}
\alias{highlightUi}
\title{Highlight UI Elements within the RStudio IDE}
\usage{
highlightUi(queries)
}
\arguments{
\item{queries}{A list of "query" objects. Each query should be a list with
entries \code{"query"} and \code{"parent"}. See \strong{Queries} for more
details.}
}
\description{
This function can be used to highlight UI elements within the RStudio IDE.
UI elements can be selected using query selectors; most commonly, one should
choose to highlight elements based on their IDs when available.
}
\details{
The tool at:\preformatted{Help -> Diagnostics -> Show DOM Elements }
can be useful for identifying the classes and IDs assigned to the different
elements within RStudio.
}
\note{
The \code{highlightUi} function was introduced in RStudio 1.3.658.
}
\section{Queries}{
Elements are selected using the same queries as through the web
\code{querySelectorAll()} API. See
\url{https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll}
for more details.
For example, to highlight the Save icon within the Source pane, one might
use:\preformatted{rstudioapi::highlightUi("#rstudio_tb_savesourcedoc") }
In some cases, multiple UI elements need to be highlighted -- e.g. if you
want to highlight both a menu button, and a menu item within the menu
displayed after the button is pressed. We'll use the Environment Pane's
Import Dataset button as an example. To highlight the \verb{From Text
(readr)} command, you might use:\preformatted{rstudioapi::highlightUi( list(
list(query = "#rstudio_mb_import_dataset", parent = 0L), list(query =
"#rstudio_label_from_text_readr_command", parent = 1L) ) ) }
}
\examples{
\dontrun{rstudioapi::highlightUi("#rstudio_workbench_panel_git")}
# clear current highlights
\dontrun{rstudioapi::highlightUi("")}
# highlight within an RMD
\dontrun{rstudioapi::highlightUi(".rstudio_chunk_setup .rstudio_run_chunk")}
# Optionally provide a callback adjacent to
# the queries that will be executed when the
# highlighted element is clicked on.
\dontrun{rstudioapi::highlightUi(
list(
list(
query="#rstudio_workbench_panel_git",
callback="rstudioapi::highlightUi('')"
)
)
)}
}
|
