# @codingheads/sticky-header 中文文档

规范地址：https://npmcn.com/package/%40codingheads/sticky-header/

版本：1\.0\.2
npm 元数据更新时间：2022-04-05T00:09:35.442Z
中文译文更新时间：2026-11-10T09:11:59.274Z
软件包许可：GPL-3

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

原始 npm 页面：https://www.npmjs.com/package/%40codingheads/sticky-header
原文对照：https://npmcn.com/package/%40codingheads/sticky-header/?lang=original
项目主页：https://github.com/Codingheads-Developer/sticky-header
源码仓库：https://github.com/Codingheads-Developer/sticky-header

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

- 包体积（解压后）：86.4 kB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-07-10T09:00:12.912Z
- 最新版本发布：2021-07-10T09:17:36.357Z
- 近 30 天下载量：5729（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

一个允许您创建粘贴头的库. 用这个 `position: sticky` 和交叉观察员

## 安装

```sh
npm install @codingheads/sticky-header
```

也可以使用：`pnpm add @codingheads/sticky-header`、`yarn add @codingheads/sticky-header`、`bun add @codingheads/sticky-header`

## README

# 粘贴页眉

这个库允许您创建粘贴头. 用这个 `position: sticky` 和交叉观察员.

插件不需要jQuery,但如果jQuery存在于页面上,它会加入到jQuery中.

## 安装

使用 npm(或纱线)来安装软件包.

```npm2yarn
npm install --save @codingheads/sticky-header
```

## 在 JavaScript 中初始化

要初始化库,您需要创建一个新的实例 `StickyHeader` 类 :

```javascript
import StickyHeader from '@codingheads/sticky-header';

const header = document.querySelector('header.page-header');
new StickyHeader(header, options);
```

或使用 j 查询 :

```javascript
import '@codingheads/sticky-header';

$('header.page-header).stickyHeader(options);
```

选项对象可具有以下属性:

-   `mainClass` - 插件初始化时添加的类( 默认 ): `sticky`(中文(简体) )
-   `pinnedClass` - 元素变成"粘"时添加的类别(默认: `sticky-pinned`(中文(简体) )
-   `unpinnedClass` - 当元素变成"不粘"时,该类添加(默认: `sticky-unpinned`(中文(简体) )
-   `offset` - 元素应当成为“ stuck” (默认: 0) 的偏移( 像素)
-   `addBodyClasses` - 增加一个 `pinnedClass` 财务报告和审定财务报表 `unpinnedClass` 分类到正文元素(默认:真实)

## 警告

1.  该插件使用 `position: sticky`。这在所有现代浏览器中都得到了支持。 不过, `position: sticky` 具有一些要求: 您不能有父元素 `overflow: hidden`,否则无效(该位置将静止)。 如果无法启动,请检查是否没有 `overflow: hidden` 在父元素上.
    
2.  如果您根据"stuck"/"unstuck"的状态更改了标题大小,可能需要防止窗口在这样的情况下滚动(标题会将内容推后).
    

如果你有一个 `#wrapper` 元素围绕内容(包括标题),您可以做这样的事情:

```css
header.sticky {
  top: 0;
  position: sticky;
}

/** fix for when the header grows in size when it becomes unpinned and the scroll position changes (we need to scroll more) **/
@supports (position: sticky) {
  body.sticky-unpinned #wrapper {
    overflow-anchor: none;
  }
}

```

## 常见问题

### @codingheads/sticky-header 是什么？

一个允许您创建粘贴头的库\. 用这个 position: sticky 和交叉观察员

### 如何安装 @codingheads/sticky-header？

在项目目录运行 npm install @codingheads/sticky-header，或使用 pnpm add / yarn add / bun add。

### @codingheads/sticky-header 支持 TypeScript 吗？

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

### @codingheads/sticky-header 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @codingheads/sticky-header 可以商用吗？

@codingheads/sticky-header 使用 GPL-3 许可。声明的许可为 GPL-3，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @codingheads/sticky-header 的下载量有多少？

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

### @codingheads/sticky-header 还在维护吗？

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