hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-22 21:01:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix typo

Browse source
This commit is contained in:
Richard 2024-10-25 19:40:58 -07:00
parent 0284848f92
commit 4ea1e49e4f
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -218,12 +218,12 @@ Call `observe` to create an instance of `factory` for each key present in a dict
> Because `observe` tracks the lifetime of each key in your data, your keys must be unique and unchanging. If your data is not keyed by unique and stable identifiers, consider using [`mapped`](#mappedcallback-mapper) to transform it into a keyed object before passing it to `observe`. > Because `observe` tracks the lifetime of each key in your data, your keys must be unique and unchanging. If your data is not keyed by unique and stable identifiers, consider using [`mapped`](#mappedcallback-mapper) to transform it into a keyed object before passing it to `observe`.
```luau ```luau
local todosAtom: Atom<{ [string]: string }> = atom({}) local todosAtom: Atom<{ [string]: Todo }> = atom({})
observe(todosAtom, function(todo, key) observe(todosAtom, function(todo, key)
print(`Added {todo}`) print(`Added {key}: {todo.name}`)
return function() return function()
print(`Removed {todo}`) print(`Removed {key}`)
end end
end) end)
``` ```
@ -343,10 +343,10 @@ Call `useAtom` at the top-level of a React component to read from an atom or sel
```luau ```luau
local todosAtom = require(script.Parent.todosAtom) local todosAtom = require(script.Parent.todosAtom)
local function Todos() { local function Todos()
local todos = useAtom(todosAtom) local todos = useAtom(todosAtom)
-- ... -- ...
} end
``` ```
If your selector depends on the component's state or props, remember to pass them in a dependency array. This prevents skipped updates when an untracked parameter of the selector changes. If your selector depends on the component's state or props, remember to pass them in a dependency array. This prevents skipped updates when an untracked parameter of the selector changes.