1.4.0 • Published 2 years ago

react-table-charlier v1.4.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Table component for React

What & Why

Displays a customizable table with a data set

Author

  • Alexandre Charlier

Technologies

  • made-with-JavaScript
  • made-with-React

Installation

Prerequisites

npm NodeJs

Installing react-table-charlier with npm.

npm install react-table-charlier

USE

Feature of react-table-charlier

  • Data adaptive table
  • Filter data by ascending or descending order
  • Alphanumeric search by column
  • Visual indication of the pages and the current
  • Page change by button or page number
  • Select number of lines per page

Options

  • Customization of the number of lines per page.
  • Change the name of the columns and select only those to be displayed.

Things the react-table-charlier doesn't do:

  • react-table-charlier does not fetch the data

implement the table with a single component of type - <Table/>.

<Table bodyElements={Array<object>} optionsTable={<object>} headerElements={<object>} />

The properties

  • bodyElements
  • headerElements
  • optionsTable

Body element is an array of objects representing the keys and values to display.

//exemple
 const myDataItems =[
     {
        firstName: 'George',
        lastName: 'Washington',
        dateOfBirth: '22/02/1732',
        ...
    },
    {
        ...
    } 
];


<Table bodyElements={myDataItems}  />

headerElement by default takes the name of the keys of the table. If you want to customize the name of each column in the header, create an object with the same key as your dataset and the value of your choice.

// by default
    firstName: 'firstName',
    lastName: 'lastName',
    dateOfBirth: 'dateOfBirth'

//exemple customize
 const myHeaderItems ={
     firstName: 'First name',
     lastName: 'Last name',
     dateOfBirth: 'Date of birth',
     ...
 }

<Table bodyElements={myDataItems} headerElements={myHeaderElements} />

Options, such as color or number of lines and possible selections are set in an object.

// by default
    nbRows:[10, 20]

//exemple customize
const myOptions={
    nbRows:[5,10,20,50]
  }

<Table bodyElements={myDataItems} optionsTable={myOptions} />

Code sample

//
import React from 'react';
import {Table} from 'react-table-charlier';

function App (){
   const myOptions={
       nbRows:[10,20,50]
   };

   const myHeaderItems ={
       firstName: 'First name',
       lastName: 'Last name',
       dateOfBirth: 'Date of birth'
   };

   const myDataItems =[
       { firstName: "George", lastName: "Washington", dateOfBirth: "22/02/1732" },
       { firstName: "John", lastName: "Adams", dateOfBirth: "30/10/1735" },
       { firstName: "Thomas", lastName: "Jefferson", dateOfBirth: "13/04/1743" }
   ];


   return (
       <div className="App">
           <Table bodyElements={myDataItems} headerElements={myHeaderItems} optionsTable={myOptions} />
       </div>
   );
}
1.4.0

2 years ago

1.3.2

2 years ago

1.3.0

2 years ago

1.2.1

2 years ago

1.2.0

2 years ago

1.1.0

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago