Package com.vaadin.flow.component.shared

Interface HasTooltip

All Superinterfaces:
com.vaadin.flow.component.HasElement, Serializable
All Known Subinterfaces:
InputField<E,V>
public interface HasTooltip extends com.vaadin.flow.component.HasElement
Mixin interface for components that have special handling for tooltips on the Web Component level.

Components that implement this interface get a <vaadin-tooltip slot="tooltip"> element added inside the component's light DOM and are expected to handle it appropriately on the client-side.

Use this interface only if you are implementing a new component that also has a Web Component counterpart with a custom tooltip support. Otherwise, use Tooltip.forComponent(Component) instead.

Author:
Vaadin Ltd

  • Method Summary

    Modifier and Type
    Method
    Description
    default Tooltip
    getTooltip()
    Gets the tooltip handle of the component.
    default Tooltip
    setTooltipMarkdown(String markdown)
    Sets a tooltip text for the component in Markdown format.
    default Tooltip
    setTooltipText(String text)
    Sets a tooltip text for the component as plain text.

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

  • Method Details

    • setTooltipText

      default Tooltip setTooltipText(String text)
      Sets a tooltip text for the component as plain text.
      Parameters:
      text - The tooltip text
      Returns:
      the tooltip handle

    • setTooltipMarkdown

      default Tooltip setTooltipMarkdown(String markdown)
      Sets a tooltip text for the component in Markdown format.
      Parameters:
      markdown - The tooltip text in Markdown format
      Returns:
      the tooltip handle

    • getTooltip

      default Tooltip getTooltip()
      Gets the tooltip handle of the component.
      Returns:
      the tooltip handle