floatthead

<p align="left"> <h1> <a href="https://github.com/mkoryak/floatThead/releases">jquery.floatThead</a> <a href="https://unpkg.com/floatthead/dist/jquery.floatThead.min.js"><img src="http://img.badgesize.io/https://unpkg.com/floatthead/dist/jquery.floatThead.min.js?compression=gzip&style=flat-square"></a> <a href="https://www.npmjs.com/package/floatthead"><img src="https://img.shields.io/npm/v/floatthead.svg?style=flat-square"></a> <a href="https://github.com/mkoryak/floatThead/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/floatthead.svg?style=flat-square"></a> </h1> </p> [![gif showing plugin in action](https://thumbs.gfycat.com/AnyGloriousAlpaca-size_restricted.gif)](http://mkoryak.github.io/floatThead/) ## Documentation & Examples: http://mkoryak.github.io/floatThead/ Float the table header on scroll. No changes to your HTML/CSS are required, it just works. Supports floating the header while scrolling within the window or while scrolling within a container with overflow. Supports responsive tables. ### Install #### Package managers ```console npm install floatthead bower install floatThead ``` #### Download code [Latest Release (zip)](https://github.com/mkoryak/floatThead/archive/2.2.5.zip) #### Via CDN [https://cdnjs.com/libraries/floatthead/](https://cdnjs.com/libraries/floatthead/) [https://www.jsdelivr.com/#!jquery.floatthead](https://www.jsdelivr.com/#!jquery.floatthead) [https://unpkg.com/floatthead](https://unpkg.com/floatthead) ```html  <script src="https://unpkg.com/floatthead"></script> <script> $(() => $('table').floatThead()); </script> ``` #### For java people [Webjar](https://github.com/webjars/floatThead) ### Wrappers [vuejs component](https://github.com/tmlee/vue-floatThead) by @tmlee [angularjs directive](https://github.com/brandon-barker/angular-floatThead) by @brandon-barker [yii2 framework wrapper](https://github.com/bluezed/yii2-floatThead) by @bluezed # Why not just use `position:sticky`? --------- You probably should! This plugin was created years before that existed. There are still a few reasons why you might want to use this plugin: - Your code runs in the real world, where [some browsers](https://caniuse.com/css-sticky) don't support `position: sticky`. - Any kind of non-standard scroll parent scenario, where the thing that you scroll with is not supported by `position: sticky`. - Your table's scroll parent isn't the body, but the body is what scrolls and you can't change this. - Your table scrolls horizontally within a container, but vertically within the page. - Your sticky `top` position is dynamic, or you want to know when the header becomes sticky and you don't want to write code to do this. - You don't want to learn these newfangled CSS things, you want a proven solution that works and uses jQuery, the greatest thing ever! # Things this plugin does: --------- - In prod @ big corporations and opensource projects. Maintained. See open issues. - Works on tables within a scrollable container or whole window scrolling - Works with responsive table wrappers - Works with dynamically hidden/added/removed columns - Does not clone the thead - so your events stay bound - Does what `position:fixed` cannot do (and on browsers that do not support it) - Does not mess with your styles, and doesnt require any css (see `fixed` vs `absolute` position modes) - Works with border-collapse variants, weird margins, padding and borders - Works with libs like [datatables](http://datatables.net), [perfect-scrollbar](http://mkoryak.github.io/floatThead/examples/perfect-scrollbar/), [bootstrap3](http://mkoryak.github.io/floatThead/examples/bootstrap3/), and many more - Header can be floated with `position:absolute` which adds a wrapper, or `position:fixed` which does not. Both have their pros and cons. By default the best option is chosen based on your configuration # Things this plugin 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](https://github.com/mkoryak/floatThead/issues/108), depending on your markup and safari version. - RTL is not really supported - it might work in overflow scrolling mode, if you are lucky. Expects `dir` on `html` element. - Layout issues resulting from document zoom not being 100% are not supported. Common Pitfalls ------ If you use css and html best practices, this plugin will work. If you are stuck in 1999, you better [read the faq](http://mkoryak.github.io/floatThead/faq/). How to get help with the floatThead ------------ All issues should be reported through github. Requirements: ------------- - jQuery 1.8.x or better (1.9 compliant) (or jQuery 1.7.x and jQuery UI core) Supported Browsers: ------------- - IE9 or better (**must read** [this for ANY Internet Exploder integrations](http://mkoryak.github.io/floatThead/examples/row-groups/)) - Chrome, Firefox (all versions from last 10+ years) Change Log ---------- [see CHANGELOG.md](https://github.com/mkoryak/floatThead/blob/master/CHANGELOG.md) ## Who is using floatThead ? ### [Ctrl O](https://ctrlo.com) - Ctrl O provides simple and innovative products to help an organization's business processes. Linkspace, its flagship product, helps share information between teams and individuals, in a simple and effective manner. ### [WheresTheGig.com](https://WheresTheGig.com) - A free service for the musical community ### [Google](https://www.youtube.com/watch?v=dQw4w9WgXcQ) - Internally, I happen to know... ### [tld-list.com](https://tld-list.com/) - The first table you see. ### [Samsung](https://github.com/Samsung/iotjscode/blob/3d4de15ea32d27dce5885b2c8c9e3a783c846311/www/scripts/app/main.js#L234) - For the internet of things! ### [Around 153,000 hits on github code search](https://github.com/search?q=floatThead&ref=reposearch&type=Code&utf8=%E2%9C%93) License ------- MIT