R/badgen.R

In badgen: Fast and Simple Badge Generator

#' Generate badges
#'
#' Generate a badge in the form of an svg string. Svg files can embedded directly
#' in websites or converted to png as shown in examples.
#'
#' @export
#' @returns svg string with the badge
#' @param label text for left part of the badge
#' @param status text for right part of the badge
#' @param color background for status part
#' @param labelColor background for label part
#' @param style one of 'classic' or 'flat'
#' @param scale resize badge, default size is 1
#' @param svg_icon iteral svg string with icon, see examples
#' @examples
#' home <- setwd(tempdir())
#' svg <- badgen("yolo", "success!", style = 'flat')
#' writeLines(svg, 'test.svg')
#' browseURL('test.svg')
#'
#' # Convert svg to bitmap
#' rsvg::rsvg_png('test.svg', 'test.png')
#'
#' # Add an svg icon to the badge
#' rlogo <- readLines('https://www.r-project.org/logo/Rlogo.svg')
#' svg2 <- badgen('mypkg', 'awesome', scale = 4, svg_icon = rlogo)
#' writeLines(svg2, 'test2.svg')
#' browseURL('test2.svg')
#'
#' # Cleanup
#' Sys.sleep(1)
#' unlink(c('test.svg', 'test.png', 'test2.svg'))
#' setwd(home)
badgen <- function(label, status = 'v1.2.3', color = 'green', labelColor = '555', style = 'classic', scale = 1, svg_icon = NULL){
  style <- match.arg(style, c("classic", "flat"))
  args <- list(
    label = label,
    status = status,
    color = color,
    labelColor = labelColor,
    style = style,
    scale = scale
  )
  if(length(svg_icon)){
    buf <- jsonlite::base64_enc(charToRaw(paste(svg_icon, collapse = '\n')))
    args$icon <- paste0('data:image/svg+xml;base64,', buf)
  }
  ctx$call('badgen', args)
}

#' @importFrom V8 v8
.onLoad <- function(lib, pkg){
  assign("ctx", V8::v8("window"), environment(.onLoad))
  ctx$source(system.file("js/badgen.js", package = pkg))
}