@vireocodedev/ui/sonner

Action

ExternalToast

ToasterProps as SonnerToasterProps

ToastClassnames

ToastT

ToastToDismiss

Renders the single global, MUI-themed Sonner notification region for an application.

/** Renders the single global, MUI-themed Sonner notification region for an application. */
export declare const VireoToaster: React.ForwardRefExoticComponent<import("./VireoToaster.types.js").VireoToasterSlotsAndSlotProps & {
    classes?: Partial<import("./VireoToaster.classes.js").VireoToasterClasses>;
    sx?: import("@mui/system").SxProps<import("@mui/material").Theme>;
} & Omit<ToasterProps, "className" | "style" | "theme"> & {
    className?: string;
    style?: React.CSSProperties;
} & React.RefAttributes<HTMLElement>>;

Valid keys for VireoToaster utility classes and theme style overrides.

/** Valid keys for VireoToaster utility classes and theme style overrides. */
export type VireoToasterClassKey = keyof VireoToasterClasses;

Utility classes available to VireoToaster.

/** Utility classes available to VireoToaster. */
export type VireoToasterClasses = Record<VireoToasterSlotName, string>;

Props VireoToaster inherits from its default root after excluding component-owned props.

/** Props VireoToaster inherits from its default root after excluding component-owned props. */
export type VireoToasterInheritedProps = Omit<ToasterProps, "className" | "style" | "theme"> & {
    className?: string;
    style?: React.CSSProperties;
};

Props owned by {@link VireoToaster }.

/** Props owned by {@link VireoToaster}. */
export type VireoToasterOwnProps = VireoToasterSlotsAndSlotProps & {
    /** Override or extend the utility classes applied to each slot. */
    classes?: Partial<VireoToasterClasses>;
    /** Styles applied to Sonner's generated toaster root without introducing wrapper DOM. */
    sx?: SxProps<Theme>;
};

export type VireoToasterOwnerState = {
    mobile: boolean;
    themeMode: "light" | "dark";
    direction: NonNullable<ToasterProps["dir"]>;
    position: NonNullable<ToasterProps["position"]>;
    closeButton: boolean;
    expand: boolean;
    richColors: boolean;
};

Props accepted by {@link VireoToaster }.

/** Props accepted by {@link VireoToaster}. */
export type VireoToasterProps = VireoToasterOwnProps & VireoToasterInheritedProps;

export interface VireoToasterRootSlotPropsOverrides {
    [key: `data-${string}`]: VireoDataAttributeValue;
}

Replaceable semantic regions exposed by {@link VireoToaster }.

/** Replaceable semantic regions exposed by {@link VireoToaster}. */
export type VireoToasterSlots = {
    [TSlotName in VireoToasterSlotName]: React.ElementType;
};

Slot props exposed by {@link VireoToaster }.

/** Slot props exposed by {@link VireoToaster}. */
export type VireoToasterSlotsAndSlotProps = CreateSlotsAndSlotProps<VireoToasterSlots, {
    /** @default Sonner Toaster */
    root: SlotProps<typeof Toaster, VireoToasterRootSlotPropsOverrides, VireoToasterOwnerState>;
}>;

Returns the generated utility class name for a VireoToaster slot or state.

/** Returns the generated utility class name for a VireoToaster slot or state. */
export declare function getVireoToasterUtilityClass(slot: string): string;

toast

Generated utility class names keyed by each public VireoToaster class key.

/** Generated utility class names keyed by each public VireoToaster class key. */
export declare const vireoToasterClasses: VireoToasterClasses;