@sinchsmb/ui-kit
Version:
UI kit for SinchSMB frontend
27 lines (26 loc) • 918 B
TypeScript
import { ReactNode } from 'react';
import { CommonProps } from '../../types';
import { ToastAppearance } from './constants';
/** Props for {@link Toast} */
export interface ToastProps extends CommonProps {
/** Visual appearance */
appearance?: ToastAppearance;
/** Function that will be invoked when user click by Dismiss button or by any actions */
onDismiss?: () => void;
children: ReactNode;
}
/**
* Component that can be used as toast in {@link ToastManager}.
*
* Usually you should not use this component directly, use {@link useToast} hook instead.
*
* ```tsx
* import { Toast, ToastAppearance } from 'ui-kit';
*
* <Toast appearance={ToastAppearance.Success} onDismiss={handleToastDismiss}>
* You've won $100 000 000.
* <ToastAction onClick={handleToastActionClick}>Send PayPal</ToastAction>
* </Toast>
* ```
*/
export declare function Toast(props: ToastProps): JSX.Element;