Skip to main content

 

 

 

 
Language:
 
Applies only to Traditional Web Apps
 
 
OutSystems

Tooltip

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    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

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

      The Tooltip widget is displayed.

      If the UI widget does not display, it may be because you used a ready-made app, which deletes unused widgets from the module. To make additional widgets available in your app:

      a. Go to Module > Manage dependencies.

      b. Search for and select the relevant Producer, for example OutSystemsUI. Ensure Show All is selected.

      c. On the Public elements for the selected Producer displayed on the right, ensure Show All is selected.

      d. Search for and select the element you want to add, and click Apply.

      e. In Service Studio, in the Toolbox, search for the widget again.

    2. 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.

    3. 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.

    4. 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 Adds custom style classes to the 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 UI styles being applied.
    • "myclass1 myclass2" - Adds the myclass1 and myclass2 styles to the UI styles being applied.
    You can also use the classes available on the OutSystems UI. For more information, see the OutSystems UI Live Style Guide.
    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/.
    • Was this article helpful?