Skip to contents

List Available Icons

Source: R/list_available_icons.R
list_available_icons.Rd

Shows all available icons from the icons_df dataset that can be used in the custom_icons parameter of branding() and add_branding() functions.

Usage

list_available_icons(search = NULL, show_unicode = FALSE, show_styles = FALSE)

Arguments

(NULL | character(1)) Optional search term to filter icons by name, label, or search terms (optional)

show_unicode

(logical(1)) Whether to show the Unicode values for icons. (default: FALSE)

show_styles

(logical(1)) Whether to show the icon styles (brands, solid, etc.). (default: FALSE)

Value

(data.frame) A data frame with available icons and their metadata

Examples

if (FALSE) { # \dontrun{
# List all available icons
list_available_icons()

# Search for communication-related icons
list_available_icons(search = "envelope")

# Search for social media icons
list_available_icons(search = "github")

# Show with Unicode values
list_available_icons(search = "twitter", show_unicode = TRUE)

# Show with styles information
list_available_icons(search = "phone", show_styles = TRUE)
} # }