README.md

lumin/ui

An unrivaled UI framework for Roblox.

Prerequisites

In order to use lumin/ui you must have the following dependencies installed:

• pesde@^0.5.1
• rojo@^7.4.4

Usage

This usage example will create a new TextButton in a ScreenGui with an Activated event.

local PlayerService = game:GetService("Players")
local Player = PlayerService.LocalPlayer

local UI = require(path.to.UI)
local New = UI.New
local Event = UI.Event

New "ScreenGui" {
    Name = "SampleGUI",
    IgnoreGuiInset = true,
    Parent = Player:WaitForChild("PlayerGui"),

    New "TextButton" {
        AnchorPoint = Vector2.new(0.5, 0.5),
        Position = UDim2.fromScale(0.5, 0.5),
        Size = UDim2.fromOffset(100, 100),
        ZIndex = 1,
        Event("Activated", function()
            print("Button clicked!")
        end),
    }
}

License

This project is licensed under the MIT license