npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

adonis-datagrid

v1.0.0

Published

Create sorted, filtered and paginated table data from database. Can also be used to generate CSV data.

Downloads

1

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:

$ 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.

const providers = [
  'adonis-datagrid/providers/DataGridProvider'
]

Using the module:

Send JSON response:

const DataGrid = use('DataGrid')

Route.get('/api/users', async () => {
  const config = {
    // base query
    query () {
      return use('App/Models/User').query()
    },

    // <GET param>:<DB column> 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'],

    // <GET param>:<DB column> 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:

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

{
  "total": 3,
  "perPage": 10,
  "page": 1,
  "lastPage": 1,
  "data": [
    {
      "id": 3,
      "username": "timtam",
      "email": "[email protected]"
    },
    {
      "id": 2,
      "username": "simon",
      "email": "[email protected]"
    },
    {
      "id": 4,
      "username": "jamiesimons",
      "email": "[email protected]"
    },
  ]
}

[GET] /api/users?filter[username]=simon

{
  "total": 1,
  "perPage": 10,
  "page": 1,
  "lastPage": 1,
  "data": [
    {
      "id": 2,
      "username": "simon",
      "email": "[email protected]"
    },
  ]
}

[GET] /api/users/export?search=simon&sort=id

"ID","Username","Email","Created","Deleted"
2,"simon","[email protected]","2017-11-07 10:24:43","NO"
3,"timtam","[email protected]","2017-05-04 11:14:13","NO"
4,"jamiesimons","[email protected]","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 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

Versioning

SemVer is used for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.