README

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:

###Demos and Docs

###Download

bower install floatThead

Features:

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 libs like datatables, perfect-scrollbar, bootstrap, and many more
Screen reader support
Plays nicely with angularjs

What it does not do:

Does not float the footer
Does not let you lock the first column like in excel
Safari and mobile safari are not supported. It might work, or it might not, depending on your markup and safari version.

Common Pitfalls

If you use css and html best practices, this plugin will work. If you are stuck in 1999, you better read this.

How to get help with the floatThead

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.

Download / Install:

Download

Latest Release

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

CDN Hosted

cdnjs: http://cdnjs.com/libraries/floatthead/
jsdelivr: http://www.jsdelivr.com/#!jquery.floatthead

Via Bower

Install using Bower:

bower install floatThead

Via NPM

npm install floatthead

Webjar for Maven, Gradle, SBT

https://github.com/webjars/floatThead

Requirements:

jQuery 1.8.x or better (1.9 compliant) (or jQuery 1.7.x and jQuery UI core)

Supported Browsers:

IE8 or better (read this)
Modern browsers

Demo & Docs:

DEMOS and Documentation

Using with AngularJS

I haven't written an official directive, but others have written wrappers:
https://github.com/brandon-barker/angular-floatThead

Using with IE9

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.

Change Log

1.3.1

allow 'useAbsolutePositioning', 'scrollingTop' and 'scrollingBottom' to be used, but yell about it via console.error

1.3.0

Breaking: renamed 'useAbsolutePositioning' option to position. value mappings (old -> new) are: [true -> 'absolute', false -> 'fixed', null -> 'auto']
Breaking: renamed 'scrollingTop' to top and 'scrollingBottom' to bottom
Breaking: removed cellTag and debounceResizeMs options
Breaking: removed floatThead-floatContainer class from the $floatContainer because floatThead-container class is already there and it is configurable via floatContainerClass option.
added autoReflow option
mkoryak#235 - fix tabindex of the floated header (thanks robinpoort)
mkoryak#242 - support for multiple tables within a single scrolling div
mkoryak#246 - enableAria:true causes javascript exception when using Colgroup
fixed getRowGroups, method which was busted when the header was floated
make grunt work in node 0.12

1.2.13

mkoryak#220 - Header and Body alignment problem
package.json was incorrect
autoReflow option should work better if your browser supports MutationObserver
added native support for tables within bootstrap3 tabs or jqueryui tabs
if a tables is hidden, the plugin will not try do anything when you scroll
the cat is cute

1.2.12

Huge thanks to CoryDuncan, ithielnor, jurko-gospodnetic and mhwlng for your PRs

mkoryak#168 - support for fractional column widths (no more alignment issues!)
mkoryak#175 - having tables within tables wont cause weird issues
mkoryak#165 - Fire an event when the header is floated / unfloated
mkoryak#180 - no space outside of table causes it to always float
mkoryak#185 - inner scrolling doesnt respect container border
mkoryak#186 - can init on a table without thead and later add it
mkoryak#194 - header sizing takes into account border-collapse rules
bunch of code and stylistic cleanup

1.2.11

now supports perfect-scrollbar plugin
slightly better mobile safari support
fix bower.json

1.2.10

play nicely with angularjs if it modifies the DOM behind the scenes
screen reader support via enableAria option
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

1.2.9

Deprecated the cellTag option, use headerCellSelector instead (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 destroy method that get the table back into a more pristine state

1.2.8

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

1.2.7

Changed license over to MIT

1.2.6

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

1.2.5

1.2.4

better support for really really wide tables
fixed mkoryak#53
fixed mkoryak#56

1.2.3

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: cellpadding and cellspacing
fixed mkoryak#52
fixed mkoryak#50
added floatWrapperClass option
added copyTableClass option

1.2.2

better support for tables with dynamically hidden columns
can now set a class on the floating header's container div

1.2.1

fixed issue with caption tag align:bottom
switched to uglifyjs to minify code

1.2.0

caption tag support
faster initialization when working with large tables (and small ones)

1.1.1

Fixed bugs introduced in 1.0.0 which caused issues in IE9

1.0.0

Updated code to be jquery 1.9+ compliant

Who is using floatThead ?

staticsitegenerators.net

Yii framework

api.tinata.co.uk

https://github.com/tinata/tinatapi/commit/b1cf62dd97a5caa76bafcd5ec3b4f12e6b88f385

Your site? email me: my last name at gmail

Other plugins

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.

License

MIT

intelogie / float-thead

Maintainers

Details