# @custom-react-hooks/use-idle 中文文档

规范地址：https://npmcn.com/package/%40custom-react-hooks/use-idle/

版本：1\.5\.1
npm 元数据更新时间：2024-08-18T11:20:15.056Z
中文译文更新时间：2026-11-11T05:29:13.842Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40custom-react-hooks/use-idle
原文对照：https://npmcn.com/package/%40custom-react-hooks/use-idle/?lang=original
项目主页：https://custom-react-hooks-live.vercel.app/
源码仓库：https://github.com/djkepa/custom-react-hooks

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：7.1 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=16
- 首次发布：2023-12-01T23:48:17.936Z
- 最新版本发布：2024-08-18T11:20:14.881Z
- 近 30 天下载量：4185（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

`useIdle` 是一种反应钩,旨在检测应用程序中的用户不活动或闲置时间. 它在指定的不活动期后引发状态变化,使其对自动登录或活动等行动有用.

## 安装

```sh
npm install @custom-react-hooks/use-idle
```

也可以使用：`pnpm add @custom-react-hooks/use-idle`、`yarn add @custom-react-hooks/use-idle`、`bun add @custom-react-hooks/use-idle`

## README

# 使用 Idle 钩

`useIdle` 是一种反应钩,旨在检测应用程序中的用户不活动或闲置时间. 它在指定的不活动期后引发状态变化,使其对自动登录或活动等行动有用.

## 特征

-   **空闲时间检测 :** 跟踪用户在设定周期后不活动并更改状态.
-   **活动监测:** 将闲置的计时器重置于用户交互上, 如鼠标移动、按键压和滚动等.
-   **SSR 兼容性 :** 安全处理服务器侧渲染 `window` 对象.
-   **可配置的空闲时间 :** 允许设置自定义持续时间来定义用户不活动 .

## 安装

### 只安装当前钩

```bash
npm install @custom-react-hooks/use-idle
```

或者说

```bash
yarn add @custom-react-hooks/use-idle
```

### 安装全部钩

```sh
npm install @custom-react-hooks/all
```

或者说

```sh
yarn add @custom-react-hooks/all
```

## 导入虎克

这个 `useIdle` 钩必须使用下列命名的导入方式导入:

**已命名的导入 :**

```javascript
import { useIdle } from '@custom-react-hooks/use-idle';
```

这种方法确保了钩子无缝地融入到您的项目中,在您如何使用我们的包时保持一致性和可预测性.

## 使用量

```typescript
import React from 'react';
import { useIdle } from '@custom-react-hooks/all';
import { MoonIcon, SunIcon } from '@heroicons/react/24/solid';


const IdleComponent = () => {
  const isIdle = useIdle(1000);

  return (
    <div className="center">
      {isIdle ? (
        <div className="btns">
          <MoonIcon/>
          <p>Away</p>
        </div>
      ) : (
        <div className="btns">
          <SunIcon/>
          <p>Online</p>
        </div>
      )}
      <br />
      <p>To see the effect, do not move the mouse or touch the keyboard!</p>
    </div>
  );
};

export default IdleComponent;
```

在这个例子中,钩子用于检测用户被闲置超过3秒的时间.

## API 参考

### 参数

-   `idleTime`: 以毫秒计等待的时间, 然后再将用户视为闲置 .

### 回返

-   返回布尔状态,表示用户是否闲置 .

## 使用大小写

-   **自动注销**: 为安全目的在一段时间后自动登录用户.
-   **暂停背景活动**:暂停或减少动画或数据采集等背景活动.
-   **用户活动监测**: 跟踪用户活动以了解使用模式或分析.
-   **节能**:通过缩小屏幕或减少资源密集型任务来降低能耗.

## 捐款

对加强工作的贡献 `useIdle` 欢迎光临。 请随意向存储处提交问题或调取请求.

## 常见问题

### @custom-react-hooks/use-idle 是什么？

useIdle 是一种反应钩,旨在检测应用程序中的用户不活动或闲置时间\. 它在指定的不活动期后引发状态变化,使其对自动登录或活动等行动有用\.

### 如何安装 @custom-react-hooks/use-idle？

在项目目录运行 npm install @custom-react-hooks/use-idle，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @custom-react-hooks/use-idle 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @custom-react-hooks/use-idle 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @custom-react-hooks/use-idle 可以商用吗？

@custom-react-hooks/use-idle 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @custom-react-hooks/use-idle 的下载量有多少？

根据 npm 官方下载统计，@custom-react-hooks/use-idle 在 2026/10/11 – 2026/11/09 这 30 天内被下载 4,185 次，日均约 140 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @custom-react-hooks/use-idle 还在维护吗？

最新版本 1\.5\.1 发布于 2024/08/18（2 年前）；至今共发布 8 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/12/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。