Table of Contents

Class MudScrollToTop

Namespace
MudBlazor
Assembly
MudBlazor.dll
public class MudScrollToTop : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged, IDisposable
Inheritance
MudScrollToTop
Implements
Inherited Members
Extension Methods

Constructors

MudScrollToTop() 

public MudScrollToTop()

Properties

ChildContent 

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

Property Value

RenderFragment

Classname 

protected string Classname { get; }

Property Value

string

HiddenCssClass

CSS class for the Hidden state. Here, apply some transitions and animations that will happen when the component becomes invisible

[Parameter]
[Category("Appearance")]
public string? HiddenCssClass { get; set; }

Property Value

string

OnClick 

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

Property Value

EventCallback<MouseEventArgs>

OnScroll

Called when scroll event is fired

[Parameter]
public EventCallback<ScrollEventArgs> OnScroll { get; set; }

Property Value

EventCallback<ScrollEventArgs>

ScrollBehavior

Smooth or Auto

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

Property Value

ScrollBehavior

Selector

The CSS selector to which the scroll event will be attached

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

Property Value

string

TopOffset

The distance in pixels scrolled from the top of the selected element from which the component becomes visible

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

Property Value

int

Visible

If set to true, it starts Visible. If sets to false, it will become visible when the TopOffset amount of scrolled pixels is reached

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

Property Value

bool

VisibleCssClass

CSS class for the Visible state. Here, apply some transitions and animations that will happen when the component becomes visible

[Parameter]
[Category("Appearance")]
public string? VisibleCssClass { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

Dispose()

Remove the event

public void Dispose()

OnAfterRender(bool) 

protected override void OnAfterRender(bool firstRender)

Parameters

firstRender bool