An open API service indexing awesome lists of open source software.

https://github.com/samerop/aero

Aero is a Roblox UI library focused on simplicity and performance.
https://github.com/samerop/aero

gui gui-library library lua luau open-source roblox roblox-gui roblox-lua roblox-script roblox-ui roblox-ui-lib ui ui-library

Last synced: 15 days ago
JSON representation

Aero is a Roblox UI library focused on simplicity and performance.

Awesome Lists containing this project

README

        


# Aero UI Library
- [Getting Aero](#getting-aero)
- [Creating a Window](#creating-a-window)
- [Creating a Tab](#creating-a-tab)
- [Creating a Button](#creating-a-button)
- [Creating a Toggle](#creating-a-toggle)
- [Creating a Keybind](#creating-a-keybind)
- [Creating a TextBox](#creating-a-textbox)
- [Updating a Element](#updating-a-element)
- [Notifying the Player](#notifying-the-player)
- [Icon Paths](#icon-paths)
> [!IMPORTANT]
> Use global variables for methods instead of local (e.g., `button = UI:CreateButton`).
## Getting Aero
```lua
UI = loadstring(game:HttpGet("https://raw.githubusercontent.com/samerop/Aero/main/source.lua"))()
```
## Creating a Window
```lua
UI:CreateWindow({
Title = "My Window",
Key = "1234" -- Key system (Optional)
})
```
## Creating a Tab
```lua
mainTab = UI:CreateTab({
Name = "Main"
})
```
## Creating a Button
```lua
Button = UI:CreateButton({
Text = "Button",
Tab = mainTab,

Callback = function()

end
})
```
## Creating a Toggle
```lua
Toggle = UI:CreateToggle({
Text = "Toggle: OFF",
Tab = mainTab,

Callback = function(boolean)
if boolean then
Toggle.Text = "Toggle: ON"
else
Toggle.Text = "Toggle: OFF"
end
end
})
```
## Creating a Keybind
```lua
Keybind = UI:CreateKeybind({
Text = "Keybind",
Tab = mainTab,
DefaultKeybind = Enum.KeyCode.C,
Toggle = true,

Callback = function(boolean) -- If Toggle is false, you don't need 'boolean'
if boolean then

else

end
end
})
```
## Creating a TextBox
```lua
TextBox = UI:CreateTextBox({
Text = "TextBox",
Tab = mainTab,
PlaceholderText = "",
Default = 10, -- Optional

Callback = function(text)

end
})
```
> [!NOTE]
> If the player leaves TextBox blank, Callback won't execute unless a Default value is provided.
## Updating a Element
You can easily update an element using the variable you assigned to it. For example:
```lua
button = UI:CreateButton({
Text = "Print",
Tab = mainTab,

Callback = function()
print("Hello")
button.Text = "Successfully printed"
button.BackgroundColor3 = Color3.new(0, 1, 0)
end
})
```
## Notifying the Player
![Notification](https://github.com/samerop/Aero/blob/main/gallery/Notification.png?raw=true)
```lua
UI:Notify({
Title = "Powered by Aero",
Text = "Welcome",
Duration = 5,
Icon = "rbxasset://textures/loading/robloxlogo.png" -- Optional
})
```
> [!NOTE]
> ### `Icon` Paths
> - `rbxassetid://` (user-uploaded assets, requires the asset's ID)
> - `rbxasset://` (built-in Roblox content: `%localappdata%\Roblox\Versions\\content`)