@gentleduck/hooks

中文文档
1.0.0发布于 2026/05/30MITTypeScriptES Module零依赖近 30 天下载 3089

React hooks for Duck UI.

原始使用文档
文档目录4 节
  1. Quick Start
  2. Hooks
  3. useOnOpenChange and the scroll-locked class
  4. License

@gentleduck/hooks

@gentleduck/hooks

React hooks for Duck UI.

MIT - Changelog - Contributing - Docs

npm downloads MIT


React utility hooks.

Quick Start

bun add @gentleduck/hooks
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)
      }}
    />
  )
}

Hooks

HookImportDescription
useComposedRefs@gentleduck/hooks/use-composed-refsMerge multiple refs into one
scheduleTransitionTimeout@gentleduck/hooks/schedule-transition-timeoutSchedule a callback after a CSS transition (timer factory, not a hook)
useCopyToClipboard@gentleduck/hooks/use-copy-to-clipboardCopy text to clipboard
useDebounce@gentleduck/hooks/use-debounceDebounce a callback (real hook with unmount cleanup)
useIsMobile@gentleduck/hooks/use-is-mobileDetect mobile viewport
useMediaQuery@gentleduck/hooks/use-media-querySubscribe to media queries
useOnOpenChange@gentleduck/hooks/use-on-open-changeHandle open/close state with body scroll-lock
useStableId@gentleduck/hooks/use-stable-idGenerate a stable, SSR-safe ID with a prefix

Each hook is tree-shakeable via its own subpath export.

useOnOpenChange and the scroll-locked class

useOnOpenChange toggles a scroll-locked class on document.body while the controlled element is open. Style this in your global CSS:

body.scroll-locked {
  overflow: hidden;
}

Consumers that need a different class should fork the hook.

License

MIT

版本与发布记录

@gentleduck/hooks 共发布 16 个版本,首次发布于 2025/09/02;过去 12 个月发布了 8 个版本。

版本发布日期距今
1.0.0latest2026/05/305 个月前
0.2.22026/05/205 个月前
0.2.12026/05/066 个月前
0.2.02026/04/196 个月前
0.1.132026/03/158 个月前
0.1.122026/03/108 个月前

关于 @gentleduck/hooks 的常见问题

@gentleduck/hooks 是什么?

React hooks for 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 和提交记录判断。