StickyTableHeaders 技术文档

1. 安装指南

使用 npm 安装

npm install sticky-table-headers

使用 Bower 安装

bower install StickyTableHeaders

使用 unpkg CDN

<script src="https://unpkg.com/sticky-table-headers"></script>

2. 项目使用说明

初始化插件

$('table').stickyTableHeaders();

移除插件

$('table').stickyTableHeaders('destroy');

手动触发更新

$(window).trigger('resize.stickyTableHeaders');

选项配置

fixedOffset

指定粘性表头与页面顶部的偏移量：

$('table').stickyTableHeaders({fixedOffset: $('#header')});

scrollableArea

指定滚动元素，默认为 window：

$('table').stickyTableHeaders({scrollableArea: $('.scrollable-area')});

cacheHeaderHeight

性能优化选项，设置为 true 时，插件仅在表格宽度变化时重新计算表头高度：

$('table').stickyTableHeaders({cacheHeaderHeight: true});

zIndex

设置表头的 z-index 值：

$('table').stickyTableHeaders({zIndex: 999});

重新初始化

在响应式页面中，用户调整浏览器大小时可能需要重新初始化插件：

$('table').stickyTableHeaders({fixedOffset: [new-offset]});

事件

插件会在目标 <table> 元素上触发以下事件：

• clonedHeader.stickyTableHeaders：表头克隆创建时触发。
• enabledStickiness.stickyTableHeaders：粘性表头启用时触发。
• disabledStickiness.stickyTableHeaders：粘性表头禁用时触发。

3. 项目API使用文档

初始化

$('table').stickyTableHeaders();

移除

$('table').stickyTableHeaders('destroy');

手动更新

$(window).trigger('resize.stickyTableHeaders');

选项

• fixedOffset：设置表头偏移量。
• scrollableArea：指定滚动元素。
• cacheHeaderHeight：优化性能。
• zIndex：设置表头的 z-index 值。

事件

• clonedHeader.stickyTableHeaders
• enabledStickiness.stickyTableHeaders
• disabledStickiness.stickyTableHeaders

4. 项目安装方式

使用 npm 安装

npm install sticky-table-headers

使用 Bower 安装

bower install StickyTableHeaders

使用 unpkg CDN

<script src="https://unpkg.com/sticky-table-headers"></script>

5. 已知问题

• Internet Explorer：需要显式设置 <th> 的 padding。
• Internet Explorer：表格的水平 margin 会导致表头滚动时错位。
• 与 tablesorter 插件一起使用时，在 Internet Explorer 8 中会失效。

6. 浏览器支持

• Chrome 35
• Firefox 29
• Internet Explorer 8-11
• Safari 5

注意：Internet Explorer 7 不支持，但会优雅降级。