datadog-ux-utils Documentation - v1.0.0
    Preparing search index...

    Interface IdleTrackerOptions

    Configuration options for idle tracking.

    interface IdleTrackerOptions {
        idleAfterMs?: number;
        reportToDatadog?: boolean;
        onChange?: (isIdle: boolean) => void;
    }
    Index

    Properties

    idleAfterMs? reportToDatadog? onChange?

    Properties

    idleAfterMs?: number

    Time in milliseconds before the user is considered idle.

    60000 (1 minute)
    reportToDatadog?: boolean

    Whether to automatically send an action to Datadog when idle/active state changes.

    true
    onChange?: (isIdle: boolean) => void

    Optional callback fired when the idle state changes.

    Type declaration

      • (isIdle: boolean): void

      • Parameters

        • isIdle: boolean

          true if the user is now idle, false if active.

        Returns void

    Settings

    Member Visibility

    On This Page

    Properties