001: # FixedHeader
002:
003: At times it can be useful to ensure that column titles will remain always visible on a table, even when a user scrolls down a table. The FixedHeader plug-in for DataTables will float the 'thead' element above the table at all times to help address this issue. The column titles also remain click-able to perform sorting. Key features include:
004:
005: * Fix the header to the top of the window
006: * Ability to fix the footer and left / right columns as well
007: * z-Index ordering options
008:
009:
010: # Installation
011:
012: To use FixedHeader, first download DataTables ( http://datatables.net/download ) and place the unzipped FixedHeader package into a `extensions` directory in the DataTables package. This will allow the pages in the examples to operate correctly. To see the examples running, open the `examples` directory in your web-browser.
013:
014:
015: # Basic usage
016:
017: FixedHeader is initialised using the `$.fn.dataTable.FixedHeader()` object. For example:
018:
019: ```js
020: $(document).ready( function () {
021: var table = $('#example').dataTable();
022: new $.fn.dataTable.FixedHeader( table );
023: } );
024: ```
025:
026:
027: # Documentation / support
028:
029: * Documentation: http://datatables.net/extensions/FixedHeader/
030: * DataTables support forums: http://datatables.net/forums
031:
032:
033: # GitHub
034:
035: If you fancy getting involved with the development of FixedHeader and help make it better, please refer to its GitHub repo: https://github.com/DataTables/FixedHeader
036:
037: