initial code repo
[stor4nfv.git] / src / ceph / src / pybind / mgr / dashboard / static / AdminLTE-2.3.7 / plugins / datatables / extensions / FixedHeader / Readme.txt
diff --git a/src/ceph/src/pybind/mgr/dashboard/static/AdminLTE-2.3.7/plugins/datatables/extensions/FixedHeader/Readme.txt b/src/ceph/src/pybind/mgr/dashboard/static/AdminLTE-2.3.7/plugins/datatables/extensions/FixedHeader/Readme.txt
new file mode 100644 (file)
index 0000000..875e051
--- /dev/null
@@ -0,0 +1,36 @@
+# FixedHeader
+
+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:
+
+* Fix the header to the top of the window
+* Ability to fix the footer and left / right columns as well
+* z-Index ordering options
+
+
+# Installation
+
+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.
+
+
+# Basic usage
+
+FixedHeader is initialised using the `$.fn.dataTable.FixedHeader()` object. For example:
+
+```js
+$(document).ready( function () {
+    var table = $('#example').dataTable();
+    new $.fn.dataTable.FixedHeader( table );
+} );
+```
+
+
+# Documentation / support
+
+* Documentation: http://datatables.net/extensions/FixedHeader/
+* DataTables support forums: http://datatables.net/forums
+
+
+# GitHub
+
+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
+