stark-custom-datatable

Custom Datatable

Customizable datatable for react

Create customizable datatable

Installation

npm i stark-custom-datatable

Demo

Usage

Import this component in page where you want to display table content.

import CustomTable from 'stark-custom-datatable';

Use this in your page

import CustomTable from "stark-custom-datatable";

// some code

const rowData = [
    { id: 1, name: 'Sample name', email: '[e-mail]', rowClass:'bgred' },
    { id: 2, name: 'Sample name', email: '[e-mail]' },
    { id: 3, name: 'Sample name', email: '[e-mail]' },
    { id: 4, name: 'Sample name', email: '[e-mail]' },
  ]

// some code

render() {
    return (
        <>
        <CustomTable
        // role (optional:number) : Current user role for role wise column show
        role={1}
        // columns (required:array) : dispay column , id and label compulsory and one row column with 'id' key required  
        columns={[
          { id: 'id', label: 'Id', roleAccess: [1], isDisplay: true, columnRender: (col => (<span style={{ fontWeight: 'bold' }}>{col.label}</span>)), render: (row) => { return (<b>{row.name}</b>) } },
          { id: 'name', label: 'Name', roleAccess: [1] },
          { id: 'email', label: 'Email', roleAccess: [3], classes:'bgGray' },
        ]}
        // rows (required:array) : display row data of column
        rows={rowData}
        // tableClass (optional:String) : to override class of the table
        tableClass="table-striped"
        // tableContainerClass (optional:String) : to override class of the table wrapper
        tableContainerClass=""
        // dropdownContainerClass (optional:String) : to override class of the dropdown wrapper
        dropdownContainerClass=""
        // bulkActions (optional:array) : to add action on table
        bulkActions={[
          {
            actionTitle: 'Change Status',
            actionCallback: (e) => { console.log(e) },
          },
          {
            actionTitle: 'Delete',
            actionCallback: (e) => { console.log(e) },
          }
        ]}
        // showCheckbox (optional:boolean) : to show checkbox as first column
        showCheckbox={true}
        // showPagination (optional:boolean) : to show pagination of table
        showPagination={true}
        // paginationProps (optional:Object) : to display page number based on this props
        paginationProps={{
          totalItems: 5,
          itemsPerPage: 5,
          activePage: 1, //currentPage
          onPageChange:{(changedPage) => {
            console.log(changedPage);
          }}
        }}
        // selectedRowItems (optional:array) : to show selected row in table
        selectedRowItems={[4]}
        // onSelectRowsIndexes (optional:callback) : callback to get selected row ids
        onSelectRowsIndexes={(indexes) => {
          console.log('indexes', indexes); // eslint-disable-line
        }}
        // emptyRender (optional:callback) : callback to override empty table caption
        emptyRender={() => <h4>Data not exist</h4>}
        // emptyRender (optional:String) : override label of action button
        bulkActionsLabel="Apply"
      />
        </>
    )
}

column config

• id (required:number)
• labal (required:String)
• classes (optional:String)
• roleAccess (optional:Array) - if empty then this column will be visible to all user role. if roles are given then it will be column visible to that specifed roles
• isDisplay (optional:Boolean) - hide or show column
• columnRender (optional:callback) - to override column structure of specific column
• render (optional:callback) - to override data structure of specific column

bulkActions config

• actionTitle (required:String) - to display in action dropdown
• actionCallback (required:callback) - callback when action trigger which return selected row id from table

paginationProps config

• totalItems (required:Number) - total count of record for pagination
• itemsPerPage (required:Number) - to dispay no of record per page
• activePage (required:Number) - to check current page number
• onPageChange (optional: callback) - to get current page selected

dependencies package

• react-boostrap
• boostrap
• react-js-pagination
• react-notifications
• sweetalert