mirror of
https://github.com/rstudio/shiny.git
synced 2026-02-09 22:25:59 -05:00
f834b7befb
* adding section to roxygen docs for server value of input funcs * add more server values to roxygen docs * add more server values * update more server values in documentation * Address PR feedback I reflowed the comments to have a max width of 80 on some files, so there were a flurry of line changes, but the only substantive changes were around Joe's comments. * Update R/input-slider.R Co-Authored-By: Hadley Wickham <h.wickham@gmail.com> * Apply suggestions from code review Co-Authored-By: Carson Sievert <cpsievert1@gmail.com> * PR feedback, regenerate docs. * PR Feedback * Eliminate extra newline * passwordInput()'s server value * varSelectInput()'s server value * document
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 = if (!is.null(width)) paste0("width: ", validateCssUnit(width), ";"),
|
|
shinyInputLabel(inputId, label),
|
|
tags$input(id = inputId, type="text", class="form-control", value=value,
|
|
placeholder = placeholder)
|
|
)
|
|
}
|