forked from dreamRs/shinyWidgets
-
Notifications
You must be signed in to change notification settings - Fork 0
/
input-switch.R
325 lines (322 loc) · 9.81 KB
/
input-switch.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
#' @title Bootstrap Switch Input Control
#'
#' @description
#' Create a toggle switch.
#'
#' @param inputId The \code{input} slot that will be used to access the value.
#' @param label Display a text in the center of the switch.
#' @param value Initial value (TRUE or FALSE).
#' @param onLabel Text on the left side of the switch (TRUE).
#' @param offLabel Text on the right side of the switch (FALSE).
#' @param onStatus Color (bootstrap status) of the left side of the switch (TRUE).
#' @param offStatus Color (bootstrap status) of the right side of the switch (FALSE).
#' @param size Size of the buttons ('default', 'mini', 'small', 'normal', 'large').
#' @param labelWidth Width of the center handle in pixels.
#' @param handleWidth Width of the left and right sides in pixels.
#' @param disabled Logical, display the toggle switch in disabled state?.
#' @param inline Logical, display the toggle switch inline?
#' @param width The width of the input : 'auto', 'fit', '100px', '75\%'.
#'
#' @return A switch control that can be added to a UI definition.
#'
#'
#'
#' @importFrom shiny restoreInput
#' @importFrom htmltools tags validateCssUnit
#'
#' @export
#'
#'
#' @note For more information, see the project on Github
#' \url{https://github.com/Bttstrp/bootstrap-switch}.
#'
#' @seealso \code{\link{updateSwitchInput}}, \code{\link{materialSwitch}}
#'
#' @examples
#' \dontrun{
#' ## Only run examples in interactive R sessions
#' if (interactive()) {
#'
#' # Examples in the gallery :
#' shinyWidgets::shinyWidgetsGallery()
#'
#' # Basic usage :
#' ui <- fluidPage(
#' switchInput(inputId = "somevalue"),
#' verbatimTextOutput("value")
#' )
#' server <- function(input, output) {
#' output$value <- renderPrint({ input$somevalue })
#' }
#' shinyApp(ui, server)
#' }
#' }
switchInput <- function(inputId, label = NULL, value = FALSE, onLabel = 'ON', offLabel = 'OFF',
onStatus = NULL, offStatus = NULL, size = "default", labelWidth = "auto",
handleWidth = "auto", disabled = FALSE, inline = FALSE, width = NULL) {
value <- shiny::restoreInput(id = inputId, default = value)
size <- match.arg(arg = size, choices = c('default', 'mini', 'small', 'normal', 'large'))
switchProps <- dropNulls(
list(
id = inputId, type = "checkbox", class = "sw-switchInput", `data-input-id` = inputId,
`data-on-text` = onLabel, `data-off-text` = offLabel, `data-label-text` = label,
`data-on-color` = onStatus, `data-off-color` = offStatus, #`data-state` = value,
`data-label-width` = labelWidth, `data-handle-width` = handleWidth,
`disabled` = if (!disabled) NULL else disabled,
`data-size` = if (size == "default") "" else size
)
)
switchProps <- lapply(switchProps, function(x) {
if (identical(x, TRUE))
"true"
else if (identical(x, FALSE))
"false"
else x
})
inputTag <- do.call(htmltools::tags$input, switchProps)
if (!is.null(value) && value)
inputTag$attribs$checked <- "checked"
switchInputTag <- htmltools::tags$div(
style = "margin: 3px;", class = "form-group shiny-input-container",
class = if (inline) "shiny-input-container-inline",
style = if (inline) "display: inline-block;",
style = if (!is.null(width)) paste0("width: ", htmltools::validateCssUnit(width), ";"),
inputTag
)
# Dep
attachShinyWidgetsDep(switchInputTag, "bsswitch")
}
#' @title Change the value of a switch input on the client
#'
#' @description
#' Change the value of a switch input on the client
#'
#' @param session The session object passed to function given to shinyServer.
#' @param inputId The id of the input object.
#' @param value The value to set for the input object.
#' @param label The label to set for the input object.
#' @param onLabel The onLabel to set for the input object.
#' @param offLabel The offLabel to set for the input object.
#' @param onStatus The onStatus to set for the input object.
#' @param offStatus The offStatus to set for the input object.
#' @param disabled Logical, disable state.
#'
#' @export
#'
#' @seealso \code{\link{switchInput}}
#'
#' @examples
#' \dontrun{
#'
#' if (interactive()) {
#' library("shiny")
#' library("shinyWidgets")
#'
#'
#' ui <- fluidPage(
#' tags$h1("Update", tags$code("switchInput")),
#' br(),
#' fluidRow(
#' column(
#' width = 4,
#' panel(
#' switchInput(inputId = "switch1"),
#' verbatimTextOutput(outputId = "resup1"),
#' tags$div(
#' class = "btn-group",
#' actionButton(
#' inputId = "updatevaluetrue",
#' label = "Set to TRUE"
#' ),
#' actionButton(
#' inputId = "updatevaluefalse",
#' label = "Set to FALSE"
#' )
#' ),
#' heading = "Update value"
#' )
#' ),
#'
#' column(
#' width = 4,
#' panel(
#' switchInput(inputId = "switch2",
#' label = "My label"),
#' verbatimTextOutput(outputId = "resup2"),
#' textInput(inputId = "updatelabeltext",
#' label = "Update label:"),
#' heading = "Update label"
#' )
#' ),
#'
#' column(
#' width = 4,
#' panel(
#' switchInput(
#' inputId = "switch3",
#' onLabel = "Yeaah",
#' offLabel = "Noooo"
#' ),
#' verbatimTextOutput(outputId = "resup3"),
#' fluidRow(column(
#' width = 6,
#' textInput(inputId = "updateonLabel",
#' label = "Update onLabel:")
#' ),
#' column(
#' width = 6,
#' textInput(inputId = "updateoffLabel",
#' label = "Update offLabel:")
#' )),
#' heading = "Update onLabel & offLabel"
#' )
#' )
#' ),
#'
#' fluidRow(column(
#' width = 4,
#' panel(
#' switchInput(inputId = "switch4"),
#' verbatimTextOutput(outputId = "resup4"),
#' fluidRow(
#' column(
#' width = 6,
#' pickerInput(
#' inputId = "updateonStatus",
#' label = "Update onStatus:",
#' choices = c("default", "primary", "success",
#' "info", "warning", "danger")
#' )
#' ),
#' column(
#' width = 6,
#' pickerInput(
#' inputId = "updateoffStatus",
#' label = "Update offStatus:",
#' choices = c("default", "primary", "success",
#' "info", "warning", "danger")
#' )
#' )
#' ),
#' heading = "Update onStatus & offStatusr"
#' )
#' ),
#'
#' column(
#' width = 4,
#' panel(
#' switchInput(inputId = "switch5"),
#' verbatimTextOutput(outputId = "resup5"),
#' checkboxInput(
#' inputId = "disabled",
#' label = "Disabled",
#' value = FALSE
#' ),
#' heading = "Disabled"
#' )
#' ))
#'
#' )
#'
#' server <- function(input, output, session) {
#' # Update value
#' observeEvent(input$updatevaluetrue, {
#' updateSwitchInput(session = session,
#' inputId = "switch1",
#' value = TRUE)
#' })
#' observeEvent(input$updatevaluefalse, {
#' updateSwitchInput(session = session,
#' inputId = "switch1",
#' value = FALSE)
#' })
#' output$resup1 <- renderPrint({
#' input$switch1
#' })
#'
#'
#' # Update label
#' observeEvent(input$updatelabeltext, {
#' updateSwitchInput(
#' session = session,
#' inputId = "switch2",
#' label = input$updatelabeltext
#' )
#' }, ignoreInit = TRUE)
#' output$resup2 <- renderPrint({
#' input$switch2
#' })
#'
#'
#' # Update onLabel & offLabel
#' observeEvent(input$updateonLabel, {
#' updateSwitchInput(
#' session = session,
#' inputId = "switch3",
#' onLabel = input$updateonLabel
#' )
#' }, ignoreInit = TRUE)
#' observeEvent(input$updateoffLabel, {
#' updateSwitchInput(
#' session = session,
#' inputId = "switch3",
#' offLabel = input$updateoffLabel
#' )
#' }, ignoreInit = TRUE)
#' output$resup3 <- renderPrint({
#' input$switch3
#' })
#'
#'
#' # Update onStatus & offStatus
#' observeEvent(input$updateonStatus, {
#' updateSwitchInput(
#' session = session,
#' inputId = "switch4",
#' onStatus = input$updateonStatus
#' )
#' }, ignoreInit = TRUE)
#' observeEvent(input$updateoffStatus, {
#' updateSwitchInput(
#' session = session,
#' inputId = "switch4",
#' offStatus = input$updateoffStatus
#' )
#' }, ignoreInit = TRUE)
#' output$resup4 <- renderPrint({
#' input$switch4
#' })
#'
#'
#' # Disabled
#' observeEvent(input$disabled, {
#' updateSwitchInput(
#' session = session,
#' inputId = "switch5",
#' disabled = input$disabled
#' )
#' }, ignoreInit = TRUE)
#' output$resup5 <- renderPrint({
#' input$switch5
#' })
#'
#' }
#'
#' shinyApp(ui = ui, server = server)
#'
#' }
#'
#' }
updateSwitchInput <- function(session, inputId,
value = NULL, label = NULL,
onLabel = NULL, offLabel = NULL,
onStatus = NULL, offStatus = NULL,
disabled = NULL) {
message <- dropNulls(
list(value = value, label = label,
onLabel = onLabel, offLabel = offLabel,
onStatus = onStatus, offStatus = offStatus,
disabled = disabled)
)
session$sendInputMessage(inputId, message)
}