mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-14 01:18:07 -05:00
316c3c8409
* feat(textAreaInput): Add an autoresize option * `devtools::document()` (GitHub Actions) * `yarn build` (GitHub Actions) * Update NEWS.md * Fix broken CSS selector. Rules aren't being applied correctly in PyShiny either... * Put shiny input class on container (to mirror what PyShiny does) * Refactor autoresize logic * Reduce diff size --------- Co-authored-by: cpsievert <cpsievert@users.noreply.github.com>
114 lines
3.5 KiB
R
114 lines
3.5 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/input-textarea.R
|
|
\name{textAreaInput}
|
|
\alias{textAreaInput}
|
|
\title{Create a textarea input control}
|
|
\usage{
|
|
textAreaInput(
|
|
inputId,
|
|
label,
|
|
value = "",
|
|
width = NULL,
|
|
height = NULL,
|
|
cols = NULL,
|
|
rows = NULL,
|
|
placeholder = NULL,
|
|
resize = NULL,
|
|
...,
|
|
autoresize = FALSE,
|
|
updateOn = c("change", "blur")
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{inputId}{The \code{input} slot that will be used to access the value.}
|
|
|
|
\item{label}{Display label for the control, or \code{NULL} for no label.}
|
|
|
|
\item{value}{Initial value.}
|
|
|
|
\item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'};
|
|
see \code{\link[=validateCssUnit]{validateCssUnit()}}.}
|
|
|
|
\item{height}{The height of the input, e.g. \code{'400px'}, or \code{'100\%'}; see
|
|
\code{\link[=validateCssUnit]{validateCssUnit()}}.}
|
|
|
|
\item{cols}{Value of the visible character columns of the input, e.g. \code{80}.
|
|
This argument will only take effect if there is not a CSS \code{width} rule
|
|
defined for this element; such a rule could come from the \code{width} argument
|
|
of this function or from a containing page layout such as
|
|
\code{\link[=fluidPage]{fluidPage()}}.}
|
|
|
|
\item{rows}{The value of the visible character rows of the input, e.g. \code{6}.
|
|
If the \code{height} argument is specified, \code{height} will take precedence in the
|
|
browser's rendering.}
|
|
|
|
\item{placeholder}{A character string giving the user a hint as to what can
|
|
be entered into the control. Internet Explorer 8 and 9 do not support this
|
|
option.}
|
|
|
|
\item{resize}{Which directions the textarea box can be resized. Can be one of
|
|
\code{"both"}, \code{"none"}, \code{"vertical"}, and \code{"horizontal"}. The default, \code{NULL},
|
|
will use the client browser's default setting for resizing textareas.}
|
|
|
|
\item{...}{Ignored, included to require named arguments and for future
|
|
feature expansion.}
|
|
|
|
\item{autoresize}{If \code{TRUE}, the textarea will automatically resize to fit
|
|
the input text.}
|
|
|
|
\item{updateOn}{A character vector specifying when the input should be
|
|
updated. Options are \code{"change"} (default) and \code{"blur"}. Use \code{"change"} to
|
|
update the input immediately whenever the value changes. Use \code{"blur"}to
|
|
delay the input update until the input loses focus (the user moves away
|
|
from the input), or when Enter is pressed (or Cmd/Ctrl + Enter for
|
|
\code{\link[=textAreaInput]{textAreaInput()}}).}
|
|
}
|
|
\value{
|
|
A textarea input control that can be added to a UI definition.
|
|
}
|
|
\description{
|
|
Create a textarea input control for entry of unstructured text values.
|
|
}
|
|
\section{Server value}{
|
|
|
|
A character string of the text input. The default value is \code{""}
|
|
unless \code{value} is provided.
|
|
}
|
|
|
|
\examples{
|
|
## Only run examples in interactive R sessions
|
|
if (interactive()) {
|
|
|
|
ui <- fluidPage(
|
|
textAreaInput("caption", "Caption", "Data Summary", width = "1000px"),
|
|
verbatimTextOutput("value")
|
|
)
|
|
server <- function(input, output) {
|
|
output$value <- renderText({ input$caption })
|
|
}
|
|
shinyApp(ui, server)
|
|
|
|
}
|
|
|
|
}
|
|
\seealso{
|
|
\code{\link[=updateTextAreaInput]{updateTextAreaInput()}}
|
|
|
|
Other input elements:
|
|
\code{\link{actionButton}()},
|
|
\code{\link{checkboxGroupInput}()},
|
|
\code{\link{checkboxInput}()},
|
|
\code{\link{dateInput}()},
|
|
\code{\link{dateRangeInput}()},
|
|
\code{\link{fileInput}()},
|
|
\code{\link{numericInput}()},
|
|
\code{\link{passwordInput}()},
|
|
\code{\link{radioButtons}()},
|
|
\code{\link{selectInput}()},
|
|
\code{\link{sliderInput}()},
|
|
\code{\link{submitButton}()},
|
|
\code{\link{textInput}()},
|
|
\code{\link{varSelectInput}()}
|
|
}
|
|
\concept{input elements}
|