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" />
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" />
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" />
Style & Class
<style>
    .icon-class {
        padding: 4px;
        font-size: 3rem;
        margin-left: 1rem;
        background-color: aquamarine;
    }
</style>

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

API

BitIcon parameters
Name
Type
Default value
Description
Color BitColor? null The general color of the icon.
IconName string The icon name for the icon shown
Size BitSize? null The size of the icon.
Variant BitVariant? null The visual variant of the icon.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null The aria-label of the control for the benefit of screen readers.
Class string? null Custom CSS class for the root element of the component.
Dir BitDir? null Determines the component direction.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Capture and render additional attributes in addition to the component's parameters.
Id string? null Custom id attribute for the root element. if null the UniqueId will be used instead.
IsEnabled bool true Whether or not the component is enabled.
Style string? null Custom CSS style for the root element of the component.
Visibility BitVisibility BitVisibility.Visible Whether the component is visible, hidden or collapsed.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction.
RootElement ElementReference The ElementReference of the root element.
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