R/bulma-progress_bar.R

In tjpalanca/bulma.R: Bulma CSS Framework for R

#' @title
#' Bulma Progress Bar
#'
#' @description
#' Native HTML progress bars.
#'
#' [Progress Bar](https://bulma.io/documentation/elements/progress/)
#'
#' @family Bulma Elements
#' @name bulma_progress_bar
NULL

#' @describeIn bulma_progress_bar
#' creates the progress bar
#'
#' @param value (num) current value
#' @param max   (num) maximum value
#' @param ...   (tag) content
#' @param size,color,tag (str) styling
#'
#' @export
bulma_progress_bar <- function(...,
                               value = NULL,
                               max   = NULL,
                               size  = c("small", "medium", "large"),
                               color = c("primary", "link", "info",
                                         "success", "warning", "danger"),
                               tag = tags$progress) {

  value <- as.character(assert_number(value, null.ok = TRUE))
  max   <- as.character(assert_number(max, null.ok = TRUE))

  tag(
    class = "progress",
    value = value,
    max   = max,
    ...
  ) %>%
    bulma_size(size) %>%
    bulma_color(color) %>%
    add_class("bulma_progress_bar")

}