# react-model
**Repository Path**: ByteDance/react-model
## Basic Information
- **Project Name**: react-model
- **Description**: The next generation state management library for React
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-26
- **Last Updated**: 2025-06-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# react-model ·  [](https://www.npmjs.com/package/react-model) [](https://bundlephobia.com/result?p=react-model) [](https://travis-ci.org/byte-fe/react-model) [](http://img.badgesize.io/https://cdn.jsdelivr.net/npm/react-model/dist/react-model.js) [](https://www.npmjs.com/package/react-model) [](https://codecov.io/gh/byte-fe/react-model) [](https://greenkeeper.io/) 
The State management library for React
🎉 Support Both Class and Hooks Api
⚛️ Support [preact](https://github.com/byte-fe/react-model-experiment/tree/preact), react-native and Next.js
⚔ Full TypeScript Support
📦 Built with microbundle
⚙️ Middleware Pipline ( redux-devtools support ... )
☂️ 100% test coverage, safe on production
🐛 Debug easily on test environment
```tsx
import { Model } from 'react-model'
// define model
const Todo = {
state: {
items: ['Install react-model', 'Read github docs', 'Build App']
},
actions: {
add: todo => {
// s is the readonly version of state
// you can also return partial state here but don't need to keep immutable manually
// state is the mutable state
return state => {
state.items.push(todo)
}
}
}
}
// Model Register
const { useStore } = Model(Todo)
const App = () => {
return
}
const TodoList = () => {
const [state, actions] = useStore()
return
{state.items.map((item, index) => ())}
}
```
---
## Recently Updated
* [feat(middleware): support enable/disable sepecific middleware](#how-can-i-disable-the-console-debugger)
* fix(stateupdater): fix the issue that setState on unmounted component
## Quick Start
[CodeSandbox: TodoMVC](https://codesandbox.io/s/moyxon99jx)
[Next.js + react-model work around](https://github.com/byte-fe/react-model-experiment)
[v2 docs](https://github.com/byte-fe/react-model/blob/v2/README.md)
install package
```shell
npm install react-model
```
## Table of Contents
- [Core Concept](#core-concept)
- [Model](#model)
- [Model Register](#model-register)
- [useStore](#usestore)
- [getState](#getstate)
- [actions](#actions)
- [subscribe](#subscribe)
- [Advance Concept](#advance-concept)
- [immutable Actions](#immutable-actions)
- [SSR with Next.js](#ssr-with-nextjs)
- [Middleware](#middleware)
- [Expand Context](#expand-context)
- [Other Concept required by Class Component](#other-concept-required-by-class-component)
- [Provider](#provider)
- [connect](#connect)
- [FAQ](#faq)
- [Migrate from 3.1.x to 4.x.x](#migrate-from-31x-to-4xx)
- [How can I disable the console debugger?](#how-can-i-disable-the-console-debugger)
- [How can I add custom middleware](#how-can-i-add-custom-middleware)
- [How can I make persist models](#how-can-i-make-persist-models)
- [How can I deal with local state](#how-can-i-deal-with-local-state)
- [actions throw error from immer.module.js](#actions-throw-error-from-immermodulejs)
- [How can I customize each model's middlewares?](#how-can-i-customize-each-models-middlewares)
## Core Concept
### Model
Every model has its own state and actions.
```typescript
const initialState = {
counter: 0,
light: false,
response: {}
}
interface StateType {
counter: number
light: boolean
response: {
code?: number
message?: string
}
}
interface ActionsParamType {
increment: number
openLight: undefined
get: undefined
} // You only need to tag the type of params here !
const model: ModelType = {
actions: {
increment: async (payload, { state }) => {
return {
counter: state.counter + (payload || 1)
}
},
openLight: async (_, { state, actions }) => {
await actions.increment(1) // You can use other actions within the model
await actions.get() // support async functions (block actions)
actions.get()
await actions.increment(1) // + 1
await actions.increment(1) // + 2
await actions.increment(1) // + 3 as expected !
return { light: !state.light }
},
get: async () => {
await new Promise((resolve, reject) =>
setTimeout(() => {
resolve()
}, 3000)
)
return {
response: {
code: 200,
message: `${new Date().toLocaleString()} open light success`
}
}
}
},
state: initialState
}
export default model
// You can use these types when use Class Components.
// type ConsumerActionsType = getConsumerActionsType
// type ConsumerType = { actions: ConsumerActionsType; state: StateType }
// type ActionType = ConsumerActionsType
// export { ConsumerType, StateType, ActionType }
```
[⇧ back to top](#table-of-contents)
### Model Register
react-model keeps the application state and actions in separate private stores. So you need to register them if you want to use them as the public models.
`model/index.ts`
```typescript
import { Model } from 'react-model'
import Home from '../model/home'
import Shared from '../model/shared'
const models = { Home, Shared }
export const { getInitialState, useStore, getState, actions, subscribe, unsubscribe } = Model(models)
```
[⇧ back to top](#table-of-contents)
### useStore
The functional component in React ^16.8.0 can use Hooks to connect the global store.
The actions returned from useStore can invoke dom changes.
The execution of actions returned by useStore will invoke the rerender of current component first.
It's the only difference between the actions returned by useStore and actions now.
```tsx
import React from 'react'
import { useStore } from '../index'
// CSR
export default () => {
const [state, actions] = useStore('Home')
const [sharedState, sharedActions] = useStore('Shared')
return (
Home model value: {JSON.stringify(state)}
Shared model value: {JSON.stringify(sharedState)}
)
}
```
optional solution on huge dataset (example: TodoList(10000+ Todos)):
1. use useStore on the subComponents which need it.
2. use useStore selector. (version >= v4.0.0-rc.0)
[advance example with 1000 todo items](https://codesandbox.io/s/react-model-v4-todomvc-oxyij)
[⇧ back to top](#table-of-contents)
### getState
Key Point: [State variable not updating in useEffect callback](https://github.com/facebook/react/issues/14066)
To solve it, we provide a way to get the current state of model: getState
Note: the getState method cannot invoke the dom changes automatically by itself.
> Hint: The state returned should only be used as readonly
```jsx
import { useStore, getState } from '../model/index'
const BasicHook = () => {
const [state, actions] = useStore('Counter')
useEffect(() => {
console.log('some mounted actions from BasicHooks')
return () =>
console.log(
`Basic Hooks unmounted, current Counter state: ${JSON.stringify(
getState('Counter')
)}`
)
}, [])
return (
<>
state: {JSON.stringify(state)}
)
}
```
[⇧ back to top](#table-of-contents)
### actions
You can call other models' actions with actions api
actions can be used in both class components and functional components.
```js
import { actions } from './index'
const model = {
state: {},
actions: {
crossModelCall: () => {
actions.Shared.changeTheme('dark')
actions.Counter.increment(9)
}
}
}
export default model
```
[⇧ back to top](#table-of-contents)
### subscribe
subscribe(storeName, actions, callback) run the callback when the specific actions executed.
```typescript
import { subscribe, unsubscribe } from './index'
const callback = () => {
const user = getState('User')
localStorage.setItem('user_id', user.id)
}
// subscribe action
subscribe('User', 'login', callback)
// subscribe actions
subscribe('User', ['login', 'logout'], callback)
// unsubscribe the observer of some actions
unsubscribe('User', 'login') // only logout will run callback now
```
[⇧ back to top](#table-of-contents)
## Advance Concept
### immutable Actions
The actions use [immer](https://github.com/mweststrate/immer) produce API to modify the Store. You can return a producer in action.
Using function as return value can make your code cleaner when you modify the deep nested value.
TypeScript Example
```ts
// StateType and ActionsParamType definition
// ...
const model: ModelType = {
actions: {
increment: async (params, { state: s }) => {
// return (state: typeof s) => { // TypeScript < 3.9
return state => {
state.counter += params || 1
}
},
decrease: params => s => {
s.counter += params || 1
}
}
}
export default model
```
JavaScript Example
```js
const Model = {
actions: {
increment: async (params) => {
return state => {
state.counter += params || 1
}
}
}
}
```
[⇧ back to top](#table-of-contents)
### SSR with Next.js
Store: shared.ts
[⇧ back to top](#table-of-contents)
### Middleware
We always want to try catch all the actions, add common request params, connect Redux devtools and so on. We Provide the middleware pattern for developer to register their own Middleware to satisfy the specific requirement.
```tsx
// Under the hood
const tryCatch: Middleware<{}> = async (context, restMiddlewares) => {
const { next } = context
await next(restMiddlewares).catch((e: any) => console.log(e))
}
// ...
let actionMiddlewares = [
tryCatch,
getNewState,
setNewState,
stateUpdater,
communicator,
devToolsListener
]
// ...
// How we execute an action
const consumerAction = (action: Action) => async (params: any) => {
const context: Context = {
modelName,
setState,
actionName: action.name,
next: () => {},
newState: null,
params,
consumerActions,
action
}
await applyMiddlewares(actionMiddlewares, context)
}
// ...
export { ... , actionMiddlewares}
```
⚙️ You can override the actionMiddlewares and insert your middleware to specific position
[⇧ back to top](#table-of-contents)
### Expand Context
```typescript
const ExtCounter: ModelType<
{ name: string }, // State Type
{ ext: undefined }, // ActionParamsType
{ name: string } // ExtContextType
> = {
actions: {
// { state, action } => { state, action, [name] }
ext: (_, { name }) => {
return { name }
}
},
state: { name: '' }
}
const { useStore } = Model(ExtCounter, { name: 'test' })
// state.name = ''
const [state, actions] = useStore()
// ...
actions.ext()
// state.name => 'test'
```
[⇧ back to top](#table-of-contents)
## Other Concept required by Class Component
### Provider
The global state standalone can not effect the react class components, we need to provide the state to react root component.
```jsx
import { PureComponent } from 'react'
import { Provider } from 'react-model'
class App extends PureComponent {
render() {
return (
)
}
}
```
[⇧ back to top](#table-of-contents)
### connect
We can use the Provider state with connect.
Javascript decorator version
```jsx
import React, { PureComponent } from 'react'
import { Provider, connect } from 'react-model'
const mapProps = ({ light, counter }) => ({
lightStatus: light ? 'open' : 'close',
counter
}) // You can map the props in connect.
@connect(
'Home',
mapProps
)
export default class JSCounter extends PureComponent {
render() {
const { state, actions } = this.props
return (
<>
[⇧ back to top](#table-of-contents)
## FAQ
### Migrate from 3.1.x to 4.x.x
1. remove Model wrapper
`sub-model.ts`
```ts
// 3.1.x
export default Model(model)
// 4.x.x
export default model
```
`models.ts`
```ts
import Sub from './sub-model'
export default Model({ Sub })
```
2. use selector to replace depActions
`Shared.ts`
```ts
interface State {
counter: number
enable: boolean
}
interface ActionParams {
add: number
switch: undefined
}
const model: ModelType = {
state: {
counter: 1
enable: false
},
actions: {
add: (payload) => state => {
state.counter += payload
},
switch: () => state => {
state.enable = !state.enable
}
}
}
```
```ts
const Component = () => {
// 3.1.x, Component rerender when add action is invoked
const [counter] = useStore('Shared', ['add'])
// 4.x.x, Component rerender when counter value diff
const [counter] = useStore('Shared', state => state.counter)
}
```
### How can I disable the console debugger
```typescript
import { middlewares } from 'react-model'
// Find the index of middleware
// Disable all actions' log
middlewares.config.logger.enable = false
// Disable logs from specific type of actions
middlewares.config.logger.enable = ({ actionName }) => ['increment'].indexOf(actionName) !== -1
```
[⇧ back to top](#table-of-contents)
### How can I add custom middleware
```typescript
import { actionMiddlewares, middlewares, Model } from 'react-model'
import { sendLog } from 'utils/log'
import Home from '../model/home'
import Shared from '../model/shared'
// custom middleware
const ErrorHandler: Middleware = async (context, restMiddlewares) => {
const { next } = context
await next(restMiddlewares).catch((e: Error) => sendLog(e))
}
// Find the index of middleware
const getNewStateMiddlewareIndex = actionMiddlewares.indexOf(
middlewares.getNewState
)
// Replace it
actionMiddlewares.splice(getNewStateMiddlewareIndex, 0, ErrorHandler)
const stores = { Home, Shared }
export default Model(stores)
```
[⇧ back to top](#table-of-contents)
#### How can I make persist models
```typescript
import { actionMiddlewares, Model } from 'react-model'
import Example from 'models/example'
// Example, not recommend to use on production directly without consideration
// Write current State to localStorage after action finish
const persistMiddleware: Middleware = async (context, restMiddlewares) => {
localStorage.setItem('__REACT_MODEL__', JSON.stringify(context.Global.State))
await context.next(restMiddlewares)
}
// Use on all models
actionMiddlewares.push(persistMiddleware)
Model({ Example }, JSON.parse(localStorage.getItem('__REACT_MODEL__')))
// Use on single model
const model = {
state: JSON.parse(localStorage.getItem('__REACT_MODEL__'))['you model name']
actions: { ... },
middlewares: [...actionMiddlewares, persistMiddleware]
}
```
[⇧ back to top](#table-of-contents)
### How can I deal with local state
What should I do to make every Counter hold there own model? 🤔
```tsx
class App extends Component {
render() {
return (
)
}
}
```
Counter model
```ts
interface State {
count: number
}
interface ActionParams {
increment: number
}
const model: ModelType = {
state: {
count: 0
},
actions: {
increment: payload => {
// immer.module.js:972 Uncaught (in promise) Error: An immer producer returned a new value *and* modified its draft. Either return a new value *or* modify the draft
// Not allowed
// return state => (state.count += payload)
return state => {
state.count += payload
}
}
}
}
```
)
}
export default Counter
```
[⇧ back to top](#table-of-contents)
### actions throw error from immer.module.js
```
immer.module.js:972 Uncaught (in promise) Error: An immer producer returned a new value *and* modified its draft. Either return a new value *or* modify the draft
```
How to fix:
```tsx
actions: {
increment: payload => {
// Not allowed
// return state => (state.count += payload)
return state => {
state.count += payload
}
}
}
```
[⇧ back to top](#table-of-contents)
### How can I customize each model's middlewares?
You can customize each model's middlewares.
```typescript
import { actionMiddlewares, Model } from 'react-model'
const delayMiddleware: Middleware = async (context, restMiddlewares) => {
await timeout(1000, {})
context.next(restMiddlewares)
}
const nextCounterModel: ModelType = {
actions: {
add: num => {
return state => {
state.count += num
}
},
increment: async (num, { actions }) => {
actions.add(num)
await timeout(300, {})
}
},
// You can define the custom middlewares here
middlewares: [delayMiddleware, ...actionMiddlewares],
state: {
count: 0
}
}
export default Model(nextCounterModel)
```
[⇧ back to top](#table-of-contents)