deblan-mirror/TableFilter
1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-06-08 00:42:28 +02:00
Code Issues Releases Wiki Activity

Updated 1.13 Help instructions (markdown)

koalyptus 2017-05-24 13:20:17 +10:00
parent c65b7e915c
commit cd47443e30
1 changed files with 92 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

119
1.13-Help-instructions.md

@ -14,81 +14,146 @@
<th>help_instructions</th>
<td>boolean</td>
<td><p> enables / disables question mark visibility showing
help container element (default - true)</td>
help container element (default - boolean|object)</td>
<td>Note that the help feature is generated automatically unless you
set this property to false </td>
<td><code>var tfConfig = { help_instructions: false }</code></td>
<td>
<pre>
var tfConfig = { help_instructions: true };
// or
var tfConfig = {
help_instructions: {}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_target_id</th>
<th>target_id</th>
<td>string</td>
<td> defines the id of the element containing the instructions
button (<strong>?</strong>) (default - null)</td>
<td>By default the <strong>? </strong>is generated in the top toolbar</td>
<td><code>var tfConfig = { help_instructions_target_id: 'myContainerId'
}</code></td>
<td>
<pre>
var tfConfig = {
help_instructions: {
target_id: 'myContainerId'
}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_container_target_id</th>
<th>container_target_id</th>
<td>string</td>
<td> defines the id of the container element for instructions
content (default - null)</td>
<td></td>
<td><code>var tfConfig = { help_instructions_container_target_id: 'myContainerId'
}</code></td>
<td>
<pre>
var tfConfig = {
help_instructions: {
container_target_id: 'myContainerId'
}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_text</th>
<th>text</th>
<td>string</td>
<td> sets the help/instructions text (default - 'Use the
filters above each column to filter and limit table data.')</td>
<td></td>
<td><code>var tfConfig = { help_instructions_text: 'My Help text here...'
}</code></td>
<td>
<pre>
var tfConfig = {
help_instructions: {
text: 'My Help text here...'
}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_html</th>
<th>html</th>
<td>string</td>
<td> sets the help/instructions HTML (default - null)</td>
<td></td>
<td><code>var tfConfig = { help_instructions_html: '&lt;p&gt;My Help
text here...&lt;/p&gt;&lt;p&gt;Hello world!&lt;/p&gt;' }</code></td>
<td>
<pre>
var tfConfig = {
help_instructions: {
html: '<p>My Help text here...</p><p>Hello world!</p>'
}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_btn_text</th>
<th>btn_text</th>
<td>string</td>
<td> sets the help/instructions button text (default -
'?')</td>
<td></td>
<td><code>var tfConfig = { help_instructions_btn_text: 'Help' }</code></td>
<td>
<pre>
var tfConfig = {
help_instructions: {
btn_text: 'Help'
}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_btn_html</th>
<th>btn_html</th>
<td>string</td>
<td> sets the help/instructions button HTML (default -
'?')</td>
<td>Note that the onclick event is added automatically to the html element
and overwrites any eventual onclick attribut</td>
<td><code>var tfConfig = { help_instructions_btn_html: '&lt;button&gt;Help&lt;/button&gt;'
}</code></td>
<td>Note that the onclick event is added by default to the html element
and overwrites any eventual onclick attribute</td>
<td>
<pre>
var tfConfig = {
help_instructions: {
btn_html: '<button>Help</button>'
}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_btn_css_class</th>
<th>css_class</th>
<td>string</td>
<td> defines the css class of the help/instructions button
(default - 'helpBtn')</td>
<td></td>
<td><code>var tfConfig = { help_instructions_btn_css_class: 'myCssClass'
}</code></td>
<td>
<pre>
var tfConfig = {
help_instructions: {
css_class: 'myCssClass'
}
};
</pre>
</td>
</tr>
<tr>
<th>help_instructions_container_css_class</th>
<th>container_css_class</th>
<td>string</td>
<td> defines the css class of the help/instructions container
(default - 'helpCont')</td>
<td></td>
<td><code>var tfConfig = { help_instructions_container_css_class: 'myCssClass'
}</code></td>
<td>
<pre>
var tfConfig = {
help_instructions: {
container_css_class: 'myCssClass'
}
};
</pre>
</td>
</tr>
</tbody>
</table>