rsuite/src/Alert/Alert.d.ts

A suite of react components

import * as React from 'react';

import { StandardProps } from '../@types/common';

export interface AlertProps extends StandardProps {
  /** The prefix of the component CSS class */
  classPrefix?: string;

  /** The distance from the top of the message box */
  top?: number;

  /** message box duration (Unit: milliseconds) */
  duration?: number;

  /** The parent container of Alert */
  getContainer?: () => HTMLElement;
}

export interface AlertAPI {
  /** A message may be formatted to display a positive message */
  success(content: string | React.ReactElement, duration?: number, onClose?: () => void): void;

  /** A message may be formatted to display a negative message */
  error(content: string | React.ReactElement, duration?: number, onClose?: () => void): void;

  /** A message may be formatted to display information */
  info(content: string | React.ReactElement, duration?: number, onClose?: () => void): void;

  /** A message may be formatted to display warning messages */
  warning(content: string | React.ReactElement, duration?: number, onClose?: () => void): void;

  /** Used to configure where the message is displayed */
  config(options: AlertProps): void;

  /** Close the message */
  close(key?: string): void;

  /** Close all messages */
  closeAll(): void;
}

declare const Alert: AlertAPI;

export default Alert;