@mehul214/react-native-flash-toast 0.0.0-stage → 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,231 @@
+import React, { ReactNode } from 'react';
+import { StyleProp, ViewStyle, TextStyle } from 'react-native';
+
+type FlashMessageType = 'default' | 'success' | 'danger' | 'warning' | 'info';
+type FlashMessagePosition = 'top' | 'bottom' | 'center';
+type FlashMessageTransition = 'slide' | 'fade' | 'bounce';
+type FlashMessageIcon = FlashMessageType | 'none' | ReactNode | ((props: {
+    size: number;
+    color: string;
+}) => ReactNode);
+interface FlashMessageAction {
+    label: string;
+    onPress: () => void;
+    style?: StyleProp<ViewStyle>;
+    textStyle?: StyleProp<TextStyle>;
+}
+interface FlashMessageOptions {
+    /** Unique ID for the message. Auto-generated if not provided */
+    id?: string;
+    /** Primary title or content */
+    message: string | ReactNode;
+    /** Secondary subtitle or body content */
+    description?: string | ReactNode;
+    /** Preset semantic style */
+    type?: FlashMessageType;
+    /** Screen position: 'top', 'bottom', or 'center'. Default: 'top' */
+    position?: FlashMessagePosition;
+    /** Display duration in milliseconds before auto-hiding. Default: 3000ms. Set to 0 to disable */
+    duration?: number;
+    /** Whether the message auto-dismisses after duration. Default: true */
+    autoHide?: boolean;
+    /** Floating pill with rounded corners vs edge-to-edge bar. Default: true */
+    floating?: boolean;
+    /** Preset or custom icon */
+    icon?: FlashMessageIcon;
+    /** Interactive action button (e.g. Undo, Retry) */
+    action?: FlashMessageAction;
+    /** Callback fired when the flash message card is tapped */
+    onPress?: () => void;
+    /** Callback fired when the flash message is long-pressed */
+    onLongPress?: () => void;
+    /** Callback fired after the message appears */
+    onShow?: () => void;
+    /** Callback fired after the message has fully hidden */
+    onHide?: () => void;
+    /** Custom container style */
+    style?: StyleProp<ViewStyle>;
+    /** Custom title text style */
+    titleStyle?: StyleProp<TextStyle>;
+    /** Custom description text style */
+    textStyle?: StyleProp<TextStyle>;
+    /** Override background color */
+    backgroundColor?: string;
+    /** Override text and icon color */
+    color?: string;
+    /** Dismiss when tapped. Default: true */
+    hideOnPress?: boolean;
+    /** Enable swipe up/down gesture to dismiss. Default: true */
+    swipeToDismiss?: boolean;
+    /** Temporarily pause the autoHide timer while finger touches the banner. Default: true */
+    pauseOnPress?: boolean;
+    /** Show an animated countdown progress bar at the bottom of the card. Default: false */
+    showProgressBar?: boolean;
+    /** Transition animation style: 'slide' | 'fade' | 'bounce'. Default: 'slide' */
+    transition?: FlashMessageTransition;
+    /** Override manual top inset / status bar height if needed */
+    statusBarHeight?: number;
+    /** Custom render function to completely override inner layout */
+    customComponent?: (options: FlashMessageOptions, hide: () => void) => ReactNode;
+}
+interface FlashMessageRef {
+    showMessage: (options: FlashMessageOptions) => void;
+    hideMessage: () => void;
+}
+interface FlashMessageContainerProps {
+    /** Default position for all messages if not specified in options */
+    position?: FlashMessagePosition;
+    /** Default duration in ms. Default: 3000 */
+    duration?: number;
+    /** Default floating style. Default: true */
+    floating?: boolean;
+    /** Default transition. Default: 'slide' */
+    transition?: FlashMessageTransition;
+    /** Optional top status bar offset */
+    statusBarOffset?: number;
+    /** Optional bottom navigation bar offset */
+    bottomOffset?: number;
+    /** Extra container style */
+    style?: StyleProp<ViewStyle>;
+    /** Can message replace current one immediately or queue. Default: 'replace' */
+    mode?: 'replace' | 'queue';
+}
+
+declare const FlashMessage: React.ForwardRefExoticComponent<FlashMessageContainerProps & React.RefAttributes<FlashMessageRef>>;
+
+declare class FlashMessageManager {
+    private defaultInstance;
+    private instances;
+    private pendingQueue;
+    register(ref: FlashMessageRef, id?: string): void;
+    unregister(id?: string): void;
+    showMessage(options: FlashMessageOptions, targetId?: string): void;
+    hideMessage(targetId?: string): void;
+}
+declare const flashManager: FlashMessageManager;
+/**
+ * Imperative helper to trigger a flash message from anywhere in the app
+ * (services, Zustand, Redux, API handlers, navigation screens).
+ */
+declare function showMessage(options: FlashMessageOptions): void;
+/**
+ * Imperative helper to dismiss the currently displayed flash message.
+ */
+declare function hideMessage(): void;
+/**
+ * Modern alias for showMessage
+ */
+declare const flash: typeof showMessage;
+declare const dismissFlash: typeof hideMessage;
+
+interface FlashMessageContextValue {
+    show: (options: FlashMessageOptions) => void;
+    hide: () => void;
+}
+interface FlashMessageProviderProps extends FlashMessageContainerProps {
+    children: React.ReactNode;
+}
+declare const FlashMessageProvider: React.FC<FlashMessageProviderProps>;
+declare function useFlashMessage(): FlashMessageContextValue;
+
+interface BuiltInIconProps {
+    type: FlashMessageType;
+    size?: number;
+    color?: string;
+}
+declare const BuiltInIcon: React.FC<BuiltInIconProps>;
+
+declare const COLORS: Record<FlashMessageType, {
+    background: string;
+    text: string;
+    icon: string;
+}>;
+declare const styles: {
+    rootOverlay: {
+        position: "absolute";
+        left: number;
+        right: number;
+        zIndex: number;
+        elevation: number;
+    };
+    rootTop: {
+        top: number;
+    };
+    rootBottom: {
+        bottom: number;
+    };
+    rootCenter: {
+        top: number;
+        bottom: number;
+        justifyContent: "center";
+        alignItems: "center";
+    };
+    toastContainer: any;
+    floatingContainer: {
+        marginHorizontal: number;
+        borderRadius: number;
+        borderWidth: number;
+        borderColor: string;
+    };
+    edgeToEdgeContainer: {
+        marginHorizontal: number;
+        borderRadius: number;
+    };
+    contentWrapper: {
+        flex: number;
+        flexDirection: "row";
+        alignItems: "center";
+        paddingVertical: number;
+        paddingHorizontal: number;
+    };
+    iconContainer: {
+        marginRight: number;
+        justifyContent: "center";
+        alignItems: "center";
+    };
+    textContainer: {
+        flex: number;
+        justifyContent: "center";
+    };
+    titleText: {
+        fontSize: number;
+        fontWeight: "600";
+        letterSpacing: number;
+        color: string;
+    };
+    descriptionText: {
+        fontSize: number;
+        fontWeight: "400";
+        color: string;
+        marginTop: number;
+        lineHeight: number;
+    };
+    actionButton: {
+        marginLeft: number;
+        paddingHorizontal: number;
+        paddingVertical: number;
+        borderRadius: number;
+        backgroundColor: string;
+    };
+    actionButtonText: {
+        fontSize: number;
+        fontWeight: "700";
+        color: string;
+    };
+    progressBarContainer: {
+        position: "absolute";
+        bottom: number;
+        left: number;
+        right: number;
+        height: number;
+        backgroundColor: string;
+    };
+    progressBarFill: {
+        height: "100%";
+        backgroundColor: string;
+    };
+};
+
+// @ts-ignore
+export = FlashMessage;
+export { BuiltInIcon, COLORS, FlashMessage, type FlashMessageAction, type FlashMessageContainerProps, type FlashMessageIcon, type FlashMessageOptions, type FlashMessagePosition, FlashMessageProvider, type FlashMessageRef, type FlashMessageTransition, type FlashMessageType, dismissFlash, flash, flashManager, hideMessage, showMessage, styles, useFlashMessage };