Generate the html necessary to use a Font Awesome icon as the favicon (the icon that appears on browser tabs) for a shiny app or other HTML document.
Arguments
- name
The name of the Font Awesome icon. This could be as a short name (e.g.,
"npm"
,"drum"
, etc.), or, a full name (e.g.,"fab fa-npm"
,"fas fa-drum"
, etc.). The names should correspond to current Version 6 Font Awesome names. A list of short and full names can be accessed through thefa_metadata()
function withfa_metadata()$icon_names
andfa_metadata()$icon_names_full
. If supplying a previous name associated with the icon, it will be internally translated to the current name and a Version 6 icon will be returned.- ...
Arguments passed on to
fontawesome::fa
fill,fill_opacity
The fill color of the icon can be set with
fill
. If not provided then the default value of"currentColor"
is applied so that the SVG fill matches the color of the parent HTML element'scolor
attribute. The opacity level of the SVG fill can be controlled with a decimal value between0
and1
.stroke,stroke_width,stroke_opacity
The stroke options allow for setting the color, width, and opacity of the SVG outline stroke. By default, the stroke width is very small at
"1px"
so a size adjustment with"stroke_width"
can be useful. The"stroke_opacity"
value can be any decimal values between0
and1
(bounds included).height,width
The height and width style attributes of the rendered SVG. If nothing is provided for
height
then a default value of"1em"
will be applied. If awidth
isn't given, then it will be calculated in units of"em"
on the basis of the icon's SVG"viewBox"
dimensions.margin_left,margin_right
The length value for the margin that's either left or right of the icon. By default,
"auto"
is used for both properties. If space is needed on either side then a length of"0.2em"
is recommended as a starting point.vertical_align
The vertical alignment of the icon. By default, a length of
"-0.125em"
is used.position
The value for the
position
style attribute. By default,"relative"
is used here.title
An option for populating the SVG
'title'
attribute, which provides on-hover text for the icon. By default, no title text is given to the icon. Ifa11y == "semantic"
then title text will be automatically given to the rendered icon, however, providing text here will override that.prefer_type
Chooses the type of icon returned if: (1) providing a short name, and (2) that icon has both solid and regular types. For example, using
name = "address-book"
will result in two types of icons for an Address Book. By default, this preference is set to"regular"
and the other option is"solid"
.a11y
Cases that distinguish the role of the icon and inform which accessibility attributes to be used. Icons can either be
"deco"
(decorative, the default case) or"sem"
(semantic). Using"none"
will result in no accessibility features for the icon.
Value
A shiny.tag
(see htmltools::tag()
) that can be used to embed a
favicon in a shiny app or other HTML document.