# react-module-regular

> A React component that returns a table with a search input, sortable columns and customizable results per page.

Latest version **0.0.0** (published 2023-12-12) · 0 weekly downloads

## Install

```sh
npm install react-module-regular
pnpm add react-module-regular
yarn add react-module-regular
bun add react-module-regular
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2023-12-12 |
| First published | 2023-12-12 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | bdioubate |
| Keywords | react, modal, component, react-component |

## Links

- npm: https://www.npmjs.com/package/react-module-regular
- npm.io page: https://npm.io/package/react-module-regular

## Dependencies (8)

- [prop-types](https://npm.io/package/prop-types.md) ^15.8.1
- [web-vitals](https://npm.io/package/web-vitals.md) ^2.1.4
- [react-icons](https://npm.io/package/react-icons.md) ^4.7.1
- [react-scripts](https://npm.io/package/react-scripts.md) 5.0.1
- [@testing-library/react](https://npm.io/package/@testing-library/react.md) ^13.4.0
- [babel-preset-react-app](https://npm.io/package/babel-preset-react-app.md) ^10.0.1
- [@testing-library/jest-dom](https://npm.io/package/@testing-library/jest-dom.md) ^5.16.5
- [@testing-library/user-event](https://npm.io/package/@testing-library/user-event.md) ^13.5.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.0 (latest) — 2023-12-12

## README

# paginated-react-table

A React component that returns a table with a search input, sortable columns and customizable results per page.


## Installation

Install my-project with npm

```bash
  npm install paginated-react-table
```
    
## Usage/Examples

```javascript
import PaginatedReactTable from 'paginated-react-table'

const tableTitle = "Current Employees"
const headersArray = [
  'First Name', 
  'Last Name', 
  'Start Date', 
  'Department', 
  'Date of Birth', 
  'Street', 
  'City', 
  'State', 
  'Zip Code'
]
const dataArray = [
  {
    firstName: 'Larry', 
    lastName: 'Anderson', 
    startDate: '05/01/2020', 
    department: 'Human Resources', 
    dateOfBirth: '12/03/2001', 
    street: '4190 Woodside Circle', 
    city: 'Quincy', 
    state: 'FL', 
    zipCode: '32351'
  }, 
  {
    firstName: 'Simon', 
    lastName: 'Hornbeck', 
    startDate: '01/01/2018', 
    department: 'Legal', 
    dateOfBirth: '07/16/1999', 
    street: '3171 Cerullo Road', 
    city: 'Louisville', 
    state: 'KY', 
    zipCode: '40244'
  }, 
  { 
    firstName: 'Ashley', 
    lastName: 'Jones', 
    startDate: '09/14/2016', 
    department: 'Sales', 
    dateOfBirth: '09/03/1999', 
    street: '3931 Saints Alley', 
    city: 'Tampa', 
    state: 'FL', 
    zipCode: '33602'
  }
]

/*
N.B. : If you want to display a table with no data at initialization,
you can initialize with `dataArray = null` :
It will display 'No data available in table' inside the tbody,
and will disable the options (buttons, searchbar, select,...). 
*/

const App = () => {
  return (
    <PaginatedReactTable
      tableTitle={tableTitle}
      headersArray={headersArray}
      dataArray={dataArray}
    />
  )
}

export default App
```


## Props

| Prop | Type     | Description                |
| :-------- | :------- | :------------------------- |
| `tableTitle` | `string` | **Required**. Title of the table |
| `headersArray` | `array of str` | **Required**. Headers of the table |
| `dataArray` | `array of obj` | **Required**. Data of the table. If you don't have any data yet, initialise the array with `null`. |

## Node version

This package requires Node.js version 16.16.0 or later.
## License

[MIT](https://choosealicense.com/licenses/mit/)

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