Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix atomWithBroadcast description #2106

Merged
merged 2 commits into from
Sep 4, 2023
Merged

docs: fix atomWithBroadcast description #2106

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5115b8
fix atomWithBroadcast description
AjaxSolutions Aug 31, 2023
b8c2372
Merge branch 'main' into broadcast-channel
AjaxSolutions Sep 2, 2023
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
7 changes: 3 additions & 4 deletions docs/recipes/atom-with-broadcast.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ keywords: creators,broadcast
> browser tabs and frames, similar to `atomWithStorage` but with the
> initialization limitation.

This can be useful when you want the state to interact with each other without
the use of localStorage and that by just using The Broadcast Channel API allows
basic communication between browsing contexts (that is, windows, tabs, frames,
create a component or iframes) and workers on the same origin. According to the MDN documentation receiving a message in initialization is not supported in broadcast and if we want to support that we may need to add extra stuff to atomWithBroadcast (like local storage).
This can be useful when you want states to interact with each other without the use of localStorage.
By using the BroadcastChannel API, you can enable basic communication between browsing contexts such as windows, tabs, frames, components, or iframes, and workers on the same origin.
According to the MDN documentation, receiving a message during initialization is not supported in the BroadcastChannel, but if you want to support that functionality, you may need to add extra option to atomWithBroadcast, such as local storage.

```tsx
import { atom } from 'jotai'
Expand Down
Loading