Badge
Badge component is a small visual element used to highlight or indicate specific information within a user interface.
Usage
Basic
63
Variant
The badge offers three variants: Fill (default), Outline, and Text.
84
84
84
84
84
84
Overlap
The badge distance from its base content can be changed using the Overlap parameter.
63
Dot
Badge size can be reduced and hide any of its content.
Max
When content is integer type, you can define a max value to display.
63+
Customization
Here are some examples of customizing the badge content.
String content
Text
Icon
Hidden
You can easily hide the badge using its Hidden parameter.
63
Position
You can customize the badge position to enhance the user experience.
63
TopLeft
Color
Offering a range of specialized color variants, providing visual cues for specific actions or states within your application.
Primary
84
84
84
Secondary
84
84
84
Tertiary
84
84
84
Info
84
84
84
Success
84
84
84
Warning
84
84
84
SevereWarning
84
84
84
Error
84
84
84
Size
Varying sizes for badges tailored to meet diverse design needs, ensuring flexibility and visual hierarchy within your interface.
Small
84
84
84
Medium
84
84
84
Large
84
84
84
Style & Class
Empower customization by overriding default styles and classes, allowing tailored design modifications to suit specific UI requirements.
Component's Style & Class:
84
Anchor
84Styles & Classes:
84
84
Events
Managing clicking on the badge event (OnClick).
0
API
BitBadge parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| ChildContent | RenderFragment? | null | Child content of component, the content that the badge will apply to. |
| Classes | BitBadgeClassStyles? | null | Custom CSS classes for different parts of the BitBadge. |
| Color | BitColor? | null | The general color of the badge. |
| Content | object? | null | Content you want inside the badge. Supported types are string and integer. |
| Dot | bool | false | Reduces the size of the badge and hide any of its content. |
| Hidden | bool | false | The visibility of the badge. |
| IconName | string? | null | Sets the Icon to use in the badge. |
| Max | int? | null | Max value to display when content is integer type. |
| OnClick | EventCallback<MouseEventArgs> | Button click event if set. | |
| Overlap | bool | false | Overlaps the badge on top of the child content. |
| Position | BitPosition? | null | The position of the badge. |
| Size | BitSize? | null | The size of badge, Possible values: Small | Medium | Large |
| Styles | BitBadgeClassStyles? | null | Custom CSS styles for different parts of the BitBadge. |
| Variant | BitVariant? | null | The visual variant of the badge. |
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. |
BitBadgeClassStyles properties
Name |
Type |
Default value |
Description |
|---|---|---|---|
| Root | string? | null | Custom CSS classes/styles for the root element of the BitBadge. |
| BadgeWrapper | string? | null | Custom CSS classes/styles for the badge wrapper of the BitBadge. |
| Badge | string? | null | Custom CSS classes/styles for the badge of the BitBadge. |
| Icon | string? | null | Custom CSS classes/styles for the icon of the BitBadge. |
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. |
BitSize enum
Name |
Value |
Description |
|---|---|---|
| Small | 0 | The small size badge. |
| Medium | 1 | The medium size badge. |
| Large | 2 | The large size badge. |
BitPosition enum
Name |
Value |
Description |
|---|---|---|
| TopLeft | 0 | |
| TopCenter | 1 | |
| TopRight | 2 | |
| CenterLeft | 3 | |
| Center | 4 | |
| CenterRight | 5 | |
| BottomLeft | 6 | |
| BottomCenter | 7 | |
| BottomRight | 8 |
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. |
- On this page