mirror of
https://github.com/centau/vide.git
synced 2026-08-20 14:41:37 +00:00
Fix mistakes in docs
This commit is contained in:
parent
baf308ccf3
commit
bacb4fa0f0
8 changed files with 12 additions and 18 deletions
|
|
@ -57,7 +57,7 @@ as a guard against unintentional rerendering of UI.
|
|||
|
||||
## Recreating [`switch()`](/api/reactivity-dynamic#switch-reactive)
|
||||
|
||||
```lua
|
||||
```luau
|
||||
local function switch(key)
|
||||
return function(map)
|
||||
return derive(function()
|
||||
|
|
@ -76,7 +76,7 @@ between reruns, we cannot use `untrack()` anymore which automatically destroys
|
|||
on rerun; we must use `root()` where the lifetime of each scope is managed
|
||||
manually and independently.
|
||||
|
||||
```lua
|
||||
```luau
|
||||
local function indexes<I, VI, VO>(
|
||||
input: () -> Map<I, VI>,
|
||||
transform: (value: () -> VI, index: I) -> VO
|
||||
|
|
@ -26,9 +26,9 @@ local source = vide.source
|
|||
local effect = vide.effect
|
||||
local cleanup = vide.cleanup
|
||||
|
||||
local function changed(prop: string, callback: (new) -> ())
|
||||
local function changed(property: string, callback: (new) -> ())
|
||||
return action(function(instance)
|
||||
local connection = instance:GetPropertyChangedSignal(prop):Connect(function()
|
||||
local connection = instance:GetPropertyChangedSignal(property):Connect(function()
|
||||
callback(instance[property])
|
||||
end)
|
||||
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ local count = source(0)
|
|||
|
||||
root(function()
|
||||
local text = derive(function()
|
||||
return "count: " .. text()
|
||||
return "count: " .. count()
|
||||
end)
|
||||
|
||||
effect(function()
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ effects depending on it.
|
|||
|
||||
You can also read from a source within an effect without the effect tracking it.
|
||||
|
||||
```lua
|
||||
```luau
|
||||
local source = vide.source
|
||||
local effect = vide.effect
|
||||
local untrack = vide.untrack
|
||||
|
|
|
|||
|
|
@ -35,8 +35,6 @@ local function setup()
|
|||
effect(function()
|
||||
print(count())
|
||||
end)
|
||||
|
||||
return count
|
||||
end
|
||||
|
||||
setup() -- error, effect() tried to create a reactive scope with no stable scope
|
||||
|
|
|
|||
|
|
@ -34,14 +34,10 @@ count source is created inside the component.
|
|||
External sources can also be passed into components for them to use.
|
||||
|
||||
```luau
|
||||
local function Counter(props: { count: () -> number })
|
||||
local function CountDisplay(props: { count: () -> number })
|
||||
local count = props.count
|
||||
|
||||
local instance = create "TextButton" {
|
||||
Activated = function()
|
||||
count(count() + 1)
|
||||
end
|
||||
}
|
||||
local instance = create "TextLabel" {}
|
||||
|
||||
effect(function()
|
||||
instance.Text = "count: " .. count()
|
||||
|
|
@ -52,11 +48,11 @@ end
|
|||
|
||||
local count = source(0)
|
||||
|
||||
Counter {
|
||||
CountDisplay {
|
||||
count = count
|
||||
}
|
||||
|
||||
count(1) -- the Counter component will update to display this 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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue