mirror of
https://github.com/koalyptus/TableFilter.git
synced 2024-05-21 07:46:42 +02:00
publish README to gh-pages (auto)
branch: master
SHA: c7d6de72f7
range SHA: 81f31a3106fb...c7d6de72f785
build id: 375208741
build number: 1103
This commit is contained in:
parent
2dcb1f2fb0
commit
7b0c97ba16
22
LICENSE
Normal file
22
LICENSE
Normal file
|
@ -0,0 +1,22 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015 Max Guglielmi
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included
|
||||
in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
173
README.md
Normal file
173
README.md
Normal file
|
@ -0,0 +1,173 @@
|
|||
[![Build Status](https://api.travis-ci.org/koalyptus/TableFilter.svg?branch=master)](https://travis-ci.org/koalyptus/TableFilter)
|
||||
[![Document](https://koalyptus.github.io/TableFilter/docs/badge.svg)](https://koalyptus.github.io/TableFilter/docs/source.html)
|
||||
[![codecov](https://codecov.io/gh/koalyptus/TableFilter/branch/master/graph/badge.svg)](https://codecov.io/gh/koalyptus/TableFilter)
|
||||
[![Greenkeeper badge](https://badges.greenkeeper.io/koalyptus/TableFilter.svg)](https://greenkeeper.io/)
|
||||
|
||||
# TableFilter
|
||||
|
||||
> A Javascript library making HTML tables filterable
|
||||
|
||||
TableFilter is a modernised version of the [HTML Table Filter generator](http://tablefilter.free.fr) 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.
|
||||
|
||||
## Features
|
||||
* Convert a regular HTML table into an advanced grid component providing:
|
||||
* Advanced columns filtering model
|
||||
* Sorting and pagination capabilities
|
||||
* Complete selection model ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)
|
||||
* Extended keyboard navigation ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)
|
||||
* Inline cell or row editing ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)
|
||||
* Row insertion or deleting ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)
|
||||
* And even more features...
|
||||
* Attach to an existing HTML table
|
||||
* Integration with any server-side technology as this is a pure client-side
|
||||
solution
|
||||
* Exhaustive documentation and poweful API
|
||||
|
||||
## Getting started
|
||||
* Clone the repo using Git:
|
||||
```shell
|
||||
git clone https://github.com/koalyptus/TableFilter.git
|
||||
```
|
||||
|
||||
* You can [download](https://github.com/koalyptus/TableFilter/archive/master.zip) this repository.
|
||||
|
||||
* TableFilter is available on [npm repository](https://www.npmjs.com/package/tablefilter), you can install it from the command line using the following command:
|
||||
```shell
|
||||
npm install tablefilter --save-dev
|
||||
```
|
||||
* or get the future features from the ``next`` release channel:
|
||||
```shell
|
||||
npm install tablefilter@next --save-dev
|
||||
```
|
||||
* Alternatively you can also [access these files from unpkg CDN](https://unpkg.com/tablefilter/), download them or point your package manager to them.
|
||||
|
||||
## Setup
|
||||
### Using modules
|
||||
Require `TableFilter`:
|
||||
```javascript
|
||||
// ES2015 modules
|
||||
import TableFilter from 'tablefilter';
|
||||
|
||||
// CommonJS or AMD modules
|
||||
var TableFilter = require('tablefilter');
|
||||
```
|
||||
|
||||
### Using distribution scripts
|
||||
If you are not using a module system, you can reference the distribution scripts directly in your html pages:
|
||||
```html
|
||||
<script src="path_to/node_modules/tablefilter/dist/tablefilter/tablefilter.js"></script>
|
||||
```
|
||||
|
||||
### Placing manually the distribution scripts in your project
|
||||
Copy the ``tablefilter`` directory under ``dist`` and place it at desired location in your project. Then include the main js file in your page:
|
||||
```shell
|
||||
<script src="path/to/my/scripts/tablefilter/tablefilter.js"></script>
|
||||
```
|
||||
|
||||
### Usage
|
||||
Place the following snippet just under the HTML table and always define a ``base_path`` property in the configuration object to reflect the path to the script
|
||||
```shell
|
||||
<script>
|
||||
var tf = new TableFilter(document.querySelector('.my-table'), {
|
||||
base_path: 'path/to/my/scripts/tablefilter/'
|
||||
});
|
||||
tf.init();
|
||||
</script>
|
||||
```
|
||||
If the ``base_path`` property is not specified, it will default to ``/tablefilter`` directory:
|
||||
```shell
|
||||
your-page.html
|
||||
|— tablefilter
|
||||
```
|
||||
|
||||
## Development
|
||||
This project requires node.js and Grunt to be installed:
|
||||
- install [node.js](https://nodejs.org/) v8.9.4 or higher
|
||||
- install [Grunt](http://gruntjs.com/getting-started) from the command line using npm (comes with node.js):
|
||||
```shell
|
||||
npm install -g grunt-cli
|
||||
```
|
||||
Once ``Grunt`` is sorted out you can follow the instructions below.
|
||||
Start by installing any dependencies.
|
||||
|
||||
```shell
|
||||
npm install
|
||||
```
|
||||
Use
|
||||
```shell
|
||||
npm run dev
|
||||
```
|
||||
command to launch a build / watch cycle and start the local
|
||||
sever on port ``8080``.
|
||||
|
||||
Use
|
||||
```shell
|
||||
npm run build
|
||||
```
|
||||
command to generate a production build.
|
||||
|
||||
The
|
||||
```shell
|
||||
npm run dist
|
||||
```
|
||||
command will create a production build, run the tests and finally generate
|
||||
the demos:
|
||||
|
||||
To run all the tests and generate the coverage report:
|
||||
|
||||
```shell
|
||||
npm test
|
||||
```
|
||||
|
||||
or to run specific test(s):
|
||||
|
||||
```shell
|
||||
grunt test-only:test.html
|
||||
grunt test-only:test.html,test-sort.html
|
||||
```
|
||||
|
||||
to view the coverage report(s), open the `index.html` under the
|
||||
`report/coverage` folder or
|
||||
[online](https://codecov.io/gh/koalyptus/TableFilter).
|
||||
|
||||
## Demos
|
||||
Check out the online [examples](http://koalyptus.github.io/TableFilter/examples)
|
||||
or generate the demos locally:
|
||||
```shell
|
||||
npm run build:demos
|
||||
```
|
||||
then run the local webserver:
|
||||
```shell
|
||||
npm start
|
||||
```
|
||||
then pick a demo from:
|
||||
```shell
|
||||
http://localhost:8080/demos/
|
||||
```
|
||||
|
||||
## Documentation
|
||||
Find exhaustive documentation on the configuration options in the [WIKI](https://github.com/koalyptus/TableFilter/wiki) section.
|
||||
|
||||
Autogenerated documentation of the ES6 modules is available on the website: [docs](http://koalyptus.github.io/TableFilter/docs)
|
||||
|
||||
If you previously used the HTML Table Filter Generator plugin, verify the configuration
|
||||
options you are using are still supported: [Obsolete](https://github.com/koalyptus/TableFilter/wiki/Obsolete)
|
||||
|
||||
Run this task to generate the documentation in the ``docs/docs`` directory:
|
||||
```shell
|
||||
npm run esdoc
|
||||
```
|
||||
|
||||
## Support
|
||||
* GitHub for [reporting bugs](https://github.com/koalyptus/TableFilter/blob/master/CONTRIBUTING.md#reporting-bugs) and [feature requests](https://github.com/koalyptus/TableFilter/blob/master/CONTRIBUTING.md#suggesting-enhancements-and-features).
|
||||
|
||||
## License
|
||||
[MIT](LICENSE)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
Loading…
Reference in a new issue