R/carousel.R

In JohnCoene/mjml: Create Responsive Emails

#' Carousel
#'
#' The first MJML interactive component, it displays a gallery of images or "carousel".
#' Readers can interact by hovering and clicking on thumbnails depending on the email client they use.
#'
#' @inheritParams mj_ml
#' @param src image source.
#'
#' @examples
#' mj_ml(
#'   mj_body(
#'     mj_column(
#'       mj_carousel(
#'         mj_carousel_image(paste0("https://media.vanityfair.com/photos/",
#'                                  "54cbf3da998d4de83ba3602a/master/",
#'                                  "w_960,c_limit/image.jpg")),
#'         mj_carousel_image(paste0("https://media.vanityfair.com/photos/",
#'                                  "54cbf3dafde9250a6c402ed2/master/",
#'                                  "w_690,c_limit/image.jpg"))
#'       )
#'     )
#'   )
#' )
#'
#' @seealso \href{official documentation}{https://mjml.io/documentation/#mjml-carousel}
#'
#' @rdname carousel
#' @export
mj_carousel <- function(...){
  htmltools::tag("mj-carousel", list(...))
}

#' @rdname carousel
#' @export
mj_carousel_image <- function(src, ...){
  if(missing(src)) stop("missing src")
  htmltools::tag("mj-carousel-image", list(src = src, ...))
}