Tooltip

Collaborate with us

Edit this page on GitHub

You can use the Tooltip UI Pattern to dynamically display informative text when a user hovers over, clicks, or taps an on-screen element.

How to use the Tooltip UI Pattern

In Service Studio, in the Toolbox, search for Tooltip.

The Tooltip widget is displayed.
To From the Toolbox, drag the Tooltip widget into the Main Content area of your application's screen.

By default, the Tooltip widget contains Widget and Content placeholders.
Add your content to the placeholders.

In this example, we add a Save button to the Widget placeholder and enter the tooltip text 'Save your details' in the Content placeholder.
On the Properties tab, change the look and feel of the Tooltip by setting the (optional) properties.

After following these steps and publishing the module, you can test the pattern in your app.

Properties

Properties	Description
Trigger (Trigger Identifier): Optional	Set the trigger type for the content. The predefined options are: Click Hover Manual Examples Blank - The tooltip is triggered by hovering over the element (Entities.Trigger.Hover). This is the default. Entities.Trigger.Click - The tooltip is triggered by clicking the element.
IsVisible (Boolean): Optional	If True, the tooltip is visible when the page is first loaded (without the need for the initial trigger). If False, the tooltip is not visible. This is the default.
Position ( PositionBase Identifier): Optional	Set the tooltip's position. The predefined options are: Bottom Left Right Top Examples Blank - The tooltip is displayed on top of the element. (Entities.PositionBase.Top). This is the default. Entities.PositionBase.Right - The tooltip is displayed to the right of the element.
ExtendedClass (Text): Optional	Add custom style classes to the Tooltip UI Pattern. You define your custom style classes in your application using CSS. Examples Blank - No custom styles are added (default value). "myclass" - Adds the myclass style to the Tooltip UI styles being applied. "myclass1" "myclass2" - Adds the myclass1 and myclass2 styles to the Tooltip UI styles being applied.
AdvancedFormat (Text): Optional	Allows for more options beyond what is provided through the input parameters. Example: `{ arrow: false }`. For more information, visit https://atomiks.github.io/tippyjs/.