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.

Sections serve two distinct purposes in WindUI depending on where they are created:
  • Sidebar sections — created via Window:Section(Config), they render a collapsible header in the sidebar that groups Tab entries under a title.
  • Content sections — created via Tab:Section(Config) or Group:Section(Config), they render a text heading or a boxed container directly inside a tab’s content panel. These are elements, not sidebar navigation, and behave like any other element (they can contain buttons, toggles, etc.).

​
Sidebar Section

Use Window:Section(Config) to create a collapsible group in the sidebar. Call :Tab() on the returned object to add tabs that belong to that group. 
local ElementsSection    = Window:Section({ Title = "Elements" })
local ConfigUsageSection = Window:Section({ Title = "Config Usage" })
local OtherSection       = Window:Section({ Title = "Other" })

-- Add tabs to a section
local OverviewTab = ElementsSection:Tab({
    Title     = "Overview",
    Icon      = "solar:home-2-bold",
    IconColor = Color3.fromHex("#83889E"),
    IconShape = "Square",
    Border    = true,
})

local ConfigTab = ConfigUsageSection:Tab({
    Title     = "Config Usage",
    Icon      = "solar:folder-with-files-bold",
    IconColor = Color3.fromHex("#7775F2"),
    IconShape = nil,
    Border    = true,
})

local DiscordTab = OtherSection:Tab({
    Title  = "Discord",
    Border = true,
})

​
Config

​
Title
string
default:"Section"
Text displayed as the section header in the sidebar.
​
Icon
string
Icon shown to the left of the header title.
​
IconThemed
boolean
When true, the icon color follows the active theme.
​
Opened
boolean
default:"false"
When true, the section starts expanded instead of collapsed.

​
Methods

​
Section:Tab(TabConfig)
Tab
Adds a tab to this sidebar section. The tab entry appears under the section header and the section becomes expandable. Returns a Tab object.
​
Section:Open()
Expands the section with an animated slide-down transition.
​
Section:Close()
Collapses the section with an animated slide-up transition.
A sidebar section only shows the chevron expand/collapse control after at least one tab has been added via Section:Tab().

​
Content Section (Element)

Use Tab:Section(Config) to render a heading or boxed container inside a tab’s content panel. Once any child element is added to it, it becomes collapsible. 
-- Simple text heading
DiscordTab:Section({
    Title    = "Join our Discord server!",
    TextSize = 20,
})

-- Inline heading with custom font weight
AboutSection:Section({
    Title      = "What is WindUI?",
    TextSize   = 24,
    FontWeight = Enum.FontWeight.SemiBold,
})

-- Descriptive text block
AboutSection:Section({
    Title             = "WindUI is a stylish, open-source UI library...",
    TextSize          = 18,
    TextTransparency  = 0.35,
    FontWeight        = Enum.FontWeight.Medium,
})

-- Boxed section with a border that starts expanded
local OverviewSection1 = OverviewGroup3:Section({
    Title     = "Section 1",
    Desc      = "Section exampleee",
    Box       = true,
    BoxBorder = true,
    Opened    = true,
})

OverviewSection1:Button({
    Title    = "Button 1",
    Justify  = "Center",
    Icon     = "",
    Callback = function() print("clicked button 1") end,
})
OverviewSection1:Space()
OverviewSection1:Toggle({
    Title    = "Toggle 2",
    Callback = function(v) print("clicked toggle 2:", v) end,
})

​
Config

​
Title
string
default:"Section"
The heading text.
​
Desc
string
A secondary description rendered beneath the title.
​
TextSize
number
default:"19"
Font size of the title text.
​
FontWeight
Enum.FontWeight
default:"Enum.FontWeight.SemiBold"
Font weight of the title text.
​
TextTransparency
number
default:"0.05"
Transparency of the title text. 0 is fully opaque.
​
Box
boolean
default:"false"
Wraps the section and its children in a rounded background frame.
​
BoxBorder
boolean
default:"false"
Adds a glass-sheen border to the box frame. Requires Box = true.
​
Opened
boolean
default:"false"
When true, the section starts in the expanded state. Only applies once child elements are added.
​
Icon
string
Icon shown to the left of the heading.
​
IconThemed
boolean
When true, the icon color follows the active theme.

​
Element Methods

Content sections support the same element methods as Tab: Section:Button() · Section:Toggle() · Section:Slider() · Section:Input() · Section:Dropdown() · Section:Colorpicker() · Section:Keybind() · Section:Group() · Section:Section() · Section:Space() · Section:Paragraph() · Section:Image() · Section:Code()

​
Methods

​
Section:Open()
Expands the section to reveal its child elements.
​
Section:Close()
Collapses the section, hiding child elements.
​
Section:SetTitle(title)
Updates the heading text.
​
Section:SetDesc(desc)
Updates or creates the description text beneath the heading.

Build docs developers (and LLMs) love

Get started for freeTalk to us