@types/redux-ui

Installation

npm install --save @types/redux-ui

Summary

This package contains type definitions for redux-ui (https://github.com/tonyhb/redux-ui).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-ui.

index.d.ts

/// <reference types="react" />
import * as Redux from "redux";

export interface uiParams<UIStateShape> {
    // optional key which is used to determine the UI path in which state will
    // be stored. if omitted this is randomly generated.
    key?: string | undefined;

    // optional persist, defaults to false. if set to true persist will keep UI
    // state for this component after it unmounts. if set to false the UI state
    // will be deleted and recreated when the component remounts
    persist?: boolean | undefined;

    // **required**: UI state for the component
    state: UIStateShape;

    // customReducer: you can handle the UI state for this component's scope
    // by dispatching actions
    reducer?(state: any, action: any): any;

    // optional mergeProps passed to react-redux' @connect
    mergeProps?(stateProps: any, dispatchProps: any, ownProps: any): any;

    // optional `options` passed to react-redux @connect
    options?: {
        pure?: boolean | undefined;
        withRef?: boolean | undefined;
    } | undefined;
}

export interface ReduxUIProps<UIStateShape> {
    // The key passed to the decorator from the decorator
    // (eg. 'some-decorator' with `@ui('some-decorator')`
    uiKey: string;

    // The UI state for the component's `uiKey`
    ui: UIStateShape;

    // A function accepting either a name/value pair or object which updates
    // state within `uiKey`
    updateUI(obj: UIStateShape): void;
    updateUI(key: string, value: any): void;

    // A function which resets the state within `uiKey` to its default
    resetUI(): void;
}

export const reducer: Redux.Reducer<any>;

export default function ui<UIStateShape>(params?: uiParams<UIStateShape>): <T>(component: T) => T;

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/react, redux

Credits

These definitions were written by .