# just-table

> A simple React table component that just works.

Latest version **0.3.4** (published 2023-10-25) · 0 weekly downloads

## Install

```sh
npm install just-table
pnpm add just-table
yarn add just-table
bun add just-table
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.4 |
| Published | 2023-10-25 |
| First published | 2023-06-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 27.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | arnell0 |

## Links

- npm: https://www.npmjs.com/package/just-table
- npm.io page: https://npm.io/package/just-table

## Recent versions

- 0.3.4 (latest) — 2023-10-25
- 0.3.3 — 2023-10-25
- 0.3.2 — 2023-10-25
- 0.3.1 — 2023-10-25
- 0.3.0 — 2023-10-24
- 0.2.7 — 2023-10-16
- 0.2.6 — 2023-06-28
- 0.2.5 — 2023-06-28
- 0.2.4 — 2023-06-28
- 0.2.3 — 2023-06-28
- 0.2.2 — 2023-06-28
- 0.2.1 — 2023-06-28
- 0.2.0 — 2023-06-28
- 0.1.2 — 2023-06-27
- 0.1.1 — 2023-06-27
- … 1 more at https://npm.io/package/just-table/versions

## README

# just-table
A simple React table component that just works.  

[https://github.com/arnell0/just-table](Github)

# example
```javascript
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](https://github.com/arnell0/just-table/blob/main/screenshot.png?raw=true)

| 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. 

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

classes:
- just-wrapper
- just-table

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

---
_Source: https://npm.io/package/just-table · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
