1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-06-09 01:12:38 +02:00

Updated 1.10 Status bar (markdown)

koalyptus 2017-05-17 13:50:39 +10:00
parent b98f9cd770
commit 0062d367b2

@ -11,35 +11,66 @@
<tbody>
<tr>
<th>status_bar</th>
<td>boolean</td>
<td>boolean|object</td>
<td>if set true, it will display a "status" message detailing filtering
operations (default - false)&nbsp;</td>
<td><p>&nbsp;</p></td>
<td><code> var tfConfig = { status_bar: true}</code></td>
<td>
<pre>
var tfConfig = { status_bar: true };
// or
var tfConfig = {
status_bar: {}
};
</pre>
</td>
</tr>
<tr>
<th>status_bar_target_id</th>
<th>target_id</th>
<td>string</td>
<td>defines the id of the element that will contain the status bar</td>
<td></td>
<td><code>var tfConfig = { status_bar_target_id: 'myContainerId'
}</code></td>
<td><code>
<pre>
var tfConfig = {
status_bar: {
target_id: 'myContainerId'
}
};
</pre>
</td>
</tr>
<tr>
<th>status_bar_text</th>
<th>text</th>
<td>string</td>
<td>sets the text of the label preceding the "status" message (default
+ "") </td>
<td></td>
<td><code>var tfConfig = { status_bar_text: 'Status: ' }</code></td>
<td>
<pre>
var tfConfig = {
status_bar: {
text: 'Status: '
}
};
</pre>
</td>
</tr>
<tr>
<th>status_bar_css_class</th>
<th>css_class</th>
<td>string</td>
<td>defines the css class of the status' container element &nbsp;(default
+ 'status')</td>
<td></td>
<td><code>var tfConfig = { status_bar_css_class: 'myClass' }</code></td>
<td>
<pre>
var tfConfig = {
status_bar: {
css_class: 'myClass'
}
};
</pre>
</td>
</tr>
<tr>
<th>msg_filter</th>
@ -109,7 +140,15 @@
<li>msg: the message string</li>
</ul>
</td>
<td><code>var tfConfig = { on_before_show_msg: function(tf, msg){ alert(msg); }}</code></td>
<td>
<pre>
var tfConfig = {
status_bar: {
on_before_show_msg: function(tf, msg){ alert(msg); }
}
};
</pre>
</td>
</tr>
<tr>
<th>on_after_show_msg</th>
@ -122,7 +161,15 @@
<li>msg: the message string</li>
</ul>
</td>
<td><code>var tfConfig = { on_after_show_msg: function(tf, msg){ alert(msg); }}</code></td>
<td>
<pre>
var tfConfig = {
status_bar: {
on_after_show_msg: function(tf, msg){ alert(msg); }
}
};
</pre>
</td>
</tr>
</tbody>
</table>