Skip to main content

React Table Example | React Table Filter | NPM

React Table - The react-table is a lightweight, fast and extendable data-grid built for React.

Features of React Table –
1.      Lightweight at 11kb (and just 2kb more for styles)
2.      Fully Customizable (JSX, templates, state, styles, callbacks)
3.      Client-side & Server-side pagination
4.      Multi-sort
5.      Filters
6.      Pivoting and Aggregation
7.      Minimal design and easily
8.      Fully controllable via optional props and callbacks
Explore Best 63 FAQs in React

#Installation - Install
> npm i react-table

#Import the react-table module -
// ES6
import ReactTable from 'react-table'

// ES5
var ReactTable = require('react-table').default

#Import styles by including react-table.css -
// JS (Webpack)
import 'react-table/react-table.css'

// Old-school
<link rel="stylesheet" href="node_modules/react-table/react-table.css">

As an Example -
import React, { Component } from 'react'
import ReactTable from 'react-table'
import ReactTableDefaults from 'react-table'

export default class User extends Component {
    data = [];
    columns = [];

    constructor(props) {
        super(props);

        //ReactTableDefaults used for Display Default number of Rows
        Object.assign(ReactTableDefaults, {
            defaultPageSize: 5,
            minRows: 1
        });

        //Your Grid Data
        this.data = [{
            id: 10001,
            name: 'Anil Singh',
            age: 35,
            friend: {
                name: 'Dilip Singh',
                age: 35,
            }
        }, {
            id: 10002,
            name: 'Sunil Singh',
            age: 25,
            friend: {
                name: 'Sushil',
                age: 26,
            }
        }, {
            id: 10003,
            name: 'Sushil Singh',
            age: 26,
            friend: {
                name: 'Anil',
                age: 35,
            }
        }, {
            id: 10004,
            name: 'Aradhya',
            age: 5,
            friend: {
                name: 'Reena ',
                age: 28,
            }
        }, {
            id: 10005,
            name: 'Reena Singh',
            age: 28,
            friend: {
                name: 'Aradhay',
                age: 5,
            }
        }, {
            id: 10006,
            name: 'UP Singh',
            age: 35,
            friend: {
                name: 'Dilip',
                age: 35,
            }
        }];

        //Your ReactTable Disply columns
        this.columns = [
            {
                Header: 'ID', // Custom header components!
                accessor: 'id',
                Cell: props => <span className='number'>{props.value}</span>
            }, {
                Header: 'Name',
                accessor: 'name',
                Cell: props => <span className='number'>{props.value}</span>,
                filterable: true
            }, {
                Header: 'Age',
                accessor: 'age',
                Cell: props => <span className='number'>{props.value}</span> // Custom cell components!,         
            }, {
                id: 'friendName', // Required because our accessor is not a string
                Header: 'Friend Name',
                accessor: d => d.friend.name // Custom value accessors!           
            }, {
                Header: props => <span>Friend Age</span>, // Custom header components!
                accessor: 'friend.age'
            }]
    }
    render() {
        return (
            <>
                <div><h4>User List -</h4></div>
                <div>
                    <ReactTable 
                    data={this.data} 
                    columns={this.columns} 
                    defaultPageSize={5} 
                    minRows={2} />
                </div>
            </>
        )
    }
}

Data -
Simply pass the data prop anything that resembles an array or object.
<ReactTable
  data={[...]}
/>

Props -
These are all of the available props (and their default values) for the main <ReactTable /> component.
{
    // General
    data: [],
    resolveData: data => resolvedData,
    loading: false,
    showPagination: true,
    showPaginationTop: false,
    showPaginationBottom: true
    showPageSizeOptions: true,
    pageSizeOptions: [5, 10, 20, 25, 50, 100],
    defaultPageSize: 20,
    minRows: undefined, // controls the minimum number of rows to display - default will be `pageSize`
    // NOTE: if you set minRows to 0 then you get rid of empty padding rows BUT your table formatting will also look strange when there are ZERO rows in the table
    showPageJump: true,
    collapseOnSortingChange: true,
    collapseOnPageChange: true,
    collapseOnDataChange: true,
    freezeWhenExpanded: false,
    sortable: true,
    multiSort: true,
    resizable: true,
    filterable: false,
    defaultSortDesc: false,
    defaultSorted: [],
    defaultFiltered: [],
    defaultResized: [],
    defaultExpanded: {},
    defaultFilterMethod: (filter, row, column) => {
      const id = filter.pivotId || filter.id
      return row[id] !== undefined ? String(row[id]).startsWith(filter.value) : true
    },
    defaultSortMethod: (a, b, desc) => {
      // force null and undefined to the bottom
      a = a === null || a === undefined ? '' : a
      b = b === null || b === undefined ? '' : b
      // force any string values to lowercase
      a = typeof a === 'string' ? a.toLowerCase() : a
      b = typeof b === 'string' ? b.toLowerCase() : b
      // Return either 1 or -1 to indicate a sort priority
      if (a > b) {
        return 1
      }
      if (a < b) {
        return -1
      }
      // returning 0, undefined or any falsey value will use subsequent sorts or
      // the index as a tiebreaker
      return 0
    },
    PadRowComponent: () => <span>&nbsp;</span>, // the content rendered inside of a padding row
   
    // Controlled State Overrides (see Fully Controlled Component section)
    page: undefined,
    pageSize: undefined,
    sorted: [],
    filtered: [],
    resized: [],
    expanded: {},
   
    // Controlled State Callbacks
    onPageChange: undefined,
    onPageSizeChange: undefined,
    onSortedChange: undefined,
    onFilteredChange: undefined,
    onResizedChange: undefined,
    onExpandedChange: undefined,
   
    // Pivoting
    pivotBy: undefined,
   
    // Key Constants
    pivotValKey: '_pivotVal',
    pivotIDKey: '_pivotID',
    subRowsKey: '_subRows',
    aggregatedKey: '_aggregated',
    nestingLevelKey: '_nestingLevel',
    originalKey: '_original',
    indexKey: '_index',
    groupedByPivotKey: '_groupedByPivot',
   
    // Server-side callbacks
    onFetchData: () => null,
   
    // Classes
    className: '',
    style: {},
   
    // Component decorators
    getProps: () => ({}),
    getTableProps: () => ({}),
    getTheadGroupProps: () => ({}),
    getTheadGroupTrProps: () => ({}),
    getTheadGroupThProps: () => ({}),
    getTheadProps: () => ({}),
    getTheadTrProps: () => ({}),
    getTheadThProps: () => ({}),
    getTheadFilterProps: () => ({}),
    getTheadFilterTrProps: () => ({}),
    getTheadFilterThProps: () => ({}),
    getTbodyProps: () => ({}),
    getTrGroupProps: () => ({}),
    getTrProps: () => ({}),
    getTdProps: () => ({}),
    getTfootProps: () => ({}),
    getTfootTrProps: () => ({}),
    getTfootTdProps: () => ({}),
    getPaginationProps: () => ({}),
    getLoadingProps: () => ({}),
    getNoDataProps: () => ({}),
    getResizerProps: () => ({}),
   
    // Custom pagination rendering
    renderPageJump: ({ onChange, value, onBlur, onKeyPress, inputType, pageJumpText }) => component,
    renderCurrentPage: page => component,
    renderTotalPagesCount: pages => component,
    renderPageSizeOptions: ({
        pageSize,
        pageSizeOptions,
        rowsSelectorText,
        onPageSizeChange,
        rowsText,
      }) => component
   
    // Global Column Defaults
    // To override only some values, import { ReactTableDefaults } from 'react-table'
    // and construct your overrides (e.g. {...ReactTableDefaults.column, className: 'react-table-cell'})
    column: {
      // Renderers
      Cell: undefined,
      Header: undefined,
      Footer: undefined,
      Aggregated: undefined,
      Pivot: undefined,
      PivotValue: undefined,
      Expander: undefined,
      Filter: undefined,
      // Standard options
      sortable: undefined, // use table default
      resizable: undefined, // use table default
      filterable: undefined, // use table default
      show: true,
      minWidth: 100,
      // Cells only
      className: '',
      style: {},
      getProps: () => ({}),
      // Headers only
      headerClassName: '',
      headerStyle: {},
      getHeaderProps: () => ({})
      // Footers only
      footerClassName: '',
      footerStyle: {},
      getFooterProps: () => ({}),
      filterAll: false,
      filterMethod: undefined,
      sortMethod: undefined,
      defaultSortDesc: undefined,
    },
   
    // Global Expander Column Defaults
    // To override only some values, import { ReactTableDefaults } from 'react-table'
    // and construct your overrides (e.g. {...ReactTableDefaults.expanderDefaults, sortable: true})
    expanderDefaults: {
      sortable: false,
      resizable: false,
      filterable: false,
      width: 35
    },
   
    // Global Pivot Column Defaults
    pivotDefaults: {},
   
    // Text
    previousText: 'Previous',
    nextText: 'Next',
    loadingText: 'Loading...',
    noDataText: 'No rows found',
    pageText: 'Page',
    ofText: 'of',
    rowsText: 'rows',
   
    // Accessibility Labels
    pageJumpText: 'jump to page',
    rowsSelectorText: 'rows per page',
  }  

Override the core defaults using -

import { ReactTableDefaults } from 'react-table'

Object.assign(ReactTableDefaults, {
  defaultPageSize: 5,
  minRows: 2
  //...
})


Or
Just define them as props -
<ReactTable
  defaultPageSize={5}
  minRows={2}
  //...
/>

ReactTable Columns -
<ReactTable /> requires a columns prop, which is an array of objects containing the following properties
[{
    //...
    // General
    accessor: 'propertyName', // or Accessor eg. (row) => row.propertyName 
    id: 'myProperty', // Conditional - A unique ID is required if the accessor is not a string or if you would like to override the column name used in server-side calls
    sortable: boolean, // Overrides the table option
    resizable: boolean, // Overrides the table option
    filterable: boolean, // Overrides the table option
    show: true, // can be used to hide a column
    width: undefined, // A hardcoded width for the column. This overrides both min and max width options
    minWidth: 100, // A minimum width for this column. If there is extra room, column will flex to fill available space (up to the max-width, if set)
    maxWidth: undefined, // A maximum width for this column.
   
   
    // Cell Options
    className: '', // Set the classname of the `td` element of the column
    style: {}, // Set the style of the `td` element of the column
    // Header & HeaderGroup Options
    headerClassName: '', // Set the classname of the `th` element of the column
    headerStyle: {}, // Set the style of the `th` element of the column
    getHeaderProps: (state, rowInfo, column, instance) => ({}), 
    // Header Groups only
    columns: [...], // See Header Groups section below
   
    filterAll: false,
    //...
  }]  

Download source code from Github click...

NPM Source Link Click... for more detail

Labels

Labels:
By Anil Singh | Rating of this article (*****)

Popular posts from this blog

39 Best Object Oriented JavaScript Interview Questions and Answers

Most Popular 37 Key Questions for JavaScript Interviews. What is Object in JavaScript? What is the Prototype object in JavaScript and how it is used? What is "this"? What is its value? Explain why "self" is needed instead of "this". What is a Closure and why are they so useful to us? Explain how to write class methods vs. instance methods. Can you explain the difference between == and ===? Can you explain the difference between call and apply? Explain why Asynchronous code is important in JavaScript? Can you please tell me a story about JavaScript performance problems? Tell me your JavaScript Naming Convention? How do you define a class and its constructor? What is Hoisted in JavaScript? What is function overloadin
Read more

List of Countries, Nationalities and their Code In Excel File

Download JSON file for this List - Click on JSON file    Countries List, Nationalities and Code Excel ID Country Country Code Nationality Person 1 UNITED KINGDOM GB British a Briton 2 ARGENTINA AR Argentinian an Argentinian 3 AUSTRALIA AU Australian an Australian 4 BAHAMAS BS Bahamian a Bahamian 5 BELGIUM BE Belgian a Belgian 6 BRAZIL BR Brazilian a Brazilian 7 CANADA CA Canadian a Canadian 8 CHINA CN Chinese a Chinese 9 COLOMBIA CO Colombian a Colombian 10 CUBA CU Cuban a Cuban 11 DOMINICAN REPUBLIC DO Dominican a Dominican 12 ECUADOR EC Ecuadorean an Ecuadorean 13 EL SALVADOR
Read more

25 Best Vue.js 2 Interview Questions and Answers

What Is Vue.js? The Vue.js is a progressive JavaScript framework and used to building the interactive user interfaces and also it’s focused on the view layer only (front end). The Vue.js is easy to integrate with other libraries and others existing projects. Vue.js is very popular for Single Page Applications developments. The Vue.js is lighter, smaller in size and so faster. It also supports the MVVM ( Model-View-ViewModel ) pattern. The Vue.js is supporting to multiple Components and libraries like - ü   Tables and data grids ü   Notifications ü   Loader ü   Calendar ü   Display time, date and age ü   Progress Bar ü   Tooltip ü   Overlay ü   Icons ü   Menu ü   Charts ü   Map ü   Pdf viewer ü   And so on The Vue.js was developed by “ Evan You ”, an Ex Google software engineer. The latest version is Vue.js 2. The Vue.js 2 is very similar to Angular because Evan You was inspired by Angular and the Vue.js 2 components looks like -
Read more

React | Encryption and Decryption Data/Text using CryptoJs

To encrypt and decrypt data, simply use encrypt () and decrypt () function from an instance of crypto-js. Node.js (Install) Requirements: 1.       Node.js 2.       npm (Node.js package manager) 3.       npm install crypto-js npm   install   crypto - js Usage - Step 1 - Import var   CryptoJS  =  require ( "crypto-js" ); Step 2 - Encrypt    // Encrypt    var   ciphertext  =  CryptoJS . AES . encrypt ( JSON . stringify ( data ),  'my-secret-key@123' ). toString (); Step 3 -Decrypt    // Decrypt    var   bytes  =  CryptoJS . AES . decrypt ( ciphertext ,  'my-secret-key@123' );    var   decryptedData  =  JSON . parse ( bytes . toString ( CryptoJS . enc . Utf8 )); As an Example,   import   React   from   'react' ; import   './App.css' ; //Including all libraries, for access to extra methods. var   CryptoJS  =  require ( "crypto-js" ); function   App () {    var   data
Read more

.NET Core MVC Interview Questions and Answers

» OOPs Interview Questions Object Oriented Programming (OOP) is a technique to think a real-world in terms of objects. This is essentially a design philosophy that uses a different set of programming languages such as C#... Posted In .NET » .Net Constructor Interview Questions A class constructor is a special member function of a class that is executed whenever we create new objects of that class. When a class or struct is created, its constructor is called. A constructor has exactly the same name as that of class and it does not have any return type… Posted In .NET » .NET Delegates Interview Questions Delegates are used to define callback methods and implement event handling, and they are declared using the "delegate" keyword. A delegate in C# is similar to function pointers of C++, but C# delegates are type safe… Posted In .NET » ASP.Net C# Interview Questions C# was developed by Microsoft and is used in essentially all of their products. It is mainly used for
Read more