-
Notifications
You must be signed in to change notification settings - Fork 131
/
Copy pathfavicon.Rd
48 lines (39 loc) · 1.07 KB
/
favicon.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/use_favicon.R
\name{use_favicon}
\alias{use_favicon}
\alias{remove_favicon}
\alias{favicon}
\title{Add a favicon to your shinyapp}
\usage{
use_favicon(path, pkg = get_golem_wd(), method = "curl")
remove_favicon(path = "inst/app/www/favicon.ico")
favicon(
ico = "favicon",
rel = "shortcut icon",
resources_path = "www",
ext = "ico"
)
}
\arguments{
\item{path}{Path to your favicon file (.ico or .png)}
\item{pkg}{Path to the root of the package. Default is \code{get_golem_wd()}.}
\item{method}{Method to be used for downloading files, 'curl' is default see \code{\link[utils:download.file]{utils::download.file()}}.}
\item{ico}{path to favicon file}
\item{rel}{rel}
\item{resources_path}{prefix of the resource path of the app}
\item{ext}{the extension of the favicon}
}
\value{
Used for side-effects.
An HTML tag.
}
\description{
This function adds the favicon from \code{ico} to your shiny app.
}
\examples{
if (interactive()) {
use_favicon()
use_favicon(path = "path/to/your/favicon.ico")
}
}