Allow arbitrary UI code in the choices for radio buttons and checkbox group input #1521

bborgesr · 2016-12-30T23:50:53Z

Example app:

ui <- fluidPage(
  sidebarLayout(
    sidebarPanel( 
      radioButtons("normal", "Normal radio buttons:",
        c("Normal" = "norm", "Uniform" = "unif",
         "Log-normal" = "lnorm", "Exponential" = "exp")),
      hr(),
      radioButtons("fancy", "Fancy radio buttons:",
      choiceNames = list(tags$span(HTML("Normal &mu;<sub>1</sub>")),
        icon("calendar", "fa-3x"),
        icon("bed"),
        icon("cog", lib = "glyphicon"),
        img(src = "https://www.rstudio.com/wp-content/uploads/2016/09/RStudio-Logo-Blue-Gray-250.png")),
      choiceValues = c("html", "icon1", "icon2", "icon3", "img"))),
    mainPanel(textOutput("rb1"), textOutput("rb2"))
  )
)

server <- function(input, output, session) {
  output$rb1 <- renderText({
    paste("You chose", input$normal)
  })
  
  output$rb2 <- renderText({
    paste("You chose", input$fancy)
  })
}

shinyApp(ui, server)

bborgesr · 2017-01-01T22:55:05Z

Fixes #1348 and fixes #1437

jcheng5 · 2017-01-01T23:31:54Z

I'd prefer choiceNames and choiceValues instead of choicesNames and choicesValues.

I don't like that choices, choicesNames, and choicesValues propagate beyond checkChoicesArgs; I think choices should go away, since it can be thought of as a shorthand for choicesNames <- names(choices) and choicesValues <- unname(choices). Then the rest of the code (like validateSelected) can just deal with one way of specifying these values, instead of two.

I tend to think of functions that are named checkFoo and validateFoo as simply returning TRUE or FALSE, or throwing warnings or errors. In these cases we're using them to do normalization. Not a big deal and you don't have to change the names in this PR but maybe something to keep in mind moving forward.

(Don't forget the inspecting/merging of the API branch needs to happen before the conference, this PR can be merged after the conference...)

bborgesr · 2017-01-16T18:09:27Z

R/input-utils.R

+      stop("`choicesNames` and `choicesValues` must not be named.")
+    }
+  } else {
+    if (lenNames != 0 || lenVals != 0) {


check for NULL instead

bborgesr · 2017-01-16T18:12:27Z

R/input-utils.R

+    if (lenNames != lenVals) {
+      stop("`choicesNames` and `choicesValues` must have the same length.")
+    }
+    if (!is.null(names(choicesNames)) || !is.null(names(choicesValues))) {


use anyNamed instead

wch · 2017-01-16T18:07:51Z

R/input-utils.R

+    if (lenNames != 0 || lenVals != 0) {
+      warning("Using `choices` argument; ignoring `choicesNames` and
+                `choicesValues`.")
+      choicesNames = NULL


Should be <-.

bborgesr · 2017-03-22T02:40:41Z

I think I've addressed all points and this should be good to squash-merge.

The one possible hiccup is what we're breaking backward compatibility (but only for unexported functions!) as we change the name of some of the internal utility functions (switch from "validate"/"check" prefixes to "normalize", per Joe's comment above) and their expected arguments (pass in choiceNames and choiceValues instead of choices).

jcheng5 · 2017-03-23T00:38:20Z

Maybe we can review this together tomorrow. It's been so long I don't remember :)

wch · 2017-03-23T18:32:27Z

R/input-utils.R


 # Before shiny 0.9, `selected` refers to names/labels of `choices`; now it
 # refers to values. Below is a function for backward compatibility. It also
 # coerces the value to `character`.
-validateSelected <- function(selected, choices, inputId) {
+normalizeSelected <- function(selected, inputId, choiceNames, choiceValues) {


Since 0.10.0 (which was released in June 2014) users have gotten a warning if selected was a name instead of a value. So I think it's safe to assume that no one is doing that anymore. And that means that we can remove this function entirely. We will need to do selected <- as.character(selected) where we previously called validateSelected, for the reasons in the comment directly below.

wch · 2017-03-23T18:45:11Z

R/update-input.R

-                               type = 'checkbox') {
-  if (!is.null(choices))
-    choices <- choicesWithNames(choices)
+                               selected = NULL, inline = FALSE, type = NULL,


It would be good to error if type is NULL.

wch · 2017-03-23T18:51:18Z

R/input-utils.R

+    choiceValues <- unname(choices)
+  }
+
+  return(list(choiceNames = choiceNames, choiceValues = choiceValues))


If choices, choicesNames, and choicesValues are all NULL, this should return a list like:

list(choiceNames = NULL, choiceValues = NULL)

And also have a test for it.

Also, choiceNames and choiceValues should always be lists (or NULL), and not character vectors.

…icesNames` and `choicesValues`)

…choiceValues`

wch · 2017-03-27T14:21:37Z

NEWS.md

@@ -5,6 +5,8 @@ shiny 1.0.0.9001

 ### Breaking changes

+* The functions `radioButtons()`, `checkboxGroupInput()` and `selectInput()` (and the corresponding `updateXXX()` functions) no longer accept a `selected` argument whose value is the name of a choice, instead of the value of the choice. This feature had been soft-deprecated since Shiny 0.10 (printing a warning message, but still trying to match the name to the right choice) and it's now been completely deprecated.


It would be more accurate to say that it had been deprecated (not soft-deprecated) since 0.10.0.

bborgesr added the review label Dec 30, 2016

bborgesr self-assigned this Jan 1, 2017

bborgesr commented Jan 16, 2017

View reviewed changes

wch reviewed Jan 16, 2017

View reviewed changes

bborgesr force-pushed the barbara/htmlChoices branch 2 times, most recently from d8671c3 to 057e404 Compare March 22, 2017 02:34

wch reviewed Mar 23, 2017

View reviewed changes

bborgesr mentioned this pull request Mar 23, 2017

Feature Request: allow selectizeInput to be passed HTML #1620

Open

bborgesr added 15 commits March 24, 2017 17:55

working but ugly

00276ab

handle dependencies

2c44437

better

9571285

added documentation and example

4ea3990

uncommenting

cc67907

fix tests

b6bbd11

update funs

35136b9

fix docs

f982be2

make checkChoicesArgs fun

4055c6b

name elements of return list

e909e35

minor updates

f14dd69

don't propagate choices beyond normalizeCheckArgs() (only keep `cho…

c6e1e40

…icesNames` and `choicesValues`)

replace choicesNames with choiceNames, and choicesValues with `…

2b28ea2

…choiceValues`

a bunch of tests

81fe6a1

news item and comment

8961778

some changes after feedback from Winston

bcd8fce

bborgesr force-pushed the barbara/htmlChoices branch from 683ce26 to bcd8fce Compare March 24, 2017 17:57

bborgesr added 4 commits March 24, 2017 19:52

try to adapt things for selectInput

362ff9f

add mustExist to update-input

2488690

revert selectInput adaptation (and add a space in error message)

0687f04

added breaking change NEWS item

e1a2752

wch reviewed Mar 27, 2017

View reviewed changes

bborgesr added 2 commits March 27, 2017 16:33

edge cases and numbers

724fa36

remove call to validateselected

c0902f8

bborgesr merged commit d62a2fc into master Mar 27, 2017

bborgesr removed the review label Mar 27, 2017

This was referenced Mar 27, 2017

HTML elements as labels for radio buttons #1437

Closed

Feature request: Images associated with radioButton inputs #1348

Closed

wch mentioned this pull request Dec 4, 2021

Consider swapping order of choices and values for input_radio_buttons, input_checkbox_group, and input_select posit-dev/py-shiny#5

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow arbitrary UI code in the choices for radio buttons and checkbox group input #1521

Allow arbitrary UI code in the choices for radio buttons and checkbox group input #1521

bborgesr commented Dec 30, 2016 •

edited

bborgesr commented Jan 1, 2017

jcheng5 commented Jan 1, 2017

bborgesr Jan 16, 2017

bborgesr Jan 16, 2017

wch Jan 16, 2017

bborgesr commented Mar 22, 2017

jcheng5 commented Mar 23, 2017

wch Mar 23, 2017

wch Mar 23, 2017

wch Mar 23, 2017

wch Mar 23, 2017

wch Mar 27, 2017

		@@ -5,6 +5,8 @@ shiny 1.0.0.9001

		### Breaking changes

		* The functions `radioButtons()`, `checkboxGroupInput()` and `selectInput()` (and the corresponding `updateXXX()` functions) no longer accept a `selected` argument whose value is the name of a choice, instead of the value of the choice. This feature had been soft-deprecated since Shiny 0.10 (printing a warning message, but still trying to match the name to the right choice) and it's now been completely deprecated.

Allow arbitrary UI code in the choices for radio buttons and checkbox group input #1521

Allow arbitrary UI code in the choices for radio buttons and checkbox group input #1521

Conversation

bborgesr commented Dec 30, 2016 • edited

bborgesr commented Jan 1, 2017

jcheng5 commented Jan 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bborgesr commented Mar 22, 2017

jcheng5 commented Mar 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bborgesr commented Dec 30, 2016 •

edited