@dgithiomi/sbui-web 1.0.0 → 1.0.3

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-import React, { ReactNode, RefObject, TextareaHTMLAttributes, FocusEvent } from 'react';
+import React, { ReactNode, RefObject, TextareaHTMLAttributes, FocusEvent, PropsWithChildren } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 type TooltipAnimation = "fade" | "scale" | "none";
 type TooltipPointerDirection = "left" | "right" | "center";
@@ -222,4 +223,88 @@ type ProgressBarProps = {
 
 declare const ProgressBar: React.FC<ProgressBarProps>;
 
-export { ProgressBar, type ProgressBarProps, TextArea, type TextAreaProps, type TextAreaResize, type TextAreaSize, type TextAreaStatus, Tooltip, type TooltipAnimation, type TooltipPlacement, type TooltipPointerDirection, type TooltipProps, type TooltipTrigger, type TooltipVariant };
+/**
+ * The duration that a toast notification should be visible.
+ * - "short": Typically a brief delay (e.g., 2-3 seconds).
+ * - "long": A longer delay (e.g., 5-6 seconds).
+ */
+type ToastDuration = "short" | "long";
+/**
+ * Visual style variants for the toast notification.
+ * - "success": Indicates a successful or positive action.
+ * - "error": Indicates an error or negative action.
+ * - "warning": Indicates a warning or potentially problematic action.
+ * - "info": Provides informational feedback to the user.
+ */
+type ToastVariant = "success" | "error" | "warning" | "info";
+/**
+ * Interface describing the visual properties for a particular toast variant.
+ * Used to customize the appearance according to the variant type.
+ */
+interface ToastVariantProps {
+    /** The icon to display, based on the variant. */
+    icon: ReactNode;
+    /** The text color to use for toast content. */
+    textColor: string;
+    /** The background color for the icon container. */
+    iconBackground: string;
+    /** The background color of the toast itself. */
+    backgroundColor: string;
+    /** The color used for the content within the toast (may differ from general text color). */
+    toastContentColor: string;
+}
+/**
+ * Core properties for a toast notification.
+ * Used when displaying or creating a toast within the UI.
+ */
+interface ToastProps {
+    /** Optional title to display above the message. */
+    title?: string;
+    /** The main message to display in the toast (required). */
+    message: string;
+    /** The variant determines the toast's styling and icon. */
+    variant: ToastVariant;
+    /** How long the toast should remain visible. If not provided, defaults may be used. */
+    duration?: ToastDuration;
+    /** Function called when the toast is closed or dismissed. */
+    onClose?: () => void;
+}
+/**
+ * Internal representation of a toast, typically managed by the toast system.
+ * Extends ToastProps with a unique identifier for handling toast instances.
+ */
+interface ToastInternal extends ToastProps {
+    /** Unique identifier for the toast instance (used internally for management). */
+    toastUUID: string;
+}
+/**
+ * The context shape for the Toast provider, enabling components to trigger toasts.
+ * Exposes the showToast method, which accepts toast properties except an "id".
+ */
+interface ToastContextType {
+    /**
+     * Show a new toast.
+     * @param toast - An object specifying the toast's properties.
+     */
+    showToast: (toast: ToastProps) => void;
+}
+
+declare const Toast: React.FC<ToastProps>;
+
+declare const ToastContext: React.Context<ToastContextType | null>;
+declare const ToastProvider: React.FC<{
+    children: ReactNode;
+}>;
+
+declare function useToast(): ToastContextType;
+
+interface SbuiProviderProps extends PropsWithChildren {
+    /**
+     * Keep this provider extensible: feature providers can be toggled here
+     * as the library grows without forcing consumer-level wrapper churn.
+     */
+    enableToastProvider?: boolean;
+}
+declare const SbuiProvider: ({ children, enableToastProvider, }: SbuiProviderProps) => react_jsx_runtime.JSX.Element;
+
+export { ProgressBar, type ProgressBarProps, SbuiProvider, type SbuiProviderProps, TextArea, type TextAreaProps, type TextAreaResize, type TextAreaSize, type TextAreaStatus, Toast, ToastContext, type ToastContextType, type ToastDuration, type ToastInternal, type ToastProps, ToastProvider, type ToastVariant, type ToastVariantProps, Tooltip, type TooltipAnimation, type TooltipPlacement, type TooltipPointerDirection, type TooltipProps, type TooltipTrigger, type TooltipVariant, useToast };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import React, { ReactNode, RefObject, TextareaHTMLAttributes, FocusEvent } from 'react';
+import React, { ReactNode, RefObject, TextareaHTMLAttributes, FocusEvent, PropsWithChildren } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 type TooltipAnimation = "fade" | "scale" | "none";
 type TooltipPointerDirection = "left" | "right" | "center";
@@ -222,4 +223,88 @@ type ProgressBarProps = {
 
 declare const ProgressBar: React.FC<ProgressBarProps>;
 
-export { ProgressBar, type ProgressBarProps, TextArea, type TextAreaProps, type TextAreaResize, type TextAreaSize, type TextAreaStatus, Tooltip, type TooltipAnimation, type TooltipPlacement, type TooltipPointerDirection, type TooltipProps, type TooltipTrigger, type TooltipVariant };
+/**
+ * The duration that a toast notification should be visible.
+ * - "short": Typically a brief delay (e.g., 2-3 seconds).
+ * - "long": A longer delay (e.g., 5-6 seconds).
+ */
+type ToastDuration = "short" | "long";
+/**
+ * Visual style variants for the toast notification.
+ * - "success": Indicates a successful or positive action.
+ * - "error": Indicates an error or negative action.
+ * - "warning": Indicates a warning or potentially problematic action.
+ * - "info": Provides informational feedback to the user.
+ */
+type ToastVariant = "success" | "error" | "warning" | "info";
+/**
+ * Interface describing the visual properties for a particular toast variant.
+ * Used to customize the appearance according to the variant type.
+ */
+interface ToastVariantProps {
+    /** The icon to display, based on the variant. */
+    icon: ReactNode;
+    /** The text color to use for toast content. */
+    textColor: string;
+    /** The background color for the icon container. */
+    iconBackground: string;
+    /** The background color of the toast itself. */
+    backgroundColor: string;
+    /** The color used for the content within the toast (may differ from general text color). */
+    toastContentColor: string;
+}
+/**
+ * Core properties for a toast notification.
+ * Used when displaying or creating a toast within the UI.
+ */
+interface ToastProps {
+    /** Optional title to display above the message. */
+    title?: string;
+    /** The main message to display in the toast (required). */
+    message: string;
+    /** The variant determines the toast's styling and icon. */
+    variant: ToastVariant;
+    /** How long the toast should remain visible. If not provided, defaults may be used. */
+    duration?: ToastDuration;
+    /** Function called when the toast is closed or dismissed. */
+    onClose?: () => void;
+}
+/**
+ * Internal representation of a toast, typically managed by the toast system.
+ * Extends ToastProps with a unique identifier for handling toast instances.
+ */
+interface ToastInternal extends ToastProps {
+    /** Unique identifier for the toast instance (used internally for management). */
+    toastUUID: string;
+}
+/**
+ * The context shape for the Toast provider, enabling components to trigger toasts.
+ * Exposes the showToast method, which accepts toast properties except an "id".
+ */
+interface ToastContextType {
+    /**
+     * Show a new toast.
+     * @param toast - An object specifying the toast's properties.
+     */
+    showToast: (toast: ToastProps) => void;
+}
+
+declare const Toast: React.FC<ToastProps>;
+
+declare const ToastContext: React.Context<ToastContextType | null>;
+declare const ToastProvider: React.FC<{
+    children: ReactNode;
+}>;
+
+declare function useToast(): ToastContextType;
+
+interface SbuiProviderProps extends PropsWithChildren {
+    /**
+     * Keep this provider extensible: feature providers can be toggled here
+     * as the library grows without forcing consumer-level wrapper churn.
+     */
+    enableToastProvider?: boolean;
+}
+declare const SbuiProvider: ({ children, enableToastProvider, }: SbuiProviderProps) => react_jsx_runtime.JSX.Element;
+
+export { ProgressBar, type ProgressBarProps, SbuiProvider, type SbuiProviderProps, TextArea, type TextAreaProps, type TextAreaResize, type TextAreaSize, type TextAreaStatus, Toast, ToastContext, type ToastContextType, type ToastDuration, type ToastInternal, type ToastProps, ToastProvider, type ToastVariant, type ToastVariantProps, Tooltip, type TooltipAnimation, type TooltipPlacement, type TooltipPointerDirection, type TooltipProps, type TooltipTrigger, type TooltipVariant, useToast };