vide/docs/index.md
2024-10-28 20:08:31 +01:00

1.6 KiB

layout next hero features
home
text link
Introduction /tut/crash-course/1-introduction
name text tagline image actions
Vide A reactive UI and state library for Luau.
src alt
/logo.svg Vide
theme text link
brand Quick Start /tut/crash-course/1-introduction
theme text link
alt API Reference /api/reactivity-core
title details
Reactively driven Powerful and modern primitives inspired by SolidJS to build fluid UI with little friction
title details
Declarative and concise Syntax built to be minimal and clean while also obvious and easy to understand to anyone
title details
Fully Luau Typecheckable Ensure you write correct and robust code through the Luau typechecking engine.

Installation

Vide can be installed through 3 different ways.

:::tabs == Wally

Add the following line to your wally.toml and then re-install your packages

[dependencies]
vide = centau/vide@0.3.1

== Roblox

im so sorry you have to use rojo and build it yourself or ask someone in ross to build a vide rbxm for you 😭 cen is too busy working on system verilog

:::

Quick Examples

A simple counter element that counts up when you click on it.

local vide = require("vide")

local source = vide.source
local create = vide.create

local function Counter()
	local count = source(0)

	return create "TextButton" {
    Size = UDim2.fromOffset(200, 50),
		Text = function()
			return `count: {count()}`
		end,

		Activated = function()
			count(count() + 1)
		end
	}
end

return Counter