@4react/state 中文文档教程

Question

@4react / state

React 应用程序的类似 Redux 的状态容器。

NOTE

这个包很大程度上受到 Redux 的启发。 请考虑支持他们的工作。

Usage

Import dependency

npm i @4react/state

Create Store

使用 createStore 实用程序创建商店提供者及其相应的消费者挂钩， 将商店的主要减速器传递给它。

import { createStore } from '@4react/state'

export const [ MyStore, useMyStore ] = createStore(myStoreReducer)

Provide Store

使用store provider 将商店提供给您的应用程序。

import { MyStore } from 'myStore'

const App = () => {
  return (
    <MyStore>
      <MyComponent />
    </MyStore>
  )
}

Use store

使用store custom hook retrieve store data 和dispatch actions

const MyInnerComponent = () => {
  const { data, dispatch } = useMyStore()

  const onClick = () => {
     dispatch({ type: 'YOUR_ACTION' })
  }

  return (
    <>
      <span>{data}</span>
      <button onClick={onClick}>
        click here
      </button>
    </>
  )
}

API

createStore()

创建一个 store provider 和它对应的 hook。

根据您要实施的状态管理类型， 你可以决定保留一个单一的全球商店， 而不是创建多个商店并将它们提供给应用程序的不同部分。

您还可以针对不同的方式使用多个嵌套商店。

createStore(reducer, [preloadedState], [enhancer])

Param	Type	Default	Description
reducer	Function	-	A reducing function that returns the next state, given the current state and an action.
preloadedState	any	computed	optional. The initial state. If not specify the initial state is automatically computed from reducers state default value.
enhancer	Function	-	optional. The store enhancer. You may optionally specify it to enhance the store with third-party capabilities.

返回包含 2 个不同元素的数组：

1. The custom store provider (see Store Provider)
2. The custom consumer hook. (see Consumer Hook)

Store Provider

Store Provider 用于为整个应用程序提供全局存储。 它在应用程序主组件中最常用。

const App = () => {
  return (
    <MyStore>
      ...
    </MyStore>
  );
};

Param	Type	Default	Description
data	any	-	optional You can use this prop to force the providing of specific store data. It is most commonly used for testing purpose.

Consumer Hook

Consumer Hook 用于检索实际的存储状态 和调度功能。

const { data, dispatch } = useMyStore()

const { data } = useMyStore(store => store.counter)

Param	Type	Default	Description
selector	Function	-	optional Use to retrieve a custom section of the store state.

Return (object)	Type	Description
data	any	The actual store state or a selection of it.
dispatch	Function	The dispatch function, used to dispatch actions

combineReducers()

类似于 Redux 的 combineReducers，它创建一个新的 reducer 从 减速器的映射。 结果函数将能够减少状态 具有传递给它的减速器地图的相同形状。

const todos = combineReducers({
  all: allReducer,
  checked: checkedReducer
})

参数：

1. reducers (object): the map of reducers to be combined together.
2. [initialValue] (any): This parameter is optional. If not specify the state default value is automatically computed from reducers state default state value inside the passed map.

Param	Type	Default	Description
reducers	object	-	The map of reducers to be combined together.
initialValue	any	computed	optional If not specify, it is automatically computed from reducers default states value inside the passed map.