update docs

This commit is contained in:
Joe 2026-02-09 21:47:49 -06:00
parent 0b1e8c89dc
commit 7b73720143
586 changed files with 5616 additions and 1325 deletions

View file

@ -0,0 +1,60 @@
# Reactive Components
Reactive components in Vide are created using sources and effects - sources to
store the data, and effects to display the data.
```luau
local create = vide.create
local source = vide.source
local effect = vide.effect
local function Counter()
local count = source(0)
local instance = create "TextButton" {
Activated = function()
count(count() + 1)
end
}
effect(function()
instance.Text = "count: " .. count()
end)
return instance
end
```
Above is an example of a counter component, that when clicked, will increment
its internal count, and automatically update its text to reflect that count.
Each instance of `Counter()` will maintain its own independent count, since the
count source is created inside the component.
External sources can also be passed into components for them to use.
```luau
local function CountDisplay(props: { count: () -> number })
local count = props.count
local instance = create "TextLabel" {}
effect(function()
instance.Text = "count: " .. count()
end)
return instance
end
local count = source(0)
CountDisplay {
count = count
}
count(1) -- the CountDisplay component will update to display this count
```
Sources can be created internally or passed in from externally, there are no
restrictions on how they are used as long as the effect using it is created
within a stable scope.