added "stickyHeader_zIndex" docs. Fixes #332

This commit is contained in:
Mottie 2013-10-08 20:22:05 -05:00
parent c962a7c20d
commit 653c2a562c

View File

@ -901,7 +901,7 @@ From the example function above, you'll end up with something similar to this HT
<td>&quot;&gt; thead th, &gt; thead td&quot;</td>
<td>jQuery selectors used to find cells in the header.
<div class="collapsible">
You can change this, but the table will still need the required thead and tbody before this plugin will work properly.
You can change this, but the table will still need the required thead and tbody before this plugin will work properly.
<br>Added <code>&gt;</code> to the selector in v2.3 to prevent targetting nested table headers. It was modified again in v2.4 to include <code>td</code> cells within the thead.
</div>
</td>
@ -1161,7 +1161,7 @@ From the example function above, you'll end up with something similar to this HT
<td>&quot;default&quot;</td>
<td>This option will add a theme css class name to the table <code>&quot;tablesorter-{theme}&quot;</code> for styling (v2.4).
<div class="collapsible">
<br>When changing this theme option, make sure that the appropriate css theme file has also been loaded. Included theme files include:
<br>When changing this theme option, make sure that the appropriate css theme file has also been loaded. Included theme files include:
<a href="themes.html" target="_blank" title="open themes in a new window">see all themes</a><br>
<iframe style="width:100%;height:300px;" src="themes.html"></iframe>
</div>
@ -1343,8 +1343,18 @@ $(function(){
filter_serversideFiltering : false,
// *** stickyHeaders widget ***
// css class name applied to the sticky header
stickyHeaders : "tablesorter-stickyHeader",
// extra class name added to the sticky header row
stickyHeaders : '',
// number or jquery selector targeting the position:fixed element
stickyHeaders_offset : 0,
// added to table ID, if it exists
stickyHeaders_cloneId : '-sticky',
// trigger "resize" event on headers
stickyHeaders_addResizeEvent : true,
// if false and a caption exist, it won't be included in the sticky header
stickyHeaders_includeCaption : true,
// The zIndex of the stickyHeaders, allows the user to adjust this to their needs
stickyHeaders_zIndex : 2
// *** resizable widget ***
// if false, resized columns are not saved for next page reload
@ -1775,7 +1785,7 @@ $(function(){
Note: if the <code>filter_ignoreCase</code> option is <code>true</code>, it DOES alter the normalized value (n) by making it all lower case.<br><br>
</li>
<li>
Make a custom filter for the column.
Make a custom filter for the column.
<pre class="prettyprint lang-javascript">$(function(){
$("table").tablesorter({
widgets: ["filter"],
@ -2147,6 +2157,28 @@ $('table').trigger('search', false);</pre></div>
<td></td>
</tr>
<tr id="widget-sticky-headers-zindex">
<td><a href="#" class="toggle2">stickyHeaders_zIndex</a></td>
<td>Numeric</td>
<td>2</td>
<td>
Sticky Headers widget: The zIndex added to the stickyHeaders. This option allows the user to adjust the value to their needs (<span class="version">v2.11</span>).
<div class="collapsible">
<br>
Use the <a href="#widget-sticky-headers-zindex"><code>stickyHeaders_zIndex</code></a> option as follows:
<pre class="prettyprint lang-javascript">$(function(){
$("table").tablesorter({
widgets: ["stickyHeaders"],
widgetOptions : {
// The zIndex of the stickyHeaders, allows the user to adjust this to their needs
stickyHeaders_zIndex : 100
}
});
});</pre></div>
</td>
<td></td>
</tr>
<tr id="widget-resizable">
<td><a href="#" class="toggle2">resizable</a></td>
<td>Boolean</td>
@ -2256,7 +2288,7 @@ $.extend($.tablesorter.themes.jui, {
theme : 'jui', // set theme name from $.tablesorter.themes here
widgets : ["uitheme"], // initialize ui theme styling widget of the table
widgetOptions: {
uitheme : "jui" // this is now optional in v2.7, it is overridden by the theme option
uitheme : "jui" // this is now optional in v2.7, it is overridden by the theme option
}
});
});</pre>