@swat-sccs/react-simple-snackbar/dist/index.d.ts

A really simple React snackbar component

import { ReactElement } from "react";

declare module '@swat-sccs/react-simple-snackbar' {

    export type SnackbarProviderProps = {
        children?: React.Component | React.Component[] | ReactElement | ReactElement[];
    };

    export function SnackbarProvider(props: SnackbarProviderProps): ReactNode;

    /**
     * @argument node The node you want to show into the Snackbar.
     * @argument duration A number in milliseconds to set the duration of the Snackbar. The default value is 5000.
     */
    type OpenSnackbar = (node: string | JSX.Element, duration?: number) => void;

    /**
     * This method is used if you want to close the Snackbar programmatically. It doesn't receive any params.
     */
    type CloseSnackbar = () => void;

    export interface SnackbarOptions {

        /**
         * A custom position for your Snackbar. The default value is bottom-center
         */
        position?: 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';

        /**
         * A style object with camelCased properties and string values. These styles are applied to the Snackbar itself.
         */
        style?: { [key: string]: string };

        /**
         * Same as style, but the styles are applied to the close button. You can use font properties to style the X icon.
         */
        closeStyle?: { [key: string]: string };
    }

    export const useSnackbar: (options?: SnackbarOptions) => [OpenSnackbar, CloseSnackbar];

    export interface WithSnackbar {
        openSnackbar: OpenSnackbar;
        closeSnackbar: CloseSnackbar;
    }

    export const withSnackbar: <P extends object>(Component: React.ComponentType<P>, options?: SnackbarOptions) => React.ComponentType<P & WithSnackbar>;
}