npm.io
0.3.4 • Published 3 years ago

just-table

Licence
—
Version
0.3.4
Deps
0
Size
28 kB
Vulns
0
Weekly
0

just-table

A simple React table component that just works.

https://github.com/arnell0/just-table

example

import Table from 'just-table';

const data = [
    {
        'id': 1,
        'name': 'John',
        'surname': 'Doe',
        'age': 25,
    },
    {
        'id': 2,
        'name': 'Jane',
        'surname': 'Doe',
        'age': 23,
    },
    {
        'id': 3,
        'name': 'John',
        'surname': 'Smith',
        'age': 30,
    },
    {
        'id': 4,
        'name': 'Jane',
        'surname': 'Smith',
        'age': 28,
    },
]

// columns can be generated from data keys (camel case, underscore, dash) if autoGenerateColumns is true or columns can be provided manually

// with autoGenerateColumns
const JustTable = () => <Table data={data} /> // yes it's that simple


// with columns
const columns = [
    'id',
    'name',
    'surname',
    'age',
]

const JustTable = () => <Table data={data} columns={columns} />

example screenshot

Parameter Default Value Comment
data [] array of objects
columns [] array of objects
fullWidth true if true, table will take 100% width of parent container
autoGenerateColumns true if true, columns will be generated from data keys, if false, columns must be provided (camel case, underscore, dash)
pagination true if true, pagination will be enabled
paginationSize 10 number of rows per page (pagination have to be enabled)
search true if true, search will be enabled (search by all columns)
stickyHeader true if true, header will be sticky
stickyFooter true if true, footer will be sticky
styled false if true, table will be styled with base styling
onRowClick (row) => {} function to be called when row is expanded
onRowCreate () => {} function to be called when row is created
onColumnClick (column) => {} function to be called when column is expanded
onColumnCreate () => {} function to be called when column is created

styling

Styling is simple, if you want to style table, you can pass styled prop to table component and it will be styled with base styling. If you want to style table yourself, you can target the native HTML elements under the class "just-table" eg.

.just-table > table > tr > td {
    padding: 10px;
}

classes:

  • just-wrapper
  • just-table

TODO

  • pagination
  • search
  • style serach
  • rows per page
  • sticky header and footer
  • sort columns
  • onRowClick
  • onRowCreate
  • onColumnClick
  • onColumnCreate
  • base styling setting
  • select rows
  • filter columns
  • change all buttons to icons if user sets icons=true
  • virtualize
  • handle nested data