Float the table header without special css. This plugin assumes nothing about your table markup and "just works" without losing your events or styles. Supports floating the header while scrolling within the window or while scrolling within a container with overflow. Plays nice with AngularJS and datatables and well written plugins. My cat loves it.
Check out the demo / docs page for copious examples:
- Floats the table header - it remains in viewport as you scroll
- Works on tables within a scrollable container or whole window scrolling
- Horizontal or vertical scrolling
- Doesn't clone the thead - so your events stay bound
- Doesn't mess with your styles
- Works on any table
- Requires no special css
- Works with datatables out of the box
- Screen reader support
- Plays nicely with angularjs
- Does not float the footer
- Does not let you lock the first column like in excel
- Safari is not fully supported. It might work, or it might not, depending on your markup and safari version.
If you use css and html best practices, this plugin will work. If you are stuck in 1999, you better read this.
All issues should be reported through github. If you don't have an account you can make one.
Providing the following will greatly increase the chances of your issue being resolved quickly:
- Include the browser and operating system where you are having the problem. If its IE, a screenshot is also nice since I don't have quick access to that abomination.
- Provide a jsfiddle that reproduces your issue in its simplest form possible. If its hard to read your code, you did it wrong.
- A description of the issue and steps to reproduce
I will do my best to help you in a timely manner.
Inside of that zip the following javascript files are of interest to you:
/dist/jquery.floatThead.js= development version/dist/jquery.floatThead.min.js= production version
if your project includes underscore and you want to save a few bytes you can use the slim version:
/dist/jquery.floatThead-slim.js/dist/jquery.floatThead-slim.min.js
http://cdnjs.com/libraries/floatthead/
Install using Bower:
bower install floatTheadnpm install floattheadhttps://github.com/webjars/floatThead
- jQuery 1.8.x or better (1.9 compliant) (or jQuery 1.7.x and jQuery UI core)
- IE8 or better (read this)
- Modern browsers
I haven't written an official directive, but others have written wrappers:
https://github.com/brandon-barker/angular-floatThead
FloatThead will not work properly in IE9 unless you have the following meta tag in the head of the page:
<meta http-equiv="X-UA-Compatible" content="IE=11; IE=10; IE=9; IE=8; IE=7; IE=EDGE" />With very big tables, you may also run into this exciting bug: http://stackoverflow.com/questions/5805956/internet-explorer-9-not-rendering-table-cells-properly
Watch for it.
- now supports perfect-scrollbar plugin
- slightly better mobile safari support
- fix bower.json
- play nicely with angularjs if it modifies the DOM behind the scenes
- screen reader support via
enableAriaoption - mkoryak#122 - better default options for ie
- mkoryak#121 - header layout bug
- mkoryak#128 - issues with scrollbar size detection in certain layouts
- mkoryak#127 - destroy not removing some elements
- Deprecated the
cellTagoption, useheaderCellSelectorinstead (see docs) - mkoryak#101 - huge performance improvement
- mkoryak#98 - Border-collapse ignored on scroll
- mkoryak#99 - Incorrect scroll width calculation in some cases
- A couple of updates to the
destroymethod that get the table back into a more pristine state
- mkoryak#82 - table not disappearing when out of view in a certain layout
- mkoryak#84 - header not aligned if your scrolling container has a certain height
- mkoryak#86 - do not take hidden TRs into account when calculating header height
- Changed license over to MIT
- new stuff:
- added support for tables with existing
<colgroup>elements - added a grunt task to build dist to master
- bug fixes:
- mkoryak#57 - window resize issues on windows
- mkoryak#70 - better support for responsive tables
- mkoryak#71 - incorrectly unbinding events in destroy
- mkoryak#75 - dom leakage in destroy
- bug fixes:
- mkoryak#66
- mkoryak#65
- mkoryak#62
- better support for really really wide tables
- fixed mkoryak#53
- fixed mkoryak#56
- removed underscore dependency, added a slim version which is very slightly smaller and requires underscore
- now supporting a few evil deprecated table attributes that people still use:
cellpaddingandcellspacing - fixed mkoryak#52
- fixed mkoryak#50
- added floatWrapperClass option
- added copyTableClass option
- better support for tables with dynamically hidden columns
- can now set a class on the floating header's container div
- fixed issue with caption tag align:bottom
- switched to uglifyjs to minify code
captiontag support- faster initialization when working with large tables (and small ones)
- Fixed bugs introduced in 1.0.0 which caused issues in IE9
- Updated code to be jquery 1.9+ compliant
Your site? email me: my last name at gmail
There are plenty of other fixed header / floating header / scrolling table header plugins that attempt to do the same thing this plugin does. None of them support both window and overflow scrolling and many of them depend on special css or require that you set the table column widths. Some of them are good and some of them suck. Go ahead and check them out too.
I have compiled a list here with comments on each one:
| Plugin | Window Scrolling | Overflow-X Scrolling | Overflow-Y Scrolling | No Special CSS | Keeps Bound Events | Freeze Columns | |:-------------:|:-------------:|:-----:|:-------------:|:-------------:|:-----:|:-----:|:-----:| | FloatThead | yes | yes | yes | yes | yes | no | | Fixed-Table-Header | no | yes | no | yes | no | no | | jquery.scrollTableBody | no | yes | yes | no | ?? | no | | Fixed table rows cols | no | yes | yes | no | ?? | yes | | Table Fixed Header | yes | no | no | yes | no | no | | Sticky Table Header | yes | no | no | yes | yes | no | | Grid | no | yes | yes | yes | yes | no |
Fixed-Table-Header This is the original. It has been around for ages and it will be the first plugin you find when you start looking. It also has a ton of open unresolved issues. It does not support window scrolling, it does not seem to support y-scrolling withing the container. It loses the events you attached to the thead. Lots of open issues. Stay away.
Fixed table rows cols Does not support window scrolling. Requires you to specify the column widths for the table. This means that the table will not be able to optimally lay itself out. It does support freezing columns in place. If you need that, this might be the plugin for you.
jquery.scrollTableBody Does not support window scrolling. A newcomer to the scene, not a mature project. Has some major issues with cell padding. Stay away until issues are resolved.
Grid This lib is very different from the rest because its main usecase is to give you a sortable grid. You do not run this plugin on an existing table - you need to provide a json or xml data source. This is a great lightweight replacement for datatables. This may be the plugin for you if you are not converting an existing table.
Table Fixed Header This is a window scrolling plugin, does not support overflow scrolling. Does not work properly when the window is resized and the table width changes. Floated header sticks around if you scroll past table. Author welcomes pull requests but does not fix issues. Stay away
Sticky Table Header This is a window scrolling plugin. Does not support overflow scrolling. It is probably the best window scrolling plugin (besides this one). The author seems to fix issues as they arise.
MIT