fa_metadata: Get metadata on the included Font Awesome assets

View source: R/fa_metadata.R

fa_metadataR Documentation

Get metadata on the included Font Awesome assets

Description

This function provide some metadata about the included Font Awesome assets in the fontawesome package. The list that is returned has the following components:

  • version: The released version number for the Font Awesome icons

  • icon_count: The total count of unique Font Awesome icons

  • icon_names: A vector of short names (e.g., "npm", "drum", etc.) for all included icons

  • icon_names_full: A vector containing the full names (e.g., "fab fa-npm", "fas fa-drum", etc.) for all included icons

  • icon_names_fa(r|s|b): Vectors of short names within the regular ("r"), solid ("s"), and brand ("b") groups

  • icon_names_full_fa(r|s|b): Vectors with the full names of icons within the regular ("r"), solid ("s"), and brand ("b") groups

Usage

fa_metadata()

Value

A list with metadata for the included Font Awesome assets.

Examples

if (interactive()) {

# Get information on the Font Awesome
# assets included in this package
fa_metadata()

}


rstudio/fontawesome documentation built on April 12, 2024, 11:12 p.m.