Skip to content

quick-filters.md

Latest commit

 

History

History
59 lines (51 loc) · 1.33 KB

quick-filters.md

File metadata and controls

59 lines (51 loc) · 1.33 KB
Raw

Quick Filters

Guide to the Quick Filters plugin, which adds one-click predefined filters or search inputs to list pages for faster navigation across common record subsets.

Quick filters

Allows you to add search input or select with preseted filters at the list view

Setup

First, install the plugin:

pnpm add @adminforth/quick-filters

Then add it to yours resource:

import QuickFiltersPlugin from '@adminforth/quick-filters';

And finally add it to list of plugins:

  plugins: [
    ...
    //diff-add
    new QuickFiltersPlugin({
      //diff-add
      filters: [
        //diff-add
        {
          //diff-add
          name: 'Listing',
          //diff-add
          enum: [
            //diff-add
            { label: 'Listed', filters: () => Filters.EQ('listed', true) },
            //diff-add 
            { label: 'Not listed', filters: () => Filters.EQ('listed', false) },
            //diff-add
          ]
          //diff-add
        },
        //diff-add
        {
          //diff-add
          name: 'Title',
          //diff-add
          searchInput: (searchVal) => Filters.ILIKE('title', searchVal)
          //diff-add
        },
        //diff-add
      ]
      //diff-add
    }),
    ...
  ]

alt text