mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
32f93a2be1
* Update roxygen and regenerate. Mostly just whitespace changes and `code` -> `verb`. * R6 documentation for MockShinySession * Install roxygen from GH * % are now auto-escaped (We still need to go find the rest) * Fixed the ramining \% in roxygen Found looking for ^#'.*\\% in all R files, so I believe this is all of them. * Regenerate docs * Decreate indent in roxygen so paragraphs don't get interpreted as code blocks. https://github.com/r-lib/roxygen2/issues/948#issuecomment-546386172 * Namespace * Add MockShinySession reference to pkgdown. * Clean up test warnings * Export session
79 lines
2.3 KiB
R
79 lines
2.3 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/update-input.R
|
|
\name{updateTextAreaInput}
|
|
\alias{updateTextAreaInput}
|
|
\title{Change the value of a textarea input on the client}
|
|
\usage{
|
|
updateTextAreaInput(
|
|
session,
|
|
inputId,
|
|
label = NULL,
|
|
value = NULL,
|
|
placeholder = NULL
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{session}{The \code{session} object passed to function given to
|
|
\code{shinyServer}.}
|
|
|
|
\item{inputId}{The id of the input object.}
|
|
|
|
\item{label}{The label to set for the input object.}
|
|
|
|
\item{value}{The value to set for the input object.}
|
|
|
|
\item{placeholder}{The placeholder to set for the input object.}
|
|
}
|
|
\description{
|
|
Change the value of a textarea input on the client
|
|
}
|
|
\details{
|
|
The input updater functions send a message to the client, telling it to
|
|
change the settings of an input object. The messages are collected and sent
|
|
after all the observers (including outputs) have finished running.
|
|
|
|
The syntax of these functions is similar to the functions that created the
|
|
inputs in the first place. For example, \code{\link{numericInput}()} and
|
|
\code{updateNumericInput()} take a similar set of arguments.
|
|
|
|
Any arguments with NULL values will be ignored; they will not result in any
|
|
changes to the input object on the client.
|
|
|
|
For \code{\link{radioButtons}()}, \code{\link{checkboxGroupInput}()} and
|
|
\code{\link{selectInput}()}, the set of choices can be cleared by using
|
|
\code{choices=character(0)}. Similarly, for these inputs, the selected item
|
|
can be cleared by using \code{selected=character(0)}.
|
|
}
|
|
\examples{
|
|
## Only run examples in interactive R sessions
|
|
if (interactive()) {
|
|
|
|
ui <- fluidPage(
|
|
sliderInput("controller", "Controller", 0, 20, 10),
|
|
textAreaInput("inText", "Input textarea"),
|
|
textAreaInput("inText2", "Input textarea 2")
|
|
)
|
|
|
|
server <- function(input, output, session) {
|
|
observe({
|
|
# We'll use the input$controller variable multiple times, so save it as x
|
|
# for convenience.
|
|
x <- input$controller
|
|
|
|
# This will change the value of input$inText, based on x
|
|
updateTextAreaInput(session, "inText", value = paste("New text", x))
|
|
|
|
# Can also set the label, this time for input$inText2
|
|
updateTextAreaInput(session, "inText2",
|
|
label = paste("New label", x),
|
|
value = paste("New text", x))
|
|
})
|
|
}
|
|
|
|
shinyApp(ui, server)
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link[=textAreaInput]{textAreaInput()}}
|
|
}
|