mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-14 01:18:07 -05:00
65 lines
1.7 KiB
R
65 lines
1.7 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/input-checkbox.R
|
|
\name{checkboxInput}
|
|
\alias{checkboxInput}
|
|
\title{Checkbox Input Control}
|
|
\usage{
|
|
checkboxInput(inputId, label, value = FALSE, width = 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{value}{Initial value (\code{TRUE} or \code{FALSE}).}
|
|
|
|
\item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'};
|
|
see \code{\link[=validateCssUnit]{validateCssUnit()}}.}
|
|
}
|
|
\value{
|
|
A checkbox control that can be added to a UI definition.
|
|
}
|
|
\description{
|
|
Create a checkbox that can be used to specify logical values.
|
|
}
|
|
\section{Server value}{
|
|
|
|
\code{TRUE} if checked, \code{FALSE} otherwise.
|
|
}
|
|
|
|
\examples{
|
|
## Only run examples in interactive R sessions
|
|
if (interactive()) {
|
|
|
|
ui <- fluidPage(
|
|
checkboxInput("somevalue", "Some value", FALSE),
|
|
verbatimTextOutput("value")
|
|
)
|
|
server <- function(input, output) {
|
|
output$value <- renderText({ input$somevalue })
|
|
}
|
|
shinyApp(ui, server)
|
|
}
|
|
|
|
}
|
|
\seealso{
|
|
\code{\link[=checkboxGroupInput]{checkboxGroupInput()}}, \code{\link[=updateCheckboxInput]{updateCheckboxInput()}}
|
|
|
|
Other input elements:
|
|
\code{\link{actionButton}()},
|
|
\code{\link{checkboxGroupInput}()},
|
|
\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}
|