29 lines
889 B
R
29 lines
889 B
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/htmlBoxManipulation.R
|
|
\name{htmlAddBoxHelpLink}
|
|
\alias{htmlAddBoxHelpLink}
|
|
\title{Adds a "help" (question mark) icon to a box tools section (right side)}
|
|
\usage{
|
|
htmlAddBoxHelpLink(box, href, title = NULL)
|
|
}
|
|
\arguments{
|
|
\item{box}{The box to add a help icon/link to}
|
|
|
|
\item{href}{The help uri to load}
|
|
|
|
\item{title}{Optional title for the help link. Defaults to box title}
|
|
}
|
|
\value{
|
|
The modified box
|
|
}
|
|
\description{
|
|
The uri to load can have a replacement marker supplied '\%box\%' which will be
|
|
substituded with a sanitized copy of the box title. Preference is given to
|
|
the slugify package, however if unavailable a warning is generated and the
|
|
fallback of URLEncode is used.
|
|
}
|
|
\examples{
|
|
x <- shinydashboard::box(title = "This is a box")
|
|
htmlAddBoxHelpLink(x, href = "http://example.com/help-guide#\%box\%")
|
|
}
|