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

    Interface ReportOptions

    Options for persistent report banners

    Customize the appearance and action button of persistent banner notifications displayed via Notifications.report.

    interface ReportOptions {
        actionText?: string;
        icon?: string;
    }
    Index

    Properties

    Properties

    actionText?: string

    Text to display on the optional action button

    If provided, an action button will be shown. When clicked, the report's promise resolves to true. Use action buttons for actions like "Retry", "Cancel", or "View Details".

    icon?: string

    Icon to display on the banner

    Use an icon name string to provide visual context for the report's status, for example 'sync' for syncing or 'dashed_cloud' for offline.