Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add customer filter for search #777

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

wanlwanl
Copy link

@wanlwanl wanlwanl commented Sep 17, 2021

Add custom filter for search

Interface

export interface SearchConfig {
  keyword?: string;
  enabled?: boolean;
  ignoreHiddenColumns?: boolean;
  debounceTimeout?: number;
  selector?: (cell: TCell, rowIndex: number, cellIndex: number) => string;
  server?: {
    url?: (prevUrl: string, keyword: string) => string;
    body?: (prevBody: BodyInit, keyword: string) => BodyInit;
  };
  filter?: (keyword: string, rows: Row[]) => Row[];
}

Usage

var grid = new Grid({
      columns: ['a', 'b', 'c'],
      data: [
        [1, 2, 3],
        [4, 5, 6],
      ],
      search: {
        enabled: true,
        filter: (keyword, rows) => {
          const filtered = rows.filter((row) =>
            row.cells.some((cell) => cell.data == parseInt(keyword, 10) + 1),
          );
          return filtered;
        },
      },
    }).render(ref.current);

Sample

Filter rows by number x that contains x+1

  1. go to folder tests/dev-server
  2. udpate src/index.js to:
import './style';
import { Grid } from 'gridjs';
import 'gridjs/dist/theme/mermaid.css';
import { useEffect, useRef } from 'preact/hooks';

export default function App() {
  const ref = useRef();

  useEffect(() => {
    new Grid({
      columns: ['a', 'b', 'c'],
      data: [
        [1, 2, 3],
        [4, 5, 6],
      ],
      search: {
        enabled: true,
        filter: (keyword, rows) => {
          const filtered = rows.filter((row) =>
            row.cells.some((cell) => cell.data == parseInt(keyword, 10) + 1),
          );
          console.log('filtered', filtered);
          return filtered;
        },
      },
    }).render(ref.current);
  });

  return (
    <div id="wrapper">
      <h1>Hello, World!</h1>
      <div id="container" ref={ref} />
    </div>
  );
}
  1. npm run start
  2. input 3 in search box, the table will show the 2nd row (4,5,6) only
    image

@afshinm afshinm added the new feature New feature or request label Sep 21, 2021
@wanlwanl
Copy link
Author

wanlwanl commented Oct 8, 2021

@afshinm hey! check this out and tell me what do you think about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants