LoadingButton - bit BlazorUI
Home Docs

LoadingButton

LoadingButton are used to display a loading indicator inside of a button. In some cases, a button's action kicks off some event which requires a loading state. This component composed together the Button component and the Loader component in a way that is accessible and easy to use.

Usage

Basic
Style & Class
Visibility
Visible: [ ]
Hidden: [ ]
Collapsed: [ ]
LoadingLabel
LoadingLabelPosition
LoadingTemplate
Button Type


ClassStyles

Implementation

BitLoadingButton 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.
ButtonStyle BitButtonStyle BitButtonStyle.Primary The style of button, Possible values: Primary | Standard.
ButtonType BitButtonType? null The type of the button.
ChildContent RenderFragment? The content of button, It can be Any custom tag or a text.
ClassStyles BitLoadingButtonClassStyles? null Custom CSS classes/styles for different parts of the BitLoadingButton.
IsLoading bool false Determine whether the button is in loading mode or not.
LoadingLabel string? null The loading label to show next to the spinner.
LoadingLabelPosition BitLabelPosition BitLabelPosition.Right The position of the loading Label in regards to the spinner animation.
LoadingTemplate RenderFragment? null Used to customize the content inside the Button in the Loading state.
OnClick EventCallback<MouseEventArgs> Callback for when the button clicked.
Title string? null The tooltip 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.
BitLoadingButtonClassStyles properties
Name
Type
Default value
Description
Container BitClassStylePair? Custom CSS classes/styles for the internal container of the BitLoadingButton.
Primary BitClassStylePair? Custom CSS classes/styles for the primary section of the BitLoadingButton.
Secondary BitClassStylePair? Custom CSS classes/styles for the secondary section of the BitLoadingButton.
BitClassStylePair properties
Name
Type
Default value
Description
Class string? Custom CSS classes.
Style string? Custom CSS styles.
BitButtonStyle enum
Name
Value
Description
Primary 0 The button with white text on a blue background.
Standard 1 The button with black text on a white background.
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).
BitSpinnerSize enum
Name
Value
Description
Medium 0 20px Spinner diameter.
Large 1 28px Spinner diameter.
Small 2 16px Spinner diameter.
XSmall 3 12px Spinner diameter.
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).