MudOverlay API

Pages
Properties
Name Type Default Description
Behavior
Absolute
bool
False Icon class names, separated by space
ChildContent
RenderFragment
null Child content of the component.
DarkBackground
bool
False If true applys the themes dark overlay color.
LightBackground
bool
False If true applys the themes light overlay color.
LockScroll
bool
True If true (default), the Document.body element will not be able to scroll
LockScrollClass
string
"scroll-locked" The css class that will be added to body if lockscroll is used.
Visible
bool
False If true overlay will be visible. Two-way bindable.
ZIndex
int
5 Sets the z-index of the overlay.
Click action
AutoClose
bool
False If true overlay will set Visible false on click.
Command
ICommand
null Command executed when the user clicks on an element.
CommandParameter
object
null Command parameter.
Common
Class
string
null User class names, separated by space.
Style
string
null User styles, applied on top of the component's own classes and styles.
Tag
object
null Use Tag to attach any user data object to the component for your convenience.
UserAttributes
Dictionary<string, object>
UserAttributes carries all attributes you add to the component that don't match any of its parameters. They will be splatted onto the underlying HTML tag.
EventCallbacks
Name Type Description
OnClick EventCallback<MouseEventArgs> Fired when the overlay is clicked
VisibleChanged EventCallback<bool> Fires when Visible changes
Methods
Name Parameters Return Description
Dispose()
An unhandled error has occurred. Reload 🗙