Skip to content

React plugin used to generate datatable from Array

Notifications You must be signed in to change notification settings

Pectorel/react-datatable

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React Datatable Light

A simple datatable library for React. Useful for displaying, sorting and searching through JSON Array data.

Features

  • Data displayed in a table
  • Sorting
  • Searching

How To Use ?

Prerequisite

  • React 18.2 or higher
  • Vite to setup your React project

installation

Npm npm i react-datatable-light -S

Yarn yarn add react-datatable-light

Pnpm pnpm add react-datatable-light

Import the Datatable react component from Datatable.jsx :

import Datatable from "react-datatable-light/Datatable"

function App(){
  const data = [
    {firstName: "John", lastName: "Doe"}, 
    {firstName: "Jane", lastName: "Smith"}
  ];

  return <Datatable data={data} />;
}

export default App;

Options

There are a few options that you can use with the library, to specify options use the option attribute in the Datatable component :

import Datatable from "react-datatable-light/Datatable";

<Datatable data={data} options={
  {perPage: 25, entries: false, search: true, sort: false}
}>

Options List

  • options.perPage (int) / Default : 10 | Defines the number of items per page
  • options.entries (boolean) / Default true | Show / Hide the entries select menu to change the entries showed per page
  • options.search (boolean) / Default true | Show / Hide the search input
  • options.sort (boolean) / Default true | enable / Disable the sort feature on columns
  • options.pagination.limit (int) / Default 5 | Indicates how much pages buttons we show at first and last page. Minimum limit is at 3 to avoid off limits and step option bugs in pagination.
  • options.pagination.step (int) / Default 1 | Indicates how much page number we get before and after current page when above the limit option. This option MUST be smaller than limit !

Custom style

You can add a className attribute to add your own css class

<Datatable data={data} className={"custom-class"}/>;

In your CSS file :

.custom-class{
    /* Your custom style */
}

About

React plugin used to generate datatable from Array

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published