R/djpr_plot_text.R

In djpr-data/djprshiny: Common Functions For DJPR Shiny Apps

#' Functions to create title, subtitle, and caption of plots
#' Creates container
#' Currently implemented via inline CSS.
#' @param rel_font_size Numeric. Relative font size. In percent, so `100` would
#' set the font size equal to the base font size.
#' @param ... arguments passed to container (eg. `div`)
#' @return A `shiny.tag` object.
#' @examples
#'
#' djpr_plot_title("A title goes here")
#'
#' djpr_plot_subtitle("A subtitle goes here", rel_font_size = 100)
#'
#' # Use as container in shiny::textOutput()
#' \dontrun{
#' textOutput("title", container = djpr_plot_title)
#' }
#' @rdname djpr_plot_text
#' @export

djpr_plot_title <- function(...,
                            rel_font_size = 129) {
  htmltools::h3(...,
    style = paste0(
      "font-size: ",
      rel_font_size,
      "%; font-weight: bold; line-height: 1.2; margin-top: 14px; margin-bottom: 1px;"
    ),
    `data-toc-skip` = ""
  )
}

#' @rdname djpr_plot_text
#' @export
djpr_plot_subtitle <- function(...,
                               rel_font_size = 100) {
  htmltools::h4(...,
    style = paste0(
      "font-size: ",
      rel_font_size,
      "%; font-weight: normal; line-height: 1.5; margin-top: 0px; margin-bottom: 1px;"
    ),
    `data-toc-skip` = ""
  )
}

#' @rdname djpr_plot_text
#' @export
djpr_plot_caption <- function(...,
                              rel_font_size = 73) {
  htmltools::div(..., style = paste0(
    "font-size: ",
    rel_font_size,
    "%; font-weight: normal; line-height: 1; font-style: italic; padding-top: 6px;"
  ))
}