Tooltip

Tooltip displays an information icon associated with a single element or a row of elements. When the user hovers over the information icon, a pop-up displays the tooltip Text property contents.

Tooltip is a container element, normally with a single contained element.

Note

If there are multiple contained elements, they are displayed vertically within the tooltip element on the UI builder canvas, but are displayed horizontally when rendered in the UI.

See examples

Properties

  • ID
    Element identifier.
  • Width

    • Sets the width of the tooltip container according to the combined widths of the contained elements.
    • Uses all of the available width.
      For more information, see Element distribution.
  • Text
    What is displayed when the user hovers over the tooltip element.
  • Enable markdown
    Toggle on for the Text field to be treated as basic markdown syntax. (see examples)

    Note

    For more information on basic markdown syntax, see the Markdown basic syntax guide.

  • Enable auto-width (see examples)
    Enable for the tooltip width to be calculated automatically. Otherwise, the max tooltip width is 300px.
  • Placement
    Specifies the popup tooltip text placement relative to the icon.
    There are 12 options:
    • top

    • top-start

    • top-end

    • bottom

    • bottom-start

    • bottom-end

    • left

    • left-start

    • left-end

    • right

    • right-start

    • right-end

Examples

Width=Fit examples

In all three examples, the tooltip container element limits the width to the minimum required for the contained elements.

Note

In the examples, the input with Width=Fill expands to the maximum available width within the tooltip container. However, since the tooltip container Width=Fit, the available space is limited.

../../../../../../_images/ss-element-tooltip-fit.png

Width=Fill examples

In all three examples, the tooltip container element expands to the maximum width available. Although, only in examples 2 and 3, where a contained element does the same, is this evident. In the first example, the tooltip

../../../../../../_images/ss-element-tooltip-fill.png

Auto-width examples

Note

In these examples, the Enable markdown property is also enabled.

Auto-width disabled

../../../../../../_images/ss-element-tooltip-autowidthoff.png

Auto-width enabled

../../../../../../_images/ss-element-tooltip-autowidth.png