# adonis-datagrid > Create sorted, filtered and paginated table data from database. Can also be used to generate CSV data. Latest version **1.0.0** (published 2017-11-09) · MIT license · 0 weekly downloads ## Install ```sh npm install adonis-datagrid pnpm add adonis-datagrid yarn add adonis-datagrid bun add adonis-datagrid ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2017-11-09 | | First published | 2017-11-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 9 | | Author | Simon Tong | | Maintainers | simontong | | Keywords | adonis, datagrid, adonis-datagrid | ## Links - npm: https://www.npmjs.com/package/adonis-datagrid - Repository: https://github.com/simontong/adonis-datagrid - Homepage: https://github.com/simontong/adonis-datagrid#readme - Issues: https://github.com/simontong/adonis-datagrid/issues - npm.io page: https://npm.io/package/adonis-datagrid ## Dependencies (2) - [lodash](https://npm.io/package/lodash.md) ^4.17.4 - [json2csv](https://npm.io/package/json2csv.md) ^3.11.5 ## Alternatives - [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads - [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads - [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads - [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads - [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads ## Recent versions - 1.0.0 (latest) — 2017-11-09 ## README # adonis-datagrid Create sorted, filtered and paginated table data from database. Can also be used to generate CSV data. ## How to use Install npm module: ```bash $ adonis install adonis-datagrid ``` ## Register provider Once you have installed adonis-datagrid, make sure to register the provider inside `start/app.js` in order to make use of it. ```js const providers = [ 'adonis-datagrid/providers/DataGridProvider' ] ``` ## Using the module: Send JSON response: ```js const DataGrid = use('DataGrid') Route.get('/api/users', async () => { const config = { // base query query () { return use('App/Models/User').query() }, // : for sortable columns sortable: { id: 'id', username: 'username', email: 'email', created: 'created_at', deleted (query, value) { query[+value ? 'whereNotNull' : 'whereNull']('deleted_at') } }, // global searchable fields searchable: ['username', 'email'], // : for filterable columns filterable: { username: 'username', }, // csv export options exportOptions: { fields: [ {label: 'ID', value: 'id'}, {label: 'Username', value: 'username'}, {label: 'Email', value: 'email'}, {label: 'Created', value: 'created_at'}, { label: 'Deleted', value: row => row.deleted_at ? 'YES' : 'NO', }, ] } } // send JSON response return DataGrid.paginate(config) }) ``` Send as CSV: ```js Route.get('/api/users/export', async ({response}) => { const csv = await DataGrid.export(/* config here */) response.header('content-type', 'text/csv') response.header('content-disposition', `attachment; filename="export.csv"`) // send CSV data return csv }) ``` ## Examples `[GET] /users?search=simon&sort=-username` ```json { "total": 3, "perPage": 10, "page": 1, "lastPage": 1, "data": [ { "id": 3, "username": "timtam", "email": "tim@wasussu.mh" }, { "id": 2, "username": "simon", "email": "simon@wasussu.mh" }, { "id": 4, "username": "jamiesimons", "email": "jamie@example.com" }, ] } ``` `[GET] /api/users?filter[username]=simon` ```json { "total": 1, "perPage": 10, "page": 1, "lastPage": 1, "data": [ { "id": 2, "username": "simon", "email": "simon@wasussu.mh" }, ] } ``` `[GET] /api/users/export?search=simon&sort=id` ``` "ID","Username","Email","Created","Deleted" 2,"simon","simon@wasussu.mh","2017-11-07 10:24:43","NO" 3,"timtam","tim@wasussu.mh","2017-05-04 11:14:13","NO" 4,"jamiesimons","jamie@example.com","2017-10-04 16:24:23","NO" ``` ## Configuration options - `query` - **(required)** Base query. - `defaults` - Default options. - `page` - Initial page. Default: `1`. - `perPageLimit` - Limits on rows per page. - `min` - Upper limit. Default: `5`. - `max` - Lower limit. Default: `100`. - `search` - Search (for `searchable` fields). Default: `''`. - `filters` - Fitlers (for `filterable` fields). Default : `{}`. - `sorts` - Sorted (for `sortable` fields). Default: `{}`. - `queryParams` - GET params that appear in URL. - `page` - Current page. Default: `'page'`. - `perPage` - Rows per page. Default: `'perPage'`. - `search` - Search. Default: `'search'`. - `filter` - Filters. Default: `'filter'`. - `sort` - Sorted. Default: `'sort'`. - `sortable` - Simple object where key is the GET param and value is the database column. For more custom database queries you an pass a function as the value which receieves two arguments: `query`, `sortable` (GET param) and `descending` (boolean). - `searchable` - Array containing column names for global search. For more custom queries you can pass a function as one of the array items which receives `search` as its argument. - `exportOptions` - Configuration options for CSV export. See [json2csv](https://github.com/zemirco/json2csv#available-options) for options. - `filterable` - Simple object where key is the GET param and value is the database column. For more custom database queries you an pass a function as the value which receieves two arguments: `query` and `value` (GET param value). ## Built With * [AdonisJS](http://adonisjs.com) - The web framework used. * [json2csv](https://github.com/zemirco/json2csv) - Used to generate CSV data. ## Versioning [SemVer](http://semver.org/) is used for versioning. For the versions available, see the [tags on this repository](https://github.com/simontong/adonis-datagrid/tags). ## Authors * **Simon Tong** - *Developer* - [simontong](https://github.com/simontong) ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. --- _Source: https://npm.io/package/adonis-datagrid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._