mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
97 lines
2.8 KiB
R
97 lines
2.8 KiB
R
#' Create a textarea input control
|
|
#'
|
|
#' Create a textarea input control for entry of unstructured text values.
|
|
#'
|
|
#' @inheritParams textInput
|
|
#' @param height The height of the input, e.g. `'400px'`, or `'100%'`; see
|
|
#' [validateCssUnit()].
|
|
#' @param cols Value of the visible character columns of the input, e.g. `80`.
|
|
#' This argument will only take effect if there is not a CSS `width` rule
|
|
#' defined for this element; such a rule could come from the `width` argument
|
|
#' of this function or from a containing page layout such as
|
|
#' [fluidPage()].
|
|
#' @param rows The value of the visible character rows of the input, e.g. `6`.
|
|
#' If the `height` argument is specified, `height` will take precedence in the
|
|
#' browser's rendering.
|
|
#' @param resize Which directions the textarea box can be resized. Can be one of
|
|
#' `"both"`, `"none"`, `"vertical"`, and `"horizontal"`. The default, `NULL`,
|
|
#' will use the client browser's default setting for resizing textareas.
|
|
#' @param autoresize If `TRUE`, the textarea will automatically resize to fit
|
|
#' the input text.
|
|
#' @return A textarea input control that can be added to a UI definition.
|
|
#'
|
|
#' @family input elements
|
|
#' @seealso [updateTextAreaInput()]
|
|
#'
|
|
#' @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)
|
|
#'
|
|
#' }
|
|
#'
|
|
#' @section Server value:
|
|
#' A character string of the text input. The default value is `""`
|
|
#' unless `value` is provided.
|
|
#'
|
|
#' @export
|
|
textAreaInput <- function(
|
|
inputId,
|
|
label,
|
|
value = "",
|
|
width = NULL,
|
|
height = NULL,
|
|
cols = NULL,
|
|
rows = NULL,
|
|
placeholder = NULL,
|
|
resize = NULL,
|
|
...,
|
|
autoresize = FALSE,
|
|
updateOn = c("change", "blur")
|
|
) {
|
|
rlang::check_dots_empty()
|
|
updateOn <- rlang::arg_match(updateOn)
|
|
|
|
value <- restoreInput(id = inputId, default = value)
|
|
|
|
if (!is.null(resize)) {
|
|
resize <- match.arg(resize, c("both", "none", "vertical", "horizontal"))
|
|
}
|
|
|
|
classes <- c("shiny-input-textarea", "form-control")
|
|
if (autoresize) {
|
|
classes <- c(classes, "textarea-autoresize")
|
|
if (is.null(rows)) {
|
|
rows <- 1
|
|
}
|
|
}
|
|
|
|
div(
|
|
class = "form-group shiny-input-container",
|
|
style = css(width = validateCssUnit(width)),
|
|
shinyInputLabel(inputId, label),
|
|
tags$textarea(
|
|
id = inputId,
|
|
class = classes,
|
|
placeholder = placeholder,
|
|
style = css(
|
|
width = if (!is.null(width)) "100%",
|
|
height = validateCssUnit(height),
|
|
resize = resize
|
|
),
|
|
rows = rows,
|
|
cols = cols,
|
|
`data-update-on` = updateOn,
|
|
value
|
|
)
|
|
)
|
|
}
|