Home Docs

ErrorBoundary

BitErrorBoundary is a simple error boundary to handle exceptions happening in its children.

Notes

To use this component, you need to install the
Bit.BlazorUI.Extras
 nuget package, as described in the Optional steps of the Getting started page.

Usage

Basic
<BitErrorBoundary>
    <BitButton OnClick="ThrowException">Throw an exception</BitButton>
</BitErrorBoundary>
@code {
    private void ThrowException()
    {
        throw new Exception("This is an exception!");
    }
}

API

BitErrorBoundary parameters
Name
Type
Default value
Description
AdditionalButtons RenderFragment? null The footer content of the boundary.
Body RenderFragment? null Alias of the ChildContent.
Footer RenderFragment? null The footer content of the boundary.
HomeText string? null The text of the Home button.
HomeUrl string? null The url of the home page for the Home button.
OnError EventCallback<Exception> The callback for when an error get caught by the boundary.
RecoverText string? null The text of the Recover button.
RefreshText string? null The text of the Refresh button.
ShowException bool false Whether the actual exception information should be shown or not.
Title string? null The header title of the boundary.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null Gets or sets the accessible label for the component, used by assistive technologies.
Class string? null Gets or sets the CSS class name(s) to apply to the rendered element.
Dir BitDir? null Gets or sets the text directionality for the component's content.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters.
Id string? null Gets or sets the unique identifier for the component's root element.
IsEnabled bool true Gets or sets a value indicating whether the component is enabled and can respond to user interaction.
Style string? null Gets or sets the CSS style string to apply to the rendered element.
TabIndex string? null Gets or sets the tab order index for the component when navigating with the keyboard.
Visibility BitVisibility BitVisibility.Visible Gets or sets the visibility state (visible, hidden, or collapsed) of the component.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed.
RootElement ElementReference Gets the reference to the root HTML element associated with this component.
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