Fixed-Header-Table/params.json

1 line
3.7 KiB
JSON

{"tagline":"jQuery plugin for tables with fixed headers ","name":"Fixed-header-table","google":"UA-10972058-2","note":"Don't delete this file! It's used internally to help with page regeneration.","body":"### Why use this plugin?\r\nFixedHeaderTable in its simplest form displays a fixed header for any valid table mark-up. This is an active jQuery plugin project so expect new features and improvements to be released.\r\nSome options include a fixed footer using the tables tfoot element or cloning the thead as a fixed footer. This plugin is meant to be lightweight, easy to use and performant.\r\n\r\n### How it works.\r\nUsing this plugin is very simple. All that is needed is valid table mark-up.\r\n```\r\n<table>\r\n <thead>\r\n <tr>\r\n <th></th>\r\n </tr>\r\n </thead>\r\n <tfoot>\r\n <tr>\r\n <td></td>\r\n </tr>\r\n </tfoot>\r\n <tbody>\r\n <tr>\r\n <td></td>\r\n </tr>\r\n </tbody>\r\n</table>\r\n```\r\n\r\nFixed Header Table will do the rest for you. Both fixed width columns and non-fixed width columns are supported. Current browser support includes Internet explorer 6-9, Chrome, Firefox, and Safari.\r\n\r\n### Theming\r\nAdding an optional themeClass will add the class to the plugin wrapper. This will allow for easy theming for the table.\r\n\r\n## Docs\r\n### Methods\r\n\r\n#### destroy\r\nRemove the fixedHeaderTable functionality completely. This will return the element back to its pre-init state.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable('destroy');\r\n\r\n#### hide\r\nHide the table.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable('hide');\r\n\r\n#### show\r\nShow the table.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable('show');\r\n\r\n### Events\r\n#### create\r\nThis event is triggered when .fixedHeaderTable is created.\r\nCode example:\r\n\t\t\t\t\t\t\t\t\r\n $('selector').fixedHeaderTable({\r\n create: function() { ... }\r\n });\r\n\r\n### Options\r\n#### altClass\r\nThe specified class name will be added to odd rows (tr) for theming.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ altClass: 'className' });\r\n\t\t\t\t\t\t\t\r\n#### autoShow\r\nWhen autoShow is false the table will be hidden automatically when fixedHeaderTable is called. The table will remain hidden until .fixedHeaderTable('show') is called on it.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ autoShow: true });\r\n\t\t\t\t\t\t\t\r\n#### cloneHeadToFoot\r\nWhen cloneHeadToFoot is true the table header will be cloned and used as the table footer.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ cloneHeadToFoot: true });\r\n\t\t\t\t\t\t\t\r\n#### fixedColumn **version 1.3 only**\r\nWhen fixedColumn is true the first column will be fixed if the table scrolls horizontally.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ fixedColumn: true });\r\n\t\t\t\t\t\t\t\r\n#### footer\r\nWhen footer is true the TFOOT of the table will be used as a fixed footer. A TFOOT must be included in the table mark-up.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ footer: true });\r\n\t\t\t\t\t\t\t\r\n#### height\r\nWhen height is set the table thead, tbody, and optional tfoot will be equal to the height value. Height is in pixels.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ height: 500 });\r\n\t\t\t\t\t\t\t\r\n#### width\r\nWhen width is set the table width will be equal to the width value. Width is in pixels.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ width: 500 });\r\n\t\t\t\t\t\t\t\r\n#### themeClass\r\nThe specified class name will be added to the table for theming.\r\nCode example:\r\n\r\n $('selector').fixedHeaderTable({ themeClass: 'className' });"}