@types/react-redux-i18n
TypeScript icon, indicating that this package has built-in type declarations

0.0.16 • Public • Published

Installation

npm install --save @types/react-redux-i18n

Summary

This package contains type definitions for react-redux-i18n (https://github.com/zoover/react-redux-i18n).

Details

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

index.d.ts

declare module "react-redux-i18n" {
    import * as react from "react";
    import * as redux from "redux";

    /**
     * Helper methods
     */
    interface I18n {
        t(code: string, options?: any): string;
        l(timestamp: number, options?: any): string;
    }
    export var I18n: I18n;

    type SubTranslationObject = string | { [key: string]: SubTranslationObject };

    type TranslationObjects = { [lang: string]: SubTranslationObject };

    type DispatchCallback<S extends redux.Action> = {
        (dispatch?: redux.Dispatch<S>, getState?: () => S): any;
    };

    type I18nState = {
        translations: TranslationObjects;
        locale: string;
    };

    type TranslateProps = {
        className?: string | undefined;
        dangerousHTML?: boolean | undefined;
        style?: React.CSSProperties | undefined;
        tag?: React.ElementType | undefined;
        value: string;
        [prop: string]: any;
    };

    type LocalizeProps = {
        className?: string | undefined;
        dangerousHTML?: boolean | undefined;
        dateFormat?: string | undefined;
        options?: Object | undefined;
        style?: React.CSSProperties | undefined;
        tag?: React.ElementType | undefined;
        value: string | number | object;
    };

    /**
     * React components
     */
    export class Translate extends react.Component<TranslateProps> {}
    export class Localize extends react.Component<LocalizeProps> {}

    /**
     * Reducer
     */
    export function i18nReducer(state?: any, options?: any): redux.Reducer<I18nState>;

    /**
     * Reducer init
     */
    export function syncTranslationWithStore(store: redux.Store<any>): void;

    /**
     *  Redux Actions
     */
    export function loadTranslations(translationsObject: TranslationObjects): DispatchCallback<any>;

    export function setLocale(locale: string): DispatchCallback<any>;
}

Additional Details

Credits

These definitions were written by Clément Devos.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/react-redux-i18n

Weekly Downloads

2,736

Version

0.0.16

License

MIT

Unpacked Size

6.58 kB

Total Files

5

Last publish

Collaborators

  • types