Class MudOverlay

Namespace

MudBlazor

Assembly

MudBlazor.dll

public class MudOverlay : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IAsyncDisposable

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudOverlay

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

IAsyncDisposable

Inherited Members

MudComponentBase.OnAfterRender(bool)

MudComponentBase.Logger

MudComponentBase.Class

MudComponentBase.Style

MudComponentBase.Tag

MudComponentBase.UserAttributes

MudComponentBase.IsJSRuntimeAvailable

MudComponentBase.FieldId

ComponentBaseWithState.OnInitialized()

ComponentBaseWithState.SetParametersAsync(ParameterView)

ComponentBaseWithState.OnParametersSet()

ComponentBaseWithState.CreateRegisterScope()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ComponentBaseWithStateExtensions.GetState<T>(ComponentBaseWithState, string)

ComponentBaseWithStateExtensions.GetState<TComponent, T>(TComponent, Func<TComponent, T>, string?)

ObjectExtensions.As<T>(object?)

Constructors

MudOverlay()

public MudOverlay()

Properties

Absolute

If true, use absolute positioning for the overlay.

[Parameter]
[Category("Behavior")]
public bool Absolute { get; set; }

Property Value

bool

AutoClose

If true overlay will set Visible false on click.

[Parameter]
[Category("Click action")]
public bool AutoClose { get; set; }

Property Value

bool

ChildContent

Child content of the component.

[Parameter]
[Category("Behavior")]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

Classname

protected string Classname { get; }

Property Value

string

DarkBackground

If true applies the themes dark overlay color.

[Parameter]
[Category("Behavior")]
public bool DarkBackground { get; set; }

Property Value

bool

LightBackground

If true applies the themes light overlay color.

[Parameter]
[Category("Behavior")]
public bool LightBackground { get; set; }

Property Value

bool

LockScroll

If true (default), the Document.body element will not be able to scroll

[Parameter]
[Category("Behavior")]
public bool LockScroll { get; set; }

Property Value

bool

LockScrollClass

The css class that will be added to body if lockscroll is used.

[Parameter]
[Category("Behavior")]
public string LockScrollClass { get; set; }

Property Value

string

OnClick

Fired when the overlay is clicked

[Parameter]
public EventCallback<MouseEventArgs> OnClick { get; set; }

Property Value

EventCallback<MouseEventArgs>

ScrimClassname

protected string ScrimClassname { get; }

Property Value

string

ScrollManager

[Inject]
public IScrollManager ScrollManager { get; set; }

Property Value

IScrollManager

Styles

protected string Styles { get; }

Property Value

string

Visible

If true overlay will be visible. Two-way bindable.

[Parameter]
[Category("Behavior")]
public bool Visible { get; set; }

Property Value

bool

VisibleChanged

Fires when Visible changes

[Parameter]
public EventCallback<bool> VisibleChanged { get; set; }

Property Value

EventCallback<bool>

ZIndex

Sets the z-index of the overlay.

[Parameter]
[Category("Behavior")]
public int ZIndex { get; set; }

Property Value

int

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

DisposeAsync()

public ValueTask DisposeAsync()

Returns

ValueTask

OnAfterRenderAsync(bool)

protected override Task OnAfterRenderAsync(bool firstTime)

Parameters

firstTime bool

Returns

Task

OnClickHandlerAsync(MouseEventArgs)

protected Task OnClickHandlerAsync(MouseEventArgs ev)

Parameters

ev MouseEventArgs

Returns

Task