HtmlForgeX

API Reference

Class

FontAwesome5Icon

Namespace HtmlForgeX
Assembly HtmlForgeX
Base Element

FontAwesome 5 icon component for displaying icons anywhere in HtmlForgeX

Inheritance

Constructors

FontAwesome5Icon 4 overloads
public FontAwesome5Icon() #

Creates a new FontAwesome 5 icon component

public FontAwesome5Icon(FontAwesome5Brands icon) #

Creates a FontAwesome 5 icon with a solid icon

Parameters

icon HtmlForgeX.FontAwesome5Solid requiredposition: 0
FontAwesome5Icon(HtmlForgeX.FontAwesome5Regular icon) #

Creates a FontAwesome 5 icon with a regular icon

Parameters

icon HtmlForgeX.FontAwesome5Regular required
FontAwesome5Icon(HtmlForgeX.FontAwesome5Brands icon) #

Creates a FontAwesome 5 icon with a brand icon

Parameters

icon HtmlForgeX.FontAwesome5Brands required

Methods

RegisterLibraries() #

Registers the required FontAwesome 5 libraries with the current document.

public override String ToString() #
Returns: String

Generates the HTML markup for the configured FontAwesome 5 icon.

Returns

String representation of the icon element.

public FontAwesome5Icon WithBorder(Boolean border = true) #
Returns: FontAwesome5Icon

Adds a border around the icon

Parameters

border System.Boolean = true optionalposition: 0
public FontAwesome5Icon WithClass(String className) #
Returns: FontAwesome5Icon

Adds custom CSS class to the icon

Parameters

className System.String requiredposition: 0
public FontAwesome5Icon WithCode(String code, FontAwesome5Style style = Solid) #
Returns: FontAwesome5Icon

Sets the icon by Unicode code (for backward compatibility or custom icons)

Parameters

code System.String requiredposition: 0
style HtmlForgeX.FontAwesome5Style = Solid optionalposition: 1
WithColor 2 overloads
public FontAwesome5Icon WithColor(RGBColor color) #
Returns: FontAwesome5Icon

Sets the icon color

Parameters

color System.String requiredposition: 0
WithColor(HtmlForgeX.RGBColor color) #

Sets the icon color using RGB values

Parameters

color HtmlForgeX.RGBColor required
public FontAwesome5Icon WithFixedWidth(Boolean fixedWidth = true) #
Returns: FontAwesome5Icon

Makes the icon fixed width

Parameters

fixedWidth System.Boolean = true optionalposition: 0
public FontAwesome5Icon WithFlip(FontAwesome5Flip flip) #
Returns: FontAwesome5Icon

Flips the icon

Parameters

flip HtmlForgeX.FontAwesome5Flip requiredposition: 0
WithIcon 3 overloads
public FontAwesome5Icon WithIcon(FontAwesome5Brands icon) #
Returns: FontAwesome5Icon

Sets a solid icon

Parameters

icon HtmlForgeX.FontAwesome5Solid requiredposition: 0
WithIcon(HtmlForgeX.FontAwesome5Regular icon) #

Sets a regular icon

Parameters

icon HtmlForgeX.FontAwesome5Regular required
WithIcon(HtmlForgeX.FontAwesome5Brands icon) #

Sets a brand icon

Parameters

icon HtmlForgeX.FontAwesome5Brands required
public FontAwesome5Icon WithPull(FontAwesome5Pull pull) #
Returns: FontAwesome5Icon

Pulls the icon to the left or right

Parameters

pull HtmlForgeX.FontAwesome5Pull requiredposition: 0
public FontAwesome5Icon WithPulse(Boolean pulse = true) #
Returns: FontAwesome5Icon

Makes the icon pulse (8-step rotation)

Parameters

pulse System.Boolean = true optionalposition: 0
public FontAwesome5Icon WithRotate(FontAwesome5Rotate rotate) #
Returns: FontAwesome5Icon

Rotates the icon

Parameters

rotate HtmlForgeX.FontAwesome5Rotate requiredposition: 0
public FontAwesome5Icon WithSize(FontAwesomeSize size) #
Returns: FontAwesome5Icon

Sets the icon size using FontAwesome size classes

Parameters

size HtmlForgeX.FontAwesomeSize requiredposition: 0
public FontAwesome5Icon WithSpin(Boolean spin = true) #
Returns: FontAwesome5Icon

Makes the icon spin continuously

Parameters

spin System.Boolean = true optionalposition: 0