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.

Notifications appear at the edge of the screen and automatically dismiss after a configurable duration. You create them by calling WindUI:Notify(Config).

​
Basic usage

WindUI:Notify({
  Title = "Hello",
  Content = "Welcome to WindUI!",
})

​
Parameters

​
Title
string
default:"\"Notification\""
The heading text displayed in the notification.
​
Content
string
Body text shown below the title. Supports RichText markup.
​
Icon
string
Icon name (e.g. "solar:bell-bold") or rbxassetid:// URL displayed on the left side.
​
IconThemed
boolean
When true, the icon tint follows the current theme’s text color.
​
Background
string
An image URL (rbxassetid://) used as the notification background.
​
BackgroundImageTransparency
number
Transparency of the background image. 0 is fully opaque, 1 is invisible.
​
Duration
number
default:"5"
Seconds before the notification auto-dismisses. A progress bar tracks the remaining time.
​
CanClose
boolean
default:"true"
When true, an × button is rendered so the user can dismiss the notification early. Set to false to hide the close button.
​
Buttons
table
An array of button config tables rendered at the bottom of the notification. Each button supports the same Title, Icon, Variant, and Callback fields as dialog buttons.

​
Examples

WindUI:Notify({
  Title = "Export complete",
  Content = "Your config has been saved to the clipboard.",
})

WindUI:Notify({
  Title = "Hello",
  Content = "Welcome to the WindUI Example!",
  Icon = "solar:bell-bold",
  Duration = 5,
})

WindUI:Notify({
  Title = "Hello",
  Content = "Welcome to the WindUI Example!",
  Icon = "solar:bell-bold",
  Duration = 5,
  CanClose = false,
})

ButtonTab:Button({
  Title = "Notify Button",
  Callback = function()
    WindUI:Notify({
      Title = "Hello",
      Content = "Welcome to the WindUI Example!",
      Icon = "solar:bell-bold",
      Duration = 5,
      CanClose = false,
    })
  end,
})

​
Mobile offset

On mobile, the open button sits at the bottom of the screen. Call WindUI:SetNotificationLower(true) to shift the notification stack upward so it does not overlap the button. 
WindUI:SetNotificationLower(true)
Call WindUI:SetNotificationLower(false) to reset to the default position.
SetNotificationLower affects the entire notification holder, not individual notifications. Call it once after creating your window.

​
Return value

WindUI:Notify() returns the notification object. You can dismiss it programmatically by calling :Close(). 
local n = WindUI:Notify({
  Title = "Processing…",
  CanClose = false,
  Duration = 60,
})

task.wait(3)
n:Close()

Build docs developers (and LLMs) love

Get started for freeTalk to us