Function startIdleTracker

startIdleTracker(opts?: IdleTrackerOptions): () => void

Starts tracking user idle state.

Parameters

opts: IdleTrackerOptions = {}
Idle tracking configuration.

Returns () => void

A function to stop idle tracking.

Example

import { startIdleTracker } from "datadog-ux-utils/idle";

const stop = startIdleTracker({
  idleAfterMs: 2 * 60 * 1000, // 2 minutes
  onChange: (isIdle) => {
    console.log(isIdle ? "User is idle" : "User is active");
  },
});

// Later, if you want to stop tracking:
stop();