Function useIdle

  • useIdle(ms?, initialState?): boolean

  • Returns a flag when idle for the specified time duration

    Parameters

    • ms: number = oneMinute

      time in milliseconds

    • initialState: boolean = false

      initial state for idle

    Returns boolean

    the idle state, true/false

    Example

    const state = useIdle();
    // Prints false, true after 1 minute
    console.log(state);

Settings

Member Visibility

Theme