stalker-tooltip
Reactive icon

Stalker Tooltip

Stable version 1.0.3 (Compatible with OutSystems 11)
Uploaded
 on 4 Jun
 by 
5.0
 (8 ratings)
stalker-tooltip

Stalker Tooltip

Documentation
1.0.2
1. Install the latest component version
Check the OutSystems Forge for the Stalker Tooltip component and ensure that the latest version is installed in your environment. If it's not installed, proceed with the installation. This component doesn't have any additional dependencies. You can also download and install the demo application at this time.

2. Manage your dependencies
Add a desired dependency in your module from StalkerTooltip module through manage dependencies and choose the StalkerTooltip Block.



3. Using the StalkerTooltip block
Simply add the component to your screen, add your text to the TooltipContent placeholder and it's done.



Fill the block parameters:



Configure the inputs at your own needs.
•   HoverContainerClass (mandatory) [text] - Wrapper container that will wrap all the elements from which you desire the tooltip to appear. The event listeners used in this pattern will be set to this element;
NOTE: If the tooltip is inside a div with transform properties, this container should have the same dimensions as the element being transformed. As an example, when using the OutSystems Sidebar widget, the Hover ContainerClass should be a wrapper around all the sidebar content.
• HoverElementsClass [text] - If defined only hover/clicks in elements containing this class will trigger the tooltip. If empty the tooltip will always be visible inside the container defined by the HoverContainerClass input;
• TooltipOffsetX [integer] - Tooltip X axis offset relative to the cursor. Default -20;
• TooltipOffsetY [integer] - Tooltip Y axis offset relative to the cursor. Default 35;
• TooltipWidth [integer] - Defines the tooltip width. Default 175px;
• PositionRelativeToParent [boolean]: CSS Transform property on parent elements might mess with the tooltip positioning. If using the tooltip inside an element with Transform properties (ex. sidebar) and it's not working properly, set this flag to True;
• OnClickOnly [boolean]: Set to true to make the tooltip appear only in click, and not on hover;
• ExtendedClass [text]: Adds classes to the placeholder;


Notes:
•   No styles applied by default.

1.0.0

Configuration:

  1. Reference the StalkerTooltip block.
  2. Add the block to the desired screen/block.
  3. Set inputs:
  • HoverContainerClass (mandatory)

Wrapper container that will wrap all the elements from which you desire the tooltip to appear. The event listeners used in this pattern will be set to this element. 

NOTE: If the tooltip is inside a div with transform properties, this container should have the same dimensions as the element being transformed. As an example, when using the OutSystems Sidebar widget, the Hover ContainerClass should be a wrapper around all the sidebar content.

  • HoverElementsClass

If defined only hover/clicks in elements containing this class will trigger the tooltip. If empty the tooltip will always be visible inside the container defined by the HoverContainerClass input.

  • TooltipOffsetX

Tooltip X axis offset relative to the cursor. Default -20.

  • TooltipOffsetY

Tooltip Y axis offset relative to the cursor. Default 35.

  • TooltipWidth

Defines the tooltip width. Default 175px.

  • PositionRelativeToParent

CSS Transform property on parent elements might mess with the tooltip positioning. If using the tooltip inside an element with Transform properties (ex. sidebar) and it's not working properly, set this flag to True.

  • ExtendedClass

Adds classes to the placeholder.