# @gentleduck/hooks 中文文档

规范地址：https://npmcn.com/package/%40gentleduck/hooks/

版本：1\.0\.0
npm 元数据更新时间：2026-05-30T06:22:33.525Z
中文译文更新时间：2026-11-16T04:10:26.940Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gentleduck/hooks
原文对照：https://npmcn.com/package/%40gentleduck/hooks/?lang=original
项目主页：https://gentleduck.org/duck-ui
源码仓库：https://github.com/gentleeduck/gentleduck

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

- 包体积（解压后）：15.8 kB，31 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：0 个
- peer 依赖：react ^19\.2\.4，react-dom ^19\.2\.4
- 首次发布：2025-09-02T14:15:08.086Z
- 最新版本发布：2026-05-30T06:22:33.410Z
- 近 30 天下载量：3089（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 8 个）

## 中文简介

反应钩子为Duck UI.

## 安装

```sh
npm install @gentleduck/hooks
```

也可以使用：`pnpm add @gentleduck/hooks`、`yarn add @gentleduck/hooks`、`bun add @gentleduck/hooks`

## README

![@gentleduck/hooks](https://npmcn.com/package/public/logo-dark.svg)

# @ gentleduck/ hooks (英语)

反应钩子为Duck UI.

[麻省理工学院](https://npmcn.com/package/LICENSE) - 说吧 [更改日志](https://npmcn.com/package/CHANGELOG.md) - 说吧 [捐款](https://npmcn.com/package/CONTRIBUTING.md) - 说吧 [文档](https://gentleduck.org/duck-ui)

[![npm](https://img.shields.io/npm/v/@gentleduck/hooks.svg)](https://www.npmjs.com/package/@gentleduck/hooks) [![downloads](https://img.shields.io/npm/dm/@gentleduck/hooks.svg)](https://www.npmjs.com/package/@gentleduck/hooks) [![MIT](https://img.shields.io/npm/l/@gentleduck/hooks.svg)](https://npmcn.com/package/LICENSE)

* * *

反应效用钩.

## 快速启动

```bash
bun add @gentleduck/hooks
```

```tsx
import { useState } from 'react'
import { useDebounce } from '@gentleduck/hooks/use-debounce'

function Search() {
  const [value, setValue] = useState('')

  // useDebounce takes a CALLBACK (not a value). The returned function is
  // stable across renders, debounced by 300ms, and auto-cancelled on unmount.
  const debouncedSearch = useDebounce((q: string) => {
    fetch(`/api/search?q=${encodeURIComponent(q)}`)
  }, 300)

  return (
    <input
      value={value}
      onChange={(e) => {
        setValue(e.target.value)
        debouncedSearch(e.target.value)
      }}
    />
  )
}
```

## 钩子

| 钩子 | 导入 | 说明 |
| --- | --- | --- |
| `useComposedRefs` | `@gentleduck/hooks/use-composed-refs` | 将多对数合并为一 |
| `scheduleTransitionTimeout` | `@gentleduck/hooks/schedule-transition-timeout` | CSS 过渡后安排回调( 定时器厂, 不是钩子) |
| `useCopyToClipboard` | `@gentleduck/hooks/use-copy-to-clipboard` | 复制文本到剪贴板 |
| `useDebounce` | `@gentleduck/hooks/use-debounce` | 取消回调( 真正的钩子带有卸载清理) |
| `useIsMobile` | `@gentleduck/hooks/use-is-mobile` | 检测移动视图端口 |
| `useMediaQuery` | `@gentleduck/hooks/use-media-query` | 订阅媒体查询 |
| `useOnOpenChange` | `@gentleduck/hooks/use-on-open-change` | 处理打开/ 关闭状态, 机构滚动锁 |
| `useStableId` | `@gentleduck/hooks/use-stable-id` | 生成一个具有前缀的稳定、SSR安全ID |

每个钩子通过自己的子路径导出可被树震动.

### `useOnOpenChange` 编辑 `scroll-locked` 类

`useOnOpenChange` 切换一个 `scroll-locked` 课开始 `document.body` 时 控制元素打开。 在您的全球 CSS 中样式 :

```css
body.scroll-locked {
  overflow: hidden;
}
```

需要不同阶层的消费者应该把钩子叉开.

## 许可证

麻省理工学院

## 常见问题

### @gentleduck/hooks 是什么？

反应钩子为Duck UI\.

### 如何安装 @gentleduck/hooks？

在项目目录运行 npm install @gentleduck/hooks，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.2\.4）、react-dom（^19\.2\.4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gentleduck/hooks 支持 TypeScript 吗？

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

### @gentleduck/hooks 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gentleduck/hooks 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gentleduck/hooks 可以商用吗？

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

### @gentleduck/hooks 的下载量有多少？

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

### @gentleduck/hooks 还在维护吗？

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

