1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-05-20 15:26:40 +02:00
TableFilter/README.md
2015-06-07 01:19:40 +10:00

1.6 KiB

TableFilter

Filter HTML tables data easily

This script adds to any html table a "filter by column" feature that enables users to filter and limit the data displayed within a long table. 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 facilities
    • Complete selection model (addon)
    • Extended keyboard navigation (addon)
    • Inline cell or row editing (addon)
    • Row insertion or deleting (addon)
    • And even more behaviors...
  • Attach to an existing HTML table
  • Integration with any server-side technology as this is a pure client-side solution
  • Callbacks for all events, and delegates for most actions
  • Exhaustive documentation and API
  • Valuable support provided under a Premium request

##Setup Include the bundled js file in your page:

<script src="tablefilter/tablefilter.js"></script>

##Development Start by installing any dependencies.

npm install

Use the Grunt dev task to launch a build / watch cycle and start the local sever on port 8080:

grunt dev

Use the build task to generate a production build:

grunt build

The default Grunt task will create a production build and also run the tests:

grunt

To run all the tests:

grunt test

and to run specific test(s):

grunt test-only:test.html
grunt test-only:test.html,test-sort.html

Support

  • GitHub for reporting bugs and feature requests.

License

MIT