pulse-rb 1.2.24

package/adapters/windui.llms.txt

@@ -0,0 +1,366 @@
+# Wind UI — LLM Reference (v1.6.64-fix)
+# Source: https://footagesus.github.io/treehub-web/docs/windui
+# GitHub: https://github.com/Footagesus/WindUI
+
+## LOADING
+
+```lua
+local _version = "1.6.64-fix"
+local WindUI = loadstring(game:HttpGet(
+    "https://github.com/Footagesus/WindUI/releases/download/" .. _version .. "/main.lua"
+))()
+-- Optional post-load config:
+WindUI:SetNotificationLower(true)   -- push notifications lower on screen
+WindUI:SetFont("rbxassetid://id")   -- custom font
+WindUI:SetParent(Parent)            -- where UI renders (default: CoreGui)
+WindUI:SetTheme("Dark")             -- global theme override
+```
+
+## WINDOW
+
+```lua
+local Window = WindUI:CreateWindow({
+    Title      = "string",               -- required
+    Icon       = "lucide-name"|"rbxassetid://id"|"url",
+    Author     = "by name",              -- subtitle
+    Folder     = "FolderName",           -- used by ConfigManager
+    Size       = UDim2.fromOffset(w, h), -- default ~950x600
+    MinSize    = Vector2.new(400,300),
+    MaxSize    = Vector2.new(1920,1080),
+    Position   = UDim2.fromScale(0.5,0.5),
+    Theme      = "Dark",                 -- built-in or custom
+    Resizable  = true,
+    Transparent = true,
+    Acrylic    = true,
+    ToggleKey  = Enum.KeyCode.RightControl,
+    HideSearchBar = false,
+    AutoScale  = false,
+    NewElements = false,
+    OpenButton = {                       -- floating open button (MOBILE SUPPORT)
+        Enabled        = true,           -- show the button
+        Title          = "Open",         -- optional label
+        Draggable      = true,
+        OnlyMobile     = true,           -- show only on mobile devices
+        Scale          = 1,
+        CornerRadius   = UDim.new(0,8),
+        StrokeThickness = 1,
+        Color          = ColorSequence.new(Color3, Color3),
+    },
+    Topbar = {
+        Height      = 40,
+        ButtonsType = "Default"|"Mac",
+    },
+    User = { ... },         -- show user avatar/name
+    KeySystem = { ... },    -- built-in key system
+})
+```
+
+Window methods:
+- `:Tab(config)` → Tab
+- `:Section(config)` → Section (window-level, appears in sidebar)
+- `:Tag(config)` → Tag badge in topbar
+- `:Dialog(config)` → Dialog
+- `:SetTitle(str)`, `:SetAuthor(str)`, `:SetIcon(str)`, `:SetSize(UDim2)`
+- `:SetToggleKey(Enum.KeyCode)`   ← USE THIS for toggle key
+- `:SetTheme(str)`, `:SetUIScale(n)`, `:GetUIScale()`
+- `:SetPanelBackground(bool)`, `:ToggleTransparency(bool)`
+- `:SetToTheCenter()`, `:Toggle()`, `:Open()`, `:Close()`, `:Destroy()`
+- `:ToggleFullscreen()`, `:SelectTab(tab)`, `:LockAll()`, `:UnlockAll()`
+- `:OnOpen(fn)`, `:OnClose(fn)`, `:OnDestroy(fn)`
+- `:EditOpenButton(config)`
+- `:DisableTopbarButtons(table)`, `:CreateTopbarButton(config)`
+- `Window.ConfigManager:Config(name)` → Config
+- `Window.CurrentConfig:Save()`, `Window.CurrentConfig:Load()`
+
+## TAB
+
+```lua
+local Tab = Window:Tab({
+    Title       = "string",
+    Icon        = "string",
+    Desc        = "string",      -- tooltip
+    IconColor   = Color3,
+    IconShape   = "Square"|nil,
+    IconThemed  = false,
+    Border      = false,
+    Locked      = false,
+    ShowTabTitle = false,
+    TabTitleAlign = "Left",
+})
+```
+
+Tab methods:
+- `:Section(config)` → Section (see below)
+- `:Button(config)`, `:Toggle(config)`, `:Slider(config)`, `:Dropdown(config)`
+- `:Input(config)`, `:Keybind(config)`, `:Colorpicker(config)`
+- `:Paragraph(config)`, `:Image(config)`, `:Divider()`, `:Space(config)`
+- `:Group(config)` (DEPRECATED)
+- `:Select()`, `:SetTitle(str)`, `:SetDesc(str)`, `:Lock()`, `:Unlock()`
+- `:ScrollToTheElement(index)`
+
+## SECTION  (groupbox equivalent — used inside Tab)
+
+```lua
+local Section = Tab:Section({
+    Title      = "string",
+    Desc       = "string",
+    TextSize   = number,
+    FontWeight = Enum.FontWeight,
+    Box        = true,           -- draws a bordered box around the section
+    BoxBorder  = true,           -- border on the box
+    Opened     = true,           -- expanded by default
+})
+-- Section has the same element methods as Tab:
+-- Section:Toggle(...), Section:Button(...), etc.
+```
+
+## ELEMENTS — all work on Tab or Section container
+
+### Toggle
+```lua
+local Elem = Container:Toggle({
+    Title    = "string",
+    Desc     = "string",
+    Icon     = "string",
+    Type     = "Toggle"|"Checkbox",
+    Value    = false,            -- initial state
+    Locked   = false,
+    Flag     = "flag_key",       -- for config persistence
+    Callback = function(v: boolean) end,
+})
+Elem:Set(bool)
+Elem:Toggle()
+Elem:SetTitle(str), Elem:SetDesc(str)
+Elem:Lock(), Elem:Unlock(), Elem:Highlight(), Elem:Destroy()
+```
+
+### Slider
+```lua
+local Elem = Container:Slider({
+    Title    = "string",
+    Desc     = "string",
+    Step     = 1,
+    Width    = 130,
+    IsTooltip = false,
+    IsTextbox = false,
+    Value    = { Min = 0, Max = 100, Default = 50 },
+    Icons    = { From = "icon", To = "icon" },
+    Flag     = "flag_key",
+    Callback = function(v: number) end,
+})
+Elem:Set(number)
+Elem:SetMin(n), Elem:SetMax(n)
+Elem:SetTitle(str), Elem:SetDesc(str)
+Elem:Lock(), Elem:Unlock(), Elem:Highlight(), Elem:Destroy()
+```
+
+### Dropdown
+```lua
+-- Values can be simple strings:
+--   Values = {"A", "B", "C"}
+-- Or rich objects:
+--   Values = { {Title="A", Desc="desc", Icon="icon", Callback=fn, Locked=bool}, {Type="Divider"} }
+
+local Elem = Container:Dropdown({
+    Title          = "string",
+    Desc           = "string",
+    Values         = table,
+    Value          = "default"|table,  -- string for single, table for multi
+    Multi          = false,
+    AllowNone      = false,
+    SearchBarEnabled = false,
+    Locked         = false,
+    Flag           = "flag_key",
+    Callback       = function(v: string|table) end,
+})
+Elem:Select(value)           -- string or table
+Elem:Refresh(newValues)      -- replace options list
+Elem:SetTitle(str), Elem:SetDesc(str)
+Elem:Lock(), Elem:Unlock(), Elem:Highlight(), Elem:Destroy()
+```
+
+### Button
+```lua
+Container:Button({
+    Title       = "string",
+    Desc        = "string",
+    Icon        = "string",
+    IconAlign   = "Right"|"Left",
+    Color       = Color3,
+    Justify     = "Between"|"Center"|"Left",
+    Locked      = false,
+    LockedTitle = "string",
+    Flag        = "flag_key",
+    Callback    = function() end,
+})
+-- methods: :SetTitle, :SetDesc, :Lock, :Unlock, :Highlight, :Destroy
+```
+
+### Keybind
+```lua
+local Elem = Container:Keybind({
+    Title    = "string",
+    Desc     = "string",
+    Value    = "G",              -- key name string e.g. "V", "RightControl"
+    Locked   = false,
+    Flag     = "flag_key",
+    Callback = function(v) end,  -- fires when the bound key is pressed
+})
+Elem:Set(Enum.KeyCode)
+Elem:SetTitle(str)
+Elem:Lock(), Elem:Unlock()
+```
+
+### Input
+```lua
+Container:Input({
+    Title       = "string",
+    Desc        = "string",
+    Icon        = "string",
+    InputIcon   = "string",
+    Type        = "Default"|"Textarea",
+    Placeholder = "string",
+    Value       = "string",
+    Locked      = false,
+    Flag        = "flag_key",
+    Callback    = function(v: string) end,
+})
+-- methods: :Set(str), :SetTitle, :SetDesc, :Lock, :Unlock, :Highlight, :Destroy
+```
+
+### Colorpicker
+```lua
+Container:Colorpicker({
+    Title    = "string",
+    Desc     = "string",
+    Default  = Color3.fromRGB(255,255,255),
+    Transparency = 0,
+    Locked   = false,
+    Flag     = "flag_key",
+    Callback = function(color: Color3) end,
+})
+-- methods: :Set(Color3, transparency?), :Lock, :Unlock
+```
+
+### Paragraph
+```lua
+Container:Paragraph({
+    Title       = "string",
+    Desc        = "string",
+    Image       = "url",
+    ImageSize   = number,
+    Thumbnail   = "url",
+    ThumbnailSize = number,
+    Color       = "Red"|Color3,
+    TextSize    = number,
+    Justify     = "Center"|"Left",
+    Locked      = false,
+    Buttons     = { {Title="btn", Icon="icon", Variant="Primary", Callback=fn} },
+})
+-- methods: :SetTitle, :SetDesc, :SetImage(img, size?), :SetThumbnail(img,size?), :SetColor, :Destroy
+```
+
+### Divider
+```lua
+Container:Divider()   -- no parameters
+```
+
+### Space
+```lua
+Container:Space({ Columns = 1 })   -- vertical gap, columns = spacing width
+```
+
+### Tag  (badge in window topbar)
+```lua
+local Tag = Window:Tag({
+    Title = "string",
+    Icon  = "string",
+    Color = Color3,
+    Border = false,
+})
+Tag:SetTitle(str), Tag:SetIcon(str), Tag:SetColor(Color3)
+```
+
+## NOTIFICATIONS
+```lua
+WindUI:Notify({
+    Title    = "string",
+    Content  = "string",
+    Icon     = "string",
+    Duration = 3,
+    CanClose = true,
+})
+```
+
+## DIALOG
+```lua
+local D = Window:Dialog({
+    Title   = "string",
+    Icon    = "string",
+    Content = "string",
+    Buttons = {
+        { Title="Yes", Icon="string", Variant="Primary", Callback=fn },
+        { Title="No",  Callback=fn },
+    },
+})
+D:Show()
+D:Close()
+```
+
+## POPUP
+```lua
+local P = WindUI:Popup({
+    Title   = "string",
+    Icon    = "string",
+    Content = "string",
+    Buttons = { {Title="OK", Callback=fn} },
+})
+P:Close()
+```
+
+## THEMES
+Built-in: "Dark" (and possibly others)
+Custom:
+```lua
+WindUI:AddTheme({
+    Name        = "MyTheme",
+    Accent      = Color3.fromHex("#18181b"),
+    Background  = Color3.fromHex("#101010"),
+    Outline     = Color3.fromHex("#FFFFFF"),
+    Text        = Color3.fromHex("#FFFFFF"),
+    Placeholder = Color3.fromHex("#7a7a7a"),
+    Button      = Color3.fromHex("#52525b"),
+    Icon        = Color3.fromHex("#a1a1aa"),
+})
+WindUI:SetTheme("MyTheme")
+```
+
+## CONFIG PERSISTENCE  (via Flag property + ConfigManager)
+```lua
+-- Elements with Flag = "key" auto-track their state.
+local Cfg = Window.ConfigManager:Config("MyConfig")  -- creates/loads MyConfig.json
+Cfg:Save()
+Cfg:Load()
+
+-- Config files stored at:
+-- [executor]/WindUI/[Window.Folder]/configs/MyConfig.json
+```
+
+## ICONS
+- Lucide (default): `"save"`, `"bird"`, `"bell"`, etc.
+- Prefixed sets: `"solar:pen-bold"`, `"craft:home"`, etc.
+- Roblox asset: `"rbxassetid://123456789"` (+ IconThemed=true for theme tint)
+- URL: `"https://example.com/icon.png"`
+
+## MOBILE SUPPORT
+Wind UI natively supports mobile via the OpenButton config:
+```lua
+OpenButton = {
+    Enabled    = true,
+    OnlyMobile = true,    -- only shows on mobile, hidden on desktop
+    Draggable  = true,
+    Scale      = 1,
+}
+```
+No extra code needed — Wind UI handles touch input, scrolling, and resizing internally.
+The toggle key still works on PC; the button provides the mobile open/close gesture.