New to Telerik UI for Blazor? Start a free 30-day trial

TelerikTooltip

Class

A component that shows contextual hints for elements matched by TargetSelector. Configure content via Template (receives TooltipTemplateContext), position with Position, and trigger using ShowOn. Control timing through ShowDelay and HideDelay, and dimensions with Width/Height. Optionally set an explicit tooltip id via Id for accessibility.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class TelerikTooltip : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikTooltip

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Constructors

TelerikTooltip()

public TelerikTooltip()

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

public override void Dispose()

Overrides: BaseComponent.Dispose()

OnAfterRenderAsync(bool)

Task

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)

OnInitializedAsync()

Task

protected override Task OnInitializedAsync()

Returns:

Task

Overrides: BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Task

protected override Task OnParametersSetAsync()

Returns:

Task

Overrides: ComponentBase.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Task

public override Task SetParametersAsync(ParameterView parameters)

Parameters:parametersParameterViewReturns:

Task

Overrides: ComponentBase.SetParametersAsync(ParameterView)

Properties

Collision

TooltipCollision?

Specifies the behavior of the Tooltip when it does not fit in the viewport. Valid values are: Flip - the tooltip will flip if there is sufficient available space on the opposite side. Fit - the tooltip will be shifted (moved) until it is fully visible. By default, the Tooltip fits inside the viewport when there is a collision.

[Parameter]
public TooltipCollision? Collision { get; set; }

Height

string

Defines the height of the Component as a CSS value.

[Parameter]
public string Height { get; set; }

HideDelay

int

The delay before the closing of the Tooltip in milliseconds.

[Parameter]
public int HideDelay { get; set; }

Id

string

Specifies id attribute of the Tooltip element. Can be useful so you can point an aria-described-by attribute of your target to the tooltip ID for the benefit of screen readers.

[Parameter]
public string Id { get; set; }

Position

TooltipPosition

Defines the placement of the Tooltip in relation to its target. Supports Top, Bottom, Left and Right position.

[Parameter]
public TooltipPosition Position { get; set; }

ShowDelay

int

The delay before the opening of the Tooltip in milliseconds.

[Parameter]
public int ShowDelay { get; set; }

ShowOn

TooltipShowEvent

Defines the event which will trigger the Tooltip to show. The possible events are Click and Hover. The default value is Hover.

[Parameter]
public TooltipShowEvent ShowOn { get; set; }

TargetSelector

string

Specifies the selector for the target elements of the tooltip. Uses CSS-type selectors.

[Parameter]
public string TargetSelector { get; set; }

Template

RenderFragment<TooltipTemplateContext>

Specifies the template for the content of the tooltip. The @context of the template contains all data attribute of the target element, lowercase, and the title attribute of the target.

[Parameter]
public RenderFragment<TooltipTemplateContext> Template { get; set; }

Width

string

Defines the width of the Component as a CSS value. The default value is "auto".

[Parameter]
public string Width { get; set; }