@adaptabletools/adaptable/src/AdaptableOptions/NotificationsOptions.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

/**
 * Options related to System Status Messages and Notifications in Adaptable.
 */
export interface NotificationsOptions {
    /**
     * How many Notifications can be displayed at one time
     *
     * @defaultValue  3
     * @gridInfoItem
     * noCodeItem
     */
    maxNotifications?: number;
    /**
     * Where Notification will appear (if anywhere)
     *
     * @defaultValue 'BottomRight'
     * @gridInfoItem
     */
    position?: ToastPositions;
    /**
     * How long (in ms) Notifications display for
     *
     * @defaultValue 3000
     * @gridInfoItem
     */
    duration?: number | 'always';
    /**
     * Shows a Progress Bar in the Notification
     *
     * @defaultValue false
     * @gridInfoItem
     */
    showProgressBar?: boolean;
    /**
     * Closes Notification automatically when its clicked
     *
     * @defaultValue false
     * @gridInfoItem
     */
    closeWhenClicked?: boolean;
    /**
     * Pauses the Notification when mouse hovers over it
     *
     * @defaultValue false
     * @gridInfoItem
     */
    pauseWhenHovering?: boolean;
    /**
     * Can Notification be dragged
     *
     * @defaultValue false
     * @gridInfoItem
     */
    isDraggable?: boolean;
    /**
     * How Notification will appear: Bounce, Slide, Zoom or Flip
     *
     * @defaultValue 'Slide'
     * @gridInfoItem
     */
    transition?: 'Bounce' | 'Slide' | 'Zoom' | 'Flip';
    /**
     * Display System Status Messages as Notifications
     *
     * @defaultValue false
     * @gridInfoItem
     */
    showSystemStatusMessageNotifications?: boolean;
    /**
     * How many System Status Messages to hold in State; when limit is reached, oldest Message is removed
     *
     * @defaultValue  100
     * @gridInfoItem
     * @transition
     */
    maxSystemMessagesInStore?: number;
    /**
     * Displays the application icon in Notifications
     * @defaultValue false
     */
    showApplicationIcon?: boolean;
}
/**
 * Different positions offered by Notifications
 */
export type ToastPositions = 'TopRight' | 'TopCenter' | 'TopLeft' | 'BottomRight' | 'BottomCenter' | 'BottomLeft';
/**
 * Different transitions offered by Notifications
 */
export type ToastTransitions = 'Bounce' | 'Slide' | 'Zoom' | 'Flip';