@yarcl/react
    Preparing search index...

    Interface ToastOptions

    Options for toast.

    interface ToastOptions {
        action?: { label: string; onClick: () => void };
        color?: Color;
        description?: ReactNode;
        dismissLabel?: string;
        duration?: number;
        gap?: Responsive<Spacing>;
        padding?: Responsive<Spacing>;
        radius?: Radius;
        textStyle?: TextStyle;
        title: ReactNode;
        urgent?: boolean;
    }
    Index
    action? color? description? dismissLabel? duration? gap? padding? radius? textStyle? title urgent?
    action?: { label: string; onClick: () => void }

    A single action, e.g. Undo. Choosing it dismisses the toast.

    color?: Color

    Accent color, from the colors config.

    config.defaults.color
    description?: ReactNode

    Supporting text.

    dismissLabel?: string

    Accessible name of this notification's dismiss button.

    config.labels.dismiss
    duration?: number

    Time before it dismisses itself, in ms. Paused while hovered or focused. 0 keeps it until dismissed.

    config.timing.toastDuration
    gap?: Responsive<Spacing>

    Space between the message, action and dismiss button, from the spacing config. Accepts a scalar or breakpoint map.

    config.components.Toast.gap ?? config.defaults.gap
    padding?: Responsive<Spacing>

    Inner spacing, from the spacing config. Accepts a scalar or breakpoint map.

    config.components.Toast.padding ?? config.defaults.padding
    radius?: Radius

    Corner radius, from the radii config.

    config.components.Toast.radius ?? config.defaults.radius
    textStyle?: TextStyle

    Typography style, from the typography.styles config.

    config.components.Toast.textStyle ?? config.defaults.labelStyle
    title: ReactNode

    Main message.

    urgent?: boolean

    Announces immediately (role="alert") instead of politely. Use for errors that need attention.

    Settings
    Member Visibility

    On This Page
    Properties