roact

by Roblox

Roblox /roact

A view management library for Roblox Lua similar to React

161 Stars 51 Forks Last release: 4 months ago (v1.3.0) Apache License 2.0 432 Commits 10 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Roact

GitHub Actions Build Status Coveralls Coverage Documentation
A declarative UI library for Roblox Lua inspired by React.
 

Installation

Method 1: Model File (Roblox Studio)

  • Download the
    rbxm
    model file attached to the latest release from the GitHub releases page.
  • Insert the model into Studio into a place like
    ReplicatedStorage

Method 2: Filesystem

  • Copy the
    src
    directory into your codebase
  • Rename the folder to
    Roact
  • Use a plugin like Rojo to sync the files into a place

Documentation

For a detailed guide and examples, check out the official Roact documentation.

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

local Roact = require(Roact)

-- Create our virtual tree describing a full-screen text label. local tree = Roact.createElement("ScreenGui", {}, { Label = Roact.createElement("TextLabel", { Text = "Hello, world!", Size = UDim2.new(1, 0, 1, 0), }), })

-- Turn our virtual tree into real instances and put them in PlayerGui Roact.mount(tree, LocalPlayer.PlayerGui, "HelloWorld")

License

Roact is available under the Apache 2.0 license. See LICENSE.txt for details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.