IconButton - bit BlazorUI
Home Docs

IconButton

IconButton is a type of button with only an icon describing its action.

Usage

Basic
Style & Class
Visibility
Visible: [ ]
Hidden: [ ]
Collapsed: [ ]
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.
ClassStyles BitIconButtonClassStyles Custom CSS classes/styles 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.
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.
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
Container BitClassStylePair? Custom CSS classes/styles for the modal container.
BitClassStylePair properties
Name
Type
Default value
Description
Class string? Custom CSS class.
Style string? Custom CSS style.
BitButtonType enum
Name
Value
Description
Button 0 The button is a clickable button.
Submit 1 The button is a submit button (submits form-data).
Reset 2 The button is a reset button (resets the form-data to its initial values).
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).