Extras
MessageBox
Bit.BlazorUI.Extras
BitMessageBox is a pre-implemented box for showing messages with title and body.
Notes
To use this component, you need to install the Bit.BlazorUI.Extras(opens in a new tab) nuget package, as described in the Optional steps of the Getting started page.
Usage
Every example is live. Open its code to see exactly what produced the component running underneath.
Basic
The basic usage of the BitMessageBox, rendered inline inside a BitCard.
It's a title
It's a body.
BitModal
Show the BitMessageBox inside a BitModal component and close it using the OnClose event.
BitModalService
Show the BitMessageBox as the content of a modal shown by the BitModalService.
BitMessageBoxService
Show the BitMessageBox with a simple call to the Show method of the BitMessageBoxService.
This service uses the BitModalService to show the message box, so a BitModalContainer has to be
mounted in the layout for it to render.
Style & Class
Customize the appearance of BitMessageBox using styles and CSS classes.
It's a title
It's a body.
It's a title
It's a body.
RTL
Use BitMessageBox in right-to-left (RTL).
عنوان پیام
متن تست پیام...
API
Every parameter, public member, sub-class and enum this component exposes.
BitMessageBox parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| Body | string? | null | The body of the message box. |
| Classes | BitMessageBoxClassStyles? | null | Custom CSS classes for different parts of the message box. |
| OkText | string? | null | The text of the Ok button. |
| OnClose | EventCallback | The event callback for closing the message box. | |
| Styles | BitMessageBoxClassStyles? | null | Custom CSS styles for different parts of the message box. |
| Title | string? | null | The title of the message box. |
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. |
| ForceAnimation | bool | false | Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested. |
| 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. |
BitMessageBoxClassStyles properties
| Name | Type | Default value | Description |
|---|---|---|---|
| Root | string? | null | Custom CSS classes/styles for the root element of the BitMessageBox. |
| Container | string? | null | Custom CSS classes/styles for the container of the BitMessageBox. |
| Header | string? | null | Custom CSS classes/styles for the header of the BitMessageBox. |
| Title | string? | null | Custom CSS classes/styles for the title of the BitMessageBox. |
| Spacer | string? | null | Custom CSS classes/styles for the BitSpacer of the BitMessageBox. |
| CloseButton | BitButtonClassStyles? | null | Custom CSS classes/styles for the CloseButton of the BitMessageBox. |
| Body | string? | null | Custom CSS classes/styles for the body of the BitMessageBox. |
| Footer | string? | null | Custom CSS classes/styles for the footer of the BitMessageBox. |
| OkButton | BitButtonClassStyles? | null | Custom CSS classes/styles for the OkButton of the BitMessageBox. |
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
Found a mistake, a gap, or something that could be clearer? Every page and every component is one click from its source.