1.0.4 • Published 1 year ago

datable-react v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

datable-react

Datable is a ReactJS library to create a custom and sortable data table. This is the V1 of this project.

NPM JavaScript Style Guide

Image

Features

  • Searching a direct data
  • Paginate and Sort data
  • Customizable
  • Add table headers
  • Responsive

Install

npm install --save datable-react

or

npm i datable-react

General

import {DataTable} from 'datable-react';
import {Header} from 'datable-react';
import {Table} from 'datable-react';
import {Footer} from 'datable-react';
import {labels, data} from './your-data-repository'

//css module for the table
import "datable-react/dist/index.css";

//to use all the table - Header, table, footer 
<DataTable labels={labels} data={data} />

//to use the header
<Header labels={labels} data={data} />

//to use only the table
<Table labels={labels} data={data} />

//to use the footer
<Footer labels={labels} data={data} />

include data

// titles of columns:
const labels = [ 
      { text: "column title 1", value: "valueTitle1" },
      { text: "column title 2", value: "valueTitle2" },
      { text: "column title 3", value: "valueTitle3" },
      {...},
]

// data in rows:
const data = [ 
      { valueTitle1: "data 1",
        valueTitle2: "data 2",
        valueTitle3: "data 3",
       }
]

// example
const labels = [
    { text: "First Name", value: "firstName" },
    { text: "Last Name", value: "lastName" },
    { text: "Start Date", value: "startDate" },
    { text: "Department", value: "department" },
  ];
  
  const data = [
    {
      firstName: "Tyson",
      lastName: "Doe",
      startDate: "04/14/2021",
      department: "Marketing",
    },
    {
      firstName: "Anna",
      lastName: "Alia",
      startDate: "03/02/2020",
      department: "Marketing",
    },
]

Custom

PropertyTypeRequiredDefaultDescription
labelsarraytrue[]Names of columns
dataarraytrue[]Data in rows
languagebooleanfalsefalsefalse = french, true = english
firstBackgroundstringfalse'#5e5d5c'Background color of columns and active page
secondBackgroundstringfalse'#e9e9ed'Background color of certains rows and page not active
colorstringfalse'white'Column font color
arrowColorstringfalse'#75797a'Arrow's color to sort data
customButtonobjectfalse[]to customize the previous and next button
customColumnobjectfalsebackgroundColor, colorto customize the column component
customFooterobjectfalse[]to customize the footer component
customHeaderobjectfalse[]to customize the header component
customPaginationobjectfalse[]to customize the pagination
customRowobjectfalsebackgroundColor, filterto customize the row component
customSearchobjectfalse[]to customize the search section
customArrowobjectfalse[]to customize arrows to sort data
customLengthobjectfalse[]to customize the section of "show length entries"

Exemple custom

<DataTable 
labels={labels} 
data={data} 
language={true}
firstBackground={"#038C3E"}
secondBackground={"#DEF4E0"}
arrowColor={"#022601"}
/>

Image

License

MIT © loeMa

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago

0.1.0

1 year ago