Giter Club home page Giter Club logo

react-delta-table's Introduction

React Delta Table

React TypeScript Visual Studio Code SASS Git

 

🏁 Requirements

 

React Data Table Component requires the following be installed in your project:

  • React 16.8.0+
  • React DOM 16.8.0+

If you're using Typescript:

  • Typescript 4.7.3

 

📦 Installation

 

npm

npm install react-delta-table

yarn

yarn add react-delta-table

 

📈 Features

 

  • Pagination
  • Search
  • Display/hide columns
  • Responsive
  • Export to CSV/JSON

 

📷 Check these link for a preview image

 

Dark table component

Light table component

 

🚀 How to use

 

I. Import

 

Import the DataTable from "react-delta-table". By default the table will set it width to 100%. Use a container if you want the table to use only a certain width.  

Example :  

import { createRoot } from 'react-dom/client';
import { DataTable } from 'react-delta-table';

const container = document.getElementById('root')
const root = createRoot(container)
root.render(
    <div style={{width: "80vw", margin: "auto"}}>
        <DataTable 
            headers={['First Name', 'Last Name', 'Birth', 'Start Date', 'Department', 'Street', 'City', 'State', 'Zip Code']} 
            rows={
                [
                    [
                        "Bruce",
                        "Wayne",
                        "06/17/1983",
                        "05/04/2022",
                        "Engineering",
                        "Blackgate",
                        "Gotham",
                        "NY",
                        "89000"
                    ],
                    [
                        "Clark ",
                        "Kent",
                        "01/08/1981",
                        "02/09/2022",
                        "Legal",
                        "General Ford",
                        "Metropolis",
                        "TX",
                        "7000"
                    ],
                    [
                        "Diana",
                        "Prince",
                        "05/14/1901",
                        "05/14/2022",
                        "Sales",
                        "Venici Beach",
                        "Miami",
                        "CA",
                        "28924"
                    ]
                ]
            }
            itemPerPageRanges={[5, 10, 20, 50, 100]}
            labels={{
                search: "Search : ",
                display: "Display : ",
                export: "Export to :",
                first: "First",
                previous: "Prev",
                next: "Next",
                last: "Last",
            }}
            className=""
            theme="dark"
        />
    </div>
)

 

II. Props

 

headers: Array[string] required

An array of strings that includes all your headers. The order in your array will be the order oof your headers

 

rows: Array[Array[string]] required

An array of arrays of strings. Each array in this array will be a row in your table. In each of this array (row) there will be a cell value

 

itemPerPageRanges: Array[number] required

Each number will be a possible number of items per page that you will can select in the item per page select component of the table

 

labels: Object { search: string, display: string, export: string, first: string, previous: string, next: string, last: string } required

Object that contains all the value for the text labels of the table. Replace the string value with what you want instead

 

className string

A className attribut that will be include in first position of the higher component of the table HTML tree. Check the inspector for the html of the component for more details.

 

theme: "dark" | "light" required

Two default dark/light style for the table component

react-delta-table's People

Contributors

tensorflowters avatar

Watchers

 avatar  avatar

Forkers

trellixvulnteam

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.