rsuite/esm/toaster/toaster.d.ts

A suite of react components

import React from 'react';
import { ToastContainerProps } from './ToastContainer';
export interface Toaster {
    /**
     * Push a toast message.
     * @param message The message to be displayed.
     *                eg: `<Message type="success" description="Success" />` or `<Notification type="success" closable>Success</Notification>`
     * @param options The options of the toast message. (optional)
     *                eg: `{ placement: 'topCenter', duration: 5000 }`
     * @returns The key of the toast message.
     */
    push(message: React.ReactNode, options?: ToastContainerProps): string | undefined | Promise<string | undefined>;
    /**
     * Remove a toast message.
     * @param key  The key of the toast message.
     */
    remove(key: string): void;
    /**
     * Clear all toast messages.
     */
    clear(): void;
}
declare const toaster: Toaster;
export default toaster;