R/gov_list.R

In shinyGovstyle: Custom Gov Style Inputs for Shiny

#' Gov List function
#'
#' @param list vector of list
#' @param style options: "none", "bullet", "number". defaults to "none"
#' @family Govstyle text types
#' @export
#' @examples
#' ui <- shiny::fluidPage(
#'   shinyGovstyle::header(
#'     org_name = "Example",
#'     service_name = "User Examples"
#'   ),
#'   shinyGovstyle::banner(
#'     inputId = "banner", type = "beta", 'This is a new service'
#'   ),
#'   shinyGovstyle::gov_layout(
#'     size = "two-thirds",
#'     shinyGovstyle::heading_text("gov_list", size = "s"),
#'     shinyGovstyle::gov_text("List:"),
#'     gov_list(list = c("a", "b", "c")),
#'     shinyGovstyle::gov_text("Bulleted list:"),
#'     gov_list(list = c("a", "b", "c"), style = "bullet"),
#'     shinyGovstyle::gov_text("Numbered list:"),
#'     gov_list(list = c("one", "two", "three"), style = "number")
#'   )
#' )
#'
#' server <- function(input, output, session) {}
#'
#' if (interactive()) shinyApp(ui = ui, server = server)
gov_list <- function(list, style = "none") {
  # check style argument
  if (!style %in% c("none", "bullet", "number")) {
    stop(
      cat(
        'style argument must be one of the following values:
        "none"
        "bullet"
        "number"
        '
      )
    )
  }

  # create list wrapper
  list_wrapper <- function(x) {
    # get list style class
    if (style == "bullet") {
      list_style_class <- "govuk-list--bullet"
    } else if (style == "number") {
      list_style_class <- "govuk-list--number"
    } else {
      list_style_class <- ""
    }

    # get shiny tag to use (ordered list or unordered list)
    if (style == "number") {
      shiny_tag <- shiny::tags$ol
    } else {
      shiny_tag <- shiny::tags$ul
    }

    # put together wrapper
    shiny_tag(
      class = stringr::str_c("govuk-list", list_style_class, sep = " "),
      x
    )
  }

  # apply wrapper over list to get full list
  result <- list_wrapper(purrr::map(list, function(x) {
    shiny::tags$li(x)
  }))
  attachDependency(result)
}