ex_fontawesome v0.7.2

View Source FontAwesome.Icon (ex_fontawesome v0.7.2)

This module defines the data structure and functions for working with icons stored as SVG files.

Link to this section Summary

Types

t()

Functions

%FontAwesome.Icon{}

Defines the FontAwesome.Icon struct.

insert_attrs(arg, attrs)

Inserts HTML attributes into an SVG icon

opts_to_attrs(opts)

Converts opts to HTML attributes

parse!(filename)

Parses a SVG file and returns structured data

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %FontAwesome.Icon{file: binary(), name: String.t(), type: String.t()}

Link to this section Functions

Link to this function

%FontAwesome.Icon{}

View Source (struct)

Defines the FontAwesome.Icon struct.

Its fields are:

  • :type - the type of the icon

  • :name - the name of the icon

  • :file - the binary of the icon

Link to this function

insert_attrs(arg, attrs)

View Source 
@spec insert_attrs(
  binary(),
  keyword()
) :: Phoenix.HTML.safe()

Inserts HTML attributes into an SVG icon

Link to this function

opts_to_attrs(opts)

View Source 
@spec opts_to_attrs(keyword()) :: list()

Converts opts to HTML attributes

Link to this function

parse!(filename)

View Source 
@spec parse!(String.t()) :: t()

Parses a SVG file and returns structured data