原生javascript 固定表头原理与源码

时间:2024-12-27 08:34:38

我在工作中需要固定表头这个功能,我不想去找,没意思。于是就写了一个,我写的是angularjs 自定义指令 起了个 "fix-header" ,有人叫  “freeze-header” ,算了,看心情吧,最近心情不太好就不改了~~~

想了想,我还是改成原生吧,angularjs就是个毛毛~~~。

先讲一下思路:

1.想一想,再想一想,肯定用定位了,具体是绝对定位还是固定定位,看实际情况;

    2.clone 一份thead元素,用于再创建一个定位的表头;

    3.clone有点坑,不能clone当前元素的 实际 宽高 和 事件, 只能获取原先的加上;

    4.加scroll事件;

    5.我很开心,成功了~~~~;

先把页面创建了 ,就叫fixHeaderDemo.html,如下:

 <!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<style>
*{box-sizing: border-box;}
.table{max-width: 100%; width: 100%;border-collapse: collapse;}
.table>thead>tr>th{background-color: #059ca1; color:#FFF; padding-top:10px;padding-bottom: 10px;}
.table>thead>tr>th,.table>tbody>tr>td{
border:1px solid #CCC;
}
</style>
</head>
<body>
<div style="width: 80%; margin:40px auto; height: 100px;overflow: auto;position: relative;">
<table class="table">
<thead>
<tr>
<th>Name1</th>
<th>Name2</th>
<th>Name3</th>
</tr>
</thead>
<tbody>
<tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr><tr>
<td>亚瑟</td>
<td>荆轲</td>
<td>程咬金</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>

上面的都太小儿科了,js才是关键。

其实真的很简单,有兴趣还能在优化:

第一步,先来个构造函数,这个构造函数接收一个参数,也就是你要固定的那个表格,代码如下:

 function FixHeader(tableElement){
this.tableElement=tableElement;
}

第二步,写FixHeader构造函数的方法:

 FixHeader.prototype={
constructor:FixHeader,
init:function(){
//这个位置是初始化的位置
}
};

第三步,其实我们的滚动是表格外面有个div父级元素,设置了他的最大高度,当超过这个最大高度就显示滚动条。那么,我们在初始化函数中肯定先获取div和表头元素等一些初始的事情;

  init:function(){
//获取表格的父级元素
this.tableParent=this.tableElement.parentNode;
//获取thead元素
this.header=this.tableElement.querySelector('thead');
//克隆thead元素
this.cloneHeader=this.header.cloneNode(true);
}

第四步,我们要用克隆的数据,往表格中插入一个固定的表头,可能会问为什么要clone一下呢?因为如果直接操作原来的表头数据会直接影响,我们不是要去动原来的东西,那些东西已经完美了;如果你有兴趣可以

尝试一下,你会收获很大。在FixHeader原型中加了一个cloneFixHeader函数;

 cloneFixHeader:function(){
this.cloneHeader.className='cloneThead';
this.cloneHeader.style.position='absolute';
this.cloneHeader.style.top=0;
this.cloneHeader.style.left=0;
this.cloneHeader.style.right='-1px';
this.tableElement.appendChild(this.cloneHeader);
}

上面的代码大家肯定明白,就是给clone的元素加一些样式和属性,加一个className是为了标识它是克隆的。那先看看效果,在初始化函数中调用cloneFixHeader()函数;

运行的截图如下:

原生javascript 固定表头原理与源码

我的天哪,这是怎么回事,怎么这个熊样了。哈哈。。。上面我已经说了clone不能把原来的宽高和事件一起克隆了,有些人是在css中把每个表格的宽度都写死,这是多么不好的做法,每次加或者减一列,都要修改css中的宽度。那我们是怎么解决的呢?太简单了,把每个元素的宽高设置到clone的元素中不就可以了吗!

 cloneFixHeader:function(){
var cloneThs=this.cloneHeader.children[0].children,
ths=this.header.children[0].children,
th,cloneTh,i=0,l=cloneThs.length;
for(;i<l;i++){
th=ths[i];cloneTh=cloneThs[i];
cloneTh.style.width=th.offsetWidth+'px';
cloneTh.style.height=th.offsetHeight+'px';
}
this.cloneHeader.className='cloneThead';
this.cloneHeader.style.position='absolute';
this.cloneHeader.style.top=0;
this.cloneHeader.style.left=0;
this.cloneHeader.style.right='-1px';
this.tableElement.appendChild(this.cloneHeader);
}

运行的结果如下(太完美了~~~):

原生javascript 固定表头原理与源码

第五步,应该监听滚动事件了。先在原型中加一个函数叫listenerScroll ,代码如下:

 listenerScroll:function(ev){
var top=ev.target.scrollTop,
//用于判断是否已经添加上了,添加了就不让再次添加
cloneThead=ev.target.querySelector('.cloneThead');
if(top>0){
if(cloneThead){
cloneThead.style.display='block';
cloneThead.style.top=top+'px';
return;
}
this.cloneFixHeader();
}else{
if(cloneThead){
cloneThead.style.display='none';
}
}
},

把在init中调用的cloneFixHeader() 函数换成监听事件:

 init:function(){
this.tableParent=this.tableElement.parentNode;
this.header=this.tableElement.querySelector('thead');
this.cloneHeader=this.header.cloneNode(true);
this.tableParent.addEventListener('scroll',this.listenerScroll.bind(this),false);
},

上面看似完美了,但是当你改变浏览器窗口大小时,你会惊讶于我是多么认真与细心,是的,当窗口变化时,一切都不完美了,原因你应该知道的呀!

截图如下:

原生javascript 固定表头原理与源码

亲,你想到了方法吗?是的,就是监听窗口大小变化,好了再加一个listenerResize函数:

 listenerResize:function(){
var that=this;
if(that.timer){
clearTimeout(that.timer);
}
that.timer=setTimeout(function(){
var top=that.tableParent.scrollTop;
if(top<=0){
return;
}
var globalWidth=that.global.innerWidth;
if(that.globalWidth&&that.globalWidth==globalWidth){
return;
}
that.globalWidth=globalWidth;
var cloneThead=that.tableElement.querySelector('.cloneThead'),
theads=that.tableElement.querySelectorAll('thead'),i,l=theads.length;
for(i=0;i<l;i++){
if(theads[i].className!='cloneThead'){
that.header=theads[i];
break;
}
}
if(cloneThead){
var cloneThs=cloneThead.children[0].children,
ths=that.header.children[0].children,
th,cloneTh;
l=cloneThs.length;
for(i=0;i<l;i++){
th=ths[i];cloneTh=cloneThs[i];
cloneTh.style.width=th.offsetWidth+'px';
cloneTh.style.height=th.offsetHeight+'px';
}
return;
}
that.cloneFixHeader();
},60);
},

最后全部js代码如下:

 function FixHeader(tableElement, global) {
this.tableElement = tableElement;
this.global = global;
this.timer = null;
}
FixHeader.prototype = {
constructor: FixHeader,
init: function () {
this.tableParent = this.tableElement.parentNode;
this.header = this.tableElement.querySelector('thead');
this.cloneHeader = this.header.cloneNode(true);
this.tableParent.addEventListener('scroll', this.listenerScroll.bind(this), false);
this.global.addEventListener('resize', this.listenerResize.bind(this), false);
},
listenerScroll: function (ev) {
var top = ev.target.scrollTop,
//用于判断是否已经添加上了,添加了就不让再次添加
cloneThead = ev.target.querySelector('.cloneThead');
if (top > 0) {
if (cloneThead) {
cloneThead.style.display = 'block';
cloneThead.style.top = top + 'px';
return;
}
this.cloneFixHeader();
} else {
if (cloneThead) {
cloneThead.style.display = 'none';
}
}
},
listenerResize: function () {
var that = this;
if (that.timer) {
clearTimeout(that.timer);
}
that.timer = setTimeout(function () {
var top = that.tableParent.scrollTop;
if (top <= 0) {
return;
}
var globalWidth = that.global.innerWidth;
if (that.globalWidth && that.globalWidth == globalWidth) {
return;
}
that.globalWidth = globalWidth;
var cloneThead = that.tableElement.querySelector('.cloneThead'),
theads = that.tableElement.querySelectorAll('thead'), i, l = theads.length;
for (i = 0; i < l; i++) {
if (theads[i].className != 'cloneThead') {
that.header = theads[i];
break;
}
}
if (cloneThead) {
var cloneThs = cloneThead.children[0].children,
ths = that.header.children[0].children,
th, cloneTh;
l = cloneThs.length;
for (i = 0; i < l; i++) {
th = ths[i];
cloneTh = cloneThs[i];
cloneTh.style.width = th.offsetWidth + 'px';
cloneTh.style.height = th.offsetHeight + 'px';
}
return;
}
that.cloneFixHeader();
}, 60);
},
cloneFixHeader: function () {
var cloneThs = this.cloneHeader.children[0].children,
ths = this.header.children[0].children,
th, cloneTh, i = 0, l = cloneThs.length;
for (; i < l; i++) {
th = ths[i];
cloneTh = cloneThs[i];
cloneTh.style.width = th.offsetWidth + 'px';
cloneTh.style.height = th.offsetHeight + 'px';
}
this.cloneHeader.className = 'cloneThead';
this.cloneHeader.style.position = 'absolute';
this.cloneHeader.style.top = 0;
this.cloneHeader.style.left = 0;
this.cloneHeader.style.right = '-1px';
this.tableElement.appendChild(this.cloneHeader);
}
};

调用方式如下:

  new FixHeader(document.querySelector('.table'), window).init();

总结:

表头固定可以用了,不过由于我知识有限,可能上面有错误的地方,请大家批评指出。