useIdle

Category

Sensors

Hook that defines the logic when the user is idle

import { useIdle } from '@elysiumorg/solid-use';

Usage

const { idle, lastActive } = useIdle();

Demo

source

Api

Parameters

Name	Type	Default	Note
milliseconds?	number	ONE_MINUTE	The idle time in milliseconds
options.initialState?	boolean	false	The options for the hook
options.events?	Array<keyof WindowEventMap>	IDLE_EVENTS

Returns

UseIdleReturn