@codebayu/react-native-toast/src/types.ts

The Package for creating dynamic and reusable styles in React Native App

import { ImageSourcePropType } from 'react-native';

// Types
type ToastType = 'warning' | 'success' | 'error';

interface ToastOptions {
  /** Duration in milliseconds before the toast disappears. Default is 4000ms. */
  duration?: number;
  /** Animation duration in milliseconds. Default is 400ms. */
  animationDuration?: number;
  /** Position from the top of the screen. Default is 80. */
  position?: number;
}

interface ToastRef {
  /** Show a toast with a message, type, and optional configuration. */
  show: (message: string, type?: ToastType, options?: ToastOptions) => void;
  /** Hide the toast, with an optional callback after hiding. */
  hide: (callback?: () => void) => void;
}

interface ToastConfig {
  text?: string;
  type?: ToastType;
  visible: boolean;
  duration: number;
  animationDuration: number;
  position: number;
}

/** The main Toast component. This should be rendered once in your app. */
interface ToastComponentProps {
  defaultDuration?: number;
  defaultAnimationDuration?: number;
  defaultPosition?: number;
  customIcons?: {
    success?: ImageSourcePropType;
    error?: ImageSourcePropType;
    warning?: ImageSourcePropType;
  };
  customColors?: {
    success?: { background: string; text: string };
    error?: { background: string; text: string };
    warning?: { background: string; text: string };
  };
}

interface ToastProps {
  showToast: (
    message: string,
    type?: ToastType,
    options?: ToastOptions,
  ) => void;
  hideToast: (callback?: () => void) => void;
}

// Fix the empty interface error by either:
// Option 1: Make it a type alias instead
type ToasterComponentProps = ToastComponentProps;

// Option 2: Add a comment explaining why it extends with no additional properties
// interface ToasterComponentProps extends ToastComponentProps {
//   // Currently identical to ToastComponentProps, may be extended in the future
// }

export type {
  ToastType,
  ToastOptions,
  ToastRef,
  ToastConfig,
  ToastComponentProps,
  ToastProps,
  ToasterComponentProps,
};