Class IgbTooltip

Provides a way to display supplementary information related to an element when a user interacts with it (e.g., hover, focus). It offers features such as placement customization, delays, sticky mode, and animations.

Inheritance
System.Object
BaseRendererControl
IgbTooltip
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbTooltip : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbTooltip()

Declaration
public IgbTooltip()

Properties

Anchor

An element instance or an IDREF to use as the anchor for the tooltip. @remarks Trying to bind to an IDREF that does not exist in the current DOM root at will not work. In such scenarios, it is better to get a DOM reference and pass it to the tooltip instance.

Declaration
public string Anchor { get; set; }
Property Value
Type Description
System.String

Closed

Declaration
public EventCallback<IgbVoidEventArgs> Closed { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosedScript

Declaration
public string ClosedScript { get; set; }
Property Value
Type Description
System.String

Closing

Declaration
public EventCallback<IgbVoidEventArgs> Closing { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

ClosingScript

Declaration
public string ClosingScript { get; set; }
Property Value
Type Description
System.String

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

DisableArrow

Whether to disable the rendering of the arrow indicator for the tooltip.

Declaration
public bool DisableArrow { get; set; }
Property Value
Type Description
System.Boolean

HideDelay

Specifies the number of milliseconds that should pass before hiding the tooltip. @default 300

Declaration
public double HideDelay { get; set; }
Property Value
Type Description
System.Double

HideTriggers

Which event triggers will hide the tooltip. Expects a comma separate string of different event triggers. @default pointerleave, click

Declaration
public string HideTriggers { get; set; }
Property Value
Type Description
System.String

Message

Specifies a plain text as tooltip content.

Declaration
public string Message { get; set; }
Property Value
Type Description
System.String

Offset

The offset of the tooltip from the anchor in pixels. @default 6

Declaration
public double Offset { get; set; }
Property Value
Type Description
System.Double

Open

Whether the tooltip is showing. @default false

Declaration
public bool Open { get; set; }
Property Value
Type Description
System.Boolean

Opened

Declaration
public EventCallback<IgbVoidEventArgs> Opened { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpenedScript

Declaration
public string OpenedScript { get; set; }
Property Value
Type Description
System.String

Opening

Declaration
public EventCallback<IgbVoidEventArgs> Opening { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbVoidEventArgs>

OpeningScript

Declaration
public string OpeningScript { get; set; }
Property Value
Type Description
System.String

Placement

Where to place the floating element relative to the parent anchor element. @default bottom

Declaration
public PopoverPlacement Placement { get; set; }
Property Value
Type Description
PopoverPlacement

ShowDelay

Specifies the number of milliseconds that should pass before showing the tooltip. @default 200

Declaration
public double ShowDelay { get; set; }
Property Value
Type Description
System.Double

ShowTriggers

Which event triggers will show the tooltip. Expects a comma separate string of different event triggers. @default pointerenter

Declaration
public string ShowTriggers { get; set; }
Property Value
Type Description
System.String

Sticky

Specifies if the tooltip remains visible until the user closes it via the close button or Esc key. @default false

Declaration
public bool Sticky { get; set; }
Property Value
Type Description
System.Boolean

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

WithArrow

Whether to render an arrow indicator for the tooltip. @default false

Declaration
public bool WithArrow { get; set; }
Property Value
Type Description
System.Boolean

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

Hide()

Declaration
public bool Hide()
Returns
Type Description
System.Boolean

HideAsync()

Hides the tooltip if not already hidden.

Declaration
public Task<bool> HideAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Show(String)

Declaration
public bool Show(string target = null)
Parameters
Type Name Description
System.String target
Returns
Type Description
System.Boolean

ShowAsync(String)

Shows the tooltip if not already showing. If a target is provided, sets it as a transient anchor.

Declaration
public Task<bool> ShowAsync(string target = null)
Parameters
Type Name Description
System.String target
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Toggle()

Declaration
public bool Toggle()
Returns
Type Description
System.Boolean

ToggleAsync()

Toggles the tooltip between shown/hidden state

Declaration
public Task<bool> ToggleAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Implements

System.IDisposable