Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Footagesus/WindUI/llms.txt

Use this file to discover all available pages before exploring further.

Tooltips are small floating labels that appear near a UI element on hover. WindUI renders them in a dedicated ScreenGui layer (WindUI/Tooltips) so they always display above all other UI elements. There are two main ways tooltips appear in WindUI:
  1. Slider IsTooltip — shows the current value above the slider thumb while dragging or hovering.
  2. Tab Desc — shows a description tooltip when hovering a tab in the sidebar.

​
Slider tooltip

Set IsTooltip = true on a slider to show the current numeric value in a tooltip above the drag handle. 
SliderTab:Slider({
  Title = "Slider Example",
  Desc = "Hahahahaha hello",
  IsTooltip = true,
  IsTextbox = false,
  Width = 200,
  Step = 1,
  Value = {
    Min = 0,
    Max = 200,
    Default = 100,
  },
  Callback = function(value)
    print(value)
  end,
})
The tooltip updates in real time as the user drags the thumb. It disappears when the user releases the slider.

​
Slider without a title or textbox

IsTooltip works on sliders that have no title or textbox, making the tooltip the only visible indicator of the current value: 
SliderTab:Slider({
  IsTooltip = true,
  Step = 1,
  Value = {
    Min = 0,
    Max = 200,
    Default = 100,
  },
  Callback = function(value)
    print(value)
  end,
})

​
Slider with range icons and tooltip

SliderTab:Slider({
  IsTooltip = true,
  Step = 1,
  Value = {
    Min = 0,
    Max = 100,
    Default = 50,
  },
  Icons = {
    From = "sfsymbols:sunMinFill",
    To = "sfsymbols:sunMaxFill",
  },
  Callback = function(value)
    print(value)
  end,
})

​
Tab description tooltip

Tabs accept a Desc field. When Desc is set, hovering the tab in the sidebar reveals a tooltip with that description text. 
Window:Tab({
  Title = "About WindUI",
  Desc = "Description Example",
  Icon = "solar:info-square-bold",
})
The tooltip appears to the right of the sidebar tab, not below it. Its position adjusts to stay within the screen bounds.

​
Tooltip appearance

Tooltips are rendered as pill-shaped labels using the theme’s Tooltip color token. They animate in with a scale and fade transition and animate out the same way.
Tooltips have a maximum width of 400 px and wrap text automatically (IsTextWrap is true by default inside the module). They scale with the Small size variant for compact contexts like the slider thumb.

​
Tooltip module

Internally, tooltips are created with Tooltip.New(Title, Parent, IsArrow, ColorType, Size, IsTextWrap) from src/components/ui/Tooltip.lua. The returned object exposes two methods:
MethodDescription
:Open()Fades the tooltip in and scales it to full size.
:Close(IsDestroy)Fades the tooltip out. Destroys the container by default (IsDestroy defaults to true).
You do not normally call this module directly — WindUI components that support tooltips call it internally.

Build docs developers (and LLMs) love

Get started for freeTalk to us