@pixotope/toasts 0.0.0-stage → 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,134 @@
+import { HTMLAttributes, ReactNode } from "react";
+import "@pixotope/event-bus";
+//#region src/types.d.ts
+type ToastType = 'success' | 'error' | 'warning' | 'info' | 'clean' | 'insight';
+type ToastIcon = 'info' | 'warning';
+type ToastPosition = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+interface ToastAction {
+  label: ReactNode;
+  onClick: (toast: Toast) => void;
+}
+/** Everything about a toast except its title; also the shape of `<Toaster toastOptions>` defaults. */
+interface ToastOptions {
+  /** Reusing the id of a shown toast updates it in place and bumps its `count`. */
+  id?: string;
+  type?: ToastType;
+  subtitle?: ReactNode;
+  description?: ReactNode;
+  /** Monospace block for codes, paths or error details. */
+  note?: ReactNode;
+  icon?: ToastIcon;
+  action?: ToastAction;
+  /** Milliseconds before the toast dismisses itself; `Infinity` keeps it until dismissed. */
+  duration?: number;
+  showTime?: boolean;
+  /** Text left of the time, e.g. "Message received:". */
+  timeLabel?: ReactNode;
+  /** Shows the close button. */
+  dismissible?: boolean;
+  /** Shows the copy-to-clipboard button. */
+  copyable?: boolean;
+  className?: string;
+  /** Called once when the user or the timer dismisses the toast; not called by `toast.remove`. */
+  onClose?: (toast: Toast) => void;
+}
+interface ToastInput extends ToastOptions {
+  title: ReactNode;
+}
+interface Toast extends Omit<ToastInput, 'id' | 'type'> {
+  id: string;
+  type: ToastType;
+  /** How many times this id was shown; 1 for a new toast. */
+  count: number;
+  createdAt: number;
+  updatedAt: number;
+  /** False while the toast plays its exit animation before removal. */
+  visible: boolean;
+}
+//#endregion
+//#region src/toast.d.ts
+type ToastShorthand = (title: ToastInput['title'], options?: Omit<ToastOptions, 'type'>) => string;
+declare const show: (input: ToastInput) => string;
+/**
+ * Shows a toast and returns its id. Works outside React; a mounted
+ * `<Toaster>` renders it.
+ */
+declare const toast$1: typeof show & {
+  success: ToastShorthand;
+  error: ToastShorthand;
+  warning: ToastShorthand;
+  info: ToastShorthand;
+  clean: ToastShorthand;
+  insight: ToastShorthand;
+  /** Plays the exit animation, then removes; omit the id to dismiss all. */
+  dismiss: (id?: string) => void;
+  /** Removes immediately without calling `onClose`; omit the id to remove all. */
+  remove: (id?: string) => void;
+};
+//#endregion
+//#region src/useToasts.d.ts
+type ToastDefaults = Omit<ToastOptions, 'id'>;
+interface UseToastsOptions {
+  /** Most toasts returned at once; the rest wait, and their timers do not run yet. */
+  limit?: number;
+  /** Defaults for fields a toast leaves undefined. */
+  toastOptions?: ToastDefaults;
+}
+interface UseToastsResult {
+  toasts: Toast[];
+  dismiss: (id?: string) => void;
+  remove: (id?: string) => void;
+  pause: (id: string) => void;
+  resume: (id: string) => void;
+  pauseAll: () => void;
+  resumeAll: () => void;
+}
+/**
+ * Headless access to the toast store, for rendering toasts with your own
+ * components. Starts the auto-dismiss timer of every toast it returns.
+ */
+export declare const useToasts: ({ limit, toastOptions }?: UseToastsOptions) => UseToastsResult;
+//#endregion
+//#region src/Toaster.d.ts
+interface ToastOffset {
+  top?: number;
+  right?: number;
+  bottom?: number;
+  left?: number;
+}
+interface RenderToastHelpers {
+  dismiss: () => void;
+  pause: () => void;
+  resume: () => void;
+}
+interface ToasterProps {
+  position?: ToastPosition;
+  /** Distance in px from the viewport edges the position touches. */
+  offset?: ToastOffset;
+  /** Most toasts shown at once; later ones wait for a free slot. */
+  limit?: number;
+  zIndex?: number;
+  className?: string;
+  /** Defaults for fields a toast leaves undefined. */
+  toastOptions?: ToastDefaults;
+  /** Replaces the default visual; render `ToastNotification` to wrap it. */
+  renderToast?: (toast: Toast, helpers: RenderToastHelpers) => ReactNode;
+  /** Portal target; defaults to `document.body`. */
+  container?: Element | null;
+}
+/** Renders toasts raised with `toast()`. Mount one per app. */
+export declare const Toaster: ({ position, offset, limit, zIndex, className, toastOptions, renderToast, container }: ToasterProps) => import("react").ReactPortal | null;
+//#endregion
+//#region src/ToastNotification.d.ts
+interface ToastNotificationProps extends Omit<HTMLAttributes<HTMLDivElement>, 'title'> {
+  toast: Toast;
+  onDismiss?: () => void;
+}
+/** The default Pixotope toast visual, also usable inside `renderToast`. */
+export declare const ToastNotification: ({ toast, onDismiss, className, onMouseDown, onMouseEnter, ...rest }: ToastNotificationProps) => import("react").JSX.Element;
+//#endregion
+//#region src/core.d.ts
+export declare const DEFAULT_TOAST_DURATION = 3000;
+//#endregion
+export { type RenderToastHelpers, type Toast, type ToastAction, type ToastDefaults, type ToastIcon, type ToastInput, type ToastNotificationProps, type ToastOffset, type ToastOptions, type ToastPosition, type ToastShorthand, type ToastType, type ToasterProps, type UseToastsOptions, type UseToastsResult, toast$1 as toast };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,134 @@
+import { EventBus } from "@pixotope/event-bus";
+import { HTMLAttributes, ReactNode } from "react";
+//#region src/types.d.ts
+type ToastType = 'success' | 'error' | 'warning' | 'info' | 'clean' | 'insight';
+type ToastIcon = 'info' | 'warning';
+type ToastPosition = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+interface ToastAction {
+  label: ReactNode;
+  onClick: (toast: Toast) => void;
+}
+/** Everything about a toast except its title; also the shape of `<Toaster toastOptions>` defaults. */
+interface ToastOptions {
+  /** Reusing the id of a shown toast updates it in place and bumps its `count`. */
+  id?: string;
+  type?: ToastType;
+  subtitle?: ReactNode;
+  description?: ReactNode;
+  /** Monospace block for codes, paths or error details. */
+  note?: ReactNode;
+  icon?: ToastIcon;
+  action?: ToastAction;
+  /** Milliseconds before the toast dismisses itself; `Infinity` keeps it until dismissed. */
+  duration?: number;
+  showTime?: boolean;
+  /** Text left of the time, e.g. "Message received:". */
+  timeLabel?: ReactNode;
+  /** Shows the close button. */
+  dismissible?: boolean;
+  /** Shows the copy-to-clipboard button. */
+  copyable?: boolean;
+  className?: string;
+  /** Called once when the user or the timer dismisses the toast; not called by `toast.remove`. */
+  onClose?: (toast: Toast) => void;
+}
+interface ToastInput extends ToastOptions {
+  title: ReactNode;
+}
+interface Toast extends Omit<ToastInput, 'id' | 'type'> {
+  id: string;
+  type: ToastType;
+  /** How many times this id was shown; 1 for a new toast. */
+  count: number;
+  createdAt: number;
+  updatedAt: number;
+  /** False while the toast plays its exit animation before removal. */
+  visible: boolean;
+}
+//#endregion
+//#region src/toast.d.ts
+type ToastShorthand = (title: ToastInput['title'], options?: Omit<ToastOptions, 'type'>) => string;
+declare const show: (input: ToastInput) => string;
+/**
+ * Shows a toast and returns its id. Works outside React; a mounted
+ * `<Toaster>` renders it.
+ */
+declare const toast$1: typeof show & {
+  success: ToastShorthand;
+  error: ToastShorthand;
+  warning: ToastShorthand;
+  info: ToastShorthand;
+  clean: ToastShorthand;
+  insight: ToastShorthand;
+  /** Plays the exit animation, then removes; omit the id to dismiss all. */
+  dismiss: (id?: string) => void;
+  /** Removes immediately without calling `onClose`; omit the id to remove all. */
+  remove: (id?: string) => void;
+};
+//#endregion
+//#region src/useToasts.d.ts
+type ToastDefaults = Omit<ToastOptions, 'id'>;
+interface UseToastsOptions {
+  /** Most toasts returned at once; the rest wait, and their timers do not run yet. */
+  limit?: number;
+  /** Defaults for fields a toast leaves undefined. */
+  toastOptions?: ToastDefaults;
+}
+interface UseToastsResult {
+  toasts: Toast[];
+  dismiss: (id?: string) => void;
+  remove: (id?: string) => void;
+  pause: (id: string) => void;
+  resume: (id: string) => void;
+  pauseAll: () => void;
+  resumeAll: () => void;
+}
+/**
+ * Headless access to the toast store, for rendering toasts with your own
+ * components. Starts the auto-dismiss timer of every toast it returns.
+ */
+export declare const useToasts: ({ limit, toastOptions }?: UseToastsOptions) => UseToastsResult;
+//#endregion
+//#region src/Toaster.d.ts
+interface ToastOffset {
+  top?: number;
+  right?: number;
+  bottom?: number;
+  left?: number;
+}
+interface RenderToastHelpers {
+  dismiss: () => void;
+  pause: () => void;
+  resume: () => void;
+}
+interface ToasterProps {
+  position?: ToastPosition;
+  /** Distance in px from the viewport edges the position touches. */
+  offset?: ToastOffset;
+  /** Most toasts shown at once; later ones wait for a free slot. */
+  limit?: number;
+  zIndex?: number;
+  className?: string;
+  /** Defaults for fields a toast leaves undefined. */
+  toastOptions?: ToastDefaults;
+  /** Replaces the default visual; render `ToastNotification` to wrap it. */
+  renderToast?: (toast: Toast, helpers: RenderToastHelpers) => ReactNode;
+  /** Portal target; defaults to `document.body`. */
+  container?: Element | null;
+}
+/** Renders toasts raised with `toast()`. Mount one per app. */
+export declare const Toaster: ({ position, offset, limit, zIndex, className, toastOptions, renderToast, container }: ToasterProps) => import("react").ReactPortal | null;
+//#endregion
+//#region src/ToastNotification.d.ts
+interface ToastNotificationProps extends Omit<HTMLAttributes<HTMLDivElement>, 'title'> {
+  toast: Toast;
+  onDismiss?: () => void;
+}
+/** The default Pixotope toast visual, also usable inside `renderToast`. */
+export declare const ToastNotification: ({ toast, onDismiss, className, onMouseDown, onMouseEnter, ...rest }: ToastNotificationProps) => import("react").JSX.Element;
+//#endregion
+//#region src/core.d.ts
+export declare const DEFAULT_TOAST_DURATION = 3000;
+//#endregion
+export { type RenderToastHelpers, type Toast, type ToastAction, type ToastDefaults, type ToastIcon, type ToastInput, type ToastNotificationProps, type ToastOffset, type ToastOptions, type ToastPosition, type ToastShorthand, type ToastType, type ToasterProps, type UseToastsOptions, type UseToastsResult, toast$1 as toast };
+//# sourceMappingURL=index.d.ts.map