Home Docs

Icon

An icon represents concept or meaning for the user. It's used to make better user experience (UX) and user-friendly applications.

Usage

Basic
   



Disabled

    
<BitIcon IconName="@BitIconName.Accept" />
<BitIcon IconName="@BitIconName.Bus" />
<BitIcon IconName="@BitIconName.Pinned" />

<BitIcon IconName="@BitIconName.Accept" IsEnabled="false" />
<BitIcon IconName="@BitIconName.Bus" IsEnabled="false" />
<BitIcon IconName="@BitIconName.Pinned" IsEnabled="false" />
Variant
Fill





Outline





Text (default)

<BitIcon IconName="@BitIconName.Accept" Variant="BitVariant.Fill" />

<BitIcon IconName="@BitIconName.Accept" Variant="BitVariant.Outline" />

<BitIcon IconName="@BitIconName.Accept" Variant="BitVariant.Text" />
Color
Offering a range of specialized color variants, providing visual cues for specific actions or states within your application.



Primary

   



Secondary

   



Tertiary

   



Info

   



Success

   



Warning

   



SevereWarning

   



Error

    
<BitIcon Color="BitColor.Primary" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.Primary" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.Primary" IconName="@BitIconName.Pinned" />

<BitIcon Color="BitColor.Secondary" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.Secondary" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.Secondary" IconName="@BitIconName.Pinned" />

<BitIcon Color="BitColor.Tertiary" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.Tertiary" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.Tertiary" IconName="@BitIconName.Pinned" />

<BitIcon Color="BitColor.Info" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.Info" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.Info" IconName="@BitIconName.Pinned" />

<BitIcon Color="BitColor.Success" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.Success" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.Success" IconName="@BitIconName.Pinned" />

<BitIcon Color="BitColor.Warning" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.Warning" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.Warning" IconName="@BitIconName.Pinned" />

<BitIcon Color="BitColor.SevereWarning" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.SevereWarning" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.SevereWarning" IconName="@BitIconName.Pinned" />

<BitIcon Color="BitColor.Error" IconName="@BitIconName.Accept" />
<BitIcon Color="BitColor.Error" IconName="@BitIconName.Bus" />
<BitIcon Color="BitColor.Error" IconName="@BitIconName.Pinned" />
External Icons
Use icons from external libraries like FontAwesome, Material Icons, and Bootstrap Icons with the Icon parameter.


FontAwesome

     



Bootstrap Icons

      
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/7.0.1/css/all.min.css" />

<BitIcon Icon="@("fa-solid fa-house")" Size="BitSize.Large" />
<BitIcon Icon="@BitIconInfo.Css("fa-solid fa-heart")" Color="BitColor.Error" />
<BitIcon Icon="@BitIconInfo.Fa("fa-brands fa-github")" Size="BitSize.Large" />
<BitIcon Icon="@BitIconInfo.Fa("solid rocket")" Color="BitColor.Secondary" />


<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.min.css" />

<BitIcon Icon="@("bi bi-house-fill")" Size="BitSize.Large" />
<BitIcon Icon="@BitIconInfo.Css("bi bi-heart-fill")" Color="BitColor.Error" />
<BitIcon Icon="@BitIconInfo.Bi("github")" Size="BitSize.Large" />
<BitIcon Icon="@BitIconInfo.Bi("gear-fill")" Color="BitColor.Secondary" />
Size
Small

   



Medium

   



Large

    
<BitIcon Size="BitSize.Small" IconName="@BitIconName.Accept" />
<BitIcon Size="BitSize.Small" IconName="@BitIconName.Bus" />
<BitIcon Size="BitSize.Small" IconName="@BitIconName.Pinned" />

<BitIcon Size="BitSize.Medium" IconName="@BitIconName.Accept" />
<BitIcon Size="BitSize.Medium" IconName="@BitIconName.Bus" />
<BitIcon Size="BitSize.Medium" IconName="@BitIconName.Pinned" />

<BitIcon Size="BitSize.Large" IconName="@BitIconName.Accept" />
<BitIcon Size="BitSize.Large" IconName="@BitIconName.Bus" />
<BitIcon Size="BitSize.Large" IconName="@BitIconName.Pinned" />
Style & Class
<style>
    .icon-class {
        padding: 4px;
        font-size: 3rem;
        margin-left: 1rem;
        background-color: aquamarine;
    }
</style>

<BitIcon Size="BitSize.Large"
         IconName="@BitIconName.Accept" 
         Style="background-color: brown; border-radius: 4px" />

<BitIcon Class="icon-class"
         IconName="@BitIconName.Accept" />

API

BitIcon parameters
Name
Type
Default value
Description
Color BitColor? null Specifies the color theme of the icon. Default value is BitColor.Primary.
Icon BitIconInfo? null Specifies the icon configuration for rendering icons from external icon libraries using custom CSS classes. Takes precedence over IconName when both are set.
IconName string Specifies the name of the icon from the built-in Fluent UI icon library. This property is ignored when Icon is set.
Size BitSize? null Specifies the size of the icon. Default value is BitSize.Medium.
Variant BitVariant? null Specifies the visual styling variant of the icon. Default value is BitVariant.Text.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null Gets or sets the accessible label for the component, used by assistive technologies.
Class string? null Gets or sets the CSS class name(s) to apply to the rendered element.
Dir BitDir? null Gets or sets the text directionality for the component's content.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters.
Id string? null Gets or sets the unique identifier for the component's root element.
IsEnabled bool true Gets or sets a value indicating whether the component is enabled and can respond to user interaction.
Style string? null Gets or sets the CSS style string to apply to the rendered element.
TabIndex string? null Gets or sets the tab order index for the component when navigating with the keyboard.
Visibility BitVisibility BitVisibility.Visible Gets or sets the visibility state (visible, hidden, or collapsed) of the component.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed.
RootElement ElementReference Gets the reference to the root HTML element associated with this component.
BitIconInfo properties
Name
Type
Default value
Description
Name string? null Gets or sets the name of the icon.
BaseClass string? null Gets or sets the base CSS class for the icon. For built-in Fluent UI icons, this defaults to "bit-icon". For external icon libraries like FontAwesome, you might set this to "fa" or leave empty.
Prefix string? null Gets or sets the CSS class prefix used before the icon name. For built-in Fluent UI icons, this defaults to "bit-icon--". For external icon libraries, you might set this to "fa-" or leave empty.
BitColor enum
Name
Value
Description
Primary 0 Info Primary general color.
Secondary 1 Secondary general color.
Tertiary 2 Tertiary general color.
Info 3 Info general color.
Success 4 Success general color.
Warning 5 Warning general color.
SevereWarning 6 SevereWarning general color.
Error 7 Error general color.
PrimaryBackground 8 Primary background color.
SecondaryBackground 9 Secondary background color.
TertiaryBackground 10 Tertiary background color.
PrimaryForeground 11 Primary foreground color.
SecondaryForeground 12 Secondary foreground color.
TertiaryForeground 13 Tertiary foreground color.
PrimaryBorder 14 Primary border color.
SecondaryBorder 15 Secondary border color.
TertiaryBorder 16 Tertiary border color.
BitSize enum
Name
Value
Description
Small 0 Display icon using small size.
Medium 1 Display icon using medium size.
Large 2 Display icon using large size.
BitVariant enum
Name
Value
Description
Fill 0 Fill styled variant.
Outline 1 Outline styled variant.
Text 2 Text styled variant.
BitVisibility enum
Name
Value
Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).
BitDir enum
Name
Value
Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.

Feedback

You can give us your feedback through our GitHub repo by filing a new Issue or starting a new Discussion.

Or you can review / edit this page on GitHub.

Or you can review / edit this component on GitHub.
  • On this page