DefinitelyTyped/types/react-redux-toastr/index.d.ts

// Type definitions for react-redux-toastr 7.4
// Project: https://github.com/diegoddox/react-redux-toastr
// Definitions by: Aleksandar Ivanov <https://github.com/Smiche>
//                 Artyom Stukans <https://github.com/artyomsv>
//                 Mika Kuitunen <https://github.com/kulmajaba>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0

import { Component } from 'react';
import { Action, Reducer } from 'redux';

export type iconType = 'success' | 'info' | 'warning' | 'error';
export type positionType = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
export type toastType = 'success' | 'info' | 'warning' | 'light' | 'error' | 'confirm' | 'message';
export type transitionInType = 'bounceIn' | 'bounceInDown' | 'fadeIn';
export type transitionOutType = 'bounceOut' | 'bounceOutUp' | 'fadeOut';

interface BasicToastrOptions {
    attention?: boolean;
    className?: string;
    component?: Component | JSX.Element;
    icon?: JSX.Element;
    onCloseButtonClick?: () => void;
    onHideComplete?: () => void;
    onShowComplete?: () => void;
    onToastrClick?: () => void;
    progressBar?: boolean;
    removeOnHover?: boolean;
    showCloseButton?: boolean;
    timeOut?: number;
    transitionIn?: transitionInType;
    transitionOut?: transitionOutType;
}

interface LightToastrOptions {
    attention?: boolean;
    className?: string;
    component?: JSX.Element;
    icon?: iconType | JSX.Element;
    onCloseButtonClick?: () => void;
    onHideComplete?: () => void;
    onShowComplete?: () => void;
    progressBar?: boolean;
    removeOnHover?: boolean;
    showCloseButton?: boolean;
    status?: iconType;
    timeOut?: number;
    transitionIn?: transitionInType;
    transitionOut?: transitionOutType;
}

interface ConfirmToastrOptions {
    disableCancel?: boolean;
    onCancel?: () => void;
    onOk?: () => void;
}

interface ConfirmToastrCustomOptions {
    component: JSX.Element;
}

export interface Toastr {
    id: string;
    message?: string;
    options: BasicToastrOptions | LightToastrOptions;
    position: positionType;
    title?: string;
    type: toastType;
}

export interface AddToastPayload {
    id?: string;
    message?: string;
    options?: BasicToastrOptions | LightToastrOptions;
    position?: positionType;
    title?: string;
    type: toastType;
}

export interface ToastrState {
    confirm?: {
        id: string;
        message: string;
        options: ConfirmToastrOptions | ConfirmToastrCustomOptions;
        show: boolean;
    };
    toastrs: Toastr[];
}

interface ReduxToastrProps {
    confirmOptions?: {
        cancelText: string;
        okText: string;
    };
    newestOnTop?: boolean;
    options?: any; // This is currently not used, waiting for response from the package author to remove
    position?: positionType
    preventDuplicates?: boolean;
    progressBar?: boolean;
    timeOut?: number;
    toastr?: ToastrState;
    transitionIn?: transitionInType;
    transitionOut?: transitionOutType;
    className?: string;
    closeOnToastrClick?: boolean;
}

interface ToastrEmitter {
    clean: () => void;
    confirm: (message: string, options: ConfirmToastrOptions) => void;
    error: (title: string, message: string, options?: BasicToastrOptions) => void;
    info: (title: string, message: string, options?: BasicToastrOptions) => void;
    light: (title: string, message: string, options?: LightToastrOptions) => void;
    message: (title: string, message: string, options?: BasicToastrOptions) => void;
    removeByType: (type: string) => void;
    success: (title: string, message: string, options?: BasicToastrOptions) => void;
    warning: (title: string, message: string, options?: BasicToastrOptions) => void;
}

interface ToastrActionCreators {
    add: (toastr: AddToastPayload) => Action;
    clean: () => Action;
    hideConfirm: () => Action;
    remove: (id: string) => Action;
    removeByType: (type: toastType) => Action;
    showConfirm: (confirm: ConfirmToastrOptions | ConfirmToastrCustomOptions) => Action;
}

export default class ReduxToastr extends Component<ReduxToastrProps> {}
export const actions: ToastrActionCreators;
export const reducer: Reducer<ToastrState>;
export const toastr: ToastrEmitter;