Skip to content
This repository was archived by the owner on Oct 11, 2020. It is now read-only.

Fix: transactions are described as actions, which is confusing #69

Open
madeofsun wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: transactions are described as actions, which is confusing #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/state/local.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ useLocalStore<T, S>(initializer: () => T, source?: S): T

Local observable state can be introduced by using the `useLocalStore` hook, that runs its initializer function once to create an observable store and keeps it around for a lifetime of a component.

All properties of the returned object will be made observable automatically, getters will be turned into computed properties, and methods will be bound to the store and apply [mobx transactions][actions] automatically. If new class instances are returned from the initializer, they will be kept as is.
All properties of the returned object will be made observable automatically, getters will be turned into computed properties, and methods will be bound to the store and apply [mobx transactions][transactions] automatically. If new class instances are returned from the initializer, they will be kept as is.

> Note that using a local store might conflict with future React features like concurrent rendering.

> Note that transactions are not [actions][actions]. It is still needed to be [explicit about actions][useLocalStore and strict mode issue], if strict mode of mobx is used.

import { SmartTodo } from '../examples/SmartTodo'

```tsx
Expand Down Expand Up @@ -103,4 +105,6 @@ Note that internally the `useAsObservableSource` hook is used to wrap around pas

[decorators]: https://mobx.js.org/refguide/observable-decorator.html
[actions]: https://mobx.js.org/refguide/action.html
[transactions]: https://doc.ebichu.cc/mobx/refguide/transaction.html
[useLocalStore and strict mode issue]: https://github.com/mobxjs/mobx-react-lite/issues/235#issuecomment-549138533
[mobx-state-tree]: https://github.com/mobxjs/mobx-state-tree