mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-13 17:08:05 -05:00
68 lines
2.0 KiB
R
68 lines
2.0 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/update-input.R
|
|
\name{updateCheckboxInput}
|
|
\alias{updateCheckboxInput}
|
|
\title{Change the value of a checkbox input on the client}
|
|
\usage{
|
|
updateCheckboxInput(
|
|
session = getDefaultReactiveDomain(),
|
|
inputId,
|
|
label = NULL,
|
|
value = NULL
|
|
)
|
|
}
|
|
\arguments{
|
|
\item{session}{The \code{session} object passed to function given to
|
|
\code{shinyServer}. Default is \code{getDefaultReactiveDomain()}.}
|
|
|
|
\item{inputId}{The id of the input object.}
|
|
|
|
\item{label}{The label to set for the input object.}
|
|
|
|
\item{value}{Initial value (\code{TRUE} or \code{FALSE}).}
|
|
}
|
|
\description{
|
|
Change the value of a checkbox input on the client
|
|
}
|
|
\details{
|
|
The input updater functions send a message to the client, telling it to
|
|
change the settings of an input object. The messages are collected and sent
|
|
after all the observers (including outputs) have finished running.
|
|
|
|
The syntax of these functions is similar to the functions that created the
|
|
inputs in the first place. For example, \code{\link{numericInput}()} and
|
|
\code{updateNumericInput()} take a similar set of arguments.
|
|
|
|
Any arguments with NULL values will be ignored; they will not result in any
|
|
changes to the input object on the client.
|
|
|
|
For \code{\link{radioButtons}()}, \code{\link{checkboxGroupInput}()} and
|
|
\code{\link{selectInput}()}, the set of choices can be cleared by using
|
|
\code{choices=character(0)}. Similarly, for these inputs, the selected item
|
|
can be cleared by using \code{selected=character(0)}.
|
|
}
|
|
\examples{
|
|
## Only run examples in interactive R sessions
|
|
if (interactive()) {
|
|
|
|
ui <- fluidPage(
|
|
sliderInput("controller", "Controller", 0, 1, 0, step = 1),
|
|
checkboxInput("inCheckbox", "Input checkbox")
|
|
)
|
|
|
|
server <- function(input, output, session) {
|
|
observe({
|
|
# TRUE if input$controller is odd, FALSE if even.
|
|
x_even <- input$controller \%\% 2 == 1
|
|
|
|
updateCheckboxInput(session, "inCheckbox", value = x_even)
|
|
})
|
|
}
|
|
|
|
shinyApp(ui, server)
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link[=checkboxInput]{checkboxInput()}}
|
|
}
|