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.

A popup is a self-contained floating panel that opens immediately and sits above the rest of the UI. Unlike a dialog, it is not anchored to the window and does not dim or block interaction with content behind it. Popups are created by calling WindUI:Popup(Config).

​
Basic usage

WindUI:Popup({
  Title = "Welcome to the WindUI!",
  Icon = "bird",
  Content = "Hello!",
  Buttons = {
    {
      Title = "Hahaha",
      Icon = "bird",
      Variant = "Tertiary",
    },
  },
})

​
Parameters

​
Title
string
default:"\"Dialog\""
Heading text displayed at the top of the popup.
​
Icon
string
Icon name shown to the left of the title. The icon is always rendered in the current theme’s popup icon color.
​
IconThemed
boolean
When true, the icon tint follows the current theme’s text color instead of the popup icon color.
​
Content
string
Body text shown below the title. Supports RichText markup.
​
Buttons
table
An ordered array of button configs rendered in the bottom-right corner of the popup.Each button supports:
FieldTypeDescription
TitlestringButton label
IconstringOptional icon name
Variantstring"Primary", "Secondary", or "Tertiary"
CallbackfunctionCalled when the button is clicked
​
Thumbnail
table
An optional image panel rendered on the left side of the popup. Supports the following fields:
FieldTypeDescription
Imagestringrbxassetid:// URL for the thumbnail image
TitlestringOptional label overlaid on the thumbnail
When Thumbnail.Image is provided the popup width expands to accommodate the image.

​
Popup vs Dialog

PopupDialog
Blocks window inputNoYes
Attached to windowNoYes
PositionedCenter of screenCenter of window
Use caseAnnouncements, welcome screensConfirmations, destructive actions
Use a popup when you want to greet or inform the user without interrupting their ability to interact with the window. Use a dialog when you need a hard confirmation before an action proceeds.

​
Multiple buttons example

WindUI:Popup({
  Title = "Welcome to the WindUI!",
  Icon = "bird",
  Content = "Hello!",
  Buttons = {
    {
      Title = "Hahaha",
      Icon = "bird",
      Variant = "Tertiary",
    },
    {
      Title = "Hahaha",
      Icon = "bird",
      Variant = "Tertiary",
    },
    {
      Title = "Hahaha",
      Icon = "bird",
      Variant = "Tertiary",
    },
  },
})

​
Triggering a popup from a function

Wrap WindUI:Popup() in a function to call it at the right time — for example, after the window has been created: 
local function createPopup()
  return WindUI:Popup({
    Title = "Welcome to the WindUI!",
    Icon = "bird",
    Content = "Hello!",
    Buttons = {
      {
        Title = "Hahaha",
        Icon = "bird",
        Variant = "Tertiary",
      },
    },
  })
end

-- Call after window creation
createPopup()

Build docs developers (and LLMs) love

Get started for freeTalk to us