Lime Web Components API Documentation - v7.4.0
    Preparing search index...

    Interface NotificationOptions

    Options for toast notifications

    Customize the behavior and appearance of non-blocking notifications displayed via Notifications.notify.

    interface NotificationOptions {
        actionText?: string;
        dismissible?: boolean;
        multiline?: boolean;
        timeout?: number;
    }
    Index

    Properties

    actionText?: string

    Text to display on the optional action button

    If provided, an action button will be shown. When clicked, the notification's promise resolves to true. Use action buttons for quick follow-up actions like "Undo", "View", or "Dismiss".

    dismissible?: boolean

    Set to false to hide the close button

    By default the notification carries a close button, so users can dismiss it before the timeout expires. Hide the button when an actionText button is the only answer you want.

    true
    
    multiline?: boolean

    Set to true to display the message on multiple lines

    Setting this property has no effect. The underlying limel-snackbar ignores it and will remove it in a future major version. Long messages already wrap, use timeout to give readers more time.

    timeout?: number

    Number of milliseconds to wait before the notification auto-dismisses

    After this duration, the notification will automatically fade out. If not specified, uses a default timeout. Set to a higher value for longer messages that need more reading time, for example 8000 for eight seconds.