docs: add useSetAtom docs #1104
Conversation
|
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 dd4bf9e:
|
There was a problem hiding this comment.
Thanks for working on improving docs!
A few requests for changes:
useSetAtomis not injotai/utilsso it shouldn't be in utils.mdx or utils folder.- It should be in core.mdx, but we need to restructure them to split "Basic APIs" and "Additional APIs" See [RFC] useAtomValue and useSetAtom APIs in core #885. This might sound out of the scope of this PR, but we need the restructure anyway. Sorry, it hasn't be done yet.
useUpdateAtomdocs should be updated sayinguseSetAtomis available. Same foruseAtomValuein utils. This can be a separate PR.
|
Hello ! I've made some of the changes you suggested and they seem to work. |
docs/api/basic.mdx
Outdated
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| title: Core | |||
| title: Basic | |||
There was a problem hiding this comment.
Can we keep core.mdx, and have two sections "Basic APIs" and "Additional APIs" in it?
docs/utils/use-update-atom.mdx
Outdated
| @@ -4,6 +4,8 @@ title: useUpdateAtom | |||
|
|
|||
| Ref: https://github.com/pmndrs/jotai/issues/26 | |||
|
|
|||
| For newer versions of Jotai it's highly recomended to use [`useSetAtom`](/docs/api/additional.mdx#use-set-atom) instead. | |||
There was a problem hiding this comment.
It's not that "highly". In v1, we keep exporting useUpdateAtom from jotai/utils.
There was a problem hiding this comment.
Alright, makes sense. Done.
Implements docs for
useSetAtom.Closes #1019