mirror of
https://github.com/koalyptus/TableFilter.git
synced 2024-06-13 11:22:33 +02:00
173 lines
9.4 KiB
HTML
173 lines
9.4 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<base data-ice="baseUrl">
|
|
<title data-ice="title">TableFilter v0.0.0 API Document</title>
|
|
<link type="text/css" rel="stylesheet" href="css/style.css">
|
|
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
|
|
<script src="script/prettify/prettify.js"></script>
|
|
|
|
|
|
</head>
|
|
<body class="layout-container">
|
|
|
|
<header>
|
|
<a href="./">Home</a>
|
|
<a href="identifiers.html">Identifier</a>
|
|
<a href="source.html">Source</a>
|
|
|
|
<a data-ice="repoURL" href="https://github.com/koalyptus/TableFilter.git" class="repo-url-github">Repository</a>
|
|
<div class="search-box">
|
|
<span>
|
|
<img src="./image/search.png">
|
|
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
|
|
</span>
|
|
<ul class="search-result"></ul>
|
|
</div>
|
|
</header>
|
|
|
|
<nav class="navigation" data-ice="nav"><div data-ice="classWrap">
|
|
<h2>Class</h2>
|
|
<ul>
|
|
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/advancedGrid/adapterEzEditTable.js~AdapterEzEditTable.html">AdapterEzEditTable</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/sort/adapterSortabletable.js~AdapterSortableTable.html">AdapterSortableTable</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/alternateRows.js~AlternateRows.html">AlternateRows</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/checkList.js~CheckList.html">CheckList</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/clearButton.js~ClearButton.html">ClearButton</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/colOps/colOps.js~ColOps.html">ColOps</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/colsVisibility/colsVisibility.js~ColsVisibility.html">ColsVisibility</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/dropdown.js~Dropdown.html">Dropdown</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/extensions/filtersVisibility/filtersVisibility.js~FiltersVisibility.html">FiltersVisibility</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/gridLayout.js~GridLayout.html">GridLayout</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/help.js~Help.html">Help</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/highlightKeywords.js~HighlightKeyword.html">HighlightKeyword</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/loader.js~Loader.html">Loader</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/paging.js~Paging.html">Paging</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/popupFilter.js~PopupFilter.html">PopupFilter</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/rowsCounter.js~RowsCounter.html">RowsCounter</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/statusBar.js~StatusBar.html">StatusBar</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/modules/store.js~Store.html">Store</a></span></li>
|
|
<li data-ice="classDoc"><span><a href="class/src/tablefilter.js~TableFilter.html">TableFilter</a></span></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</nav>
|
|
|
|
<div class="content" data-ice="content"><div data-ice="index"><h1 id="tablefilter-build-status-https-api-travis-ci-org-koalyptus-tablefilter-svg-branch-master-https-travis-ci-org-koalyptus-tablefilter-">TableFilter <a href="https://travis-ci.org/koalyptus/TableFilter"><img src="https://api.travis-ci.org/koalyptus/TableFilter.svg?branch=master" alt="Build Status"></a></h1>
|
|
<blockquote>
|
|
<p>A Javascript library making HTML tables filterable</p>
|
|
</blockquote>
|
|
<p>TableFilter is a modernised version of the <a href="http://tablefilter.free.fr">HTML Table Filter generator</a> javascript plugin.
|
|
This library adds to any html table a "filter by column" feature that enables
|
|
users to filter and limit the data displayed within a long table. By default, the script automatically adds a filter grid bar at the top of the desired table.</p>
|
|
<h2 id="features">Features</h2>
|
|
<ul>
|
|
<li>Convert a regular HTML table into an advanced grid component providing:<ul>
|
|
<li>Advanced columns filtering model</li>
|
|
<li>Sorting and pagination facilities</li>
|
|
<li>Complete selection model (<a href="http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123">ezEditTable</a> extension)</li>
|
|
<li>Extended keyboard navigation (<a href="http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123">ezEditTable</a> extension)</li>
|
|
<li>Inline cell or row editing (<a href="http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123">ezEditTable</a> extension)</li>
|
|
<li>Row insertion or deleting (<a href="http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123">ezEditTable</a> extension)</li>
|
|
<li>And even more behaviors...</li>
|
|
</ul>
|
|
</li>
|
|
<li>Attach to an existing HTML table</li>
|
|
<li>Integration with any server-side technology as this is a pure client-side
|
|
solution</li>
|
|
<li>Callbacks for all events, and delegates for most actions</li>
|
|
<li>Exhaustive documentation and API</li>
|
|
<li>Valuable support provided under a Premium request</li>
|
|
</ul>
|
|
<h2 id="getting-started">Getting started</h2>
|
|
<p>Clone the repo using Git:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">git clone --bare https://github.com/koalyptus/TableFilter.git</code></pre>
|
|
</code></pre>
|
|
<p>Alternatively you can <a href="https://github.com/koalyptus/TableFilter/archive/master.zip">download</a> this repository.</p>
|
|
<h2 id="setup">Setup</h2>
|
|
<p>Copy the <code>tablefilter</code> directory under <code>dist</code> and place it at desired location in your project. Then include the main js file in your page:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint"><script src="path/to/my/scripts/tablefilter/tablefilter.js"></script></code></pre>
|
|
</code></pre>
|
|
<p>Place the following snippet just under the HTML table and always define a <code>base_path</code> property in the configuration object to reflect the path to the script</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint"><script>
|
|
var tf = new TableFilter('my-table-id', {
|
|
base_path: 'path/to/my/scripts/tablefilter/'
|
|
});
|
|
tf.init();
|
|
</script></code></pre>
|
|
</code></pre>
|
|
<p>If the <code>base_path</code> property is not specified, it will default to <code>/tablefilter</code> directory:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">your-page.html
|
|
|— tablefilter</code></pre>
|
|
</code></pre>
|
|
<h2 id="development">Development</h2>
|
|
<p>This project requires node.js and Grunt to be installed:</p>
|
|
<ul>
|
|
<li>install <a href="https://nodejs.org/">node.js</a></li>
|
|
<li>install <a href="http://gruntjs.com/getting-started">Grunt</a> from the command line using npm (comes with node.js):<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">npm install -g grunt-cli</code></pre>
|
|
</code></pre>
|
|
Once <code>Grunt</code> is sorted out you can follow the instructions below.
|
|
Start by installing any dependencies.</li>
|
|
</ul>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">npm install</code></pre>
|
|
</code></pre>
|
|
<p>Use the Grunt <code>dev</code> task to launch a build / watch cycle and start the local
|
|
sever on port <code>8080</code>:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">grunt dev</code></pre>
|
|
</code></pre>
|
|
<p>Use the <code>build</code> task to generate a production build:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">grunt build</code></pre>
|
|
</code></pre>
|
|
<p>The <code>default</code> Grunt task will create a production build, run the tests and finally generate the demos:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">grunt</code></pre>
|
|
</code></pre>
|
|
<p>To run all the tests:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">grunt test</code></pre>
|
|
</code></pre>
|
|
<p>and to run specific test(s):</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">grunt test-only:test.html
|
|
grunt test-only:test.html,test-sort.html</code></pre>
|
|
</code></pre>
|
|
<h2 id="demos">Demos</h2>
|
|
<p>Run the local webserver:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">grunt server</code></pre>
|
|
</code></pre>
|
|
<p>then pick a demo from:</p>
|
|
<pre><code class="lang-shell"><pre class="source-code"><code class="prettyprint">http://localhost:8080/demos/</code></pre>
|
|
</code></pre>
|
|
<h2 id="documentation">Documentation</h2>
|
|
<p>Find the complete documentation in the <a href="https://github.com/koalyptus/TableFilter/wiki">WIKI</a> section.</p>
|
|
<h2 id="support">Support</h2>
|
|
<ul>
|
|
<li>GitHub for reporting bugs and feature requests.</li>
|
|
</ul>
|
|
<h2 id="license">License</h2>
|
|
<p><a href="LICENSE.md">MIT</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="footer">
|
|
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.1.4)</span></a>
|
|
</footer>
|
|
|
|
<script src="script/search_index.js"></script>
|
|
<script src="script/search.js"></script>
|
|
<script src="script/pretty-print.js"></script>
|
|
<script src="script/inherited-summary.js"></script>
|
|
<script src="script/test-summary.js"></script>
|
|
<script src="script/inner-link.js"></script>
|
|
<script src="script/patch-for-local.js"></script>
|
|
</body>
|
|
</html>
|