react-fax-store v1.4.0

react-fax-store

基于React16的Context简单封装的状态管理库

安装

npm install --save react-fax-store

使用

import {createStore} from 'react-fax-store';

const Store = createStore(() => ({text: 'fax-store'}));

function App(){
    const data = React.useContext(Store.Context); // {text: 'fax-store'} subscribe state
    const state = store.useState(); // {text: 'fax-store'} subscribe state
    const text = store.useSelector( state => state.text ); // fax-store subscribe only state.text change
    const store = store.useStore();
    store.getState(); // {text: 'fax-store'}
    store.setState({
        text : 'react-fax-store'
    });
    // or 
    const update = store.useUpdate();
    update({
        text : 'react-fax-store'
    });

    return <Store.Consumer>{ state => console.log(state) }</Store.Consumer>
}

<Store.Provider>
    <App />
</Store.Provider>

createStore(initialValue: () => {}): Store;

创建Store对象

import {createStore} from 'react-fax-store';

createStore(() => {
    return {
        ...
    }
})

createReducer((prevState: {}, action: {type:string, [x:string]: any}),initialValue: () => {}): ReducerStore

创建Store对象

import {createStore} from 'react-fax-store';

createStore(() => {
    return {
        ...
    }
})

Store

Provider

<Store.Provider initialValue={{name: 'react-fax-store'}}>
    ...
</Store.Provider>

Consumer

<Store.Provider>
    ...
    <Store.Consumer>
        {state => {
            return <div>{state}</div>
        }}
    </Store.Consumer>
    ...
</Store.Provider>

useState

订阅整个数据

function Info(){
    const state = Store.useState();
    return <div>{state}</div>
}

useSelector

订阅指定数据

function Info(){
    const state = Store.useSelector(state => {
        return {
            username: state.username
        }
    });
    return <div>{state.username}</div>
}

useUpdate

更新数据

function Action(){
    const update = Store.useUpdate(prevState => {
        return {
            username: prevState.username + '_xc'
        }
    });
    return <button onClick={update}>Add</button>
}

useProvider

别名：useStore

获取由Provider提供的store数据对象

const store = Store.useStore();
store.getState();
// or
store.setState(...)

Context

可直接通过React.useContext获取数据

const state = React.useContext(Store.Context);

ReducerStore

继承Store

useDispatch

const dispatch = React.useDispatch();

dispatch({
    type: 'ADD',
    data: 1,
})

interface

export declare type Update<T = {}> = <K extends keyof T>(state: ((prevState: Readonly<T>) => Pick<T, K> | T | null) | Pick<T, K> | T | null) => void;
export declare type Subscriber<T = {}> = (prevState: Readonly<T>, nextState: Readonly<T>) => void;
export declare type UseSelector<T = {}> = <S extends (state: T) => any>(selector: S) => ReturnType<S>;
export declare type UseUpdate<T = {}> = () => Update<T>;
export declare type UseState<T = {}> = () => T;
export declare type UseProvider<T> = () => Provider<T>;
export declare type Consumer<T = {}> = React.FC<ConsumerProps<T>>;
export declare type Context<T> = React.Context<T>;
export declare type ReducerAction = {
    type: string;
    [x: string]: any;
};
export declare type Reducer<T> = (state: T, action: ReducerAction) => T;
export declare type Dispatch = (action: ReducerAction) => void;
export declare type UseDispatch = () => Dispatch;
export interface ConsumerProps<T = {}> {
    children: (state: T) => React.ReactElement | null;
}
interface ProviderProps<T> {
    initialValue?: T;
}
export interface Provider<T = {}> extends React.Component<ProviderProps<T>, T> {
    __$isProvider: boolean;
    getSubscribeCount(): number;
    subscribe(subscriber: Subscriber<T>): () => void;
    getState(): T;
}
export interface Store<T = {}> {
    Context: Context<T>;
    Provider: new (props: {}) => Provider<T>;
    Consumer: Consumer<T>;
    useProvider: UseProvider<T>;
    useStore: UseProvider<T>;
    useState: () => T;
    useSelector: UseSelector<T>;
    useUpdate: UseUpdate<T>;
}
export interface ReducerStore<T = {}> extends Store<T> {
    useDispatch: UseDispatch;
}
export declare const withHooks: <T extends typeof React.Component>(component: T) => T;
export declare function createStore<T extends Record<string | number | symbol, any>>(initialValue: () => T): Store<T>;
export declare function createReducer<T>(reducer: Reducer<T>, initialValue: () => T): ReducerStore<T>;

Example

store.js

import {createStore} from 'react-fax-store';

export default createStore(() => {
    return {
        name: 'react-fax-store';
    }
});

index.js

import React from 'react'
import Store from './store';

function Info(){
    const state = Store.useState();
    return <div>{state.name}</div>
}

function App(){
    return (
        <Store.Provider initialValue={{name: 'test'}}>
            <Info />
        </Store.Provider>
    );
}

export default App;