@rc-component/notification/es/hooks/useNotification.d.ts

notification ui component for react

import type { CSSMotionProps } from '@rc-component/motion';
import * as React from 'react';
import type { NotificationsProps } from '../Notifications';
import type { OpenConfig, Placement, StackConfig } from '../interface';
type OptionalConfig = Partial<OpenConfig>;
export interface NotificationConfig {
    prefixCls?: string;
    /** Customize container. It will repeat call which means you should return same container element. */
    getContainer?: () => HTMLElement | ShadowRoot;
    motion?: CSSMotionProps | ((placement: Placement) => CSSMotionProps);
    closable?: boolean | ({
        closeIcon?: React.ReactNode;
        onClose?: VoidFunction;
    } & React.AriaAttributes);
    maxCount?: number;
    duration?: number;
    showProgress?: boolean;
    pauseOnHover?: boolean;
    /** @private. Config for notification holder style. Safe to remove if refactor */
    className?: (placement: Placement) => string;
    /** @private. Config for notification holder style. Safe to remove if refactor */
    style?: (placement: Placement) => React.CSSProperties;
    /** @private Trigger when all the notification closed. */
    onAllRemoved?: VoidFunction;
    stack?: StackConfig;
    /** @private Slot for style in Notifications */
    renderNotifications?: NotificationsProps['renderNotifications'];
}
export interface NotificationAPI {
    open: (config: OptionalConfig) => void;
    close: (key: React.Key) => void;
    destroy: () => void;
}
export default function useNotification(rootConfig?: NotificationConfig): [NotificationAPI, React.ReactElement];
export {};