Methods summary
public static
string
|
#
css( )
HTML link to the FontAwesome CSS file through the bootstrapcdn
HTML link to the FontAwesome CSS file through the bootstrapcdn
Returns
string
HTML link element
See
|
public
Khill\Fontawesome\FontAwesome
|
#
__construct( string $icon = '' )
Assigns the name to the icon
Assigns the name to the icon
Parameters
- $icon
string
$icon Icon label Returns
|
public
string
|
#
__toString( )
Outputs the FontAwesome object as an HTML string
Outputs the FontAwesome object as an HTML string
Returns
string
HTML string of icon or stack
|
public
|
#
store( string $label )
Stores icon to be rendered later
Stores icon to be rendered later
Parameters
- $label
string
$label Label of icon to save in collection Throws
|
public
string
|
#
collection( string $label )
Retrieve icon from collection
Retrieve icon from collection
Parameters
- $label
string
$label Icon label used in store method Returns
string
HTML icon string
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
icon( string $icon )
Sets which icon to use
Parameters
- $icon
string
$icon Icon label, ommiting fa- prefix Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
addClass( string $class )
Adds extra classes to icon or stack
Adds extra classes to icon or stack
Parameters
- $class
string
$class CSS class Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
fixedWidth( string $icon = '' )
Sets the icon or stack to be a fixed width
Sets the icon or stack to be a fixed width
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
lg( string $icon = '' )
Sets the icon or stack to be larger
Sets the icon or stack to be larger
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
x2( string $icon = '' )
Sets the icon or stack to be 2 times larger
Sets the icon or stack to be 2 times larger
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
x3( string $icon = '' )
Sets the icon or stack to be 3 times larger
Sets the icon or stack to be 3 times larger
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
x4( string $icon = '' )
Sets the icon or stack to be 4 times larger
Sets the icon or stack to be 4 times larger
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
x5( string $icon = '' )
Sets the icon or stack to be 5 times larger
Sets the icon or stack to be 5 times larger
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
inverse( string $icon = '' )
Sets the icon or stack to be inverted in color
Sets the icon or stack to be inverted in color
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
rotate90( string $icon = '' )
Sets the icon or stack to be rotated 90 degrees
Sets the icon or stack to be rotated 90 degrees
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
rotate180( string $icon = '' )
Sets the icon or stack to be rotated 180 degrees
Sets the icon or stack to be rotated 180 degrees
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
rotate270( string $icon = '' )
Sets the icon or stack to be rotated 270 degrees
Sets the icon or stack to be rotated 270 degrees
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
flipHorizontal( string $icon = '' )
Sets the icon or stack to be flipped horizontally
Sets the icon or stack to be flipped horizontally
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
flipVertical( string $icon = '' )
Sets the icon or stack to be flipped vertically
Sets the icon or stack to be flipped vertically
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
spin( string $icon = '' )
Sets the icon to spin
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
border( string $icon = '' )
Sets a border around the icon
Sets a border around the icon
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
left( string $icon = '' )
Pulls the icon to the left
Pulls the icon to the left
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
right( string $icon = '' )
Pulls the icon to the left
Pulls the icon to the left
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
ul( string $iconLabel = '' )
Builds unordered list with icons
Builds unordered list with icons
Parameters
- $iconLabel
string
$iconLabel Default icon used in list (optional) Returns
|
public
Khill\Fontawesome\FontAwesome
|
#
li( string|array $iconLine = '' )
Adds items to unordered list with icons
Adds items to unordered list with icons
Parameters
- $iconLine
string|array
$iconLine Adds a line or lines to the unordered list Returns
|
public
Khill\Fontawesome\FontAwesome
|
#
stack( string $icon )
Sets the top icon to be used in a stack
Sets the top icon to be used in a stack
Parameters
- $icon
string
$icon Icon label Returns
Throws
|
public
Khill\Fontawesome\FontAwesome
|
#
on( string $icon )
Sets the bottom icon to be used in a stack
Sets the bottom icon to be used in a stack
Parameters
- $icon
string
$icon Icon label Returns
Throws
|