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
58 lines
1.7 KiB
R
58 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}
|