Git Product home page Git Product logo

mara's Introduction

mara

WARNING: This project has been discontinued. Do not use for new work.


Mara is a lightweight state container that allows you to write simple code to manage state in Roblox. It is inspired by Reflex and Valtio.

๐Ÿ“ฆ Installation

You can install Mara on Wally.

Alternatively, you can check out the latest GitHub Release to download the .rbxm file.

โšก๏ธ Quick Start

Take me to the documentation โ†’

๐Ÿ“ƒ Create Documents

Mara uses documents, containers that hold state.

local Mara = require(ReplicatedStorage.Packages.Mara)

local createDocument = Mara.createDocument

type Document<Contents> = Mara.Document<Contents>

type Contents = {
    a: number,
    b: boolean
}

local document = createDocument({
    a = 0,
    b = false
}) :: Document<Contents>

๐ŸŒŽ Use your documents anywhere

Mara was designed to make managing state simple and straightforward. Make edits to your document, and watch for changes!

local watch = Mara.watch

local function selectA(contents: Contents)
    return contents.a
end

watch(document, selectA, function(a: number)
    print(a)
end)

document:edit(function(contents: Contents)
    contents.a += 1
end)

๐Ÿ“ License

This project is under the MIT license.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.