R/actionbuttonUI.R

In kahaaga/shinymodules: Wrappers around common shiny modules.

#' @title actionButtonUI
#' @description Wrapper around shiny::actionButton.
#' @param id A unique string id for the action button. If your code is modularised,
#'     remember to wrap the id with the relevant session namespace function, e.g.
#'     numericValueUI(id = session$ns("someinput")).
#' @param width The width of the shiny::numericValue UI element. Must be valid
#'     css (i.e. '10\%' or '150px' will work).
#' @param icon An icon for the action button (see shiny::icon).
#' @param width The widths of the action buttons. Must be valid css.
#' @param custom_css If provided, the action button is wrapped in a div styled 
#'     by the custom_css input. For example, one could provide 
#'     custom_css = "display: inline-block;" to display the action button inline.
#' @examples
#' if (interactive()) {
#' ####################################################################
#' # Suppose we want an action button that increments a counter. We first 
#' # need to define UI and server-side logic for the button.
#' ####################################################################
#' pacman::p_load_current_gh(c("kahaaga/shinymodules", "rstudio/shiny"))
#' 
#' # Function that displays the UI created server-side.
#' actionButtonTestUI <- function(id) {
#'   ns <- NS(id)
#'   uiOutput(ns("increment_btn")
#' }

#' # Server-side module that generates the action button.
#' actionButtonTest <- function(input, output, session) {
#'   output$increment_btn <- renderUI({
#'     shinymodules::actionButtonUI(
#'       id = session$ns("increment"),
#'       label = "Push me to increment counter"
#'     )
#'   })
#' }
#' 
#' ui <- fluidPage(
#'   # Let's suppose we have a page where we want the action button
#'   # to appear. Here we call the UI logic. We'll also add a textOutput 
#'   # showing the number of times the button has been clicked.
#'   fluidRow(actionButtonTestUI(id = "helppage"), textOutput("numclicks"))
#' )
#' 
#' server <- function(input, output, session) {
#'   # Call the module that generates the action button.
#'   callModule(module = actionButtonTest, id = "helppage")
#'   
#'   # The number of times the button has been clicked
#'   output$numclicks <- renderText({input[["helppage-increment-actionbutton"]]})
#' }
#' 
#' shinyApp(ui = ui, server = server)
#' }
#' @export
actionButtonUI <- function(id,
                           label = paste("Please provide a label argument to the actionButton",
                                         " with id = ", id, ".", sep = ""),
                           icon = NULL,
                           width = NULL,
                           custom_css = NULL) {
  # Create a namespace that we encapsulate around IDs in the UI function.
  # This ensures that no UI elements of this type are duplicated, provided
  # we assign unique IDs to our UI elements.
  ns <- NS(id)
  
  # Create a shiny::actionButton with inputId ns("actionbutton") wrapped in
  # a div (styled with the custom_css argument if provided)
  div(
    id = paste(ns("actionbutton"), "-div", sep = ""),
    style = ifelse(!is.null(custom_css), custom_css, ""), 
    shiny::actionButton(
      inputId = ns("actionbutton"), 
      label = label,
      icon = icon,
      width = width
    )
  )
}

#' @title actionButtonUIs
#' @description Create a tagList of action buttons using the actionButtonUI 
#'     wrapper for shiny::actionButton. 
#' @param ids A unique string id for the numericInput. If your code is modularised,
#'     remember to wrap the id with the relevant session namespace function, e.g.
#'     numericValueUI(id = session$ns("someinput")).
#' @param labels A label for the input.
#' @param icons Icons for the action buttons.
#' @param widths The widths of the action buttons. Must be valid css (i.e. 
#'     "10\%" or "150px" will work; see shiny::validateCssUnit). To use the same 
#'     width on all action buttons, provide a single-text string or 
#'     a vector with one text string. To use different widths for each action 
#'     button, provide a vector of custom css text strings with one element per 
#'     action button.
#' @param custom_css If provided, the action buttons are wrapped in divs each
#'     styled by the custom_css input. For example, when creating multiple action
#'     buttons, one could provide custom_css = "display: inline-block;" to display 
#'     the action buttons inline. To use the same style on all action buttons, 
#'     provide a single-text string or single-element vector. To use different
#'     styles for each action button, provide a vector of custom css text strings
#'     with one element per action button.
#' @examples 
#' if (interactive()) {
#' ####################################################################
#' # Suppose we want three action buttons that increments separate counters.
#' # We first need to define UI and server-side logic for the buttons.
#' ####################################################################
#' pacman::p_load_current_gh(c("kahaaga/shinymodules", "rstudio/shiny"))
#' 
#' # Function that displays the UI created server-side.
#' actionButtonTestUI <- function(id) {
#'   ns <- NS(id)
#'   
#'   fluidRow(uiOutput(ns("increment_buttons")))
#' }
#' 
#' # Server-side module that generates the action buttons.
#' actionButtonTest <- function(input, output, session) {
#'   output$increment_buttons <- renderUI({
#'     button_ids = c("increment1", "increment2", "woopdidoop")
#'     shinymodules::actionButtonUIs(
#'       ids = sapply(button_ids, session$ns),
#'       labels = paste0("I'm a button with id '", button_ids, 
#'                       "'. Push me, please."),
#'       widths = paste0(c(200, 300, 400), "px"),
#'       custom_css = "display: inline-block"
#'     )
#'   })
#' }
#' 
#' ui <- fluidPage(
#'   # Let's suppose we have a page where we want the action button
#'   # to appear. Here we call the UI logic. We'll also add a textOutput 
#'   # showing the number of times the button has been clicked.
#'   fluidRow(
#'     actionButtonTestUI(id = "helppage"), 
#'     textOutput("numclicks1"),
#'     textOutput("numclicks2"),
#'     textOutput("numclickswoop")
#   )
#' )
#' 
#' server <- function(input, output, session) {
#'   # Call the module that generates the action button.
#'   callModule(module = actionButtonTest, id = "helppage")
#'   
#'   # The number of times the button has been clicked
#'   output$numclicks1 <- renderText({input[["helppage-increment1-actionbutton"]]})
#'   output$numclicks2 <- renderText({input[["helppage-increment2-actionbutton"]]})
#'   output$numclickswoop <- renderText({input[["helppage-woopdidoop-actionbutton"]]})
#' }
#' 
#' shinyApp(ui = ui, server = server)
#' }
#' @export
actionButtonUIs <- function(ids,
                            labels = NULL,
                            icons = NULL,
                            widths = NULL,
                            custom_css = NULL) {
  
  # Create a div 
  ui.elements = list()
  
  for (i in 1:length(ids)) {
    # Create a custom actionButton using the actionButtonUI wrapper that 
    # ensures proper namespace handling.
    
    if (is.null(widths)) {
      width = NULL
    } else if (length(widths) == 1) {
      width = widths
    } else if (length(widths) > 1) {
      width = widths[i]
    }
    
    if (is.null(custom_css)) {
      custom_css = NULL
    } else if (length(custom_css) == 1) {
      custom_css = custom_css
    } else if (length(custom_css) > 1) {
      custom_css = custom_css[i]
    }
    
    ui.elements[[i]] = actionButtonUI(
      id = ids[i],
      label = labels[i],
      icon = icons[i],
      width = width,
      custom_css = custom_css
      )
  }
  
  tagList(ui.elements)
}