{"id":13446865,"url":"https://github.com/koalyptus/TableFilter","last_synced_at":"2025-03-21T16:33:01.732Z","repository":{"id":18817109,"uuid":"22031888","full_name":"koalyptus/TableFilter","owner":"koalyptus","description":"A Javascript library making HTML tables filterable and a bit more :)","archived":false,"fork":false,"pushed_at":"2022-12-10T16:14:23.000Z","size":107741,"stargazers_count":320,"open_issues_count":56,"forks_count":96,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-04-14T19:35:41.866Z","etag":null,"topics":["filter","grid","html-table","javascript","pagination","sorting","tablefilter"],"latest_commit_sha":null,"homepage":"https://www.tablefilter.com","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koalyptus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-20T11:32:13.000Z","updated_at":"2024-04-12T09:52:10.000Z","dependencies_parsed_at":"2023-01-11T20:29:54.101Z","dependency_job_id":null,"html_url":"https://github.com/koalyptus/TableFilter","commit_stats":null,"previous_names":[],"tags_count":101,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koalyptus%2FTableFilter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koalyptus%2FTableFilter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koalyptus%2FTableFilter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koalyptus%2FTableFilter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koalyptus","download_url":"https://codeload.github.com/koalyptus/TableFilter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244829659,"owners_count":20517354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filter","grid","html-table","javascript","pagination","sorting","tablefilter"],"created_at":"2024-07-31T05:01:01.873Z","updated_at":"2025-03-21T16:33:01.299Z","avatar_url":"https://github.com/koalyptus.png","language":"HTML","readme":"[![Build Status](https://api.travis-ci.org/koalyptus/TableFilter.svg?branch=master)](https://travis-ci.org/koalyptus/TableFilter)\n[![Document](https://www.tablefilter.com/docs/badge.svg)](https://www.tablefilter.com/docs/source.html)\n[![codecov](https://codecov.io/gh/koalyptus/TableFilter/branch/master/graph/badge.svg)](https://codecov.io/gh/koalyptus/TableFilter)\n[![Greenkeeper badge](https://badges.greenkeeper.io/koalyptus/TableFilter.svg)](https://greenkeeper.io/)\n[![Donate](https://img.shields.io/badge/donate-%24-green.svg)](https://www.tablefilter.com/donate.html)\n\n# TableFilter\n\n\u003e A Javascript library making HTML tables filterable\n\nTableFilter is a modernised version of the [HTML Table Filter generator](http://tablefilter.free.fr) javascript plugin.\nThis library adds to any html table a \"filter by column\" feature that enables\nusers 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.\n\n## Features\n* Convert a regular HTML table into an advanced grid component providing:\n    * Advanced columns filtering model\n    * Sorting and pagination capabilities\n    * Complete selection model ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)\n    * Extended keyboard navigation ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)\n    * Inline cell or row editing ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)\n    * Row insertion or deleting ([ezEditTable](http://codecanyon.net/item/ezedittable-enhance-html-tables/2425123?ref=koalyptus) extension)\n    * And even more features...\n* Attach to an existing HTML table\n* Integration with any server-side technology as this is a pure client-side\nsolution\n* Exhaustive documentation and powerful API\n\n## Getting started\n* Clone the repo using Git:\n```shell\ngit clone https://github.com/koalyptus/TableFilter.git\n```\n\n* You can [download](https://github.com/koalyptus/TableFilter/archive/master.zip) this repository.\n\n* TableFilter is available on [npm repository](https://www.npmjs.com/package/tablefilter), you can install it from the command line using the following command:\n```shell\nnpm install tablefilter --save-dev\n```\n* or get the future features from the ``next`` release channel:\n```shell\nnpm install tablefilter@next --save-dev\n```\n* Alternatively  you can also [access these files from unpkg CDN](https://unpkg.com/tablefilter/), download them or point your package manager to them.\n\n## Setup\n### Using modules\nRequire `TableFilter`:\n```javascript\n// ES2015 modules\nimport TableFilter from 'tablefilter';\n\n// CommonJS or AMD modules\nvar TableFilter = require('tablefilter');\n```\n\n### Using distribution scripts\nIf you are not using a module system, you can reference the distribution scripts directly in your html pages:\n```html\n\u003cscript src=\"path_to/node_modules/tablefilter/dist/tablefilter/tablefilter.js\"\u003e\u003c/script\u003e\n```\n\n### Placing manually the distribution scripts in your project\nCopy the ``tablefilter`` directory under ``dist`` and place it at desired location in your project. Then include the main js file in your page:\n```shell\n\u003cscript src=\"path/to/my/scripts/tablefilter/tablefilter.js\"\u003e\u003c/script\u003e\n```\n\n### Usage\nPlace 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\n```shell\n\u003cscript\u003e\nvar tf = new TableFilter(document.querySelector('.my-table'), {\n    base_path: 'path/to/my/scripts/tablefilter/'\n});\ntf.init();\n\u003c/script\u003e\n```\nIf the ``base_path`` property is not specified, it will default to ``/tablefilter`` directory:\n```shell\nyour-page.html\n |— tablefilter\n```\n\n## Development\nThis project requires node.js and Grunt to be installed:\n- install [node.js](https://nodejs.org/) v8.9.4 or higher\n- install [Grunt](http://gruntjs.com/getting-started) from the command line using npm (comes with node.js):\n```shell\nnpm install -g grunt-cli\n```\nOnce ``Grunt`` is sorted out you can follow the instructions below.\nStart by installing any dependencies.\n\n```shell\nnpm install\n```\nUse\n```shell\nnpm run dev\n```\ncommand to launch a build / watch cycle and start the local\nsever on port ``8080``.\n\nUse\n```shell\nnpm run build\n```\ncommand to generate a production build.\n\nThe\n```shell\nnpm run dist\n```\ncommand will create a production build, run the tests and finally generate\nthe demos:\n\nTo run all the tests and generate the coverage report:\n\n```shell\nnpm test\n```\n\nor to run specific test(s):\n\n```shell\ngrunt test-only:test.html\ngrunt test-only:test.html,test-sort.html\n```\n\nto view the coverage report(s), open the `index.html` under the\n`report/coverage` folder or\n[online](https://codecov.io/gh/koalyptus/TableFilter).\n\n## Demos\nCheck out the online [examples](http://www.tablefilter.com/examples.html)\nor generate the demos locally:\n```shell\nnpm run build:demos\n```\nthen run the local webserver:\n```shell\nnpm start\n```\nthen pick a demo from:\n```shell\nhttp://localhost:8080/demos/\n```\n\n## Documentation\nFind exhaustive documentation on the configuration options in the [WIKI](https://github.com/koalyptus/TableFilter/wiki) section.\n\nAutogenerated documentation of the ES6 modules is available on the website: [docs](http://www.tablefilter.com/docs)\n\nIf you previously used the HTML Table Filter Generator plugin, verify the configuration\noptions you are using are still supported: [Obsolete](https://github.com/koalyptus/TableFilter/wiki/Obsolete)\n\nRun this task to generate the documentation in the ``docs/docs`` directory:\n```shell\nnpm run esdoc\n```\n\n## Support\n* 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).\n\n## License\n[MIT](LICENSE)\n\n\n\n\n\n\n","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoalyptus%2FTableFilter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoalyptus%2FTableFilter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoalyptus%2FTableFilter/lists"}