docs: migrate Codesandbox embed for next.js swc example to Stackblitz #2773

niklasbec · 2024-10-16T10:46:38Z

Summary

Moves the code examples from Codesandbox to Stackblitz .
https://stackblitz.com/orgs/custom/Jotai/projects (Team access needed to view the whole collection).
Added disclaimer to Persistence 1 Example because I wasn't sure at first what I had to do and other users might be confused as well.
Same disclaimer for the second example.
Jotai example atomWithBroadcast had a bug in the broadcast mount function which broke the example (fixed it).

Issues in code examples

For trpc the example is broken because the pokemon api is offline, do we know the dev who built it do you have a replacement api in mind I can use so we don't run into the same issue again?
The swc example doesn't work because Stackblitz struggles with swc's, if you clone the Stackblitz it works @dai-shi suggested adding a disclaimer.
Didn't manage to get Relay working => https://stackblitz.com/edit/vitejs-vite-divyhe
I didn't move the Babel and Parcel example to StackBlitz, I have no clue about either and how they intergrate with StackBlitz.

Check List

pnpm run prettier for formatting code and docs

vercel · 2024-10-16T10:46:44Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
jotai	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 9:36pm

codesandbox-ci · 2024-10-16T10:47:12Z

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.

dai-shi · 2024-10-16T11:25:12Z

Hi, thanks for working on this.
Are you able to run codesandbox one? I just tried and I can't.

https://stackblitz.com/edit/stackblitz-starters-ha5txx?file=app%2Fpage.tsx

Running it, it shows undefined: 1 in the console log. Can you confirm?

I think it should show countAtom: 1. Maybe we need to update packages?

niklasbec · 2024-10-16T11:31:13Z

Hi, thanks for working on this. Are you able to run codesandbox one? I just tried and I can't.

https://stackblitz.com/edit/stackblitz-starters-ha5txx?file=app%2Fpage.tsx

Running it, it shows undefined: 1 in the console log. Can you confirm?

I think it should show countAtom: 1. Maybe we need to update packages?

Hi, my pleasure. I will see if I can fix this.

niklasbec · 2024-10-16T12:25:40Z

@dai-shi there used to be problems with swcs on earlier next versions, but pulling that up doesn't fix it. I cloned the stackblitz and ran it locally without issues so I am relatively confident this is an issue with stackblitz handling swcs.

I will see if I can do anything about it later, and will replace the code examples running on codesandbox that don't use swcs.

dai-shi · 2024-10-16T14:42:55Z

I cloned the stackblitz and ran it locally without issues

That's at least good to know.

If you don't find a solution, we can probably merge this if you add a note somewhere saying it has to be downloaded to use.

…kblitz Feat/migrate codesandbox to stackblitz

niklasbec · 2024-10-18T21:37:17Z

I cloned the stackblitz and ran it locally without issues

That's at least good to know.

If you don't find a solution, we can probably merge this if you add a note somewhere saying it has to be downloaded to use.

Please see my updated comment :)

dai-shi

wow, this great. let's merge it and see how it goes.

github-actions · 2024-10-18T23:58:43Z

Preview in LiveCodes

Latest commit: 8c18495
Last updated: Oct 18, 2024 9:35pm (UTC)

Playground	Link
React demo	https://livecodes.io?x=id/6HX2BM3QJ

See documentations for usage instructions.

dai-shi · 2024-10-19T00:03:58Z

Thanks for your contribution! Feel free to improve docs more.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [jotai](https://github.com/pmndrs/jotai) | dependencies | minor | [`2.9.3` -> `2.11.0`](https://renovatebot.com/diffs/npm/jotai/2.9.3/2.11.0) | --- ### Release Notes <details> <summary>pmndrs/jotai (jotai)</summary> ### [`v2.11.0`](https://github.com/pmndrs/jotai/releases/tag/v2.11.0) [Compare Source](pmndrs/jotai@v2.10.4...v2.11.0) There are no public API changes, but some internal behaviors have been improved. Now, atom updates are batched in a single write, which might provide a performance benefit in certain edge cases. This feature has been requested actually for a long time, and it's finally implemented. See also [#2782](pmndrs/jotai#2782). #### What's Changed - refactor(store): rename pending to batch by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2868 - lazy recomputeDependents by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2827 - fix(store): robust flush batch by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2871 - fix(store): refactor batch priority by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2875 - feat: dev store with unstable_derive by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2852 #### New Contributors - [@rainagalbiati-turngate](https://github.com/rainagalbiati-turngate) made their first contribution in pmndrs/jotai#2882 - [@leweyse](https://github.com/leweyse) made their first contribution in pmndrs/jotai#2883 **Full Changelog**: pmndrs/jotai@v2.10.4...v2.11.0 ### [`v2.10.4`](https://github.com/pmndrs/jotai/releases/tag/v2.10.4) [Compare Source](pmndrs/jotai@v2.10.3...v2.10.4) A minor improvement for some edge cases. (For more information, see [#2789](pmndrs/jotai#2789).) #### What's Changed - fix(store): do not recompute unmounted atoms eagerly by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2849 #### New Contributors - [@rmillio](https://github.com/rmillio) made their first contribution in pmndrs/jotai#2832 - [@sukvvon](https://github.com/sukvvon) made their first contribution in pmndrs/jotai#2851 **Full Changelog**: pmndrs/jotai@v2.10.3...v2.10.4 ### [`v2.10.3`](https://github.com/pmndrs/jotai/releases/tag/v2.10.3) [Compare Source](pmndrs/jotai@v2.10.2...v2.10.3) This fixes various edge cases. Huge thanks to [@dmaskasky](https://github.com/dmaskasky) ! 🎉 #### What's Changed - fix: flushPending in async write by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2804 - fix: flush pending finally everywhere by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2818 - fix: rethrow falsy errors thrown in flushPending by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2820 - fix: setAtom uses stale pending on atom unmount by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2811 - fix: onMount setSelf does not notify listeners by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2815 - refactor(core): Use iterative approach in recompute dependents by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2821 - refactor(store): prefer epoch number comparisons to indicate value change by [@dmaskasky](https://github.com/dmaskasky) in pmndrs/jotai#2828 **Full Changelog**: pmndrs/jotai@v2.10.2...v2.10.3 ### [`v2.10.2`](https://github.com/pmndrs/jotai/releases/tag/v2.10.2) [Compare Source](pmndrs/jotai@v2.10.1...v2.10.2) Fixed some jotai/utils for a regression in v2.10.0. #### What's Changed - fix(unstable_derive): trap atom methods by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2741 - Throw error on `useAtom(undefined)` or `useAtom(null)` by [@kevinschaich](https://github.com/kevinschaich) in pmndrs/jotai#2778 - fix(utils): make 'loadable' update immediate after resolve by [@e7h4n](https://github.com/e7h4n) in pmndrs/jotai#2790 - fix(utils): make 'unwrap' update immediate after resolve by [@organize](https://github.com/organize) in pmndrs/jotai#2794 #### New Contributors - [@niklasbec](https://github.com/niklasbec) made their first contribution in pmndrs/jotai#2773 - [@romain-trotard](https://github.com/romain-trotard) made their first contribution in pmndrs/jotai#2781 - [@kretajak](https://github.com/kretajak) made their first contribution in pmndrs/jotai#2786 - [@Brokyeom](https://github.com/Brokyeom) made their first contribution in pmndrs/jotai#2798 - [@ryoku4](https://github.com/ryoku4) made their first contribution in pmndrs/jotai#2802 - [@yairEO](https://github.com/yairEO) made their first contribution in pmndrs/jotai#2805 - [@kevinschaich](https://github.com/kevinschaich) made their first contribution in pmndrs/jotai#2778 - [@e7h4n](https://github.com/e7h4n) made their first contribution in pmndrs/jotai#2790 - [@organize](https://github.com/organize) made their first contribution in pmndrs/jotai#2794 **Full Changelog**: pmndrs/jotai@v2.10.1...v2.10.2 ### [`v2.10.1`](https://github.com/pmndrs/jotai/releases/tag/v2.10.1) [Compare Source](pmndrs/jotai@v2.10.0...v2.10.1) This fixes a bug in an extreme edge case. If you find this change breaks something, please report to us. #### What's Changed - fix(core): recompute dependents in edge cases by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2742 #### New Contributors - [@vangie](https://github.com/vangie) made their first contribution in pmndrs/jotai#2753 - [@ts1994tw](https://github.com/ts1994tw) made their first contribution in pmndrs/jotai#2759 - [@KagamiChan](https://github.com/KagamiChan) made their first contribution in pmndrs/jotai#2761 - [@nguyenbry](https://github.com/nguyenbry) made their first contribution in pmndrs/jotai#2762 - [@jaycho46](https://github.com/jaycho46) made their first contribution in pmndrs/jotai#2766 - [@midzdotdev](https://github.com/midzdotdev) made their first contribution in pmndrs/jotai#2767 **Full Changelog**: pmndrs/jotai@v2.10.0...v2.10.1 ### [`v2.10.0`](https://github.com/pmndrs/jotai/releases/tag/v2.10.0) [Compare Source](pmndrs/jotai@v2.9.3...v2.10.0) It comes with another significant internal change to address some edge cases. Since v2.9.0, we've been working on some internal refactors to support more edge cases and clean up the code. Users are encouraged to update to the new versions eventually, but if you're satisfied with the current situation and prefer to avoid temporary instability, you can stick with v2.8.4 for now. #### What's Changed - breaking(core): avoid continuable promise in store api by [@dai-shi](https://github.com/dai-shi) in pmndrs/jotai#2695 #### New Contributors - [@sphinxrave](https://github.com/sphinxrave) made their first contribution in pmndrs/jotai#2653 - [@mxthxngx](https://github.com/mxthxngx) made their first contribution in pmndrs/jotai#2712 - [@hoangvu12](https://github.com/hoangvu12) made their first contribution in pmndrs/jotai#2716 - [@YuHyeonWook](https://github.com/YuHyeonWook) made their first contribution in pmndrs/jotai#2734 **Full Changelog**: pmndrs/jotai@v2.9.3...v2.10.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/380 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>

docs: migrate Codesandbox embed for next.js swc example to Stackblitz

839eccd

vercel bot deployed to Preview October 16, 2024 10:47 View deployment

niklasbec and others added 3 commits October 18, 2024 23:16

docs: moved all code samples to stackblitz except 2

2919281

fix: prettier

dd2d21d

Merge pull request #1 from niklasbec/feat/migrate-codesandbox-to-stac…

8c18495

…kblitz Feat/migrate codesandbox to stackblitz

vercel bot deployed to Preview October 18, 2024 21:36 View deployment

dai-shi approved these changes Oct 18, 2024

View reviewed changes

dai-shi merged commit 00f5e27 into pmndrs:main Oct 19, 2024
39 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: migrate Codesandbox embed for next.js swc example to Stackblitz #2773

docs: migrate Codesandbox embed for next.js swc example to Stackblitz #2773

niklasbec commented Oct 16, 2024 •

edited

Loading

vercel bot commented Oct 16, 2024 •

edited

Loading

codesandbox-ci bot commented Oct 16, 2024 •

edited

Loading

dai-shi commented Oct 16, 2024

niklasbec commented Oct 16, 2024 •

edited

Loading

niklasbec commented Oct 16, 2024 •

edited

Loading

dai-shi commented Oct 16, 2024

niklasbec commented Oct 18, 2024

dai-shi left a comment

github-actions bot commented Oct 18, 2024

dai-shi commented Oct 19, 2024

docs: migrate Codesandbox embed for next.js swc example to Stackblitz #2773

docs: migrate Codesandbox embed for next.js swc example to Stackblitz #2773

Conversation

niklasbec commented Oct 16, 2024 • edited Loading

Summary

Issues in code examples

Check List

vercel bot commented Oct 16, 2024 • edited Loading

codesandbox-ci bot commented Oct 16, 2024 • edited Loading

dai-shi commented Oct 16, 2024

niklasbec commented Oct 16, 2024 • edited Loading

niklasbec commented Oct 16, 2024 • edited Loading

dai-shi commented Oct 16, 2024

niklasbec commented Oct 18, 2024

dai-shi left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 18, 2024

Preview in LiveCodes

dai-shi commented Oct 19, 2024

niklasbec commented Oct 16, 2024 •

edited

Loading

vercel bot commented Oct 16, 2024 •

edited

Loading

codesandbox-ci bot commented Oct 16, 2024 •

edited

Loading

niklasbec commented Oct 16, 2024 •

edited

Loading

niklasbec commented Oct 16, 2024 •

edited

Loading