Class MudTooltip

Namespace

MudBlazor

Assembly

MudBlazor.dll

A small popup which provides more information.

public class MudTooltip : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudTooltip

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

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.CreateRegisterScope()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRenderAsync(bool)

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

EventUtil.AsNonRenderingEventHandler(ComponentBase, Action)

EventUtil.AsNonRenderingEventHandler(ComponentBase, Func<Task>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Action<TValue>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Func<TValue, Task>)

ComponentBaseWithStateExtensions.GetState<T>(ComponentBaseWithState, string)

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

ObjectExtensions.As<T>(object?)

Constructors

MudTooltip()

public MudTooltip()

Properties

Arrow

Displays an arrow pointing towards the tooltip content.

[Parameter]
[Category("Appearance")]
public bool Arrow { get; set; }

Property Value

bool

Remarks

Defaults to false.

ChildContent

The content described by this tooltip.

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

Property Value

RenderFragment

Classname

protected string Classname { get; }

Property Value

string

Color

The tooltip color.

[Parameter]
[Category("Appearance")]
public Color Color { get; set; }

Property Value

Color

Remarks

Defaults to Default.

ContainerClass

protected string ContainerClass { get; }

Property Value

string

Delay

The amount of time, in milliseconds, to wait from opening the popover before performing the transition.

[Parameter]
[Category("Appearance")]
public double Delay { get; set; }

Property Value

double

Remarks

Defaults to 0ms in Delay.

Disabled

Prevents this tooltip from being displayed.

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

Property Value

bool

Remarks

Defaults to false.

Duration

The length of time to animate the opening transition.

[Parameter]
[Category("Appearance")]
public double Duration { get; set; }

Property Value

double

Remarks

Defaults to 251ms in Duration.

Inline

Displays this tooltip inline with its container.

[Parameter]
[Category("Appearance")]
public bool Inline { get; set; }

Property Value

bool

Remarks

Defaults to true. When false, the content will display as a block element.

Placement

The location of the tooltip relative to its content.

[Parameter]
[Category("Appearance")]
public Placement Placement { get; set; }

Property Value

Placement

Remarks

Defaults to Bottom.

RightToLeft

Displays content right-to-left.

[CascadingParameter(Name = "RightToLeft")]
public bool RightToLeft { get; set; }

Property Value

bool

RootClass

Any CSS classes applied to the tooltip.

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

Property Value

string

Remarks

Defaults to null.

RootStyle

Any CSS styles applied to the tooltip.

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

Property Value

string

Remarks

Defaults to null.

ShowOnClick

Shows this tooltip when its content is clicked.

[Parameter]
[Category("Appearance")]
public bool ShowOnClick { get; set; }

Property Value

bool

Remarks

Defaults to false.

ShowOnFocus

Shows this tooltip when its content is focused.

[Parameter]
[Category("Appearance")]
public bool ShowOnFocus { get; set; }

Property Value

bool

Remarks

Defaults to true.

ShowOnHover

Shows this tooltip when hovering over its content.

[Parameter]
[Category("Appearance")]
public bool ShowOnHover { get; set; }

Property Value

bool

Remarks

Defaults to true.

Text

The tooltip text.

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

Property Value

string

TooltipContent

The content of the tooltip.

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

Property Value

RenderFragment

Remarks

Can contain any valid HTML.

Visible

Shows this tooltip.

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

Property Value

bool

Remarks

Defaults to false.

VisibleChanged

Occurs when Visible has changed.

[Parameter]
[Category("Behavior")]
public EventCallback<bool> VisibleChanged { get; set; }

Property Value

EventCallback<bool>

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnParametersSet()

protected override void OnParametersSet()