docs: update atom.mdx
#2271
Merged
docs: update atom.mdx
#2271
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 2dbd013:
|
himself65
commented
Nov 25, 2023
| ``` | ||
|
|
||
| - `initialValue`: the initial value that the atom will return until its value is changed. | ||
| - `read`: a function that's called on every re-render. The signature of `read` is `(get) => Value | Promise<Value>`, and `get` is a function that takes an atom config and returns its value stored in Provider as described below. Dependency is tracked, so if `get` is used for an atom at least once, the `read` will be reevaluated whenever the atom value is changed. |
There was a problem hiding this comment.
called on every re-render is incorrect. Atom's read will be only called once if it's a pure function like atom(() => 1).
himself65
commented
Nov 25, 2023
| // however, in the following cases, | ||
| // `onMount` will not be called because the atom is not subscribed: | ||
| useSetAtom(anAtom) | ||
| useAtomCallback( |
dai-shi
approved these changes
Nov 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issues or Discussions
Fixes #2268
Summary
Check List
yarn run prettierfor formatting code and docs