@nimbus-ds/components 5.23.0-rc.1 → 5.24.0-rc.1

package/dist/Toast/index.d.ts

@@ -0,0 +1,56 @@
+// Generated by dts-bundle-generator v7.2.0
+
+import React from 'react';
+import { HTMLAttributes, ReactNode } from 'react';
+
+export interface ToastProviderProperties {
+	/**
+	 * @TJS-type React.ReactNode
+	 */
+	children: ReactNode;
+}
+export type ToastProviderProps = ToastProviderProperties;
+export declare const ToastProvider: React.FC<ToastProviderProps>;
+export interface ToastComponents {
+	Provider: typeof ToastProvider;
+}
+export type Types = "primary" | "success" | "danger" | "progress";
+export interface ToastProperties {
+	/**
+	 * Unique toast ID used when hiding or removing a toast.
+	 */
+	id: string;
+	/**
+	 * The text that should appear in the toast message.
+	 */
+	text: string;
+	/**
+	 * Change the visual style of the toast.
+	 * @default primary
+	 */
+	type?: Types;
+	/**
+	 * The time in milliseconds that the toast message should persist.
+	 * @default 4000
+	 */
+	duration?: 4000 | 8000 | 16000;
+	/**
+	 * Tells you whether or not Toast should close automatically.
+	 * @default true
+	 */
+	autoClose?: boolean;
+	/**
+	 * Tells the toast position when we are using multiple toasts.
+	 * @default 0
+	 */
+	position?: number;
+}
+export type ToastProps = ToastProperties & HTMLAttributes<HTMLDivElement>;
+export declare const Toast: React.FC<ToastProps> & ToastComponents;
+export interface ToastContextProps {
+	closeToast: (id: string) => void;
+	addToast: (toast: Omit<ToastProps, "autoClose">) => void;
+}
+export declare const useToast: () => ToastContextProps;
+
+export {};