fix(inputs): action or actions added to supported inputs (#166)

nteetor · Nov 26, 2019 · d7433d5 · d7433d5
1 parent f9d6757
commit d7433d5
Show file tree

Hide file tree

Showing 27 changed files with 241 additions and 114 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -31,6 +31,7 @@ Depends:
     R (>= 3.2),
     shiny (>= 1.1.0)
 Imports:
+    htmltools (>= 0.3.6.9004),
     magrittr,
     utils
 Remotes:

diff --git a/R/actions.R b/R/actions.R
@@ -1,12 +1,43 @@
 #' Input actions
 #'
-#' These functions are used in conjunction with yonder's reactive input functions'
-#' `actions` argument.
+#' @description
 #'
-#' @param id A character string specifying the id of a [navPane()] or
-#'   [collapsePane()].
+#' Input actions are a new feature in yonder. These actions allow a reactive
+#' input to interact with elements of your application's user interface without
+#' requiring server-side logic. See below for components inputs may interact
+#' with using input actions. Not all of yonder's reactive inputs may be used
+#' with input actions.
+#'
+#' @section Supported inputs:
+#'
+#' * [buttonInput()]
+#'
+#' * [buttonGroupInput()]
+#'
+#' * [linkInput()]
+#'
+#' * [navInput()]
+#'
+#' @section Actionable components:
+#'
+#' **Nav panes**
+#'
+#' A nav pane may be shown with [showNavTarget()] or hidden with
+#' [hideNavTarget()].
+#'
+#' **Collapse panes**
+#'
+#' A collapse pane may be opened with [showCollapseTarget()] or hidden with
+#' [hideCollapseTarget()] or toggled with [toggleCollapseTarget()].
+#'
+#' Toggling a collapse pane will open the pane if closed or close the pane
+#' if currently open.
+#'
+#' **Modals**
+#'
+#'
+#' **Toasts**
 #'
-#' @param ... Additional arguments, currently ignored.
 #'
 #' @aliases action
 #' @name actions
@@ -48,7 +79,7 @@ c.input_action <- function(...) {
 
 as.list.input_action <- function(x) {
   list(
-    `data-toggle` = x$plugin,
+    `data-plugin` = x$plugin,
     `data-target` = x$target,
     `data-action` = x$action
   )

diff --git a/R/button.R b/R/button.R
@@ -23,7 +23,7 @@
 #' @param tooltip A call to [tooltip()] specifying a tooltip for the button or
 #'   link input, defaults to `NULL`.
 #'
-#' @param actions An input [action] or `NULL`.
+#' @param action An input [action] or `NULL`.
 #'
 #' @param ... Additional named arguments passed as HTML attributes to the parent
 #'   element.
@@ -127,10 +127,10 @@
 #' )
 #'
 buttonInput <- function(id, label, ..., stretch = FALSE, download = FALSE,
-                        tooltip = NULL, actions = NULL) {
+                        tooltip = NULL, action = NULL) {
   assert_id()
   assert_label()
-  assert_actions(list = FALSE)
+  assert_action()
 
   dep_attach({
     component <- (if (download) tags$a else tags$button)(
@@ -145,7 +145,7 @@ buttonInput <- function(id, label, ..., stretch = FALSE, download = FALSE,
       href = if (download) "",
       `_target` = if (download) NA,
       download = if (download) NA,
-      !!!actions,
+      !!!action,
       id = id,
       label,
       ...,
@@ -189,10 +189,10 @@ updateButtonInput <- function(id, label = NULL, value = NULL,
 #' @rdname buttonInput
 #' @export
 linkInput <- function(id, label, ..., stretch = FALSE, download = FALSE,
-                      tooltip = NULL, actions = NULL) {
+                      tooltip = NULL, action = NULL) {
   assert_id()
   assert_label()
-  assert_actions(list = FALSE)
+  assert_action()
 
   dep_attach({
     component <- (if (download) tags$a else tags$button)(
@@ -206,7 +206,7 @@ linkInput <- function(id, label, ..., stretch = FALSE, download = FALSE,
       href = if (download) "",
       `_target` = if (download) NA,
       download = if (download) NA,
-      !!!actions,
+      !!!action,
       id = id,
       label,
       ...

diff --git a/R/checkbox.R b/R/checkbox.R
@@ -76,7 +76,7 @@
 #'   active("indigo")
 #'
 checkboxInput <- function(id, choices = NULL, values = choices, selected = NULL,
-                          ..., inline = FALSE, actions = NULL) {
+                          ..., inline = FALSE) {
   assert_id()
   assert_choices()
   assert_actions()
@@ -169,20 +169,18 @@ updateSwitchInput <- function(id, choices = NULL, values = choices,
   ))
 }
 
-map_checkboxes <- function(choices, values, selected, inline, actions,
+map_checkboxes <- function(choices, values, selected, inline,
                            switches = FALSE) {
   if (is.null(choices) && is.null(values)) {
     return(NULL)
   }
 
   selected <- values %in% selected
-  actions <- normalize_actions(actions, values)
 
   Map(
     choice = choices,
     value = values,
     select = selected,
-    action = actions,
     last = seq_along(choices) == length(choices),
     function(choice, value, select, action, last) {
       id <- generate_id("checkbox")
@@ -199,7 +197,6 @@ map_checkboxes <- function(choices, values, selected, inline, actions,
           id = id,
           name = id,
           value = value,
-          !!!action,
           checked = if (select) NA,
           autocomplete = "off"
         ),

diff --git a/R/list-group.R b/R/list-group.R
@@ -1,19 +1,20 @@
 #' List group inputs
 #'
 #' List group inputs are an actionable list of items. They behave similarly to
-#' checkboxes or radios, that is, users may select one or more items from the
-#' list. However, list group items may include highly variable content.
+#' radio buttons. However, list group items may include highly variable content.
 #'
 #' @inheritParams checkboxInput
 #'
+#' @inheritParams buttonGroupInput
+#'
 #' @param choices A vector of character strings or list of tag elements specifying
 #'   the content of the list group's items.
 #'
 #' @param values A character vector specifying the values of the list items,
 #'   defaults to `choices`.
 #'
-#' @param selected One or more of `values` specifying which choices are selected
-#'   by default, defaults to `NULL`, in which case no choice is selected.
+#' @param selected One of `values` specifying which choices are selected by
+#'   default, defaults to `NULL`, in which case no choice is selected.
 #'
 #' @param layout A [responsive] argument. One of `"vertical"` or `"horizontal"`
 #'   specifying how list items are laid out, defaults to `"vertical"`. Note, if
@@ -108,10 +109,12 @@
 #' )
 #'
 listGroupInput <- function(id, choices = NULL, values = choices,
-                           selected = NULL, ..., layout = "vertical",
-                           flush = FALSE) {
+                           selected = NULL, ..., actions = NULL,
+                           layout = "vertical", flush = FALSE) {
   assert_id()
   assert_choices()
+  assert_selected(length = 1)
+  assert_actions()
   assert_possible(layout, c("vertical", "horizontal"))
   assert_possible(flush, c(TRUE, FALSE))
 
@@ -122,7 +125,7 @@ listGroupInput <- function(id, choices = NULL, values = choices,
     # drop vertical classes as they do not actually exist
     classes <- classes[!grepl("vertical", classes, fixed = TRUE)]
 
-    items <- map_listitems(choices, values, selected)
+    items <- map_listitems(choices, values, selected, actions)
 
     tags$div(
       class = str_collate(
@@ -145,6 +148,7 @@ updateListGroupInput <- function(id, choices = NULL, values = choices,
                                  session = getDefaultReactiveDomain()) {
   assert_id()
   assert_choices()
+  assert_selected(length = 1)
   assert_session()
 
   items <- map_listitems(choices, values, selected)
@@ -162,18 +166,20 @@ updateListGroupInput <- function(id, choices = NULL, values = choices,
   ))
 }
 
-map_listitems <- function(choices, values, selected) {
+map_listitems <- function(choices, values, selected, actions) {
   if (is.null(choices) && is.null(values)) {
     return(NULL)
   }
 
   selected <- values %in% selected
+  actions <- normalize_actions(actions, values)
 
   Map(
     choice = choices,
     value = values,
     select = selected,
-    function(choice, value, select) {
+    action = actions,
+    function(choice, value, select, action) {
       tags$button(
         class = str_collate(
           "list-group-item",
@@ -182,6 +188,7 @@ map_listitems <- function(choices, values, selected) {
           if (select) "active"
         ),
         value = value,
+        !!!action,
         choice
       )
     }

diff --git a/R/menu.R b/R/menu.R
@@ -6,6 +6,8 @@
 #'
 #' @inheritParams checkboxInput
 #'
+#' @inheritParams buttonGroupInput
+#'
 #' @param label A character string or tag element specifying the label of the
 #'   menu's toggle button.
 #'
@@ -59,15 +61,17 @@
 #' )
 #'
 menuInput <- function(id, label, choices = NULL, values = choices,
-                      selected = NULL, ..., direction = "down",
-                      align = "left") {
+                      selected = NULL, ..., actions = NULL,
+                      direction = "down", align = "left") {
   assert_id()
+  assert_label()
   assert_choices()
+  assert_actions()
   assert_possible(direction, c("up", "right", "down", "left"))
   assert_possible(align, c("right", "left"))
 
   dep_attach({
-    items <- map_menuitems(choices, values, selected)
+    items <- map_menuitems(choices, values, selected, actions)
 
     tags$div(
       class = str_collate(
@@ -123,25 +127,28 @@ updateMenuInput <- function(id, label = NULL, choices = NULL, values = choices,
   ))
 }
 
-map_menuitems <- function(choices, values, selected) {
+map_menuitems <- function(choices, values, selected, actions) {
   if (is.null(choices) && is.null(values)) {
     return(NULL)
   }
 
   selected <- values %in% selected
+  actions <- normalize_actions(actions, values)
 
   Map(
     choice = choices,
     value = values,
     select = selected,
-    function(choice, value, select) {
+    action = actions,
+    function(choice, value, select, action) {
       tags$button(
         class = str_collate(
           "dropdown-item",
           if (select) "active"
         ),
         type = "button",
         value = value,
+        !!!action,
         choice
       )
     }

diff --git a/R/nav.R b/R/nav.R
@@ -9,6 +9,8 @@
 #'
 #' @inheritParams checkboxInput
 #'
+#' @inheritParams buttonInput
+#'
 #' @param choices A character vector or list of tag elements specifying the
 #'   navigation items of the input.
 #'
@@ -25,8 +27,6 @@
 #' @param appearance One of `"links"`, `"pills"`, or `"tabs"` specifying the
 #'   appearance of the nav input, defaults to `"links"`.
 #'
-#' @param actions Any number of [actions], defaults to `NULL`.
-#'
 #' @section Including a menu:
 #'
 #' Use the reactive id of any nav menus to know when a menu item is clicked.