IconButton
IconButton is a type of button with only an icon describing its action.
Usage
Basic
Style & Class
Visibility
ARIA
Link button
Button Type
Implementation
BitIconButton parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AllowDisabledFocus | bool | true | Whether the icon button can have focus in disabled mode. |
| AriaDescription | string? | null | Detailed description of the icon button for the benefit of screen readers. |
| AriaHidden | bool | false | If true, add an aria-hidden attribute instructing screen readers to ignore the element. |
| ButtonType | BitButtonType | null | The type of the button. |
| Classes | BitIconButtonClassStyles | Custom CSS classes for different parts of the component. | |
| Href | string? | null | URL the link points to, if provided, icon button renders as an anchor. |
| IconName | string? | null | The icon name for the icon shown in the icon button. |
| OnClick | EventCallback<MouseEventArgs> | Callback for when the icon button clicked. | |
| Styles | BitIconButtonClassStyles | Custom CSS styles for different parts of the component. | |
| Target | string? | null | If Href provided, specifies how to open the link. |
| Title | string? | null | The title to show when the mouse is placed on the icon button. |
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. |
BitIconButtonClassStyles properties
Name |
Type |
Default value |
Description |
|---|---|---|---|
| Root | string? | Custom CSS classes/styles for the root element of the BitIconButton. | |
| Container | string? | Custom CSS classes/styles for the main container of the BitIconButton. | |
| Icon | string? | Custom CSS classes/styles for the Icon of the BitIconButton. |
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. |