mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-13 17:08:05 -05:00
Co-authored-by: Carson Sievert <cpsievert1@gmail.com> Co-authored-by: Joe Cheng <joe@rstudio.com> Co-authored-by: gadenbuie <gadenbuie@users.noreply.github.com>
49 lines
1.5 KiB
R
49 lines
1.5 KiB
R
#' Create a text input control
|
|
#'
|
|
#' Create an input control for entry of unstructured text values
|
|
#'
|
|
#' @param inputId The `input` slot that will be used to access the value.
|
|
#' @param label Display label for the control, or `NULL` for no label.
|
|
#' @param value Initial value.
|
|
#' @param width The width of the input, e.g. `'400px'`, or `'100%'`;
|
|
#' see [validateCssUnit()].
|
|
#' @param 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.
|
|
#' @return A text input control that can be added to a UI definition.
|
|
#'
|
|
#' @family input elements
|
|
#' @seealso [updateTextInput()]
|
|
#'
|
|
#' @examples
|
|
#' ## Only run examples in interactive R sessions
|
|
#' if (interactive()) {
|
|
#'
|
|
#' ui <- fluidPage(
|
|
#' textInput("caption", "Caption", "Data Summary"),
|
|
#' 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
|
|
textInput <- function(inputId, label, value = "", width = NULL,
|
|
placeholder = NULL) {
|
|
|
|
value <- restoreInput(id = inputId, default = value)
|
|
|
|
div(class = "form-group shiny-input-container",
|
|
style = css(width = validateCssUnit(width)),
|
|
shinyInputLabel(inputId, label),
|
|
tags$input(id = inputId, type="text", class="shiny-input-text form-control", value=value,
|
|
placeholder = placeholder)
|
|
)
|
|
}
|