pmndrs · dbritto-dev · Apr 24, 2024 · Apr 24, 2024 · Apr 24, 2024 · Apr 24, 2024
diff --git a/docs/community/docs-contributors.md b/docs/community/docs-contributors.md
@@ -0,0 +1,5 @@
+---
+title: Docs Contributors
+description:
+nav: 301
+---
diff --git a/docs/community/third-party-libraries.md b/docs/community/third-party-libraries.md
@@ -0,0 +1,5 @@
+---
+title: Third-party Libraries
+description:
+nav: 302
+---
diff --git a/docs/community/versioning-policy.md b/docs/community/versioning-policy.md
@@ -0,0 +1,5 @@
+---
+title: Versioning Policy
+description:
+nav: 303
+---
diff --git a/docs/community/zustand-videos.md b/docs/community/zustand-videos.md
@@ -0,0 +1,5 @@
+---
+title: Zustand Videos
+description:
+nav: 300
+---
diff --git a/docs/learn/async-data-and-data-fetching.md b/docs/learn/async-data-and-data-fetching.md
@@ -0,0 +1,5 @@
+---
+title: Async Data and Data Fetching
+description:
+nav: 106
+---
diff --git a/docs/learn/choosing-the-state-structure.md b/docs/learn/choosing-the-state-structure.md
@@ -0,0 +1,5 @@
+---
+title: Choosing the State Structure
+description: One store, multiple stores, and multiple slices
+nav: 104
+---
diff --git a/docs/learn/colocation-actions.md b/docs/learn/colocation-actions.md
@@ -0,0 +1,5 @@
+---
+title: Colocating Actions
+description:
+nav: 105
+---
diff --git a/...rn/extracting-state-logic-into-a-reducer-with-redux-and-devtools-middlewares.md b/...rn/extracting-state-logic-into-a-reducer-with-redux-and-devtools-middlewares.md
@@ -0,0 +1,5 @@
+---
+title: Extracting State Logic into a Reducer with Redux and Devtools Middlewares
+description:
+nav: 112
+---
diff --git a/docs/learn/isolating-state-between-components.md b/docs/learn/isolating-state-between-components.md
@@ -0,0 +1,5 @@
+---
+title: Isolating State Between Components
+description:
+nav: 108
+---
diff --git a/docs/learn/listening-to-selected-data-with-subscribe-with-selector-middleware.md b/docs/learn/listening-to-selected-data-with-subscribe-with-selector-middleware.md
@@ -0,0 +1,5 @@
+---
+title: Listening to Selected Data with SubscribeWithSelector Middleware
+description:
+nav: 113
+---
diff --git a/docs/learn/middleware-use-cases.md b/docs/learn/middleware-use-cases.md
@@ -0,0 +1,5 @@
+---
+title: Middleware Use Cases
+description:
+nav: 114
+---
diff --git a/docs/learn/nextjs.md b/docs/learn/nextjs.md
diff --git a/docs/learn/persisting-state-with-persist-middleware.md b/docs/learn/persisting-state-with-persist-middleware.md
@@ -0,0 +1,5 @@
+---
+title: Persisting State with Persist Middleware
+description:
+nav: 111
+---
diff --git a/...electing-data-and-preventing-re-renders-with-selectors-and-equality-function.md b/...electing-data-and-preventing-re-renders-with-selectors-and-equality-function.md
@@ -0,0 +1,5 @@
+---
+title: Selecting Data and Preventing Re-renders with selectors and equality function
+description:
+nav: 107
+---
diff --git a/docs/learn/start-new-project.md b/docs/learn/start-new-project.md
@@ -0,0 +1,5 @@
+---
+title: Start a new project
+description: Vanilla, React, and React Native
+nav: 102
+---
diff --git a/docs/learn/testing.md b/docs/learn/testing.md
diff --git a/docs/learn/thinking-in-zustand.md b/docs/learn/thinking-in-zustand.md
@@ -0,0 +1,5 @@
+---
+title: Thinking in Zustand
+description: Motivation, principles, and glossary
+nav: 101
+---
diff --git a/docs/learn/tutorial-tic-tac-toe.md b/docs/learn/tutorial-tic-tac-toe.md
@@ -0,0 +1,5 @@
+---
+title: 'Tutorial: Tic-Tac-Toe'
+description:
+nav: 100
+---
diff --git a/docs/learn/using-middlewares.md b/docs/learn/using-middlewares.md
@@ -0,0 +1,5 @@
+---
+title: Using Middlewares
+description:
+nav: 109
+---
diff --git a/docs/learn/using-typescript.md b/docs/learn/using-typescript.md
@@ -0,0 +1,5 @@
+---
+title: Using TypeScript
+description:
+nav: 103
+---
diff --git a/docs/learn/writing-immutable-update-with-immer-middleware.md b/docs/learn/writing-immutable-update-with-immer-middleware.md
@@ -0,0 +1,5 @@
+---
+title: Writing Immutable Updates with Immer Middleware
+description:
+nav: 110
+---
diff --git a/docs/reference/combine.md b/docs/reference/combine.md
@@ -0,0 +1,101 @@
+---
+title: combine
+description:
+nav: 200
+---
+
+# combine
+
+`combine` middleware lets you create a new state by combining an initial state with additional
+state created by a function. This middleware is particularly useful due to infers the state, so you
+don't need to type it.
+
+```js
+combine(initialState, additionalStateCreator)
+```
+
+- [Reference](#reference)
+  - [Signature](#combine-signature)
+  - [`setState` function](#setstate-function)
+  - [`getState` function](#getstate-function)
+  - [`subscribe` function](#subscribe-function)
+  - [`storeApi`](#storeapi)
+- [Usage](#usage)
+  - TBD
+- [Troubleshooting](#troubleshooting)
+  - TBD
+
+## Reference
+
+### `combine` Signature
+
+```ts
+combine<T, U>(initialState: T, additionalStateCreator: StateCreator<T, [], [], U>): Omit<T, keyof U> & U
+```
+
+#### Parameters
+
+- `initialState`: The value you want the state to be initially. It can be a value of any type,
+  except a function.
+- `additionalStateCreator`: A function that should take [`setState` function](#setstate-function),
+  [`getState` function](#getstate-function) and [`storeApi`](#storeapi) as arguments. It should
+  return an additional state based on the initial state.
+
+#### Returns
+
+`combine` returns a new state that is the result of merging the initial state and the additional
+state.
+
+### `setState` function
+
+The `setState` function lets you update the state to a different value and trigger re-render. You
+can pass the next state directly, a next partial state, a function that calculates it from the
+previous state, or replace it completely.
+
+#### Parameters
+
+- `nextState`: The value that you want the state to be. It can be a value of any type, but there is
+  a special behavior for functions.
+  - If you pass an object as a `nextState`. It will shallow merge `nextState` with the current
+    state. You can pass only the properties you want to update, this allows for selective state
+    updates without modifying other properties.
+  - If you pass a non-object as a `nextState`, make sure you use `replace` as `true` to avoid
+    unexpected behaviors.
+  - If you pass a function as a `nextState`. It must be pure, should take current state as its
+    only argument, and should return the next state. The next state returned by the updater
+    function face the same restrictions of any next state.
+- `replace`: This optional boolean flag controls whether to replace the entire state or merge the
+  update with the current state.
+
+#### Returns
+
+`setState` function do not have a return value.
+
+### `getState` function
+
+The `getState` function lets you access to the current state. It can be stale on asynchronous
+operations.
+
+### `subscribe` function
+
+The `subscribe` function lets you subscribe to state updates. It should take current state and
+previous state as arguments.
+
+#### Parameters
+
+- `currentState`: The current state.
+- `previousState`: The previous state.
+
+#### Returns
+
+`subscribe` returns a function that lets you unsubscribe.
+
+### `storeApi`
+
+The `storeApi` lets you access to the store API functions like
+[`setState` function](#setstate-function), [`getState` function](#getstate-function), and
+[`subscribe` function](#subscribe-function).
+
+## Usage
+
+## Troubleshooting
diff --git a/docs/reference/create-context.md b/docs/reference/create-context.md
@@ -0,0 +1,106 @@
+---
+title: createContext
+description:
+nav: 201
+---
+
+# createContext ⚛️
+
+`createContext` lets you create a context that components can provider or read a store.
+
+```js
+createContext()
+```
+
+- [Reference](#reference)
+  - [Signature](#createcontext-signature)
+  - [`Provider`](#provider)
+  - [`useContextStore`](#usecontextstore)
+  - [`useStoreApi`](#usestoreapi)
+- [Usage](#usage)
+- [Troubleshooting](#troubleshooting)
+
+## Reference
+
+### `createContext` Signature
+
+```ts
+createContext<StoreApi<T>, U = T>(): {
+  Provider: React.FC<{ createStore: StateCreator<T> }>,
+  useContextStore: (selectorFn?: (state: T) => U, equalityFn?: (a: T, b: T) => boolean) => U,
+  useStoreApi: () => StoreApi<T>
+}
+```
+
+#### Parameters
+
+`createContext` does not take any parameters.
+
+#### Returns
+
+`createContext` returns a context object.
+
+The context object itself does not hold any information. It represents which context other
+components read or provide. Typically, you will use `Provider` in components above to specify the
+context value. Call `useContexStore` in components below to read it, and call `useStoreApi` in
+components bellow to access to store API utilities. The context object has a few properties:
+
+- `Provider` lets you provide the store to components.
+- `useContextStore` lets you read the store state.
+- `useStoreApi` lets you access to store API utilities
+
+### `selector` function
+
+The `selector` function lets you return data that is based on current state. It should take current
+state as its only argument.
+
+### `equality` function
+
+The `equality` function lets you skip re-renders when certain values are unchanged. It should
+take the previous state, and its current state as arguments. It should return `true` if the
+previous and current states are equal. Otherwise, it should return `false`.
+
+### `Provider`
+
+Wrap your components into a context provider to specify the value of this context for all
+components inside:
+
+#### Props
+
+- `createStore`: Lorem ipsum dolor, sit amet consectetur adipisicing elit. Fugit, illum sequi,
+  nulla a architecto magni eum ex aspernatur laborum numquam neque rerum? Nam quas minus
+  repudiandae quam accusantium mollitia distinctio.
+- `children`: Lorem ipsum dolor sit, amet consectetur adipisicing elit. Obcaecati, iure incidunt
+  corrupti repellendus accusamus repellat, blanditiis voluptate ex libero soluta id quia, aliquid
+  nesciunt maxime voluptates alias perspiciatis aperiam autem.
+
+### `useContextStore`
+
+Call `useContextStore` at the top level of your component to read and subscribe to store state.
+
+#### Parameters
+
+- `selectorFn`: A function that lets you return data that is based on current state.
+- `equalityFn`: A function that lets you skip re-renders.
+
+#### Returns
+
+`useContextStore` returns current state.
+
+### `useStoreApi`
+
+Call `useStoreApi` at the top level of your component to access store API utilities.
+
+#### Parameters
+
+`useStoreApi` does not take any parameters.
+
+#### Returns
+
+`useStoreApi` returns Lorem ipsum dolor sit amet consectetur adipisicing elit. Libero recusandae
+necessitatibus dolorem perspiciatis accusamus vel molestiae qui officiis, iure pariatur ad iste
+error dignissimos sequi commodi sapiente quam cumque harum?
+
+## Usage
+
+## Troubleshooting