supa-table

TableComponent

A table component for React applications. It allows for custom header and data configuration and supports sorting, searching, and pagination.

Contains:

• Children
• Title
• Close button

Installation

To install:

npm install supa-table

Usage

To use the component, import it into your React code and pass in the necessary props:

import TableComponent from 'supa-table';

const data = [
    {name: 'John Doe', age: 30, occupation: 'Developer'},
    {name: 'Jane Doe', age: 28, occupation: 'Designer'},
    {name: 'Bob Smith', age: 32, occupation: 'Manager'}
];

function MyComponent() {
    const headers = [
        {name: 'Name', key: 'name', sortable: true},
        {name: 'Age', key: 'age', sortable: true},
        {name: 'Occupation', key: 'occupation', sortable: true}
    ];
    const [tableData, setTableData] = useState(data);
    const [activeLimit, setActiveLimit] = useState(10);
    const [currentPage, setCurrentPage] = useState(1);
    const handlePageChange = (page: number) => {
        setCurrentPage(page);
    };
    const handleLimitChange = (limit: number) => {
        setActiveLimit(limit);
        // update table data
        setTableData(data)
    };
    const totalResults = data.length;
    const totalPages = Math.ceil(totalResults / limit);

    return (
        <TableComponent
            headers={headers}
            data={tableData}
            limit={activeLimit}
            limitOptions={[10, 20, 50, 100]}
            currentPage={currentPage}
            onPageChange={handlePageChange}
            onLimitChange={handleLimitChange}
            totalResults={totalResults}
            totalPages={totalPages}
        />
    );
}

Props

• The headers prop is an array of objects that define the table headers, with each object having a name, key, and sortable property.
• The data prop is an array of objects that define the table data.
• The limit prop sets the number of results to be shown per page, and the sortKey prop sets the key to sort the data by.
• The limitOptions prop is an array of numbers that define the options for the limit dropdown.
• The currentPage prop sets the current page number, and the onPageChange prop is a function that is called when the page is changed.
• The totalResults prop sets the total number of results, and the totalPages prop sets the total number of pages.
• The onPageChange prop is a function that is called a page is changed.
• The onPaginate prop is a function that is called when the pagination is changed.
• The onLimitChange prop is a function that is called when the limit is changed, the function will receive the selected limit as param.

License

This project is licensed under the MIT License - see the LICENSE file for details