inst/htmltools/utils_v5.R

In leprechaun: Create Simple 'Shiny' Applications as Packages

#---------------------------------------------#
# DO NOT EDIT THIS FILE OR ADD ANYTHING TO IT #
#---------------------------------------------#

#' Columns
#' 
#' Shortcuts to create columns of specific width.
#' 
#' @param ... Any valid htmltools content and tags
#' to pass to `column`.
#' 
#' @importFrom shiny column
#' 
#' @name leprechaun-columns
#' @keywords internal
col1 <- function(...){
	column(1, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col2 <- function(...){
	column(2, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col3 <- function(...){
	column(3, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col4 <- function(...){
	column(4, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col5 <- function(...){
	column(5, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col6 <- function(...){
	column(6, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col7 <- function(...){
	column(7, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col8 <- function(...){
	column(8, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col9 <- function(...){
	column(9, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col10 <- function(...){
	column(10, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col11 <- function(...){
	column(11, ...)
}

#' @rdname leprechaun-columns
#' @keywords internal
col12 <- function(...){
	column(12, ...)
}

#' Badge
#' 
#' Add a badge.
#' 
#' @param ... Content of the badge.
#' @param class Any additional class.
#' @param color Color of the badge.
#' @param pill Whether to create a pill badge.
#' @param .tag Tag to use (`span`, or `a`)
#' 
#' @keywords internal
badge <- function(
	..., 
	class = "", 
	color = "dark", 
	pill = FALSE,
	.tag = shiny::span
){
	cl <- sprintf("%s badge bg-%s", class, color)

	if(pill)
		cl <- sprintf("%s rounded-pill", cl)

	.tag(..., class = cl)
}

#' Alert
#' 
#' Create a bootstrap 4 alert.
#' 
#' @param ... Content of the alert.
#' @param class Any additional class.
#' @param color Color of the alert.
#' 
#' @importFrom htmltools div
#' 
#' @keywords internal
alert <- function(..., class = "", color = "primary"){
	cl <- sprintf("%s alert alert-%s", class, color)

	div(
		class = cl,
		role = "alert",
		...
	)
}

#' Tag 2
#' 
#' Very similar to [htmltools::tag()] but uses
#' variadic `...` instead of a list.
#' 
#' @param .name Name of the tag.
#' @param ... Attributes and children.
#' 
#' @importFrom htmltools tag
tag2 <- function(.name, ...){
	tag(.name, list(...))	
}

#' OffCanvas
#' 
#' @param id
#' @param ... Passed to div.
#' @param class Additional class attribute to assign 
#' to parent div.
#' @param .position Position of the offcanvas.
#' 
#' @name offcanvas
#' 
#' @importFrom htmltools div
offCanvas <- function(
	id,
	...,
	class = "",
	.position = c("right", "left", "top", "bottom")
){
	if(missing(id))
		stop("Missing `id`")

	position <- match.arg(.position)
	position <- sprintf("offcanvas-%s", position)

	div(
		class = paste("offcanvas", position, class),
		...
	)
}

#' @rdname offcanvas
offCanvasHeader <- function(..., class = "") {
	div(
		class = paste("offcanvas-header", class),
		...
	)
}

#' @rdname offcanvas
offCanvasBody <- function(..., class = "") {
	div(
		class = paste("offcanvas-body", class),
		...
	)
}

#' @rdname offcanvas
offCanvasDismiss <- function() {
	tags$button(
		type = "button",
		class = "btn-close text-reset",
		`data-bs-dismiss` = "offcanvas",
		`aria-label` = "Close"
	)
}

#' @rdname offcanvas
offCanvasToggle <- function(
	target,
	color = "primary",
	class = ""
) {
	if(missing(target))
		stop("Missing `target`")

	tags$button(
		type = "button",
		class = sprintf("btn btn-%s %s", color, class),
		`aria-label` = "Close",
		`data-bs-toggle` = "offcanvas",
		href = sprintf("#%s", target),
		role = "button",
		`aria-controls` = target
	)
}

#---------------------------------------------#
# DO NOT EDIT THIS FILE OR ADD ANYTHING TO IT #
#---------------------------------------------#