Modal
Modals are temporary pop-ups that take focus from the page or app and require people to interact with them. Unlike a dialog box (Dialog), a modal should be used for hosting lengthy content, such as privacy statements or license agreements, or for asking people to perform complex or multiple actions, such as changing settings.
Usage
Basic BitModal
Advanced options
BitModal has some advanced options to be customized .
Absolute positioning
BitModal has an abosolute position option to further customize it's location.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas lorem nulla, malesuada ut sagittis sit
amet, vulputate in leo. Maecenas vulputate congue sapien eu tincidunt. Etiam eu sem turpis. Fusce tempor
sagittis nunc, ut interdum ipsum vestibulum non. Proin dolor elit, aliquam eget tincidunt non, vestibulum ut
turpis. In hac habitasse platea dictumst. In a odio eget enim porttitor maximus. Aliquam nulla nibh,
ullamcorper aliquam placerat eu, viverra et dui. Phasellus ex lectus, maximus in mollis ac, luctus vel eros.
Vivamus ultrices, turpis sed malesuada gravida, eros ipsum venenatis elit, et volutpat eros dui et ante.
Quisque ultricies mi nec leo ultricies mollis. Vivamus egestas volutpat lacinia. Quisque pharetra eleifend
efficitur.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas lorem nulla, malesuada ut sagittis sit
amet, vulputate in leo. Maecenas vulputate congue sapien eu tincidunt. Etiam eu sem turpis. Fusce tempor
sagittis nunc, ut interdum ipsum vestibulum non. Proin dolor elit, aliquam eget tincidunt non, vestibulum ut
turpis. In hac habitasse platea dictumst. In a odio eget enim porttitor maximus. Aliquam nulla nibh,
ullamcorper aliquam placerat eu, viverra et dui. Phasellus ex lectus, maximus in mollis ac, luctus vel eros.
Vivamus ultrices, turpis sed malesuada gravida, eros ipsum venenatis elit, et volutpat eros dui et ante.
Quisque ultricies mi nec leo ultricies mollis. Vivamus egestas volutpat lacinia. Quisque pharetra eleifend
efficitur.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas lorem nulla, malesuada ut sagittis sit
amet, vulputate in leo. Maecenas vulputate congue sapien eu tincidunt. Etiam eu sem turpis. Fusce tempor
sagittis nunc, ut interdum ipsum vestibulum non. Proin dolor elit, aliquam eget tincidunt non, vestibulum ut
turpis. In hac habitasse platea dictumst. In a odio eget enim porttitor maximus. Aliquam nulla nibh,
ullamcorper aliquam placerat eu, viverra et dui. Phasellus ex lectus, maximus in mollis ac, luctus vel eros.
Vivamus ultrices, turpis sed malesuada gravida, eros ipsum venenatis elit, et volutpat eros dui et ante.
Quisque ultricies mi nec leo ultricies mollis. Vivamus egestas volutpat lacinia. Quisque pharetra eleifend
efficitur.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas lorem nulla, malesuada ut sagittis sit
amet, vulputate in leo. Maecenas vulputate congue sapien eu tincidunt. Etiam eu sem turpis. Fusce tempor
sagittis nunc, ut interdum ipsum vestibulum non. Proin dolor elit, aliquam eget tincidunt non, vestibulum ut
turpis. In hac habitasse platea dictumst. In a odio eget enim porttitor maximus. Aliquam nulla nibh,
ullamcorper aliquam placerat eu, viverra et dui. Phasellus ex lectus, maximus in mollis ac, luctus vel eros.
Vivamus ultrices, turpis sed malesuada gravida, eros ipsum venenatis elit, et volutpat eros dui et ante.
Quisque ultricies mi nec leo ultricies mollis. Vivamus egestas volutpat lacinia. Quisque pharetra eleifend
efficitur.
BitModal with position
To set the modal position on the page you can use the Position parameter.
Draggable BitModal
Using custom drag element.
Implementation
BitModal parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AutoToggleScroll | bool | true | Enables the auto scrollbar toggle behavior of the Modal. |
| AbsolutePosition | bool | false | When true, the Modal will be positioned absolute instead of fixed. |
| ChildContent | RenderFragment? | null | The content of Modal, It can be Any custom tag or a text. |
| ClassStyles | BitModalClassStyles? | null | Custom CSS classes/styles for different parts of the BitModal component. |
| DragElementSelector | string? | null | The CSS selector of the drag element. by default the Modal container is the drag element. |
| IsAlert | bool? | null | Determines the ARIA role of the dialog (alertdialog/dialog). If this is set, it will override the ARIA role determined by IsBlocking and IsModeless. |
| IsBlocking | bool | false | Whether the dialog can be light dismissed by clicking outside the dialog (on the overlay). |
| IsDraggable | bool | false | Whether the Modal can be dragged around. |
| IsModeless | bool | false | Whether the dialog should be modeless (e.g. not dismiss when focusing/clicking outside of the dialog). if true: IsBlocking is ignored, there will be no overlay. |
| IsOpen | bool | false | Whether the dialog is displayed. |
| OnDismiss | EventCallback<MouseEventArgs> | A callback function for when the Modal is dismissed. | |
| Position | BitModalPosition | BitModalPosition.Center | Position of the modal on the screen. |
| ScrollerSelector | string | body | Set the element selector for which the Modal disables its scroll if applicable. |
| SubtitleAriaId | string? | null | ARIA id for the subtitle of the Modal, if any. |
| TitleAriaId | string? | null | ARIA id for the title of the Modal, if any. |
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. |
BitModalClassStyles 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. |
BitModalPosition enum
Name |
Value |
Description |
|---|---|---|
| Center | 0 | |
| TopLeft | 1 | |
| TopCenter | 2 | |
| TopRight | 3 | |
| CenterLeft | 4 | |
| CenterRight | 5 | |
| BottomLeft | 6 | |
| BottomCenter | 7 | |
| BottomRight | 8 |
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). |