import type { ComponentProps } from 'react'; import { type ToastOptions } from 'react-hot-toast/headless'; import { ToastAlert } from './ToastAlert'; /** * Displays a toast notification using the ToastAlert component from the design system. * * @param toastAlertProps - The properties to pass to the ToastAlert component * @param toastAlertProps.heading - The title/heading of the toast notification * @param toastAlertProps.description - The main content/message of the toast * @param toastAlertProps.status - The status/type of the toast (e.g., success, error, warning, info) * @param toastAlertProps.onClose - Callback function triggered when the toast is closed * @param toastAlertProps.actions - Array of action buttons to display in the toast * @param toastAlertProps.icon - Custom icon to display in the toast * @param opts - Additional options for configuring the toast behavior * @param opts.position - Position of the toast on the screen (defaults to 'bottom-right') * @param opts.duration - How long the toast should remain visible (in milliseconds, defaults to Infinity) * @returns A function that can be used to programmatically dismiss the toast * * @example * showToast({ * heading: 'Success', * description: 'Your changes have been saved', * status: 'success' * }); */ declare const showToast: ({ ...toastAlertProps }: Pick, "heading" | "description" | "status" | "onClose" | "actions" | "icon">, opts?: ToastOptions) => string; export { showToast };