mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-10 07:28:01 -05:00
120 lines
3.6 KiB
R
120 lines
3.6 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/input-checkboxgroup.R
|
|
\name{checkboxGroupInput}
|
|
\alias{checkboxGroupInput}
|
|
\title{Checkbox Group Input Control}
|
|
\usage{
|
|
checkboxGroupInput(
|
|
inputId,
|
|
label,
|
|
choices = NULL,
|
|
selected = NULL,
|
|
inline = FALSE,
|
|
width = NULL,
|
|
choiceNames = NULL,
|
|
choiceValues = NULL
|
|
)
|
|
}
|
|
\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{choices}{List of values to show checkboxes for. If elements of the list
|
|
are named then that name rather than the value is displayed to the user. If
|
|
this argument is provided, then \code{choiceNames} and \code{choiceValues}
|
|
must not be provided, and vice-versa. The values should be strings; other
|
|
types (such as logicals and numbers) will be coerced to strings.}
|
|
|
|
\item{selected}{The values that should be initially selected, if any.}
|
|
|
|
\item{inline}{If \code{TRUE}, render the choices inline (i.e. horizontally)}
|
|
|
|
\item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'};
|
|
see \code{\link[=validateCssUnit]{validateCssUnit()}}.}
|
|
|
|
\item{choiceNames, choiceValues}{List of names and values, respectively,
|
|
that are displayed to the user in the app and correspond to the each
|
|
choice (for this reason, \code{choiceNames} and \code{choiceValues}
|
|
must have the same length). If either of these arguments is
|
|
provided, then the other \emph{must} be provided and \code{choices}
|
|
\emph{must not} be provided. The advantage of using both of these over
|
|
a named list for \code{choices} is that \code{choiceNames} allows any
|
|
type of UI object to be passed through (tag objects, icons, HTML code,
|
|
...), instead of just simple text. See Examples.}
|
|
}
|
|
\value{
|
|
A list of HTML elements that can be added to a UI definition.
|
|
}
|
|
\description{
|
|
Create a group of checkboxes that can be used to toggle multiple choices
|
|
independently. The server will receive the input as a character vector of the
|
|
selected values.
|
|
}
|
|
\section{Server value}{
|
|
|
|
Character vector of values corresponding to the boxes that are checked.
|
|
}
|
|
|
|
\examples{
|
|
## Only run examples in interactive R sessions
|
|
if (interactive()) {
|
|
|
|
ui <- fluidPage(
|
|
checkboxGroupInput("variable", "Variables to show:",
|
|
c("Cylinders" = "cyl",
|
|
"Transmission" = "am",
|
|
"Gears" = "gear")),
|
|
tableOutput("data")
|
|
)
|
|
|
|
server <- function(input, output, session) {
|
|
output$data <- renderTable({
|
|
mtcars[, c("mpg", input$variable), drop = FALSE]
|
|
}, rownames = TRUE)
|
|
}
|
|
|
|
shinyApp(ui, server)
|
|
|
|
ui <- fluidPage(
|
|
checkboxGroupInput("icons", "Choose icons:",
|
|
choiceNames =
|
|
list(icon("calendar"), icon("bed"),
|
|
icon("cog"), icon("bug")),
|
|
choiceValues =
|
|
list("calendar", "bed", "cog", "bug")
|
|
),
|
|
textOutput("txt")
|
|
)
|
|
|
|
server <- function(input, output, session) {
|
|
output$txt <- renderText({
|
|
icons <- paste(input$icons, collapse = ", ")
|
|
paste("You chose", icons)
|
|
})
|
|
}
|
|
|
|
shinyApp(ui, server)
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link[=checkboxInput]{checkboxInput()}}, \code{\link[=updateCheckboxGroupInput]{updateCheckboxGroupInput()}}
|
|
|
|
Other input elements:
|
|
\code{\link{actionButton}()},
|
|
\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{textAreaInput}()},
|
|
\code{\link{textInput}()},
|
|
\code{\link{varSelectInput}()}
|
|
}
|
|
\concept{input elements}
|