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.

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

Update docs content #2508

Closed
wants to merge 56 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
9b23d94
Move docs to old docs
dbritto-dev Apr 24, 2024
b92ba68
Add new docs (WIP)
dbritto-dev Apr 24, 2024
e1c081e
Minor changes
dbritto-dev Apr 24, 2024
8828d67
Minor changes
dbritto-dev Apr 24, 2024
54344d1
Minor fixes
dbritto-dev Apr 24, 2024
90c23c0
Minor fixes
dbritto-dev Apr 24, 2024
aafed40
Minor fixes
dbritto-dev Apr 24, 2024
3144ea8
Minor fixes
dbritto-dev Apr 24, 2024
f1a3834
Minor changes
dbritto-dev Apr 24, 2024
aeb7cde
Minor fixes
dbritto-dev Apr 24, 2024
6c07e5f
Minor fixes
dbritto-dev Apr 24, 2024
60846c7
Minor changes
dbritto-dev Apr 25, 2024
7bdf1cc
Minor changes
dbritto-dev Apr 25, 2024
a4ab750
Minor changes
dbritto-dev Apr 25, 2024
1606977
Minor changes
dbritto-dev Apr 25, 2024
df190b9
Minor changes
dbritto-dev Apr 25, 2024
a5ceba7
Minor changes
dbritto-dev Apr 25, 2024
3637fe7
Minor fixes
dbritto-dev Apr 25, 2024
0746ab1
WIP
dbritto-dev Apr 25, 2024
adec185
Minor changes
dbritto-dev Apr 25, 2024
ee07ba5
WIP
dbritto-dev Apr 27, 2024
626e972
Merge branch 'main' of github.com:dbritto-dev/zustand into update-doc…
dbritto-dev Apr 27, 2024
89771e5
WIP
dbritto-dev Apr 28, 2024
72fec5c
WIP
dbritto-dev Apr 30, 2024
b1f84f8
WIP
dbritto-dev Apr 30, 2024
c4322c5
WIP
dbritto-dev Apr 30, 2024
5834bbf
WIP
dbritto-dev May 3, 2024
cdba318
WIP
dbritto-dev May 4, 2024
ac441ae
WIP
dbritto-dev May 6, 2024
aea4a45
WIP
dbritto-dev May 6, 2024
479da65
WIP
dbritto-dev May 9, 2024
135bc69
WIP
dbritto-dev May 16, 2024
17d433d
WIP
dbritto-dev May 31, 2024
c542900
WIP
dbritto-dev May 31, 2024
c3998cb
Update docs/reference/use-shallow.md
dbritto-dev Jun 2, 2024
27d8afd
Update docs/reference/create-with-equality-fn.md
dbritto-dev Jun 2, 2024
3322bea
WIP
dbritto-dev Jun 2, 2024
32d4be1
Merge branch 'main' of github.com:pmndrs/zustand into update-docs-con…
dbritto-dev Jun 2, 2024
6bd2963
Merge branch 'main' of github.com:pmndrs/zustand into update-docs-con…
dbritto-dev Jun 12, 2024
370dfab
WIP
dbritto-dev Jun 12, 2024
fc886f1
WIP
dbritto-dev Jun 13, 2024
e8cfb2d
WIP
dbritto-dev Jul 15, 2024
9daa0b8
WIP
dbritto-dev Jul 16, 2024
57c2ff3
WIP
dbritto-dev Jul 27, 2024
fdbfb0e
WIP
dbritto-dev Jul 27, 2024
ba484ce
Merge branch 'main' of github.com:pmndrs/zustand into update-docs-con…
dbritto-dev Jul 27, 2024
f2d33dd
WIP
dbritto-dev Aug 4, 2024
001f243
Merge branch 'main' of github.com:pmndrs/zustand into update-docs-con…
dbritto-dev Aug 4, 2024
4593bf0
WIP
dbritto-dev Aug 7, 2024
20af30d
Merge branch 'main' of github.com:pmndrs/zustand into update-docs-con…
dbritto-dev Aug 9, 2024
5c748b7
WIP
dbritto-dev Aug 10, 2024
5675bef
WIP
dbritto-dev Aug 14, 2024
5da8d0e
WIP
dbritto-dev Aug 14, 2024
e49b0d0
WIP
dbritto-dev Aug 24, 2024
c8e16b9
WIP
dbritto-dev Aug 25, 2024
d15ea77
Merge branch 'main' of github.com:pmndrs/zustand into update-docs-con…
dbritto-dev Aug 25, 2024
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
5 changes: 5 additions & 0 deletions docs/community/docs-contributors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Docs Contributors
description:
nav: 301
---
64 changes: 64 additions & 0 deletions docs/community/third-party-libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Third-party Libraries
description:
nav: 302
---

Zustand provides bear necessities for state management.
Although it is great for most projects,
some users wish to extend the library's feature set.
This can be done using third-party libraries created by the community.

> [!IMPORTANT]
> These libraries may have bugs, limited maintenance,
> or other limitations, and are not officially recommended
> by pmndrs or the Zustand maintainers.
> This list aims to provide a good starting point
> for someone looking to extend Zustand's feature set.

- [@colorfy-software/zfy](https://colorfy-software.gitbook.io/zfy/) — 🧸 Useful helpers for state management in React with Zustand.
- [@davstack/store](https://www.npmjs.com/package/@davstack/store) — A zustand store factory that auto generates selectors with get/set/use methods, supports inferred types, and makes global / local state management easy.
- [@dhmk/zustand-lens](https://github.com/dhmk083/dhmk-zustand-lens) — Lens support for Zustand.
- [@liveblocks/zustand](https://github.com/liveblocks/liveblocks/tree/main/packages/liveblocks-zustand) — Liveblocks middleware to make your application multiplayer.
- [@prncss-xyz/zustand-optics](https://github.com/prncss-xyz/zustand-optics) — An adapter for [optics-ts](https://github.com/akheron/optics-ts).
- [auto-zustand-selectors-hook](https://github.com/Albert-Gao/auto-zustand-selectors-hook) — Automatic generation of Zustand hooks with Typescript support.
- [derive-zustand](https://github.com/zustandjs/derive-zustand) — A function to create a derived Zustand store from other Zustand stores.
- [geschichte](https://github.com/BowlingX/geschichte) — Zustand and Immer-based hook to manage query parameters.
- [leiten-zustand](https://github.com/hecmatyar/leiten-zustand) — Cleans your store from boilerplate for requests and data transformation.
- [mobz](https://github.com/2A5F/Mobz) — Zustand-style MobX API.
- [ngx-zustand](https://github.com/JoaoPauloLousada/ngx-zustand) - A Zustand adapter for Angular.
- [persist-and-sync](https://github.com/mayank1513/persist-and-sync) - Zustand middleware to easily persist and sync Zustand state between tabs/windows/iframes with same origin.
- [shared-zustand](https://github.com/Tom-Julux/shared-zustand) — Cross-tab state sharing for Zustand.
- [simple-zustand-devtools](https://github.com/beerose/simple-zustand-devtools) — 🐻⚛️ Inspect your Zustand store in React DevTools.
- [solid-zustand](https://github.com/wobsoriano/solid-zustand) — State management in Solid using Zustand.
- [treeshakable](https://github.com/react18-tools/treeshakable) — A wrapper for library creators to avoid redundant store creation.
- [use-broadcast-ts](https://github.com/Romainlg29/use-broadcast) — Zustand middleware to share state between tabs.
- [use-zustand](https://github.com/zustandjs/use-zustand) — Another custom hook to use Zustand vanilla store.
- [vue-zustand](https://github.com/wobsoriano/vue-zustand) — State management solution for Vue based on Zustand.
- [zoov](https://github.com/InfiniteXyy/zoov) — State management solution based on Zustand with Module-like API.
- [zukeeper](https://github.com/oslabs-beta/Zukeeper) - Native devtools with state and action tracking, diffing, tree display, and time travel
- [zundo](https://github.com/charkour/zundo) — 🍜 Undo and redo middleware for Zustand, enabling time-travel in your apps.
- [zustand-ards](https://github.com/ivoilic/zustand-ards) - 💁 Simple opinionated utilities for example alternative selector formats and default shallow hooks
- [zustand-computed](https://github.com/chrisvander/zustand-computed) — A Zustand middleware to create computed states.
- [zustand-computed-state](https://github.com/yasintz/zustand-computed-state) — Simple middleware to add computed states.
- [zustand-constate](https://github.com/ntvinhit/zustand-constate) — Context-based state management based on Zustand and taking ideas from Constate.
- [zustand-context](https://github.com/fredericoo/zustand-context) — Create a zustand store in React Context, containing an initial value, or use it in your components with isolated, mockable instances.
- [zustand-di](https://github.com/charkour/zustand-di) - use react props to init zustand stores
- [zustand-forms](https://github.com/Conduct/zustand-forms) — Fast, type safe form states as Zustand stores.
- [zustand-interval-persist](https://www.npmjs.com/package/zustand-interval-persist) — An enhancement for zustand that enables automatic saving of the store's state to the specified storage at regular interval.
- [zustand-middleware-computed-state](https://github.com/cmlarsen/zustand-middleware-computed-state) — A dead simple middleware for adding computed state to Zustand.
- [zustand-middleware-xstate](https://github.com/biowaffeln/zustand-middleware-xstate) — A middleware for putting XState state machines into a global Zustand store.
- [zustand-middleware-yjs](https://github.com/joebobmiles/zustand-middleware-yjs) — A middleware for synchronizing Zustand stores with Yjs.
- [zustand-persist](https://github.com/roadmanfong/zustand-persist) — A middleware for persisting and rehydrating state.
- [zustand-pub](https://github.com/AwesomeDevin/zustand-pub) - Cross-Application/Cross-Framework State Management And Sharing based on zustand and zustand-vue for React/Vue.
- [zustand-querystring](https://github.com/nitedani/zustand-querystring) — A Zustand middleware that syncs the store with the querystring.
- [zustand-rx](https://github.com/patdx/zustand-rx) — A Zustand middleware enabling you to subscribe to a store as an RxJS Observable.
- [zustand-saga](https://github.com/Nowsta/zustand-saga) — A Zustand middleware for redux-saga (minus redux).
- [zustand-slices](https://github.com/zustandjs/zustand-slices) — A slice utility for Zustand.
- [zustand-store-addons](https://github.com/Diablow/zustand-store-addons) — React state management addons for Zustand.
- [zustand-sync-tabs](https://github.com/mayank1513/zustand-sync-tabs) — Zustand middleware to easily sync Zustand state between tabs/windows/iframes with same origin.
- [zustand-vue](https://github.com/AwesomeDevin/zustand-vue) - State management for vue (Vue3 / Vue2) based on zustand.
- [zustand-yjs](https://github.com/tandem-pt/zustand-yjs) — Zustand stores for Yjs structures.
- [zusteller](https://github.com/timkindberg/zusteller) — Your global state savior. "Just hooks" + Zustand.
- [zustood](https://github.com/udecode/zustood) — 🐻‍❄️ A modular store factory using Zustand.
- [zusty](https://github.com/oslabs-beta/Zusty) - Zustand tool to assist debugging with time travel, action logs, state snapshots, store view, render time metrics and state component tree.
5 changes: 5 additions & 0 deletions docs/community/versioning-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Versioning Policy
description:
nav: 303
---
5 changes: 5 additions & 0 deletions docs/community/zustand-videos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Zustand Videos
description:
nav: 300
---
5 changes: 5 additions & 0 deletions docs/learn/async-data-and-data-fetching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Async Data and Data Fetching
description:
nav: 106
---
5 changes: 5 additions & 0 deletions docs/learn/choosing-the-state-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Choosing the State Structure
description: One store, multiple stores, and multiple slices
nav: 104
---
5 changes: 5 additions & 0 deletions docs/learn/colocation-actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Colocating Actions
description:
nav: 105
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Extracting State Logic into a Reducer with Redux and Devtools Middlewares
description:
nav: 112
---
5 changes: 5 additions & 0 deletions docs/learn/isolating-state-between-components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Isolating State Between Components
description:
nav: 108
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Listening to Selected Data with SubscribeWithSelector Middleware
description:
nav: 113
---
5 changes: 5 additions & 0 deletions docs/learn/middleware-use-cases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Middleware Use Cases
description:
nav: 114
---
Loading