HtmlForgeX

API Reference

Class

FontAwesomeIcon

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Icons/FontAwesome/FontAwesomeIcon.cs:21
Base Element

FontAwesome icon component for displaying icons anywhere in HtmlForgeX

Inheritance

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

FontAwesomeIcon 4 overloads
public FontAwesomeIcon() #
Icons/FontAwesome/FontAwesomeIcon.cs:21

Creates a new FontAwesome icon component

public FontAwesomeIcon(FontAwesomeBrands icon) #
Icons/FontAwesome/FontAwesomeIcon.cs:46

Creates a FontAwesome icon with a solid icon

Parameters

icon HtmlForgeX.FontAwesomeSolid requiredposition: 0
FontAwesomeIcon(HtmlForgeX.FontAwesomeRegular icon) #

Creates a FontAwesome icon with a regular icon

Parameters

icon HtmlForgeX.FontAwesomeRegular required
FontAwesomeIcon(HtmlForgeX.FontAwesomeBrands icon) #

Creates a FontAwesome icon with a brand icon

Parameters

icon HtmlForgeX.FontAwesomeBrands required

Methods

RegisterLibraries() #

Registers the required FontAwesome libraries with the current document.

public override String ToString() #
Icons/FontAwesome/FontAwesomeIcon.cs:222
Returns: String

Generates the HTML markup for the configured FontAwesome icon.

Returns

String representation of the icon element.

public FontAwesomeIcon WithBorder(Boolean border = true) #
Icons/FontAwesome/FontAwesomeIcon.cs:191
Returns: FontAwesomeIcon

Adds a border around the icon

Parameters

border System.Boolean = true optionalposition: 0
public FontAwesomeIcon WithClass(String className) #
Icons/FontAwesome/FontAwesomeIcon.cs:211
Returns: FontAwesomeIcon

Adds custom CSS class to the icon

Parameters

className System.String requiredposition: 0
public FontAwesomeIcon WithCode(String code, FontAwesomeStyle style = Solid) #
Icons/FontAwesome/FontAwesomeIcon.cs:94
Returns: FontAwesomeIcon

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

Parameters

code System.String requiredposition: 0
style HtmlForgeX.FontAwesomeStyle = Solid optionalposition: 1
WithColor 2 overloads
public FontAwesomeIcon WithColor(RGBColor color) #
Icons/FontAwesome/FontAwesomeIcon.cs:125
Returns: FontAwesomeIcon

Sets the icon color

Parameters

color HtmlForgeX.RGBColor requiredposition: 0
public FontAwesomeIcon WithColor(String color) #
Icons/FontAwesome/FontAwesomeIcon.cs:133
Returns: FontAwesomeIcon

Sets the icon color using hex string

Parameters

color System.String requiredposition: 0
public FontAwesomeIcon WithFixedWidth(Boolean fixedWidth = true) #
Icons/FontAwesome/FontAwesomeIcon.cs:141
Returns: FontAwesomeIcon

Makes the icon fixed width

Parameters

fixedWidth System.Boolean = true optionalposition: 0
public FontAwesomeIcon WithFlip(FontAwesomeFlip flip) #
Icons/FontAwesome/FontAwesomeIcon.cs:178
Returns: FontAwesomeIcon

Flips the icon

Parameters

flip HtmlForgeX.FontAwesomeFlip requiredposition: 0
WithIcon 3 overloads
public FontAwesomeIcon WithIcon(FontAwesomeBrands icon) #
Icons/FontAwesome/FontAwesomeIcon.cs:84
Returns: FontAwesomeIcon

Sets a solid icon

Parameters

icon HtmlForgeX.FontAwesomeSolid requiredposition: 0
WithIcon(HtmlForgeX.FontAwesomeRegular icon) #

Sets a regular icon

Parameters

icon HtmlForgeX.FontAwesomeRegular required
WithIcon(HtmlForgeX.FontAwesomeBrands icon) #

Sets a brand icon

Parameters

icon HtmlForgeX.FontAwesomeBrands required
public FontAwesomeIcon WithPull(FontAwesomePull pull) #
Icons/FontAwesome/FontAwesomeIcon.cs:199
Returns: FontAwesomeIcon

Pulls the icon to left or right

Parameters

pull HtmlForgeX.FontAwesomePull requiredposition: 0
public FontAwesomeIcon WithPulse(Boolean pulse = true) #
Icons/FontAwesome/FontAwesomeIcon.cs:157
Returns: FontAwesomeIcon

Makes the icon pulse (8-step rotation)

Parameters

pulse System.Boolean = true optionalposition: 0
public FontAwesomeIcon WithRotate(Int32 degrees) #
Icons/FontAwesome/FontAwesomeIcon.cs:165
Returns: FontAwesomeIcon

Rotates the icon

Parameters

degrees System.Int32 requiredposition: 0
public FontAwesomeIcon WithSize(FontAwesomeSize size) #
Icons/FontAwesome/FontAwesomeIcon.cs:103
Returns: FontAwesomeIcon

Sets the icon size using FontAwesome size classes

Parameters

size HtmlForgeX.FontAwesomeSize requiredposition: 0
public FontAwesomeIcon WithSpin(Boolean spin = true) #
Icons/FontAwesome/FontAwesomeIcon.cs:149
Returns: FontAwesomeIcon

Makes the icon spin

Parameters

spin System.Boolean = true optionalposition: 0