R/gomo_gomo_no.R

In GomoGomonoMi: Animate Text using the 'Animate.css' Library

#' Generate Animated Text
#'
#' @description The function animates text using the Animate.css library
#'
#' @param text The text that should be animated
#' @param level The Markdown level of the text, available are : #, ##, ###, ####, #####, ######, text. Default to "#"
#' @param animation The type of animation. Default to "bounce".
#' @param repeating Number of times the animation is repeated (from 1 to 3). Default to 1
#' @param delay Time before triggering the animation (in seconds). Default to 0
#' @param duration The speed of the animation, available choices are: "slow", "slower", "fast", "faster". Default to "slow"
#' @param color the color of the animated text
#'
#' @return animated text
#'
#' @examples \donttest{
#'
#' # Put use_gomo() at the beginning of your Rmd Document or Shiny App (UI)
#' use_gomo()
#'
#' # Then call gomo_gomo_no() wherever you want to animate your text
#'
#' gomo_gomo_no(text = "I Love Chocolate !!!!", level = "###", animation = "tada")
#'
#' }
#' @export
#'
#'
gomo_gomo_no <- function(text, level = "#", animation = "bounce", repeating = 1, delay = 0, duration = "slow", color = "black"){


  if(!is.character(text) | !is.character(level) | !is.character(animation) | !is.character(duration)| !is.character(color)){
    stop("text, level, animation and color must be a characer string")
  }


  stopifnot(level %in%  c("#", "##", "###", "####", "#####", "######", "text"))


  level <- switch(level, "#" = "h1", "##" = "h2", "###" = "h3", "####" = "h4", "#####" = "h5", "######" = "h6","text" = "span")




  htmltools::HTML(glue::glue("<{level} style='color:{color}; display:inline-block' class='animate__animated animate__{animation} animate__repeat-{repeating} animate__delay-{delay}s animate__{duration}'>{text}</{level}>"))



}