-
-
Notifications
You must be signed in to change notification settings - Fork 601
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add atomWithBroadcast and remove subheadings
- Loading branch information
Showing
8 changed files
with
67 additions
and
19 deletions.
There are no files selected for viewing
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
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
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
6 changes: 2 additions & 4 deletions
6
docs/recipes/atom-with-refresh-default.mdx → docs/recipes/atom-with-default-refresh.mdx
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
title: atomWithRefresh | ||
nav: 8.06 | ||
keywords: creators,refresh | ||
--- | ||
|
||
> `atomWithRefresh` creates a derived atom that can be force-refreshed, by using | ||
> the update function. | ||
This is helpful when you need to refresh asynchronous data after performing a | ||
side effect. | ||
|
||
It can also be used to implement "pull to refresh" functionality. | ||
|
||
```ts | ||
import { atom, Getter } from 'jotai' | ||
|
||
export function atomWithRefresh<T>(fn: (get: Getter) => T) { | ||
const refreshCounter = atom(0) | ||
|
||
return atom( | ||
(get) => { | ||
get(refreshCounter) | ||
return fn(get) | ||
}, | ||
(_, set) => set(refreshCounter, (i) => i + 1) | ||
) | ||
} | ||
``` | ||
|
||
Here's how you'd use it to implement an refresh-able source of data: | ||
|
||
```js | ||
import { atomWithRefresh } from 'XXX' | ||
|
||
const postsAtom = atomWithRefresh((get) => | ||
fetch('https://jsonplaceholder.typicode.com/posts').then((r) => r.json()) | ||
) | ||
``` | ||
|
||
In a component: | ||
|
||
```jsx | ||
const PostsList = () => { | ||
const [posts, refreshPosts] = useAtom(postsAtom) | ||
|
||
return ( | ||
<div> | ||
<ul> | ||
{posts.map((post) => ( | ||
<li key={post.id}>{post.title}</li> | ||
))} | ||
</ul> | ||
|
||
{/* Clicking this button will re-fetch the posts */} | ||
<button type="button" onClick={refreshPosts}> | ||
Refresh posts | ||
</button> | ||
</div> | ||
) | ||
} | ||
``` |
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
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