useIdle

类别

Sensors

导出体积

1.18 kB

上次更改

3 months ago

跟踪用户是否处于不活动状态。

示例

源码 playground (beta)

为了演示目的，在此演示中将空闲超时设置为 5秒（默认为1分钟）。

空闲状态: false

非活动时间: 0秒

使用方法

import { useIdle
 } from '@vueuse/core'

const { idle
, lastActive
 } = useIdle
(5 * 60 * 1000) // 5 分钟

console
.log
(idle
.value
) // true 或 false

程序化重置：

import { useCounter
, useIdle
 } from '@vueuse/core'
import { watch
 } from 'vue'

const { inc
, count
 } = useCounter
()

const { idle
, lastActive
, reset
 } = useIdle
(5 * 60 * 1000) // 5 分钟

watch
(idle
, (idleValue
) => {
  if (idleValue
) {
    inc
()
    console
.log
(`触发了 ${count
.value
} 次`)
    reset
() // 重新启动空闲计时器。不会更改 lastActive 值
  }
})

组件使用

vue

<template>
  <UseIdle v-slot="{ idle
 }" :timeout
="5 * 60 * 1000">
    是否空闲：{{ idle
 }}
  </UseIdle>
</template>

类型声明

export interface UseIdleOptions
  extends ConfigurableWindow,
    ConfigurableEventFilter {
  /**
   * 用于监听检测到的用户活动的事件名称
   *
   * @default ['mousemove', 'mousedown', 'resize', 'keydown', 'touchstart', 'wheel']
   */
  events
?: WindowEventName
[]
  /**
   * 监听文档可见性变化
   *
   * @default true
   */
  listenForVisibilityChange
?: boolean
  /**
   * ref idle 的初始状态
   *
   * @default false
   */
  initialState
?: boolean
}
export interface UseIdleReturn {
  idle
: ShallowRef
<boolean>
  lastActive
: ShallowRef
<number>
  reset
: () => void
}
/**
 * 跟踪用户是否处于非活动状态。
 *
 * @see https://vueuse.org/useIdle
 * @param timeout default to 1 minute
 * @param options IdleOptions
 */
export declare function useIdle
(
  timeout
?: number,
  options
?: UseIdleOptions,
): UseIdleReturn