Skip to content

alexaungmyooo/react-table-component

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Aung Myo OoAung Myo Oo
Aung Myo Oo
and
Aung Myo Oo
Feb 5, 2023
56e91a5 · Feb 5, 2023

History

24 Commits
Feb 5, 2023
Feb 1, 2023
Feb 1, 2023
Feb 5, 2023
Feb 5, 2023
Feb 5, 2023
Feb 5, 2023
Feb 5, 2023

Repository files navigation

Getting Started with Table Component

The Table Component is a UI component that displays data in a tabular format. It is designed to be highly customizable and flexible to meet the needs of different projects and users.

Features

  • Supports multiple columns
  • Supports sorting of columns
  • Ability to set column width
  • Responsive design for mobile devices
  • Easy to use API with customizable options

Running the project

To run the Table Component project, use the following steps:

  1. Clone the repository to your local machine using the following command:

git clone https://github.com/alexaung/table-component.git

  1. Navigate to the project directory:

cd table-component

  1. Install the dependencies:

npm install

yarn install

  1. Start the development server:

npm start

yarn start

  1. Visit http://localhost:3000 in your browser to see the Table Component in action.

Testing

To run the tests for the Table Component, use the following command:

npm run test

yarn test

Storybook

To run the Storybook for the Table Component, use the following command:

npm run storybook

yarn storybook

Usage

import Table from 'table-component';

const data = [ { "id": 1, "name": "Mavis Chen", "mobile": "9988 7654", "expiry": "Dec 2022", "penalty": "$600" }, { "id": 2, "name": "Rodney Artichoke", "mobile": "9988 7676", "expiry": "Nov 2022", "penalty": "$300" }, { "id": 3, "name": "Valentino Morose", "mobile": "8900 7654", "expiry": "Dec 2022", "penalty": "$600" }, { "id": 4, "name": "Alex Chen", "mobile": "9988 7654", "expiry": "Dec 2022", "penalty": "$600" }, { "id": 5, "name": "Eric Widget", "mobile": "9809 7654", "expiry": "Dec 2022", "penalty": "$600" } ];

const columns = [ { title: "Name", field: "name", sortable: true }, { title: "Mobile", field: "mobile", sortable: true }, { title: "Expiry", field: "expiry", sortable: true }, { title: "Penalty", field: "penalty", sortable: true }, ];

<Table data={data} columns={columns} />

Limitations

Currently, the Table Component has the following limitations:

  • Does not support pagination

Conclusion

The Table Component is a highly customizable and flexible solution for displaying data in a tabular format. Whether you need to display a small amount of data or a large amount, the Table Component has you covered. Try it out today and see how it can improve your project!

Authors

Alex Aung Myo Oo - Initial work - Author's Github See also the list of contributors who participated in this project.

License

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published