@pathscale/ui 1.1.37 → 1.1.39

package/dist/components/toast/Toast.d.ts

@@ -1,22 +1,158 @@
-import "./toast.css";
-import { type JSX } from "solid-js";
+import "./Toast.css";
+import { type Component, type JSX, type ParentComponent } from "solid-js";
+import { type ButtonProps } from "../button";
+import { type CloseButtonProps } from "../close-button";
 import type { IComponentBaseProps } from "../types";
-declare const horizontalOptions: {
-    readonly start: "toast-start";
-    readonly center: "toast-center";
-    readonly end: "toast-end";
-};
-declare const verticalOptions: {
-    readonly top: "toast-top";
-    readonly middle: "toast-middle";
-    readonly bottom: "toast-bottom";
-};
-type ToastPosition = {
-    horizontal?: keyof typeof horizontalOptions;
-    vertical?: keyof typeof verticalOptions;
-};
-export type ToastProps = ToastPosition & IComponentBaseProps & {
-    max?: number;
-} & Omit<JSX.HTMLAttributes<HTMLDivElement>, keyof ToastPosition | "max">;
-declare const Toast: (props: ToastProps) => JSX.Element;
+export declare const DEFAULT_GAP = 12;
+export declare const DEFAULT_MAX_VISIBLE_TOAST = 3;
+export declare const DEFAULT_SCALE_FACTOR = 0.05;
+export declare const DEFAULT_TOAST_TIMEOUT = 4000;
+export declare const DEFAULT_TOAST_WIDTH = 460;
+export type ToastPlacement = "bottom" | "bottom-start" | "bottom-end" | "top" | "top-start" | "top-end" | "bottom start" | "bottom end" | "top start" | "top end";
+export type ToastVariant = "default" | "accent" | "success" | "warning" | "danger" | "info" | "error";
+export type ToastActionProps = Omit<ButtonProps, "variant" | "size">;
+export interface ToastContentValue {
+    indicator?: JSX.Element;
+    title?: JSX.Element;
+    description?: JSX.Element;
+    variant?: ToastVariant;
+    actionProps?: ToastActionProps;
+    isLoading?: boolean;
+}
+export interface ToastQueueAddOptions {
+    key?: string;
+    timeout?: number;
+    onClose?: () => void;
+}
+export interface ToastQueueItem<T extends object = ToastContentValue> {
+    key: string;
+    content: T;
+    createdAt: number;
+    timeout: number;
+    isEntering: boolean;
+    isExiting: boolean;
+}
+export interface ToastQueueOptions {
+    maxVisibleToasts?: number;
+    exitDuration?: number;
+}
+export declare class ToastQueue<T extends object = ToastContentValue> {
+    private readonly readToasts;
+    private readonly setToasts;
+    private readonly listeners;
+    private readonly closeCallbacks;
+    private readonly timeoutMeta;
+    private readonly exitTimers;
+    readonly maxVisibleToasts?: number;
+    private paused;
+    private keyCounter;
+    private readonly exitDuration;
+    constructor(options?: ToastQueueOptions);
+    private emit;
+    private updateToasts;
+    private scheduleTimeout;
+    private clearTimeoutFor;
+    private clearExitTimerFor;
+    add(content: T, options?: ToastQueueAddOptions): string;
+    close(key: string): void;
+    remove(key: string, invokeOnClose?: boolean): void;
+    clear(invokeOnClose?: boolean): void;
+    pauseAll(): void;
+    resumeAll(): void;
+    subscribe(fn: () => void): () => void;
+    toasts(): ToastQueueItem<T>[];
+    get visibleToasts(): ToastQueueItem<T>[];
+    getQueue(): ToastQueue<T>;
+}
+export type ToastRootProps = Omit<JSX.HTMLAttributes<HTMLDivElement>, "children" | "title"> & IComponentBaseProps & {
+    children?: JSX.Element;
+    title?: JSX.Element;
+    description?: JSX.Element;
+    variant?: ToastVariant;
+    indicator?: JSX.Element;
+    actionProps?: ToastActionProps;
+    isLoading?: boolean;
+    onClose?: () => void;
+    isFrontmost?: boolean;
+    isHidden?: boolean;
+    isEntering?: boolean;
+    isExiting?: boolean;
+};
+export type ToastContentProps = Omit<JSX.HTMLAttributes<HTMLDivElement>, "children"> & IComponentBaseProps & {
+    children?: JSX.Element;
+};
+export type ToastIndicatorProps = Omit<JSX.HTMLAttributes<HTMLDivElement>, "children"> & IComponentBaseProps & {
+    children?: JSX.Element;
+    variant?: ToastVariant;
+};
+export type ToastTitleProps = Omit<JSX.HTMLAttributes<HTMLParagraphElement>, "children"> & IComponentBaseProps & {
+    children?: JSX.Element;
+};
+export type ToastDescriptionProps = Omit<JSX.HTMLAttributes<HTMLParagraphElement>, "children"> & IComponentBaseProps & {
+    children?: JSX.Element;
+};
+export type ToastActionButtonProps = ToastActionProps;
+export type ToastCloseButtonProps = Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, "children"> & Omit<CloseButtonProps, "children" | "startIcon" | "endIcon">;
+declare const ToastContent: ParentComponent<ToastContentProps>;
+declare const ToastIndicator: Component<ToastIndicatorProps>;
+declare const ToastTitle: ParentComponent<ToastTitleProps>;
+declare const ToastDescription: ParentComponent<ToastDescriptionProps>;
+declare const ToastActionButton: Component<ToastActionButtonProps>;
+declare const ToastCloseButton: Component<ToastCloseButtonProps>;
+declare const ToastRoot: ParentComponent<ToastRootProps>;
+export type ToastRenderFn = (toast: ToastQueueItem<ToastContentValue>, dismiss: () => void) => JSX.Element;
+export type ToastProviderProps = Omit<JSX.HTMLAttributes<HTMLDivElement>, "children"> & IComponentBaseProps & {
+    children?: JSX.Element;
+    placement?: ToastPlacement;
+    queue?: ToastQueue<ToastContentValue> | null;
+    width?: number | string;
+    gap?: number;
+    maxVisibleToasts?: number;
+    scaleFactor?: number;
+    renderToast?: ToastRenderFn;
+};
+declare const ToastProvider: ParentComponent<ToastProviderProps>;
+export interface HeroUIToastOptions {
+    description?: JSX.Element;
+    indicator?: JSX.Element;
+    variant?: ToastVariant;
+    actionProps?: ToastActionProps;
+    isLoading?: boolean;
+    timeout?: number;
+    onClose?: () => void;
+}
+export interface ToastPromiseOptions<T = unknown> {
+    loading: JSX.Element;
+    success: ((data: T) => JSX.Element) | JSX.Element;
+    error: ((error: Error) => JSX.Element) | JSX.Element;
+}
+type ToastFunction = ((message: JSX.Element, options?: HeroUIToastOptions) => string) & {
+    success: (message: JSX.Element, options?: Omit<HeroUIToastOptions, "variant">) => string;
+    danger: (message: JSX.Element, options?: Omit<HeroUIToastOptions, "variant">) => string;
+    error: (message: JSX.Element, options?: Omit<HeroUIToastOptions, "variant">) => string;
+    info: (message: JSX.Element, options?: Omit<HeroUIToastOptions, "variant">) => string;
+    warning: (message: JSX.Element, options?: Omit<HeroUIToastOptions, "variant">) => string;
+    promise: <T>(promise: Promise<T> | (() => Promise<T>), options: ToastPromiseOptions<T>) => string;
+    close: (key: string) => void;
+    pauseAll: () => void;
+    resumeAll: () => void;
+    clear: () => void;
+    getQueue: () => ToastQueue<ToastContentValue>;
+};
+declare const toastQueue: ToastQueue<ToastContentValue>;
+declare const toast: ToastFunction;
+type ToastComponent = ParentComponent<ToastRootProps> & {
+    Provider: ParentComponent<ToastProviderProps>;
+    Content: ParentComponent<ToastContentProps>;
+    Indicator: Component<ToastIndicatorProps>;
+    Title: ParentComponent<ToastTitleProps>;
+    Description: ParentComponent<ToastDescriptionProps>;
+    ActionButton: Component<ToastActionButtonProps>;
+    CloseButton: Component<ToastCloseButtonProps>;
+    Queue: typeof ToastQueue;
+    toast: ToastFunction;
+};
+declare const Toast: ToastComponent;
 export default Toast;
+export { ToastRoot, ToastProvider, ToastContent, ToastIndicator, ToastTitle, ToastDescription, ToastActionButton, ToastCloseButton, toast, toastQueue, };
+export type { ToastFunction };